Treasury
List treasury accounts
Returns the accounts money comes in and goes out through, sorted by name; archived accounts are left out unless requested.
treasury:readtreasury:read- 120/min
- Server annotation: Read-only
- Server annotation: Idempotent
Result
generated from the schema
The BANK ACCOUNT NUMBER and the balance are not published: the identifier is enough to say which account a payment went through.
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: name, type, status, currency, createdAt, updatedAt. Defaults to "name". 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 account type: bank (a bank account), cash (a cash box) or manual.
Available options: bank, cash, manual
Filter by status: active, needs_reauth, disconnected or archived. Without it, archived accounts are left out unless includeArchived is true.
Available options: active, needs_reauth, disconnected, archived
Filter by currency, as an ISO 4217 code.
Limits: min length 3, max length 3
Set it to true to include archived accounts. Off by default; ignored when status is given.
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
Treasury account identifier.
Name by which the treasury account is recognized.
Nature of the treasury account: bank (a bank account), cash (a cash box) or manual.
Available options: bank, cash, manual
Currency of the treasury account, as an ISO 4217 code.
Treasury account status: active, needs_reauth (the bank connection must be renewed), disconnected or archived.
Available options: active, needs_reauth, disconnected, archived
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/accounts.
Related pages
Link to this section: Related pagesTreasury
List treasury accounts
Returns the accounts money comes in and goes out through, sorted by name; archived accounts are left out unless requested.
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?