cURL
curl --request POST \ --url https://api.useadam.io/v1/adam/invoices/{uuid}/payments \ --header 'Content-Type: application/json' \ --header 'X-API-Key: <api-key>' \ --data ' { "payments": [ { "amount_paid": 123, "category": "<string>", "date": "2023-12-25", "uuid": "<string>", "exchange_rate": 123 } ], "overwrite": false } '
{ "status": "success", "message": "Invoice payments updated successfully", "data": { "uuid": "550e8400-e29b-41d4-a716-446655440001", "payments": [ { "uuid": "pay-uuid-1", "amount_paid": 500, "category": "Bank Transfer", "date": "2024-01-20", "exchange_rate": 1 } ] } }
Business secret tyms_sk_... for all routes except Register business, which expects your partner secret.
tyms_sk_...
Hide child attributes
Payment method / category (e.g. Cash, Bank Transfer).
Include to update an existing payment.
If true, replaces all existing payments.
Payments applied to invoice
"success"
Single resource, array of resources, statement sections, or async job metadata — see each operation's example.
Pagination (page, limit, total) and/or report range (from, to). Cash flow may include previous_period_end.
page
limit
total
from
to
previous_period_end