API reference · Credit Limit

List Credit Limits

Method: GET
Route: /creditLimit/list
Base URL: https://ws.autorei.net
Query parameters in the example: document=29.893.264/0001-01 limit=5
Token: Requires Bearer token

Opens this request in the public API documentation, the official source of the reference.

Description

Lists your store's credit limits, with an option to filter by customer.

Query Parameters

Parameter	Type	Required	Description
`document`	string	No	CPF or CNPJ of the customer. If omitted, the listing returns the store's limits.
`limit`	integer	No	Records per page. Default 5, cap 25 — a value above that is reduced to 25, with no error.
`offset`	integer	No	Starting record of the page. Default 0.

Business rules

With no records, the response is not a list

When there are limits, the response is an array. When there are none, it is an empty object ({}). Handle both formats: iterating directly over the response breaks in the empty case.

Response · 200

Array with one object per credit limit.

Field	Type	Description
`document`	string	Customer document.
`credit_code`	string	Limit type code.
`credit_type`	string	Limit type name.
`value`	number	Total limit amount.
`balance`	number	Available balance.
`active`	boolean	Whether the limit is active.
`without_credit_limit`	boolean	Whether the customer can buy without a balance.

Errors

Code	When
401	Token missing, malformed, or expired.

Example request

curl --request GET 'https://ws.autorei.net/creditLimit/list?document=29.893.264/0001-01&limit=5' \
  --header 'Authorization: Bearer {{access_token}}'

Example responses

200Success — one limit found

[
  {
    "without_credit_limit": false,
    "balance": 5000,
    "document": "29.893.264/0001-01",
    "credit_code": "CREDITO-PADRAO",
    "active": true,
    "credit_type": "Crédito Padrão",
    "value": 5000
  }
]

Used in

Use casesEcommerce ERP integration: the typical path through the API
Use casesB2B customer portal: the typical path through the API
Use casesB2B marketplace: the typical path through the API
Use casesComplex retail and B2B2C: the typical path through the API
Use casesB2B procurement and supplies: the typical path through the API
Use casesGuided selling and counter sales: the typical path through the API
Get startedPagination and limits

POST Create Credit Limit Type /creditLimit/saveTypeCreditLimit
POST Set or Update Credit Limit for Customer /creditLimit/save

← See the group: Credit Limit

Generated from the public API collection, published on 2026-09-04: api-docs.cws.digital.