GuideLab API
Finances

Get Finance Account

Retrieve financial summary for a specific clinic account. Lab-only. Returns total invoiced, paid, outstanding, overdue, credit balance, and last payment date.

GET
/finances/accounts/{id}

Retrieve financial summary for a specific clinic account. Lab-only. Returns total invoiced, paid, outstanding, overdue, credit balance, and last payment date.

Authorization

__Secure-guidelab-prod.session_token<token>

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

In: cookie

Path Parameters

id*string

Partnership (account epoch) ID

Query Parameters

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"

Response Body

application/json

application/json

curl -X GET "https://example.com/finances/accounts/550e8400-e29b-41d4-a716-446655440000?currency=GBP"
{  "partnershipId": "string",  "partnershipStatus": "string",  "clinicId": "string",  "clinicName": "string",  "clinicNameMissing": true,  "currency": "string",  "totalInvoiced": "string",  "totalPaid": "string",  "outstanding": "string",  "overdue": "string",  "creditBalance": "string",  "lastPaymentDate": "string",  "invoiceCount": 0,  "hasActivity": true}
{  "error": "string"}

Get Cashflow GET

Return bounded monthly cash receipts, refunds, expenses, and net cash in the lab reporting currency.

Get Finances Overview GET

Retrieve a finance dashboard overview for the authenticated lab. Lab-only. Returns key metrics (outstanding, invoiced this month, payments this month, overdue), plus recent invoices and payments.