Skip to main content

​
List payments

GET /payments · requires payment_entry (view)
​
tab
string
default:"due"
due | overdue | reconcile | invoice | all
​
page
integer
default:"1"
​
pageSize
integer
default:"20"
Max 200.
​
contractId
string
​
subjectId
string
​
includeDeleted
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)
​
receivedAmount
number
Minimum 0.
​
receivedDate
string
ISO date.
​
method
string
​
payerName
string
​
receiptAccount
string
​
bankSerialNo
string
​
proof
string
File reference.
​
reconciliationStatus
string
pending | matched | exception
​
reconciliationNote
string
curl -X PATCH https://api.alforse.com/api/v1/payments/pay_123/receipt \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"receivedAmount": 250000, "receivedDate": "2026-08-05", "method": "bank_transfer"}'

​
Record invoice evidence

PATCH /payments/:paymentId/invoice · requires invoice (edit)
​
invoiceAmount
number
Minimum 0.
​
invoiceDate
string
ISO date.
​
invoiceNo
string
​
invoiceAttachment
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.