Dashboard

Mobile dashboard summaries, built on the same aggregations as the web dashboard.

GET/api/v1/dashboard/receivables

Get the receivables summary

Scope: invoices.read

Total outstanding, overdue amount, and an aging breakdown across open invoices (SENT, PARTIALLY_PAID, OVERDUE).

Example request

curl "https://invoice.avscorp.in/api/v1/dashboard/receivables" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example response

JSON

{
  "totalOutstanding": 245000,
  "overdueAmount": 87000,
  "aging": [
    {
      "bucket": "Current",
      "amount": 158000
    },
    {
      "bucket": "1-30d",
      "amount": 42000
    },
    {
      "bucket": "31-60d",
      "amount": 25000
    },
    {
      "bucket": "61-90d",
      "amount": 12000
    },
    {
      "bucket": "90+d",
      "amount": 8000
    }
  ]
}

Possible errors: unauthorized, insufficient_scope, forbidden