---
title: "List Invoices"
method: GET
path: "/invoices"
tags: ["Invoices"]
---

# List Invoices

`GET /invoices`

## Request

- Base URL: `https://api.pax8.com/v1`
- URL: `https://api.pax8.com/v1/invoices`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://token-manager.pax8.com/oauth/token`

Fetch a paginated list of invoices. Default page is 0 and default size is 10. The maximum page size is 200

## Query parameters

- `page` number
- `size` number
- `sort` 'invoiceDate' | 'dueDate' | 'status' | 'partnerName' | 'total' | 'balance' | 'carriedBalance'
- `status` 'Unpaid' | 'Paid' | 'Void' | 'Carried' | 'Nothing Due' | 'Credited'
- `invoiceDate` string, yyyy-MM-dd
- `invoiceDateRangeStart` string, yyyy-MM-dd
- `invoiceDateRangeEnd` string, yyyy-MM-dd
- `dueDate` string, yyyy-MM-dd
- `total` number
- `balance` number
- `carriedBalance` number
- `companyId` string, uuid

## Response `200`

Successful operation

- object
  - `content` Invoice[]
    - `id` string, uuid: The id
    - `invoiceDate` string, yyyy-MM-dd: The date the invoice is generated for
    - `dueDate` string, yyyy-MM-dd: The date on which payment is due
    - `balance` number: The current invoice balance
    - `carriedBalance` number: The outstanding balance until current invoiceDate
    - `total` number: The total amount due
    - `currencyCode` string: The currency ISO 4217 code
    - `partnerName` string: The name of the invoiced partner
    - `companyId` string, uuid: The company id
    - `externalId` string: The company external id
  - `page` Page
    - `size` number: The size of the page
    - `totalElements` unknown
    - `totalPages` unknown
    - `number` unknown

## Other responses

- `404`: Invalid companyId or productId

---

[API](https://skmtc.dev/pax8/apis/partner-endpoints.md) - [All operations](https://skmtc.dev/pax8/apis/partner-endpoints/llms.txt) - [OpenAPI document](https://skmtc.dev/pax8/apis/partner-endpoints/revisions/f90cec5b4720?raw)