Invoices
List the payments of an invoice
Returns the treasury payments assigned to an invoice, newest first, with the same projection as GET /api.
treasury:readtreasury:read- 120/min
- Server annotation: Read-only
- Server annotation: Idempotent
Result
generated from the schema
What it reads are treasury payments, so it takes the treasury scope, not the invoices one. The invoice must belong to the account: an unknown or foreign invoice is a 404, not an empty list.
Arguments
Invoice identifier.
Limits: min length 1
Page size (1-500). Defaults to 50.
Limits: min 1, max 500
Opaque cursor of the page to return. Pass the value of pagination. from the previous response; treat it as opaque.
Limits: max length 200
Sort order: a single field, with a leading "-" for descending (e.g. "-updatedAt"). Sortable fields: date, amount, createdAt, updatedAt. Defaults to "-date". Ties are broken by id, so the order is stable across pages, and a cursor is bound to the sort it was issued with.
Limits: max length 200
Set it to true to include pagination., the number of results that match the filters across all pages. Off by default.
Result
On success the result carries structuredContent with data and meta. These are the attributes of data.
Show the attributes of data
Payment identifier.
in when money comes in (a collection) and out when it goes out (a payment).
Payment amount as a decimal string, in the indicated currency.
Limits: pattern ^-?\d+\.\d{2}$
Payment currency, as an ISO 4217 code.
Payment date in ISO 8601 UTC.
normal, or deposit when it is an advance payment.
Treasury account the payment goes through.
Customer or supplier of the payment; null if not declared.
External reference of the payment; null if it has none.
Documents the payment is assigned to; empty if it is not linked to any.
Show child attributesHide child attributes
Kind of the linked document.
Available options: invoice, creditNote, supplierInvoice, quote, proforma, salesReceipt, simpleCreditNote, purchaseOrder
Identifier of the linked document.
Amount of this payment assigned to the document, as a decimal string.
Limits: pattern ^-?\d+\.\d{2}$
Creation date in ISO 8601 UTC.
Last modification date in ISO 8601 UTC.
An error is a result with isError: true and the problem in content[0].; there is no structuredContent. See Errors.
The same operation by REST
This tool runs GET /api/v1/invoices/{invoiceId}/payments.
Related pages
Link to this section: Related pagesInvoices
List the payments of an invoice
Returns the treasury payments assigned to an invoice, newest first, with the same projection as
GET /api./v1 /treasury /payments /{paymentId} Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with
isError: trueand the problem in the first text block. Branch on itscode.
Was this page helpful?