Histórico da Página

...

Data alteração	Motivo	O que mudou?	Aprovadores	Versão
31/01/2025	Padronização dos contratos	Contrato de retorno dos itens 4.1, 4.2, 4.5		v3

2. O que fazer?

Desenvolver integração para consulta e utilização de limite de crédito com a retaguarda

...

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.
dataerrors		Lista Erros de objetos	Lista padrão	Sim	execução API sync	Não	Uso PDVSync
numberOfRecords	double	Numero de registros	Não	Uso PDVSync
totalTime	time	Tempo de processamento API	Não	Uso PDVSync
data	Lista de objetos	Lista padrão	Sim
data.saldoDisponivel	double	Saldo do crédito disponível	Não	Deve ser enviado sempre que houver	saldoDisponivel	double	Saldo do crédito disponível	Não	Deve ser enviado sempre que houver retorno de true no atributo "success".
data.idRetaguardaLimiteCredito	string	Identificador do limite de crédito caso exista	Não

...

Erro:

{
"success": false,
"message": "Cliente com XPTO não encontrado na base de dados da retaguarda",
"detailedmessage": "",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}

...

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(Retaguarda)	Não	Sempre que possível em caso de erro justificar o erro nesse campo.
errors		Erros de execução API sync	Não	Uso PDVSync
numberOfRecords	double	Numero de registros	Não	Uso PDVSync
totalTime	time	Tempo de processamento API	Não	Uso PDVSync
detailedmessage	string	Mensagem detalhada de erros(Retaguarda)	Não	Em caso de erro detalhar o erro nesse campo.
data	Lista de objetos	Lista padrão	Sim
data.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.
data.idRetaguardaLimiteCredito	string	Identificador do limite de crédito caso exista	Não
data.valorUtilizado	double	Valor já consumido do limite de crédito	Sim
data.valorTotal	double	Valor total do limite de crédito	Sim	Esse valor é composto pela somatória do valorUtilizado e o saldoDisponivel.
data.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.
data.detalhesValorUtilizado.total	double	Valor total já utilizado.	Sim	Obrigatoriedade do objeto detalhesValorUtilizado Deve ser preenchido caso o atributo "valorUtilizado" seja maior que zero.
data.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.

...

{
"success": false,
"message": "Não foi possível encontrar limite de crédito para o cliente selecionado.",
"detailedmessage": "",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}

4.3 Contrato descida de dado forma de pagamento

...

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.
errors		Erros de execução API sync	Não	Uso PDVSync
numberOfRecords	double	Numero de registros	Não	Uso PDVSync
totalTime	time	Tempo de processamento API	Não	Uso PDVSync	data	Lista de objetos	Lista padrão	Sim
detailedmessage	string	Mensagem detalhada de erros(Retaguarda)	Não	Em caso de erro detalhar o erro nesse campo.
data	Lista de objetos	Lista padrão	Sim
data.saldoDisponivel	double	Saldo do crédito disponível	Não	Deve ser enviado sempre que houver retorno de true no atributo "success".
data.idRetaguardaLimiteCredito	string	Identificador do limite de crédito caso exista	Não
data.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.
data.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.
data.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.

...

Árvore de páginas

Versões comparadas

Versão antiga 83

Nova versão 84

Chave