---
title: "Get organisation summary"
method: GET
path: "/organisation/summary"
tags: ["Organisation"]
---

# Get organisation summary

`GET /organisation/summary`

## Request

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

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.

## Response `200`

The organisation summary

- OrganisationSummary
  - `outstandingTotal` number, required
  - `overdueTotal` number, required
  - `unpaidInvoiceCount` integer, required
  - `overdueInvoiceCount` integer, required
  - `contactCount` integer, required: Number of active contacts. Archived contacts are not counted.
  - `currency` string, required

## Other responses

- `400`: Invalid request
- `401`: Missing or invalid API key
- `403`: The public API is not enabled for the organisation, or the API key lacks the required scope
- `404`: The organisation could not be found
- `429`: Too many requests

---

[API](https://skmtc.dev/paidnice/apis/paidnice-public-api.md) · [All operations](https://skmtc.dev/paidnice/apis/paidnice-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/paidnice/apis/paidnice-public-api/revisions/d4911087b8e7?raw)