# Lists a collection of invoices

<span class="api-endpoint">GET {{<a href="#urlbases">baseURL</a>}}/pay-int-api/invoices</span>
This endpoint returns a list of invoices for the current merchant.
The query parameters are filters used to more precisely return selected invoices.
If no filters are specified, all invoices are returns.
The search uses inclusive matching.
That is, all specified filters must match to return an invoice.

Endpoint: GET /pay-int-api/invoices
Version: V1
Security: Bearer

## Query parameters:

  - `issueDateFrom` (string)
    Specifies the start date-time (in an ISO 8601 date-time UTC format) the invoice was issued.

The fields `issueDateFrom` and `issueDateTo` can be used together to form an inclusive date-time range.

Examples:<br>
2026-02<br>
2026-02-19<br>
2026-02-19T20:24:52.934Z

  - `issueDateTo` (string)
    Specifies the end date-time (in an ISO 8601 date-time UTC format) the invoice was issued.

The fields `issueDateFrom` and `issueDateTo` can be used together to form an inclusive date-time range.

Examples:<br>
2026-02<br>
2026-02-21<br>
2026-02-21T20:24:52.934Z

  - `dueDateFrom` (string)
    Specifies the start date-time (in an ISO 8601 date-time UTC format) the invoice is due.

The fields `dueDateFrom` and `dueDateTo` can be used together to form an inclusive date-time range.

Examples:<br>
2026-02<br>
2026-02-19<br>
2026-02-19T20:24:52.934Z

  - `dueDateTo` (string)
    Specifies the end date-time (in an ISO 8601 date-time UTC format) the invoice is due.

The fields `dueDateFrom` and `dueDateTo` can be used together to form an inclusive date-time range.

Examples:<br>
2026-02<br>
2026-02-21<br>
2026-02-21T20:24:52.934Z

  - `paymentDateFrom` (string)
    Specifies the start date-time (in an ISO 8601 date-time UTC format) the invoice was paid.

The fields `paymentDateFrom` and `paymentDateTo` can be used together to form an inclusive date-time range.

Examples:<br>
2026-02<br>
2026-02-19<br>
2026-02-19T20:24:52.934Z

  - `paymentDateTo` (string)
    Specifies the end date-time (in an ISO 8601 date-time UTC format) the payment was paid.

The fields `paymentDateFrom` and `paymentDateTo` can be used together to form an inclusive date-time range.

Examples:<br>
2026-02<br>
2026-02-21<br>
2026-02-21T20:24:52.934Z

  - `status` (integer)
    Specifies the status of the invoice.

Possible values:

| Value | Name              |
|:-----:|-------------------|
| 1     | Draft             |
| 2     | Published         |
| 3     | Paid              |
| 4     | Expired           |
| 5     | Canceled          |
| 6     | ProcessingPayment |
| 7     | Refunded          |

Example: 2

  - `page` (integer)
    Specifies the page number of the returned search results.

A page is considered each set of the `pageSize` value.

The maximum page value is the `pageSize` divided by the `total` count rounded up.
The count is zero-based.
For example, if `pageSize` is 50 and the `total` is 130, there are three pages.
The maximum `page` value is 2.

Values above the maximum page value will complete successfully but not return any items.

Example: 0

  - `pageSize` (integer)
    Specifies the number of items for each page of the returned search results.

A page is considered each set of the `pageSize` value.

The maximum page value is the `pageSize` divided by the `total` count rounded up.
The count is zero-based.
For example, if `pageSize` is 50 and the `total` is 130, there are three pages.
The maximum `page` value is 2.

Example: 50

  - `asc` (boolean)
    Specifies the sort order is ascending.

The sort field is specified by the `orderBy` value.

If `true`, the sort order is ascending.<br>
If `false`, the sort order is descending.

Example: true

  - `search` (string)
    Specifies the search string.

This performs a case insensitive, matching, or partially matching search.

Fields does not have to be specified.
If the results are to be sorted, the field `orderby` to specify the sort field.

## Header parameters:

  - `x-api-version` (string)

## Response 200 fields (application/json):

  - `items` (array)

  - `items.id` (string)

  - `items.number` (string)

  - `items.customerName` (string)

  - `items.issueDate` (string)
    Indicates the date-time (in an ISO 8601 date-time UTC format) of the invoice's issue.

Examples: 2026-02-19T20:24:52.934Z
    Example: 2026-02-19T20:24:52.934Z

  - `items.dueDate` (string)
    Indicates the date-time (in an ISO 8601 date-time UTC format) the due date of the invoice.

Examples: 2026-02-19T20:24:52.934Z
    Example: 2026-02-19T20:24:52.934Z

  - `items.paymentDate` (string)
    Indicates the date-time (in an ISO 8601 date-time UTC format) of the invoice's payment date.

Examples: 2026-02-19T20:24:52.934Z
    Example: 2026-02-19T20:24:52.934Z

  - `items.totalAmount` (number)
    Specifies the transaction's total amount. 

This includes the base amount, tips, taxes, shipping, discounts, and other charges.

Example: 3219.45
    Example: 3219.45

  - `items.status` (integer)
    Possible values:
| Value | Name |
|  --- | --- |
| 1 | Draft |
| 2 | Published |
| 3 | Paid |
| 4 | Expired |
| 5 | Canceled |
| 6 | ProcessingPayment |
| 7 | Refunded |

Example: 2
    Example: 2

  - `total` (integer)
    Indicates the total number of invoices found.

Example: 5
    Example: 5