Skip to main content
payments

Create /payments

Create a payment. Required: rel_type (invoice, pre_invoice, or expense), document (related document UUID), total_amount, payment_mode. Optional: date, note. Returns record with the detail projection. Client notification emails are not sent for API creates.

POST
/payments

Authorizations

Authorizationstringheaderrequired

API key (Bearer token) created in Setup → API & MCP.

Body

application/json
datestring

Payment date (Y-m-d). Defaults to today on create when omitted.

documentstringrequired

UUID of the related invoice, pre-invoice, or expense (must match rel_type).

notestring

Payment note.

payment_modestringrequired

Payment mode ID from tenant payment modes.

rel_typestringrequired

Payment relation type: invoice, pre_invoice, or expense.

total_amountstringrequired

Total paid amount.

Response

application/json

Success

recordobject

Fields enabled for this documentation instance (projection enabled: feature, option, subdomain, closures) plus account-level form field visibility. Role- and user-level field overrides are not applied here, so an API key whose staff user has such overrides may receive fewer fields. A disabled field is omitted from the response object entirely; a present key with a null value means the record simply has no value.

Still need help? Ask the team