Get the Collections header figures

curl --request GET \
  --url https://api.panoflow.io/v1/collections/summary \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.panoflow.io/v1/collections/summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "object": "collections_summary",
  "as_of": "2026-10-28T09:00:00Z",
  "month": "2026-10",
  "outstanding": {
    "amount": {
      "amount": 706500000,
      "currency": "NGN"
    },
    "invoice_count": 6
  },
  "overdue": {
    "amount": {
      "amount": 183000000,
      "currency": "NGN"
    },
    "invoice_count": 3,
    "reminders_enabled": true
  },
  "collected_this_month": {
    "amount": {
      "amount": 1230000000,
      "currency": "NGN"
    },
    "invoice_payment_count": 8,
    "includes_part_payments": true
  },
  "average_days_to_pay": {
    "days": 6,
    "previous_month_days": 8
  },
  "counts": {
    "invoices": 14,
    "payment_links": 4,
    "virtual_accounts": 14
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

Summary and customers

Get the Collections header figures

The four stat cards and tab counts on the Collections screen. “This month” is the calendar month in Africa/Lagos that contains as_of. Outstanding counts invoices in sent, partially_paid and overdue and sums what is left to pay on them; overdue is the subset past due_on. Average days to pay is the mean of (date paid in full − issued_on) over invoices paid in full this month.

Error codes: invalid_api_key, parameter_invalid, scope_missing, currency_not_enabled, rate_limited.

GET

collections

summary

Get the Collections header figures

curl --request GET \
  --url https://api.panoflow.io/v1/collections/summary \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.panoflow.io/v1/collections/summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "object": "collections_summary",
  "as_of": "2026-10-28T09:00:00Z",
  "month": "2026-10",
  "outstanding": {
    "amount": {
      "amount": 706500000,
      "currency": "NGN"
    },
    "invoice_count": 6
  },
  "overdue": {
    "amount": {
      "amount": 183000000,
      "currency": "NGN"
    },
    "invoice_count": 3,
    "reminders_enabled": true
  },
  "collected_this_month": {
    "amount": {
      "amount": 1230000000,
      "currency": "NGN"
    },
    "invoice_payment_count": 8,
    "includes_part_payments": true
  },
  "average_days_to_pay": {
    "days": 6,
    "previous_month_days": 8
  },
  "counts": {
    "invoices": 14,
    "payment_links": 4,
    "virtual_accounts": 14
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

Authorizations

Authorization

string

header

required

Server API key, scoped. pk_test_ keys hit the sandbox tenant.

Headers

X-Request-Id

string

Optional client correlation id, up to 128 characters. It is not echoed: the response's X-Request-Id is always our own req_… id. We log your value with the request as client_request_id, so support can find a request by either id. A longer value is refused with 400 parameter_invalid.

Maximum string length: 128

Query Parameters

currency

enum<string>

Currency to report in. Only NGN is live at launch. ISO 4217. Only NGN is live at launch; others return 422 currency_not_enabled.

Available options:

NGN,

USD,

GBP,

EUR,

GHS,

KES

Response

The summary.

Figures for the Collections header cards and tabs.

object

string

required

Always collections_summary.

Allowed value: "collections_summary"

as_of

string<date-time>

required

RFC 3339, UTC.

Example:

"2026-10-27T08:41:00Z"

month

string

required

The calendar month (Africa/Lagos) the "this month" figures cover, YYYY-MM.

Pattern: ^\d{4}-\d{2}$

outstanding

object

required

"Waiting to be paid": what is left to pay on invoices in sent, partially_paid and overdue.

Show child attributes

overdue

object

required

What is left to pay on invoices past their due date.

Show child attributes

collected_this_month

object

required

Money received against invoices this month, including part payments.

Show child attributes

average_days_to_pay

object

required

Mean days from issue to paid in full, for invoices paid in full this month.

Show child attributes

counts

object

required

Tab badge counts (all statuses).

Show child attributes

Accounts & transactions

Payments

Collections

Payroll

Approvals

Webhooks & events

OAuth

Get the Collections header figures

Authorizations

Headers

Query Parameters

Response