Finance

Payment

A collection or a payment recorded in treasury.

Schemas: PaymentDto

{
  "id": "id_8f2a1c",
  "direction": "string",
  "amount": "1234.50",
  "currency": "EUR",
  "date": "2026-09-01T08:00:00Z",
  "type": "string",
  "treasuryAccountId": "string",
  "contactId": "string",
  "reference": "string",
  "linkedDocuments": [
    {
      "type": "invoice",
      "id": "id_8f2a1c",
      "amount": "1234.50"
    }
  ],
  "createdAt": "2026-09-01T08:00:00Z",
  "updatedAt": "2026-09-01T08:00:00Z"
}

Generated from the schema

A collection or a payment recorded in a treasury account, with its direction (in or out), amount, currency, date and type. A payment can be tied to several documents, which linkedDocuments lists. List the payments of one invoice with GET /api/v1/invoices/{invoiceId}/payments. Payments are created and corrected from outside, and the treasury accounts they go through are not.

Attributes

idstring

Payment identifier.

directionstring

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

amountstring

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

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

currencystring

Payment currency, as an ISO 4217 code.

datestring<date-time>

Payment date in ISO 8601 UTC.

typestring

normal, or deposit when it is an advance payment.

treasuryAccountIdstring

Treasury account the payment goes through.

contactIdstring | null

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

referencestring | null

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

linkedDocumentsobject[]

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

Show child attributes

linkedDocuments.typestring

Kind of the linked document.

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

linkedDocuments.idstring

Identifier of the linked document.

linkedDocuments.amountstring

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

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

createdAtstring<date-time>

Creation date in ISO 8601 UTC.

updatedAtstring<date-time>

Last modification date in ISO 8601 UTC.

Returned by

GET /api/v1/invoices/{invoiceId}/payments — List the payments of an invoice
GET /api/v1/treasury/payments — List treasury payments
GET /api/v1/treasury/payments/{paymentId} — Get a payment

Modified by

POST /api/v1/treasury/payments — Record an incoming or outgoing payment
PATCH /api/v1/treasury/payments/{paymentId} — Update a payment
POST /api/v1/treasury/payments/{paymentId}/links — Link a payment to a document

Was this page helpful?

Example

Attributes

Returned by

Modified by