Organisation

Get organisation summary

Returns receivables totals for the authenticated organisation: amount outstanding, amount overdue, unpaid and overdue invoice counts and the number of active contacts. Totals are in the organisation's base currency.

get/organisation/summary

Request

  • Base URL: https://api.paidnice.com/rest/v1
  • URL: https://api.paidnice.com/rest/v1/organisation/summary
  • Auth: HTTP bearer

Response

The organisation summary

outstandingTotalnumber required
overdueTotalnumber required
unpaidInvoiceCountinteger required
overdueInvoiceCountinteger required
contactCountinteger required

Number of active contacts. Archived contacts are not counted.

currencystring required

Example response

{
  "outstandingTotal": 12500.5,
  "overdueTotal": 4200,
  "unpaidInvoiceCount": 42,
  "overdueInvoiceCount": 12,
  "contactCount": 310,
  "currency": "USD"
}

Changes

No recorded changes to this operation across all 1 revision of this API.