Invoices
Invoice records with line items and transaction details
Columns
| Name | Type | ReadOnly | References | Description |
| Uuid [KEY] | String | True |
ChartMogul-generated UUID | |
| CustomerUuid | String | False |
Customers.Uuid |
Associated customer UUID |
| ExternalId | String | False |
External invoice identifier | |
| CollectionMethod | String | False |
Collection method type The allowed values are automatic, manual. | |
| Status | String | True |
Invoice status The allowed values are open, paid, refunded, voided, written_off. | |
| InvoiceDate | Datetime | False |
Invoice date | |
| DisabledAt | Datetime | True |
Disablement timestamp | |
| DueDate | Datetime | False |
Payment due date | |
| Currency | String | False |
Invoice currency code | |
| CustomerExternalId | String | True |
Customer external identifier | |
| IsDisabled | Boolean | True |
Disabled status | |
| DisabledBy | String | True |
User who disabled invoice | |
| EditHistorySummary | String | True |
Edit history tracking | |
| Errors | String | True |
Validation errors | |
| LineItems | String | False |
Array of line item objects | |
| Transactions | String | False |
Array of transaction objects | |
| IsUserCreated | Boolean | True |
User-created flag |
Pseudocolumns
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description |
| DataSourceUuid | String |
Filter invoices by data source UUID |
| ValidationType | String |
Filter invoices by validation status The allowed values are valid, invalid, all. |
| IncludeEditHistories | Boolean |
Include edit history summary for automatic sources |
| IncludeDisabled | Boolean |
Include disabled invoices in response |