Skip to main content
POST
https://api.useadam.io/v1/adam
/
invoices
/
{uuid}
/
payments
Update invoice payments
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
      }
    ]
  }
}

Authorizations

X-API-Key
string
header
default:your_tyms_sk_or_partner_key
required

Business secret tyms_sk_... for all routes except Register business, which expects your partner secret.

Path Parameters

uuid
string
required

Body

application/json
payments
object[]
required
overwrite
boolean
default:false

If true, replaces all existing payments.

Response

200 - application/json

Payments applied to invoice

status
string
required
Example:

"success"

message
string
required
data
any

Single resource, array of resources, statement sections, or async job metadata — see each operation's example.

meta
object

Pagination (page, limit, total) and/or report range (from, to). Cash flow may include previous_period_end.