...
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 | Sim | Caso não 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. | Não | Deve ser preenchido caso o atributo "valorUtilizado" seja maior que zero. |
limitesCredito.DetalhesValorUtilizado.tipo | string | Tipo da origem de utilização do crédito. | Não | Deve ser preenchido caso o atributo "valorUtilizado" seja maior que zero. |
...