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.
detailedmessage	string	Mensagem detalhada de erros	Não	Em caso de erro detalhar o erro nesse campo.
data	Lista de objetos	Lista padrão	Sim
saldoDisponivel	double	Saldo do crédito disponível	Não	Deve ser enviado sempre que houver retorno de true no atributo "success".
idRetaguardaLimiteCredito	string	Identificador do limite de crédito caso exista	Não

...

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.
detailedmessage	string	Mensagem detalhada de erros	Não	Em caso de erro detalhar o erro nesse campo.
data	Lista de objetos	Lista padrão	Sim
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.
idRetaguardaLimiteCredito	string	Identificador do limite de crédito caso exista	Não
valorUtilizado	double	Valor já consumido do limite de crédito	Sim
valorTotal	double	Valor total do limite de crédito	Sim	Esse valor é composto pela somatória do valorUtilizado e o saldoDisponivel.
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.
detalhesValorUtilizado.total	double	Valor total já utilizado.	Sim	Obrigatoriedade do objeto detalhesValorUtilizado Deve ser preenchido caso o atributo "valorUtilizado" seja maior que zero.
detalhesValorUtilizado.tipo	string	Tipo da origem de utilização do crédito.	Sim	Obrigatoriedade do objeto detalhesValorUtilizado Deve ser preenchido caso o atributo "valorUtilizado" seja maior que zero.

...

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.
data	Lista de objetos	Lista padrão	Sim
detailedmessage	string	Mensagem detalhada de erros	Não	Em caso de erro detalhar o erro nesse campo.
saldoDisponivel	double	Saldo do crédito disponível	Não	Deve ser enviado sempre que houver retorno de true no atributo "success".
idRetaguardaLimiteCredito	string	Identificador do limite de crédito caso exista	Não
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.
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.
saldoDetalhadoFormaPagamento.idRetaguardaPagamentoForma	string	idRetaguarda relacionado ao tipo de forma de pagamento disponível para o 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. O idRetaguarda enviado nesse campo deve ser o mesmo enviado na carga de pagamento forma.

...

{
"success": false,
"message": "Cliente com XPTO não encontrado na base de dados da retaguarda",

"detailedMessage": null,
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}

...

Árvore de páginas

Versões comparadas

Versão antiga 82

Nova versão 83

Chave