Treasury

List treasury payments

Returns the collections and payments recorded in treasury, newest first, with the same projection as their GET.

GET
/api/v1/treasury/payments

Request examples

curl https://app.filmo.io/api/v1/treasury/payments \
  --header "Authorization: Bearer $FILMO_API_KEY"
{
  "data": [
    {
      "id": "payment_9f3a2b",
      "direction": "Example direction",
      "amount": "120.00",
      "currency": "EUR",
      "date": "2026-09-01T08:00:00.000Z",
      "type": "Example type",
      "treasuryAccountId": "treasury_account_9f3a2b",
      "contactId": "contact_9f3a2b",
      "reference": "2026-0001",
      "linkedDocuments": [
        {
          "type": "invoice",
          "id": "linked_document_9f3a2b",
          "amount": "120.00"
        }
      ],
      "createdAt": "2026-09-01T08:00:00.000Z",
      "updatedAt": "2026-09-01T08:00:00.000Z"
    }
  ],
  "pagination": {
    "nextCursor": "eyJvIjoyMH0",
    "hasMore": true,
    "total": 1
  }
}

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.

Authorizations

Bearer API key with the scope below. treasury:read

Query parameters

limitintegerdefault:50

Page size (1-500). Defaults to 50.

Limits: min 1, max 500

cursorstring

Opaque cursor of the page to return. Pass the value of pagination.nextCursor from the previous response; treat it as opaque.

Limits: max length 200

sortstring

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

directionstring

Filter by direction: in (money coming in) or out (money going out).

Available options: in, out

typestring

Filter by payment type: normal, deposit (an advance payment) or transfer (an internal transfer between treasury accounts).

Available options: normal, deposit, transfer

typesstring[]

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

treasuryAccountIdstring

Filter by the treasury account the payment goes through.

Limits: min length 1, max length 100

contactIdstring

Filter by the customer or supplier of the payment.

Limits: min length 1, max length 100

invoiceIdstring

Filter by the invoice the payment is assigned to.

Limits: min length 1, max length 100

creditNoteIdstring

Filter by the credit note the payment is assigned to.

Limits: min length 1, max length 100

orderIdstring

Filter by the order the payment is assigned to.

Limits: min length 1, max length 100

reconciledboolean

Filter by bank reconciliation: true for reconciled payments, false for the ones still pending. Absent means no filter.

dateOnstring

The payment date falls on this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

dateAfterstring

The payment date is after this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

dateBeforestring

The payment date is before this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

dateFromstring

The payment date is on or after this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

dateTostring

The payment date is on or before this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

includeTotalbooleandefault:false

Set it to true to include pagination.total, the number of results that match the filters across all pages. Off by default.

Response

application/json

Successful response.

Response schema: PaymentDto

Envelope: PaymentList. meta.warnings is present only when the operation is deprecated.

Headers: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset

dataobject[]

Show child attributes
data.idstring

Payment identifier.

data.directionstring

in when money comes in (a collection) and out when it goes out (a payment).

data.amountstring

Payment amount as a decimal string, in the indicated currency.

Limits: pattern ^-?\d+\.\d{2}$

data.currencystring

Payment currency, as an ISO 4217 code.

data.datestring<date-time>

Payment date in ISO 8601 UTC.

data.typestring

normal, or deposit when it is an advance payment.

data.treasuryAccountIdstring

Treasury account the payment goes through.

data.contactIdstring | null

Customer or supplier of the payment; null if not declared.

data.referencestring | null

External reference of the payment; null if it has none.

data.linkedDocumentsobject[]

Documents the payment is assigned to; empty if it is not linked to any.

Show child attributes
data.linkedDocuments.typestring

Kind of the linked document.

Available options: invoice, creditNote, supplierInvoice, quote, proforma, salesReceipt, simpleCreditNote, purchaseOrder

data.linkedDocuments.idstring

Identifier of the linked document.

data.linkedDocuments.amountstring

Amount of this payment assigned to the document, as a decimal string.

Limits: pattern ^-?\d+\.\d{2}$

data.createdAtstring<date-time>

Creation date in ISO 8601 UTC.

data.updatedAtstring<date-time>

Last modification date in ISO 8601 UTC.

paginationobject

Opaque-cursor pagination metadata.

Show child attributes
pagination.nextCursorstring | null

Opaque cursor of the next page; null when there are no more results. Pass it as cursor in the next request.

pagination.hasMoreboolean

Whether more results exist beyond this page.

pagination.totalinteger

Number of results matching the filters across all pages. Present only when the request sets includeTotal=true.

Limits: min 0

metaobject

Additional information about the response.

Show child attributes
meta.warningsobject[]

Lifecycle warnings; present only when the operation is deprecated.

Show child attributes
meta.warnings.codestring

Stable warning code.

Available options: deprecated

meta.warnings.messagestring

For people: what is deprecated, until when, and what to use.

meta.warnings.sunsetstring

Day (YYYY-MM-DD) the operation stops being served.

meta.warnings.replacementstring | null

operationId of the operation to use instead, or null if there is none.

Errors

StatusCodesMeaning
400validation_errorMalformed query or body. errors[] lists every offending field with its stable code.

401, 403, 429, 500 can be returned by any operation. Errors

Deprecation

This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date. Versioning policy

  • Finance

    Payment

    A collection or a payment recorded in treasury.