Client invoices

View as Markdown
Invoices your customer has **issued** — what they bill the people they sell to. The mirror of the supplier invoices, for accounts that sell: each entry carries its number and dates, the recipient, the amounts and taxes, and whether the original document is available. Together, the two sides describe the trading of a business without asking it for a spreadsheet. <Tip> **The document is a separate call.** The invoice carries `attachments` — references by `id` — and the file comes from [Download a document](api:GET/executions/results/{execution_id}/attachments/v1/{attachment_id}), the same endpoint every other original goes through. </Tip> <Note title="Requires the `client_invoices_read` feature"> Features are chosen when the execution **starts**, not here. An execution that did not ask for `client_invoices_read` answers `204`, and the only way to get the data is to run another one. </Note> | Status | Meaning | | :--- | :--- | | `200` | The invoices. | | `202` | `feature_not_ready` — `client_invoices_read` is still running. **Only this family waits**: the ones that already closed answer now. | | `204` | The execution never asked for `client_invoices_read`. No body. | | `404` | No execution with that id for your application, or it has been deleted. | <Note> **Server to server only.** This call is authorised with your application secret: it belongs in your backend, never in a browser, a mobile app or anything your customer can read. </Note>

Authentication

X-APP-SECRETstring
Application Secret

Path parameters

execution_idstringRequiredformat: "object-id"
The execution, as the acceptance response returned it.

Response

**200 OK**<br>The invoices your customer **issues** — who they billed, for how much and when. Read together with the supplier invoices, it is a picture of a business’s trading rather than of its bank account. **An empty list is an answer, not a gap**: the feature ran and the source reported none.
idstringformat: "object-id"

Invoice ID for the current execution. Note: it may change between executions.

product"client_invoice"
sub_familyenum
fetch_datestringformat: "datetime"
Date this product was fetched
identifierstringOptional
Invoice number
contractstringOptional
Contract if any
issue_datestringOptionalformat: "datetime"
Issue date
due_datestringOptionalformat: "datetime"
Due date
tax_detailslist of objectsOptional
Tax details
total_tax_amountobjectOptional
Total tax amount
total_discount_amountobjectOptional
Total discount amount
total_amountobjectOptional
Total amount
total_net_amountobjectOptional
Total net amount
issuerobjectOptional
Issuer
receiverobjectOptional
Receiver
attachmentslist of objectsOptionalDefaults to []
List of attached supporting documents

Errors

404
Not Found Error
422
Unprocessable Entity Error