Treasury
List treasury payments
Returns the collections and payments recorded in treasury, newest first, with the same projection as their GET.
treasury:readtreasury:read- 120/min
- Server annotation: Read-only
- Server annotation: Idempotent
Result
generated from the schema
Filter by direction, type, treasury account, contact, linked invoice, credit note or order, bank reconciliation and payment date. Notes and the reconciliation state are not published.
Arguments
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
Filter by direction: in (money coming in) or out (money going out).
Available options: in, out
Filter by payment type: normal, deposit (an advance payment) or transfer (an internal transfer between treasury accounts).
Available options: normal, deposit, transfer
Filter by type, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.
Available options: normal, deposit, transfer
Limits: min 1 items, max 50 items
Filter by the treasury account the payment goes through.
Limits: min length 1, max length 100
Filter by the customer or supplier of the payment.
Limits: min length 1, max length 100
Filter by the invoice the payment is assigned to.
Limits: min length 1, max length 100
Filter by the credit note the payment is assigned to.
Limits: min length 1, max length 100
Filter by the order the payment is assigned to.
Limits: min length 1, max length 100
Filter by bank reconciliation: true for reconciled payments, false for the ones still pending. Absent means no filter.
Set it to true to include pagination., the number of results that match the filters across all pages. Off by default.
Date filters by field. A bare day (YYYY-MM-DD) is read in the business timezone; an ISO 8601 instant with offset is applied as is by gte, lte, gt and lt, while on widens it to the whole business day that contains it. Fields: date.
Show child attributesHide child attributes
Show child attributesHide child attributes
From this day or instant, inclusive.
Up to this day or instant, inclusive.
Strictly after; a bare day means after the end of that day.
Strictly before; a bare day means before the start of that day.
Exactly that day; an instant means the whole business day that contains it.
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/treasury/payments.
Related pages
Link to this section: Related pagesTreasury
List treasury payments
Returns the collections and payments recorded in treasury, newest first, with the same projection as their GET.
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?