GuideLab API
Invoices

List Invoices

Retrieve a paginated list of invoices for the authenticated lab. Supports filtering by status, clinic, and search text.

GET
/invoices

Retrieve a paginated list of invoices for the authenticated lab. Supports filtering by status, clinic, and search text.

Authorization

__Secure-guidelab-prod.session_token<token>

Production session cookie set for the guidelab.co domain by Better Auth

In: cookie

Query Parameters

page?integer
Range0 < value
Default1
limit?integer
Range0 < value <= 100
Default20
status?string
search?string
sortBy?string
Default"createdAt"

Value in

  • "createdAt"
  • "issueDate"
  • "dueDate"
  • "invoiceNumber"
  • "totalAmount"
sortOrder?string
Default"desc"

Value in

  • "asc"
  • "desc"
clinicId?string
partnershipId?string
Length1 <= length
currency?string

Value in

  • "GBP"
  • "EUR"
  • "USD"
  • "CAD"
  • "AUD"
  • "NZD"
  • "CHF"
  • "SEK"
  • "NOK"
  • "DKK"
  • "PLN"
  • "CZK"
  • "HUF"
  • "RON"
  • "INR"
  • "JPY"
  • "CNY"
  • "SGD"
  • "HKD"
  • "MXN"
  • "BRL"
  • "ZAR"
allTime?boolean||

Response Body

application/json

curl -X GET "https://example.com/invoices"
{  "data": [    {      "id": "string",      "invoiceNumber": "string",      "clinicId": "string",      "clinicName": "string",      "status": "string",      "subtotal": "string",      "taxAmount": "string",      "totalAmount": "string",      "amountPaid": "string",      "amountDue": "string",      "issueDate": "string",      "dueDate": "string",      "createdAt": "string",      "property1": null,      "property2": null    }  ],  "pagination": {    "page": 0,    "limit": 0,    "total": 0,    "totalPages": 0  }}
Empty

Get Invoice By Order GET

Look up the invoice associated with a specific order. Returns the full invoice detail including items and payments.

Record Invoice Payment POST

Record a manual payment against an invoice. Lab-only. Automatically updates invoice status (partially_paid/paid), creates a transaction record, and triggers Xero payment sync if configured.