---
title: "Lists invoice headers."
method: GET
path: "/api/v1/invoices"
tags: ["Invoices"]
---

# Lists invoice headers.

`GET /api/v1/invoices`

## Request

- Base URL: `https://app.flexonthejob.com`
- URL: `https://app.flexonthejob.com/api/v1/invoices`
- Auth: HTTP bearer

Requires `ViewInvoices`. Cursor-paginated: pass the last invoice's `syncId`
as `after`.
Also available as CSV (`Accept: text/csv` or `?format=csv`); paging cursor in `X-Next-Cursor`.

## Query parameters

- `status` 'Draft' | 'Sent' | 'Viewed' | 'PartiallyPaid' | 'Paid' | 'Overdue' | 'Cancelled' | 'Outstanding' | 'Consolidated'
- `jobId` integer
- `customerId` integer
- `updatedSince` string, date-time
- `after` string
- `limit` integer
- `format` 'csv'

## Response `200`

One page of invoice headers.

- PagedResponseOfInvoiceSummary: One page of a cursor-paginated /api/v1 collection (API_AND_MCP.md: `?after=<syncId>&limit=`).
  - `items` InvoiceSummary[]: Items of this page in ascending creation order.
    - `id` integer: Numeric id, usable in `/api/v1/invoices/{id}`.
    - `syncId` string, uuid: Stable cross-device id; also the pagination cursor.
    - `invoiceNumber` string: Human-readable invoice number, e.g. `INV-1042`.
    - `status` 'Draft' | 'Sent' | 'Viewed' | 'PartiallyPaid' | 'Paid' | 'Overdue' | 'Cancelled' | 'Outstanding' | 'Consolidated'
    - `customerId` integer, nullable: Billed customer id, if any.
    - `customerName` string, nullable: Billed customer name, if any.
    - `jobId` integer, nullable: Job the invoice bills, if any.
    - `jobNumber` string, nullable: Job number, if any.
    - `salesOrderId` integer, nullable: Sales order the invoice bills, if any.
    - `description` string, nullable: Optional description.
    - `invoiceDate` string, date-time: Issue date, ISO-8601 UTC at midnight, e.g. `2026-09-05T00:00:00Z`.
    - `dueDate` string, date-time: Due date, ISO-8601 UTC at midnight, e.g. `2026-10-05T00:00:00Z`.
    - `subtotal` number, double: Sum of lines before tax.
    - `taxAmount` number, double: Tax charged.
    - `total` number, double: Subtotal plus tax.
    - `amountPaid` number, double: Payments applied.
    - `storeCreditApplied` number, double: Store credit applied.
    - `balanceDue` number, double: Total minus payments and store credit.
    - `isConsolidated` boolean: True when this invoice consolidates other invoices.
    - `consolidatedIntoInvoiceId` integer, nullable: Id of the consolidated invoice that absorbed this one, if any.
    - `sentDate` string, date-time, nullable: When the invoice was first sent, ISO-8601 UTC (e.g. `2026-09-05T14:30:00Z`); null if never sent.
    - `paidDate` string, date-time, nullable: When the invoice was paid in full, ISO-8601 UTC; null until paid.
    - `createdAt` string, date-time: Creation time, ISO-8601 UTC.
    - `updatedAt` string, date-time, nullable: Last modification time, ISO-8601 UTC; null when never edited. Use with the `updatedSince` filter to poll for changes.
  - `nextCursor` string, nullable: SyncId of the last item; pass it back as `?after=` to fetch the next page. `null` when this is the last page.

## Other responses

- `400`: Unknown `after` cursor or unrecognized `status`.
- `401`: Unauthorized
- `403`: Forbidden
- `429`: Too Many Requests

---

[API](https://skmtc.dev/flexonthejob/apis/flex-api.md) · [All operations](https://skmtc.dev/flexonthejob/apis/flex-api/llms.txt) · [OpenAPI document](https://skmtc.dev/flexonthejob/apis/flex-api/revisions/19c8f4d27acf?raw)