Histórico da Página

...

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 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	Deve ser preenchido caso o atributo "valorUtilizado" seja maior que zero. Deve ser preenchido com ao menos um item no objeto.
limitesCredito.detalhesValorUtilizado.total	double	Valor total já utilizado.Não	Sim	Obrigatoriedade do objeto detalhesValorUtilizado 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	Sim	Obrigatoriedade do objeto detalhesValorUtilizado Deve ser preenchido caso o atributo "valorUtilizado" seja maior que zero.

Exemplos

Sucesso:

{
"success": true,
"message": null,
"limitesCredito":
[
{
"saldoDisponível": 1000.00,
"idRetaguardaLimiteCredito": null,
"valorUtilizado": 3000.00,
"valorTotal": 4000.00,
"detalhesValorUtilizado":
[
{
"":1000.00
"tipo": "Contas a receber"
},
{
"total":2000.00
"tipo": "Pedidos a faturar"
}
]
}
]
}

...

Árvore de páginas

Versões comparadas

Versão antiga 70

Nova versão 71

Chave