InvoiceDto
Invoice data retrieved from third-party accounting platforms (Xero, QuickBooks, FreeAgent, etc.).
Used for displaying client invoice information and tracking outstanding balances within Sodium.
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Platform-specific invoice identifier (unique within the accounting platform) |
Platform-specific invoice identifier (unique within the accounting platform) | ||
| number | string | Invoice number (as displayed in the accounting platform) |
Invoice number (as displayed in the accounting platform) | ||
| customerId | string | Platform-specific customer identifier |
Platform-specific customer identifier | ||
| customerName | string | Customer/client name from the accounting platform |
Customer/client name from the accounting platform | ||
| totalAmount | number | Total invoice amount including tax |
Total invoice amount including tax | ||
| netAmount | number | Net amount before tax |
Net amount before tax | ||
| taxAmount | number | Tax (VAT) amount |
Tax (VAT) amount | ||
| amountDue | number | Outstanding amount still due (may be less than TotalAmount if partially paid) |
Outstanding amount still due (may be less than TotalAmount if partially paid) | ||
| date | string | Invoice date (when the invoice was issued) |
Invoice date (when the invoice was issued) | ||
| dueDate | string | Payment due date (null if no due date specified) |
Payment due date (null if no due date specified) | ||
| status | enum | Unknown Draft Unpaid Paid Overdue Void PartiallyPaid |
Unknown Draft Unpaid Paid Overdue Void PartiallyPaid | ||
| currency | string | Invoice currency code (e.g., "GBP", "USD", "EUR") |
Invoice currency code (e.g., "GBP", "USD", "EUR") | ||
| externalUrl | string | Direct link to view the invoice in the accounting platform |
Direct link to view the invoice in the accounting platform | ||
| isPdfAvailable | boolean | Whether a PDF can be downloaded for this invoice via the /pdf endpoint |
Whether a PDF can be downloaded for this invoice via the /pdf endpoint | ||
| platformData | object | Platform-specific data that doesn't fit into the common model |
Platform-specific data that doesn't fit into the common model | ||
JSON Example
{
"id": "string",
"number": "string",
"customerId": "string",
"customerName": "string",
"totalAmount": 0
}