Histórico da Página

...

Campo	Tipo	Descrição	Tipo Parâmetro	Obrigatório	Observação
IdInquilino	string	Identificador do Inquilino	Parameter/Path/Query Params	*Sim	*Usado apenas pelo PDV. Retaguarda não precisa criar API com esse parâmetro, pois o Sync já irá direcionar para o IP correto.
IdRetaguardaLoja	string	Identificador da loja na retaguarda	Parameter/Path/Query Params	Sim
cpfCnpj	string	Documento do cliente	Header	Sim
limitePgamentoForma	bool	Indica se a solicitação de limite de crédito deve ser retornada por tipo de forma de pagamento ou não.	Header	Não	Caso o parâmetro não seja enviado, o default desse parâmetro será false. Caso seja true, o retorno da retaguarda será de limite de crédito por tipo de forma de pagamento.

Response:

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	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.idRetaguardaPagamentoForma	string	idRetaguarda relacionado ao tipo de forma de pagamento disponível para o limite de crédito.	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. O idRetaguarda enviado nesse campo deve ser o mesmo enviado na carga de pagamento forma.

Exemplos

Sucesso:

{
"success": true,
"message": null,
"limitesCredito":
[
{
"saldo": 1000.00 ,
"idRetaguardaLimiteCredito": null
"saldoDetalhadoFormaPagamento":
[
{
"Valorvalor": 500.00,
"idRetaguardaPagamentoForma": "BL"
},
{
"Valorvalor": 500.00,
"idRetaguardaPagamentoForma": "CH"
}
]
}
]
}

...

Árvore de páginas

Versões comparadas

Versão antiga 62

Nova versão 63

Chave