---
title: "Retrieve invoice by ID"
method: GET
path: "/api/creditcontrol/accounts/{creditAccountId}/invoices/{invoiceId}"
tags: ["Invoices"]
---

# Retrieve invoice by ID

`GET /api/creditcontrol/accounts/{creditAccountId}/invoices/{invoiceId}`

## Request

- Base URL: `https://apiexamples.vtexcommercestable.com.br`
- URL: `https://apiexamples.vtexcommercestable.com.br/api/creditcontrol/accounts/{creditAccountId}/invoices/{invoiceId}`
- Auth: one of:
  - API key in header `X-VTEX-API-AppKey` and API key in header `X-VTEX-API-AppToken`
  - API key in header `VtexIdclientAutCookie`

Returns data from a specific invoice using `invoiceId`.

## 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.

## Path parameters

- `creditAccountId` string, required
- `invoiceId` string, required

## Headers

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

## Response `200`

OK

- object
  - `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 `checkingAccountId` parameter used in other Customer Credit API endpoints.
  - `creditValue` number, required: Credit value.
  - `createdAt` string, required: Invoice creation date.
  - `updatedAt` string, required: Date of the last update made to the invoice.
  - `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.
  - `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.

## Changes

- **2023-12-21** `0cfe5b381175`: 8 warning
  - the optional response header `Connection` removed for the status `200`
  - the optional response header `Content-Length` removed for the status `200`
  - the optional response header `Date` removed for the status `200`
  - the optional response header `Server` removed for the status `200`
  - …4 more
- **2023-11-27** `c812a194b17d`: 1 breaking
  - the `orderId` response's property type changed from `number` to `string` for status `200`
- **2023-11-27** `7dfddf64951f`: 1 warning, 1 info
  - added the new `Opened` enum value to the `status` response property for the response status `200`
  - removed the `Open` enum value from the `status` response property for the response status `200`
- **2023-11-27** `25c08deef792`: 3 warning
  - added the new `Cancelled` enum value to the `status` response property for the response status `200`
  - added the new `Open` enum value to the `status` response property for the response status `200`
  - added the new `Paid` enum value to the `status` response property for the response status `200`
- …earlier changes not shown

[Operation history](https://skmtc.dev/vtex/apis/customer-credit-api/changes/api/creditcontrol/accounts/:creditAccountId/invoices/:invoiceId/get.md)

---

[API](https://skmtc.dev/vtex/apis/customer-credit-api.md) - [All operations](https://skmtc.dev/vtex/apis/customer-credit-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vtex/apis/customer-credit-api/revisions/831ad1f05e7d?raw)