Endpoints responsáveis pelo controle da inadimplência dos clientes, bloqueando a realização de novas vendas quando necessário. Funcionalidade aplicável aos fornecedores que utilizam crédito próprio.
Início > Clientes Inadimplentes
Versão: 2.0
Clientes Inadimplentes
Endpoint para consulta dos clientes inadimplentes.
Endpoint GET
Exemplo
curl --location 'https://yandeh-seller-integration.yandeh.com.br/v2/clientes-inadimplentes' \
--header 'Authorization: Bearer ...'
Sintaxe da Resposta
Se os parâmetros forem informados corretamente, o endpoint retornará os dados com status code 200.
Exemplo de retorno:
[
{
"cnpj": "00002596600044",
"status": "I"
},
{
"cnpj": "00003000018823",
"status": "I"
}
]
Elementos da Resposta
cnpj: CNPJ do cliente
Tipo: String.
status: Indica a situação de inadimplência do cliente. O valor 'I' corresponde a cliente inadimplente.
Tipo: String.
Respostas para erros
401 Unauthorized: Token inválido
{
"detail": "Could not validate the token."
}
403 Forbidden: Acesso negado
"Access Denied"
GET Clientes Inadimplentes
POST Clientes Inadimplentes
Endpoint responsável por incluir ou remover o status de inadimplência dos clientes.
Endpoint POST
Sintaxe da Requisição
-
Tipo de requisição: POST.
-
Cabeçalho (Headers):
-
Content-Type: application/json
-
Authorization: Bearer <token>
-
-
Corpo da requisição :
Envio do JSON de acordo com o cadastro/atualização da inadimplência:
[
{
"cnpj": "10719000000160",
"adimplente_inadimplente": "A"
},
{
"cnpj": "34009089000100",
"adimplente_inadimplente": "I"
}
]
Exemplo
curl --location 'https://yandeh-seller-integration.yandeh.com.br/v2/clientes-inadimplentes' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ...' \
--data '[
{
"cnpj": "11009770000107",
"adimplente_inadimplente": "A"
},
{
"cnpj": "04030070000107",
"adimplente_inadimplente": "I"
}
]
'
Elementos da Requisição
cnpj: CNPJ do cliente.
-
Campo obrigatório
Tipo: String
adimplente_inadimplente: Status da inadimplência do cliente.
-
Valores permitidos no campo status: 'I' (inserir inadimplência) e 'A' (remover inadimplência).
-
Campo obrigatório
Tipo: String
Sintaxe da Resposta
Se os parâmetros forem informados corretamente, o endpoint retornará os dados com status code 200.
Exemplo de retorno:
true
Respostas para erros
400 Bad Request: CNPJ do cliente inválido ou não cadastrado.
[
{
"cnpj": "04039000000107",
"adimplente_inadimplente": "A",
"channel": "web",
"origem": "fornecedor",
"status": "CNPJ não registrado."
}
]