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

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

No H1, o idRetaguardaLoja não será validado no Winthor

cpfCnpj

string

Documento do cliente

Header

Sim

...

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	datastring	Lista Mensagem detalhada de objetoserros	Lista padrão	Sim	Não	Em caso de erro detalhar 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
data.saldoDisponivel	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": [
{
"idRetaguardaLimiteCredito": null,
"saldosaldoDisponivel": 1000.0
}
],
"detailedMessage": null,
"errors": null,
"message": "",
"numberOfRecords": 0,
"success": true,
"totalTime": 0
}

...

Erro:

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

...

Lista objetos

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.data
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
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. Deve ser preenchido com ao menos um item no objeto.

Exemplos

Sucesso:

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.

Exemplos

Sucesso:

{
"success": true,
"message": "",
"detailedMessage": null,
"data": [
{{
"success": true,
"message": "",
"detailedMessage": null,
"data": [
{
"saldoDisponivel": 800.0,
"idRetaguardaLimiteCredito": "01PSH00000005033CR",
"valorUtilizado": 264.0,
"valorTotalsaldoDisponivel": 372800.0,
"idRetaguardaLimiteCredito": "01PSH00000005033CR",
"valorUtilizado": 264.0,
"valorTotal": 372.0,
"detalhesValorUtilizado": [
{
"total": 532.0,
"tipo": "credito total"
}
]
}
],
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}Erro:

Bloco de código

language	sql

idRetaguardaLimiteCredito será o codcli concatenado com o termo 'LIMCRED'

 "idRetaguardaLimiteCredito": "193489-LIMCRED",

Erro:

{
"success": false,
"message": {
"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

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

limitePagamentoForma

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:

retaguarda

Parameter/Path/Query Params

Sim

cpfCnpj

string

Documento do cliente

Header

Sim

limitePagamentoForma

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:

NãoSempre que possível em caso de erro justificar

Campo	Tipo	Descrição	Obrigatório	Observaçã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.
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

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	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
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.

...

{
"data": [
{
"idRetaguardaLimiteCredito": null,
"saldosaldoDisponivel": 1000.0,
"saldoDetalhadoFormaPagamento": [
{
"idRetaguardaPagamentoForma": "BL",
"valor": 500.0
},
{
"idRetaguardaPagamentoForma": "CH",
"valor": 500.0
}
]
}
],
"detailedMessage": null,
"errors": null,
"message": "",
"numberOfRecords": 0,
"success": true,
"totalTime": 0
}

...

{
"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
}

...

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
limitePgamentoFormalimitePagamentoForma	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.

...

Árvore de páginas

Versões comparadas

Versão antiga 81

Nova versão Atual

Chave