Integrate
Common Queries
Query examples for typical use cases
Receivables
By Vendor
GET /v1/receivables?vendor_id=XBy Vendor and Debtor
GET /v1/receivables?vendor_id=X&debtor_id=YBy Debtor
GET /v1/receivables?debtor_id=YAll Receivables (No Time Filter)
GET /v1/receivables?verified_since=allSince a Specific Date
GET /v1/receivables?verified_since=2026-01-01T00:00:00ZSingle Receivable
GET /v1/receivables/:idBy Status
Without a status filter, all statuses are returned. Use status to filter:
GET /v1/receivables?status=PENDING
GET /v1/receivables?status=APPROVED
GET /v1/receivables?status=PAID
GET /v1/receivables?status=SOLD
GET /v1/receivables?status=DISPUTED
GET /v1/receivables?status=ACKNOWLEDGEDCombined Filters
GET /v1/receivables?vendor_id=X&debtor_id=Y&status=APPROVEDWith History
GET /v1/receivables?expand[]=historyWith Metadata
GET /v1/receivables?expand[]=metadataWith Both
GET /v1/receivables?expand[]=history&expand[]=metadataVendors
All Vendors
GET /v1/vendorsVendors for a Debtor
GET /v1/vendors?debtor_id=YDebtors
All Debtors
GET /v1/debtorsDebtors for a Vendor
GET /v1/debtors?vendor_id=XPagination
First Page
GET /v1/receivables?page=1&limit=100Next Page
GET /v1/receivables?page=2&limit=100The response includes has_more: true when additional pages exist.
Reference
| Query | Endpoint |
|---|---|
| Receivables for vendor X with debtor Y | GET /v1/receivables?vendor_id=X&debtor_id=Y |
| All receivables for vendor X | GET /v1/receivables?vendor_id=X |
| All receivables (no time filter) | GET /v1/receivables?verified_since=all |
| Receivables updated in last 24h | GET /v1/receivables |
| Single receivable | GET /v1/receivables/:id |
| Debtors for vendor X | GET /v1/debtors?vendor_id=X |
| Vendors for debtor Y | GET /v1/vendors?debtor_id=Y |
| Filter by status | GET /v1/receivables?status=APPROVED |
| Include history | ?expand[]=history |
| Include metadata | ?expand[]=metadata |