---
title: "GET /customerInvoices"
method: GET
path: "/customerInvoices"
tags: ["Customer Invoices"]
---

# GET /customerInvoices

`GET /customerInvoices`

Returns a list of invoices. The list can be filtered by customer, job, invoice number, and due dates.

## Query parameters

- `pageSize` integer
- `sortOrder` union
  - 'asc'
  - 'desc'
- `pageCursor` string
- `sortField` union
  - 'id'
  - 'createdAt'
  - 'dueDate'
- `customerId` number
- `jobId` number
- `invoiceNumber` string
- `dueBefore` string, date-time
- `dueAfter` string, date-time
- `filterDirectDebitStatus` union
  - 'processing'
  - 'succeeded'
  - 'failed'

## Response `200`

Successful Response

- ListCustomerInvoicesResponse
  - `result` string, required
  - `data` CustomerInvoice[], required
    - `id` number, required
    - `jobId` number, required
    - `customerId` number, required
    - `attn` string, nullable, required
    - `title` string, required
    - `description` string, nullable, required
    - `invoiceNumber` string, nullable, required
    - `receiverEmail` string, nullable, required
    - `receiverFullName` string, nullable, required
    - `receiverPostalAddress` string, nullable, required
    - `dueDate` string, date-time, nullable, required
    - `dueDays` union, required
      - number
      - string
    - `invoiceDate` string, date-time, nullable, required
    - `paidAt` string, date-time, nullable, required
    - `subtotal` number, required
    - `taxValue` number, required
    - `totalPaid` number, nullable, required
    - `taxRate` number, required
    - `type` union, required
      - 'approved'
      - 'toBeApproved'
      - 'draft'
    - `status` union, required
      - 'unpaid'
      - 'draft'
      - 'voided'
      - 'paidDisputed'
      - 'unpaidDisputed'
      - 'paid'
    - `isSent` boolean, required
    - `isFinal` boolean, required
    - `createdAt` string, date-time, required
    - `fergusPayEnabled` boolean, required
    - `directDebitStatus` union, required
      - 'processing'
      - 'succeeded'
      - 'failed'
    - `links` Links[], required
      - `href` string, required
      - `rel` string, required
      - `type` 'GET' | 'POST' | 'PUT' | 'PATCH', required
  - `paging` Pagination
    - `perPage` number, required
    - `pageCount` number, required
    - `links` object, required
      - `self` string, required
      - `previous` string, nullable, required
      - `next` string, nullable, required

## Other responses

- `4XX` — Client Request Errors
- `5XX` — Server Errors

---

[API](https://skmtc.dev/fergus/apis/fergus-api.md) · [All operations](https://skmtc.dev/fergus/apis/fergus-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/fergus/fergus-api/revisions/b4f232a22363/schema)