Billing

Record a payment

View as Markdown

POSThttps://paysuitett.com/api/v1/invoices/{id}/payments

Records money received on a posted invoice, as Record payment does in the app: the payment and its journal go in together. The amount is in the invoice's currency and defaults to the balance due, so an empty object marks the invoice paid in full today by bank transfer into the default bank account. Returns 409 CONFLICT for a draft, void or fully paid invoice, and 400 for an amount over the balance due.

Access. Master key, or a personal key held by an owner/admin or accountant. The business must have the invoices service. Runs as the holder under their row-level security.

Path parameters

idstring · uuid
Invoice ID.

Body

A JSON object. Every field is optional.

paymentDatestring · date
The day the money was received. Defaults to today (Trinidad).
amountnumber
Amount received in the invoice's currency, up to the balance due. Defaults to the balance due.
methodstring
How the customer paid. Defaults to bank_transfer.Allowed:bank_transfercashchequecardother
accountIdstring · uuid
The bank or cash account it went into. Defaults to account 1000 Bank (or the first bank or cash account).
ttdReceivednumber
Invoices in another currency: the TTD that actually reached the bank, when it differs from the TTD at the invoice's rate.
notesstring
A note kept with the payment, up to 2000 characters.

Response

201 with a JSON body, as in the example.