Invoices

An Invoice in Tabs represents a request for payment sent to a customer, detailing line items (products, services, or charges), pricing, and due dates. Invoices are generated from Obligations.

Invoice Object

Field	Type	Description	Required
id	`string`	Unique identifier for the invoice.	Yes
issueDate	`string` (YYYY-MM-DD)	The date the invoice was issued.	Yes
dueDate	`string` (YYYY-MM-DD)	The date the invoice is due.	Yes
sentDate	`string \| null` (YYYY-MM-DD)	The date the invoice was sent to the customer (if applicable).	No
createdAt	`string` (ISO 8601)	Timestamp when the invoice was created.	Yes
status	`InvoiceStatus`	Current status of the invoice (e.g., `DRAFT`, `OPEN`, `PAID`, etc.).	Yes
customerId	`string`	The ID of the customer this invoice is associated with.	Yes
originalDueDate	`string` (YYYY-MM-DD)	The original due date before any modifications.	Yes
originalIssueDate	`string` (YYYY-MM-DD)	The original issue date before any modifications.	Yes
total	`number` (cents)	Total invoice amount in cents. For example, `$100.00` = `10000`.	Yes
balanceRemaining	`number` (cents)	Remaining balance in cents (not yet paid).	Yes
externalIds	`ExternalId[]`	One or more external IDs referencing this invoice in other systems (e.g., ERP, CRM).	No
lineItems	`InvoiceItem[]`	The individual line items associated with this invoice (products, services, fees, etc.).	Yes

InvoiceItem

Each line item represents a single billing component on the invoice.

Field	Type	Description	Required
id	`string`	Unique identifier for the invoice item.	Yes
name	`string`	Name of the item (e.g., “Subscription Fee”).	Yes
description	`string`	Description providing additional details about the item.	No
quantity	`number`	Number of units for this item.	Yes
unitPrice	`number` (cents)	Price per unit in cents. For example, `$5.00` = `500`.	Yes
total	`number` (cents)	Total cost for this line item in cents (quantity × unitPrice).	Yes
item	`ItemV3Dto`	Reference to the underlying product or item details (SKU, metadata, etc.).	Yes

Note: The exact structure of item may vary depending on how your products are defined in Tabs (e.g., ItemV3Dto includes fields like SKU, descriptions, and metadata).

ExternalId

ExternalId objects can be attached to both invoices and invoice line items (if needed), helping you track these records in third-party systems.

Field	Type	Description	Required
externalId	`string`	The ID used in another system (e.g., an ERP record).	Yes
sourceType	`string` (enum)	The source system (e.g., `Salesforce`, `NetSuite`).	Yes
metadata	`any`	Additional metadata for context.	No