cURL
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": [] } }
Business secret tyms_sk_... for all routes except Register business, which expects your partner secret.
tyms_sk_...
Invoice uuid or source_uuid.
uuid
source_uuid
Single 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