Referência da API · Limite de Crédito

Definir ou Atualizar Limite de Crédito para Cliente

Método: POST
Rota: /creditLimit/save
URL base: https://ws.autorei.net
Token: Exige token Bearer

Abre esta requisição na documentação pública da API, a fonte oficial da referência.

Descrição

Cria ou atualiza o limite de crédito de um cliente já cadastrado na plataforma, para um dos tipos criados em Criar Tipo de Limite de Crédito. Reenviar para o mesmo cliente e tipo atualiza o limite existente.

Corpo da Requisição (JSON)

Os seis campos são obrigatórios. 0 e false são valores válidos, só null e string vazia contam como ausentes.

Campo	Tipo	Obrigatório	Descrição
`document`	string	Sim	CPF ou CNPJ do cliente.
`credit_code`	string	Sim	Código do tipo de limite, o `code` que você definiu ao criar o tipo.
`value`	number	Sim	Valor total do limite.
`balance`	number	Sim	Saldo disponível do limite.
`active`	boolean	Sim	`true` mantém o limite ativo.
`without_credit_limit`	boolean	Sim	`true` permite que o cliente compre mesmo sem saldo.

Resposta · 200

Campo	Tipo	Descrição
`message`	string	Confirmação da operação: `Conta criada/atualizada com sucesso`.
`document`	string	Documento do cliente, como enviado.
`credit_code`	string	Código do tipo de limite, igual ao enviado.
`credit_type`	string	Nome do tipo de limite.
`value`	number	Valor total gravado.
`balance`	number	Saldo gravado.
`active`	boolean	Se o limite está ativo.
`without_credit_limit`	boolean	Se o cliente compra sem saldo.

Erros

Código	Quando
404	Corpo ausente ou vazio: `{"status":"NOT_FOUND","message":"JSON com formato inválido e/ou não informado"}`.
400	Um dos seis campos obrigatórios está ausente ou vazio, ou o serviço de crédito não confirmou a gravação. A mensagem ecoa o payload recebido, compare com a tabela acima para achar o campo que faltou.
401	Token ausente, malformado ou expirado.

Exemplo de requisição

curl --request POST 'https://ws.autorei.net/creditLimit/save' \
  --header 'Authorization: Bearer {{access_token}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "document": "29.893.264/0001-01",
  "credit_code": "CREDITO-PADRAO",
  "value": 5000.0,
  "balance": 5000.0,
  "active": true,
  "without_credit_limit": false
}'

Respostas de exemplo

200Sucesso: limite definido

{
  "without_credit_limit": false,
  "balance": 5000,
  "document": "29.893.264/0001-01",
  "credit_code": "CREDITO-PADRAO",
  "active": true,
  "message": "Conta criada/atualizada com sucesso",
  "credit_type": "Crédito Padrão",
  "value": 5000
}

Usado em

Casos de usoIntegração ERP: o caminho típico pela API
Casos de usoPortal B2B próprio: o caminho típico pela API
Casos de usoMarketplace B2B: o caminho típico pela API
Casos de usoVarejo complexo e B2B2C: o caminho típico pela API
Casos de usoCompras B2B e suprimentos: o caminho típico pela API
Casos de usoVenda assistida e balcão: o caminho típico pela API

Endpoints relacionados

POST Criar Tipo de Limite de Crédito /creditLimit/saveTypeCreditLimit
GET Listar Limites de Crédito /creditLimit/list

← Ver o grupo: Limite de Crédito

Gerado a partir da coleção pública da API, publicada em 04/09/2026: api-docs.cws.digital.