---
title: "Search all invoices"
method: GET
path: "/api/creditcontrol/invoices"
tags: ["Invoices"]
---

# Search all invoices

`GET /api/creditcontrol/invoices`

Returns a list of invoices related to payment orders created through [customer credit accounts](https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU).

>ℹ️ Query parameters can be used individually or combined to filter invoice results.

### Queries to filter results

- **By the location of the invoices in the list (quantity of invoices)**: `?from={int}&to={int}`
- **By creation date**: `?createdDateFrom={dateISO8601}&createDateTo={dateISO8601}`. The dates should be in ISO8601 format.
- **By due date**: `?dueDateFrom={dateISO8601}&dueDateTo={dateISO8601}`. The dates should be in ISO8601 format.
- **By value**: `?value={decimal}`
- **By status**: `?status={string}`
- **By Id**: `?friendlyId={string}`
- **By observation**: `?observation={string}`
- **By creditAccountId**: `?creditAccountId={creditAcountId}`

### Combining filters

You can use the `op` query parameter to specify if filters will be evaluated as `AND` or `OR` for the query. The default behavior when there is more than one query parameter is `AND`.

Example:

For the query `?value=100&status=Paid`, the criteria will build **value = 100 AND status = Paid**.

For the same query, adding the `op` parameter (`?value=100&status=Paid&op=or`), the criteria will build **value = 100 OR status = Paid**.

## Permissions

Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:

| **Product** | **Category** | **Resource** |
| --------------- | ----------------- | ----------------- |
| Credit Control | Main | **Main Access** |
| Credit Control | Invoices | **Read Invoices** |

There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).

>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.

## Query parameters

- `from` string
- `to` string
- `createdDateFrom` string
- `createdDateTo` string
- `dueDateFrom` string
- `dueDateTo` string
- `value` number
- `status` 'Opened' | 'Paid' | 'Cancelled'
- `friendlyId` string
- `observation` string
- `creditAccountId` string, required

## Headers

- `Content-Type` string, required
- `Accept` string, required

## Response `200`

OK

- object
  - `data` object[], required — Data information.
    - `id` string, required — Invoice identification.
    - `friendlyId` string, required — Simplified identification of an invoice. This code is created automatically, always associated with an existing invoice. It consists of an 8-digit random ID (of numbers and letters) and the installment.
    - `status` 'Opened' | 'Paid' | 'Cancelled', required — Invoice status.
    - `value` number, required — Invoice value.
    - `accountId` string, required — Account identification. It is the same `creditAccountId` parameter used in other Customer Credit API endpoints.
    - `creditValue` number, required — Credit value.
    - `createdAt` string, required — Invoice creation date.
    - `resolvedAt` string, nullable — Invoice closing date.
    - `updatedAt` string, required — Date of the last update made to the invoice.
    - `paymentLink` string, nullable — Link (URL) created to direct the customer to an invoice payment environment (optional).
    - `originalDueDate` string, required — Original invoice expiration date.
    - `dueDate` string, required — Modified invoice expiration date.
    - `installment` number, required — Identification of installment number.
    - `orderId` string, required — Identification of the order that generated the invoice.
    - `observation` string, nullable — Observation notes about the invoice.
    - `transactionId` string, required — Identification of the invoice transaction. This is the same number as the `id` field, removing the last three characters.
    - `numberOfInstallments` number, required — Number of installments.
    - `creditAccountId` string, required — Credit account identification. It is the same `accountId` parameter used in other Customer Credit API endpoints.
  - `summary` object, required — Summary information.
    - `total` number, required — Total amount payable (sum of invoices listed with status `Open`).
    - `count` integer, required — Number of invoices listed.
    - `totalPaid` number — Total amount paid (sum of invoices listed with status `Paid`).
    - `totalCancelled` number — Total amount canceled (sum of invoices listed with status `Cancelled`).

---

[API](https://skmtc.net/vtex/apis/customer-credit-api.md) · [All operations](https://skmtc.net/vtex/apis/customer-credit-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vtex/customer-credit-api/versions/6397d4efe3b7/schema)