GuideLab API

Get Finances Overview

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.

GET
/finances/overview

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.

Authorization

__Secure-guidelab-prod.session_token<token>

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

In: cookie

Response Body

application/json

curl -X GET "https://example.com/finances/overview"
{  "metrics": {    "currencyTotals": [      {        "currency": "string",        "totalOutstanding": "string",        "invoicedThisMonth": "string",        "invoicedThisMonthCount": 0,        "paymentsThisMonth": "string",        "paymentsThisMonthCount": 0,        "overdueAmount": "string",        "overdueCount": 0      }    ]  },  "recentInvoices": [    {      "id": "string",      "invoiceNumber": "string",      "clinicName": "string",      "clinicNameMissing": true,      "status": "string",      "totalAmount": "string",      "amountDue": "string",      "dueDate": "string",      "issueDate": "string",      "currency": "string"    }  ],  "recentPayments": [    {      "id": "string",      "invoiceId": "string",      "invoiceNumber": "string",      "clinicName": "string",      "clinicNameMissing": true,      "amount": "string",      "method": "string",      "status": "string",      "paidAt": "string",      "currency": "string"    }  ]}