Record Invoice Payment

Invoices

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.

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

Invoice ID

Header Parameters

idempotency-key*string

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

amount*string

Match^[+-]?\d+(?:\.\d+)?$

method*string

Value in

"card"
"bank_transfer"
"cash"
"cheque"
"stripe"
"direct_debit"
"other"

reference?string

Lengthlength <= 500

paidAt?string

Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}(?::\d{2}(?:\.\d{1,9})?)?(?:Z|[+-]\d{2}:\d{2})$

notes?string

Lengthlength <= 2000

reportingFxRate?string

Match^[+-]?\d+(?:\.\d+)?$

reportingFxEffectiveDate?string

Response Body

`application/json`

curl -X POST "https://example.com/invoices/550e8400-e29b-41d4-a716-446655440000/payment" \  -H "idempotency-key: string" \  -H "Content-Type: application/json" \  -d '{    "amount": "string",    "method": "card"  }'

{  "success": true,  "paymentId": "string",  "invoiceStatus": "string",  "amountPaid": "string",  "amountDue": "string",  "overpaymentAmount": "string"}

Empty

List Invoices GET

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

Update Invoice PUT

Edit draft invoice metadata or perform an allowed lifecycle transition. Financial headers are derived from line items and payment states are ledger-derived.