*REST API › Objects › Finance*

# Payment

> A collection or a payment recorded in treasury.

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`](https://docs.filmo.io/rest-api/endpoint-reference/invoices/list-the-payments-of-an-invoice). Payments are created and corrected from outside, and the treasury accounts they go through are not.

Schemas: `PaymentDto`

## Attributes

| Name | Type | Description |
| --- | --- | --- |
| `id` | string | Payment identifier. |
| `direction` | string | in when money comes in (a collection) and out when it goes out (a payment). |
| `amount` | string | Payment amount as a decimal string, in the indicated currency. |
| `currency` | string | Payment currency, as an ISO 4217 code. |
| `date` | string<date-time> | Payment date in ISO 8601 UTC. |
| `type` | string | normal, or deposit when it is an advance payment. |
| `treasuryAccountId` | string | Treasury account the payment goes through. |
| `contactId` | string | Customer or supplier of the payment; null if not declared. |
| `reference` | string | External reference of the payment; null if it has none. |
| `linkedDocuments` | object[] | Documents the payment is assigned to; empty if it is not linked to any. |
| `linkedDocuments.type` | string | Kind of the linked document. `invoice`, `creditNote`, `supplierInvoice`, `quote`, `proforma`, `salesReceipt`, `simpleCreditNote`, `purchaseOrder` |
| `linkedDocuments.id` | string | Identifier of the linked document. |
| `linkedDocuments.amount` | string | Amount of this payment assigned to the document, as a decimal string. |
| `createdAt` | string<date-time> | Creation date in ISO 8601 UTC. |
| `updatedAt` | string<date-time> | Last modification date in ISO 8601 UTC. |

## Example

*Payment · Generated from the schema*

```json
{
  "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"
}
```

## Returned by

- [`GET /api/v1/invoices/{invoiceId}/payments`](https://docs.filmo.io/rest-api/endpoint-reference/invoices/list-the-payments-of-an-invoice) — List the payments of an invoice
- [`GET /api/v1/treasury/payments`](https://docs.filmo.io/rest-api/endpoint-reference/treasury/list-treasury-payments) — List treasury payments
- [`GET /api/v1/treasury/payments/{paymentId}`](https://docs.filmo.io/rest-api/endpoint-reference/treasury/get-a-payment) — Get a payment

## Modified by

- [`POST /api/v1/treasury/payments`](https://docs.filmo.io/rest-api/endpoint-reference/treasury/record-an-incoming-or-outgoing-payment) — Record an incoming or outgoing payment
- [`PATCH /api/v1/treasury/payments/{paymentId}`](https://docs.filmo.io/rest-api/endpoint-reference/treasury/update-a-payment) — Update a payment
- [`POST /api/v1/treasury/payments/{paymentId}/links`](https://docs.filmo.io/rest-api/endpoint-reference/treasury/link-a-payment-to-a-document) — Link a payment to a document

---

Canonical URL: https://docs.filmo.io/rest-api/objects/payment  
Last updated: 2026-10-25