Account

Get account statements

Changed on Dec 21, 2023

Retrieves the customer credit account statements.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources 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 for this resource list. You must create a custom 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.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

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
- API key in header X-VTEX-API-AppKey and API key in header X-VTEX-API-AppToken
- or API key in header VtexIdclientAutCookie

Path parameters

creditAccountIdstring required

Example:01bce461-9g03-12ds-8217-b3d39271e15b

Credit account identification.

Headers

Content-Typestring required

Example:application/json

Type of the content being sent.

Acceptstring required

Example:application/json

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Response

currentBalancenumber required

Current balance value.

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

previousBalancenumber required