---
title: "Get account statements"
method: GET
path: "/api/creditcontrol/accounts/{creditAccountId}/statements"
tags: ["Account"]
---

# Get account statements

`GET /api/creditcontrol/accounts/{creditAccountId}/statements`

## Request

- Base URL: `https://apiexamples.vtexcommercestable.com.br`
- URL: `https://apiexamples.vtexcommercestable.com.br/api/creditcontrol/accounts/{creditAccountId}/statements`
- 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`

Retrieves the [customer credit account](https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU) statements.

## 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 | Statements | **Read Statements** |

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

## Headers

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

## Response `200`

OK

- object
  - `statements` object[], required: Statements information.
    - `value` number, required: Operation value.
    - `date` string, required: Operation date.
    - `doneby` string: Email of the person responsible for the operation.
    - `origin` 'Credit' | 'Invoice' | 'Payment' | 'Statement', required: Operation origin.
    - `metadata` object: Metadata information.
      - `transactionId` string: Transaction identification.
      - `numberOfInstallments` number: Number of installments.
  - `currentBalance` number, required: Current balance value.
  - `intervalBalance` number, required: Interval balance. Indicates the balance between debits and credits made since the account was opened. Negative values ​​indicate that there were more debits than new credits in the account.
  - `previousBalance` number, required: Current balance value.

## Changes

- **2023-12-21** `0cfe5b381175`: 11 warning
  - the optional response header `Connection` removed for the status `200`
  - the optional response header `Content-Encoding` 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`
  - …7 more
- **2023-11-27** `25c08deef792`: 4 warning
  - added the new `Credit` enum value to the `statements/items/origin` response property for the response status `200`
  - added the new `Invoice` enum value to the `statements/items/origin` response property for the response status `200`
  - added the new `Payment` enum value to the `statements/items/origin` response property for the response status `200`
  - added the new `Statement` enum value to the `statements/items/origin` response property for the response status `200`
- **2023-11-24** `c8735f67eb83`: 1 breaking, 3 info
  - removed the required property `statements/items/description` from the response with the `200` status
  - added the optional property `statements/items/doneby` to the response with the `200` status
  - added the optional property `statements/items/metadata` to the response with the `200` status
  - added the required property `statements/items/origin` to the response with the `200` status
- **2023-11-17** `1a0ba22582f0`: 1 info
  - media type `application/json; charset=utf-8` was changed to `application/json` for the response status `200`

[Operation history](https://skmtc.dev/vtex/apis/customer-credit-api/changes/api/creditcontrol/accounts/:creditAccountId/statements/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)