Histórico da Página

...

4.2 Contrato de consulta de limite de crédito detalhado

Endpoint: /api/pdvsyncserver/retaguarda/v2/processoonlinelimitecreditodetalhes/{IdInquilino}/{IdRetaguardaLoja}
Método: Get
Autenticação: Bearer token
Permissão: Client

Request:

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

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

Sim	Caso não o ERP não encontre nenhum registro de limite de crédito para o cliente, deve retornar saldo disponível igual a zero

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.valorUtilizado	double	Valor já consumido do limite de crédito

sim

	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	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	Deve ser preenchido caso o

atributo valorUtilizado

atributo "valorUtilizado" seja maior que zero.

Exemplos

Sucesso:

{
"success": true,
"message": null,
"limitesCredito":
[
{
"saldosaldoDisponí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"
}
]
}
]
}

Erro:

{
"success": false,
"message": "Cliente com XPTO não encontrado na base de dados da retaguardaNão foi possível encontrar limite de crédito para o cliente selecionado."
}

4.3 Contrato descida de dado forma de pagamento

...

Árvore de páginas

Versões comparadas

Versão antiga 52

Nova versão 53

Chave