List invoices - useadam.io Developer API

List invoices

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

{
  "status": "success",
  "message": "Invoices 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": 0,
      "balance": 1000,
      "currency": "USD",
      "source_uuid": null
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 1
  }
}

GET

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

invoices

List invoices

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

{
  "status": "success",
  "message": "Invoices 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": 0,
      "balance": 1000,
      "currency": "USD",
      "source_uuid": null
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 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.

Query Parameters

schema

string

page

integer

limit

integer

date_order

enum<string>

Available options:

asc,

desc

Response

200 - application/json

Paginated invoice list

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.