Get invoice - useadam.io Developer API

Get invoice

curl --request GET \
  --url https://api.useadam.io/v1/adam/invoices/{uuid} \
  --header 'X-API-Key: <api-key>'

{
  "status": "success",
  "message": "Invoice retrieved successfully",
  "data": {
    "uuid": "550e8400-e29b-41d4-a716-446655440001",
    "date": "2024-01-15",
    "due_date": "2024-02-15",
    "narration": "Web development services",
    "total_amount": 1000,
    "amount_paid": 250,
    "balance": 750,
    "currency": "USD",
    "record_items": [],
    "payments": []
  }
}

GET

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

invoices

{uuid}

Get invoice

curl --request GET \
  --url https://api.useadam.io/v1/adam/invoices/{uuid} \
  --header 'X-API-Key: <api-key>'

{
  "status": "success",
  "message": "Invoice retrieved successfully",
  "data": {
    "uuid": "550e8400-e29b-41d4-a716-446655440001",
    "date": "2024-01-15",
    "due_date": "2024-02-15",
    "narration": "Web development services",
    "total_amount": 1000,
    "amount_paid": 250,
    "balance": 750,
    "currency": "USD",
    "record_items": [],
    "payments": []
  }
}

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

Invoice uuid or source_uuid.

Response

200 - application/json

Single 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.