Properties
| Name | Type | Description |
|---|---|---|
| code | string | The unique code for this submission |
The unique code for this submission | ||
| client | ClientRefDto | |
| billingDate | string | The target invoice date |
The target invoice date | ||
| submittedAt | string | When the invoice was pushed to the platform |
When the invoice was pushed to the platform | ||
| externalInvoiceId | string | The invoice ID from the accounting platform |
The invoice ID from the accounting platform | ||
| externalInvoiceNumber | string | The invoice number from the accounting platform |
The invoice number from the accounting platform | ||
| externalInvoiceUrl | string | Direct URL to view the invoice on the accounting platform |
Direct URL to view the invoice on the accounting platform | ||
| status | enum | Pending Submitted Failed Projected |
Pending Submitted Failed Projected | ||
| errorMessage | string | Failure reason if push failed |
Failure reason if push failed | ||
| sentToClientAt | string | When the accounting platform emailed this invoice to the client, or null if it did not |
When the accounting platform emailed this invoice to the client, or null if it did not | ||
| sendError | string | Why the invoice could not be emailed, on a submission that was otherwise raised successfully |
Why the invoice could not be emailed, on a submission that was otherwise raised successfully | ||
| lineCount | integer | Number of line items in this submission |
Number of line items in this submission | ||
| totalAmount | number | Total amount of all line items (Quantity × UnitPrice) |
Total amount of all line items (Quantity × UnitPrice) | ||
| submittedTotal | number | The line total at the moment the invoice was pushed to the accounting platform, pinned |
The line total at the moment the invoice was pushed to the accounting platform, pinned | ||
| lineItems | array of ClientBillingLineItemDto | The billing line items in this submission |
The billing line items in this submission | ||
| createdDate | string | When the submission was created |
When the submission was created | ||
| updatedDate | string | When the submission was last updated |
When the submission was last updated | ||
JSON Example
{
"code": "string",
"client": {
"code": "string",
"name": "string",
"logoUrl": "string"
},
"billingDate": "2024-01-01T00:00:00Z",
"submittedAt": "2024-01-01T00:00:00Z",
"externalInvoiceId": "string"
}