VUZDevelopers

Get outstanding invoices with pagination

GET
/analytics/collections/outstanding

Retrieves paginated list of outstanding invoices.

Sort Options:

  • amount: Outstanding amount
  • daysOverdue: Days past due date (default)
  • client: Client name
  • dueDate: Due date

Filter Options:

  • Aging bucket (current, 31-60, 61-90, 90+)

Data Returned:

  • Invoice details (number, client, amounts)
  • Due date and days overdue
  • Aging bucket with color coding

Authorization

X-Api-Key<token>

Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.

In: header

Query Parameters

page?number

Page number

Default1
limit?number

Items per page

Default20
sortBy?string

Sort field

Default"daysOverdue"

Value in

  • "amount"
  • "daysOverdue"
  • "client"
  • "dueDate"
sortOrder?string

Sort order

Default"desc"

Value in

  • "asc"
  • "desc"
agingBucket?string

Filter by aging bucket

Value in

  • "current"
  • "31-60"
  • "61-90"
  • "90+"

Response Body

application/json

application/json

curl -X GET "https://example.com/analytics/collections/outstanding"
{  "currency": "string",  "invoices": [    {      "id": "string",      "documentNumber": "string",      "docType": "string",      "clientId": "string",      "clientName": "string",      "amount": 0,      "paidAmount": 0,      "outstanding": 0,      "issueDate": "string",      "dueDate": "string",      "daysOverdue": 0,      "agingBucket": "string",      "agingColor": "string"    }  ],  "pagination": {    "total": 0,    "page": 0,    "limit": 0,    "totalPages": 0  }}