Skip to main content

List payments

GET /payments · requires payment_entry (view)
string
default:"due"
due | overdue | reconcile | invoice | all
integer
default:"1"
integer
default:"20"
Max 200.
string
string
boolean

Payment stats

GET /payments/stats · requires payment_entry (view) Summary counts for the current tenant (and subjectScope, if restricted) — this is what backs the Dashboard receivables numbers.

Record a receipt

PATCH /payments/:paymentId/receipt · requires payment_entry (edit)
number
Minimum 0.
string
ISO date.
string
string
string
string
string
File reference.
string
pending | matched | exception
string

Record invoice evidence

PATCH /payments/:paymentId/invoice · requires invoice (edit)
number
Minimum 0.
string
ISO date.
string
string
File reference.
All fields on both endpoints are optional — send only what changed. See Payments & Invoices for how this fits into the contract lifecycle, and Files for how proof / invoiceAttachment file references are produced.