Update invoice (partial)

curl --request PATCH \
  --url https://api.useadam.io/v1/adam/invoices/{uuid} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "date": "2023-12-25",
  "due_date": "2023-12-25",
  "narration": "<string>",
  "record_items": [
    "<unknown>"
  ]
}
'

{
  "status": "success",
  "message": "Invoice updated successfully",
  "data": {
    "uuid": "550e8400-e29b-41d4-a716-446655440001",
    "narration": "Updated invoice description"
  }
}

PATCH

https://api.useadam.io/v1/adam

invoices

{uuid}

Update invoice (partial)

curl --request PATCH \
  --url https://api.useadam.io/v1/adam/invoices/{uuid} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "date": "2023-12-25",
  "due_date": "2023-12-25",
  "narration": "<string>",
  "record_items": [
    "<unknown>"
  ]
}
'

{
  "status": "success",
  "message": "Invoice updated successfully",
  "data": {
    "uuid": "550e8400-e29b-41d4-a716-446655440001",
    "narration": "Updated invoice description"
  }
}

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

date

string<date>

due_date

string<date>

narration

string

record_items

any[]

Response

200 - application/json

Invoice updated (partial)

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.