Invoice

List invoices

Returns invoices for the authenticated organisation ordered by due date, earliest first. Defaults to unpaid invoices; filter by contact, status or due date range. Deleted invoices are never returned.

get/invoices

Request

Base URL: https://api.paidnice.com/rest/v1
URL: https://api.paidnice.com/rest/v1/invoices
Auth: HTTP bearer

Query parameters

limitinteger

Maximum number of records to return

Example:10

cursorstring

Opaque cursor from a previous response's nextCursor. Omit to start from the most recent record.

contactIdinteger nullable

Only invoices for this contact

Example:123

status'unpaid' | 'overdue' | 'paid'

unpaid: approved invoices with a balance owing. overdue: unpaid invoices whose due date has passed in the organisation's timezone. paid: fully paid invoices.

dueBeforestring date

Only invoices due on or before this date (YYYY-MM-DD)

Example:2026-06-30

dueAfterstring date

Only invoices due on or after this date (YYYY-MM-DD)

Example:2026-06-01

Response

A page of invoices

nextCursorstring

Pass as the cursor query parameter to fetch the next page. Absent on the last page.

Example response

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000123",
      "accountingSystemId": "INV-123",
      "status": "AUTHORISED",
      "number": "INV-000123",
      "reference": "PO-456",
      "currency": "USD",
      "sentToCustomer": true,
      "dueAmount": 12.5,
      "totalAmount": 50,
      "subtotalAmount": 45,
      "taxAmount": 5,
      "paidAmount": 10,
      "discountAmount": 2,
      "creditedAmount": 3,
      "exchangeRate": 1,
      "accountingSystemExchangeRate": 1.25,
      "issueDate": "2026-06-01",
      "dueDate": "2026-06-15",
      "lastSyncedDate": "2026-06-16T08:00:00.000Z",
      "portalUrl": "https://portal.paidnice.com/i/abc123"
    }
  ]
}

Changes

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