API Docs / Schemas / ClientInvoiceSubmissionDto

ClientInvoiceSubmissionDto

Response DTO for an invoice submission

Properties

Name Type Description
codestring

The unique code for this submission

The unique code for this submission

clientCodeAndNameDto
billingDatestring

The target invoice date

The target invoice date

submittedAtstring

When the invoice was pushed to the platform

When the invoice was pushed to the platform

externalInvoiceIdstring

The invoice ID from the accounting platform

The invoice ID from the accounting platform

externalInvoiceNumberstring

The invoice number from the accounting platform

The invoice number from the accounting platform

externalInvoiceUrlstring

Direct URL to view the invoice on the accounting platform

Direct URL to view the invoice on the accounting platform

statusenum

Pending Submitted Failed Projected

Pending Submitted Failed Projected

errorMessagestring

Failure reason if push failed

Failure reason if push failed

lineCountinteger

Number of line items in this submission

Number of line items in this submission

totalAmountnumber

Total amount of all line items (Quantity × UnitPrice)

Total amount of all line items (Quantity × UnitPrice)

lineItemsarray of ClientBillingLineItemDto

The billing line items in this submission

The billing line items in this submission

createdDatestring

When the submission was created

When the submission was created

updatedDatestring

When the submission was last updated

When the submission was last updated

JSON Example

{
  "code": "string",
  "client": {
    "code": "string",
    "name": "string"
  },
  "billingDate": "2024-01-01T00:00:00Z",
  "submittedAt": "2024-01-01T00:00:00Z",
  "externalInvoiceId": "string"
}

Used By Operations

Contained in Schemas