Developers

Invoices

Aphra makes an invoice for every completed treatment, and businesses can write invoices by hand. Use this endpoint to copy them into your accounting package.

Statuses

Status Meaning
draft Not sent yet, can still change.
issued Sent to the customer, not yet paid.
paid Paid.
void Cancelled.

List invoices

GET /api/v1/invoices

Scope: invoices:read. Newest first.

Query parameter Description
status Only invoices with this status.
limit, offset See pagination.
curl "https://app.aphrabooking.com/api/v1/invoices?status=paid&limit=100" \
  -H "Authorization: Bearer $APHRA_KEY"
{
  "invoices": [
    {
      "id": "a91f0c2e-4b6d-4e8a-9c3f-1d2e5b7a8c90",
      "number": "2026-0142",
      "status": "paid",
      "subtotal": 59.09,
      "taxTotal": 5.91,
      "total": 65,
      "currency": "USD",
      "issueDate": "2026-11-20",
      "dueDate": "2026-11-20",
      "customerName": "Maria Janga",
      "customerEmail": "maria@example.com",
      "createdAt": "2026-11-20T15:02:37.551+00:00"
    }
  ],
  "limit": 100,
  "offset": 0
}

issueDate and dueDate are calendar dates in the business’s time zone, without a time. Invoice lines are not in the response yet.