...
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. |
| limitesCredito | 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". |
| limitesCredito.saldoDisponivel | double | Saldo do crédito disponível | Não | Deve ser enviado sempre que houver retorno de true no atributo "success". |
| limitesCredito.idRetaguardaLimiteCredito | string | Identificador do limite de crédito caso exista | Não |
Exemplos
Sucesso:
{
"success": true,
"messagedata": null,[
"limitesCredito":
[
{
"saldoDisponivelidRetaguardaLimiteCredito": 1000.00 null,
"saldo": 1000.0
}
],
"detailedMessage": null,
"idRetaguardaLimiteCreditoerrors": null,
}
]"message": "",
"numberOfRecords": 0,
"success": true,
"totalTime": 0
}
Erro:
{
"success": false,
"success": false,
"message": "Cliente com XPTO não encontrado na base de dados da retaguarda" "message": "Cliente com XPTO não encontrado na base de dados da retaguarda",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}
4.2 Contrato de consulta de limite de crédito detalhado online
...
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. | limitesCredito | 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". | limitesCredito.saldoDisponivel | double | Saldo do crédito disponível | Não | Deve ser enviado sempre que houver retorno de true no atributo "success". |
| limitesCredito.idRetaguardaLimiteCredito | string | Identificador do limite de crédito caso exista | Não | ||||
| limitesCredito.saldoDetalhadoFormaPagamento | Lista de objetos | Lista com os limites de créditos retornados por forma de pagamento | Não | Deve ser enviado sempre que for solicitada na requisição no atributo o atributo "limitePgamentoForma" como true e o valor do saldo for maior que zero. | |||
| limitesCredito.saldoDetalhadoFormaPagamento.valor | double | Valor por forma de pagamento do limite de crédito | Sim | Deve ser enviado sempre que for solicitada na requisição no atributo o atributo "limitePgamentoForma" como true e o valor do saldo for maior que zero. | |||
| limitesCredito.saldoDetalhadoFormaPagamento.idRetaguardaPagamentoForma | string | idRetaguarda relacionado ao tipo de forma de pagamento disponível para o limite de crédito. | Sim |
|
...
