DocumentPayment (object)
Payment record linking a payable (invoice, credit note, dunning, receipt) to an optional bank transaction.
| Feld | Typ | Beschreibung | |||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| amount_cents* | integer | Signed; positive = incoming payment, negative = outgoing (e.g. credit note payout) | |||||||||||||||||||||||||||
| bank_transaction | allOf(1) | Present when bank_transaction_id is set and relation was loaded Bank transaction linked to a document payment (subset of fields for display).
| |||||||||||||||||||||||||||
| bank_transaction_id | integer | Set when this payment is linked to a bank transaction | |||||||||||||||||||||||||||
| created_at | string (date-time) | Creation timestamp in ISO 8601 format. | |||||||||||||||||||||||||||
| currency_code | string | — | |||||||||||||||||||||||||||
| id* | integer | — | |||||||||||||||||||||||||||
| note | string | — | |||||||||||||||||||||||||||
| payable_id* | integer | — | |||||||||||||||||||||||||||
| payable_type* | string | API entity type of the document (Invoice, CreditNote, Dunning, Receipt) | |||||||||||||||||||||||||||
| payment_date* | string | Date in Y-m-d format | |||||||||||||||||||||||||||
| payment_kind | string | bank = real bank payment; clearing = invoice/credit note offset without bank movement string
| |||||||||||||||||||||||||||
| settlement_credit_note_id | integer | Credit note id for clearing payments; use with settlement_id to reverse the offset from invoice views | |||||||||||||||||||||||||||
| settlement_id | integer | Set for clearing payments that belong to a payable settlement |
Beispiel (JSON)
{
"id": 0,
"payable_type": "string",
"payable_id": 0,
"amount_cents": 0,
"currency_code": "string",
"payment_date": "2025-01-14T00:00:00.000Z"
}