...
Campo | Tipo | Descrição | Obrigatório | Observação | |||
|---|---|---|---|---|---|---|---|
| success | bool | Indica se a consulta de limite de crédito ocorreu corretamente | Sim | Exemplo: Se o cliente não foi encontrado, deve ser retornado "false", pois a partir disso o PDV sabe que não haverá objeto de limite de crédito para exibir e sim apenas a mensagem justificando a ausência efetiva do limite de crédito. | |||
| message | string | Mensagem de retorno de erros | Não | Sempre que possível em caso de erro justificar o erro nesse campo. | |||
| limitesCreditodata | Lista de objetos | Lista com dos limites de créditos retornados | Não | Deve ser enviado sempre que houver retorno de true no atributo "success". | padrão | Não | |
| limitesCredito.saldoDisponivel | double | Saldo do crédito disponível | Sim | Caso o ERP não encontre nenhum registro de limite de crédito para o cliente, deve retornar saldo disponível igual a zero. | |||
| limitesCredito.idRetaguardaLimiteCredito | string | Identificador do limite de crédito caso exista | Não | ||||
| limitesCredito.valorUtilizado | double | Valor já consumido do limite de crédito | Sim | ||||
| limitesCredito.valorTotal | double | Valor total do limite de crédito | Sim | Esse valor é composto pela somatória do valorUtilizado e o saldoDisponivel. | |||
| limitesCredito.detalhesValorUtilizado | Lista de objetos | Lista de detalhamento da composição do limite de crédito já utilizado. | Não |
| |||
| limitesCredito.detalhesValorUtilizado.total | double | Valor total já utilizado. | Sim |
| |||
| limitesCredito.detalhesValorUtilizado.tipo | string | Tipo da origem de utilização do crédito. | Sim |
|
...
{
"success": true,
"message": null"",
"limitesCreditodetailedMessage": null,
"data": [
{
"saldoDisponívelsaldoDisponivel": 1000800.000,
"idRetaguardaLimiteCredito": null"01PSH00000005033CR",
"valorUtilizado": 3000264.000,
"valorTotal": 4000372.000,
"detalhesValorUtilizado": [
[
{
"total": 1000532.00
0,
"tipo": "Contas a recebercredito total"
},
{}
"total":2000.00]
"tipo": "Pedidos a faturar"}
],
}"errors": null,
]"totalTime": 0,
}
]"numberOfRecords": 0
}
Erro:
{
"success": false,
"message": "Não foi possível encontrar limite de crédito para o cliente selecionado.",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}
4.3 Contrato descida de dado forma de pagamento
...
