Histórico da Página

...

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

Dúvidas:

Levantadas pelo time Sync
- Não é importante ter a data ou o período considerado para trazer os "detalhes" do que esta compondo o limite de crédito ?
- O nome da da API como detalhes não esta muito sugestivo a um extrato ?
  - O nome não poderia ser processoonlinelimitecreditosintetico ?

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

...

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	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.
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
limitesCredito.valorTotal	double	Valor total do limite de crédito	Sim	Esse valor é composto pela somatória do valorUtilizado e o saldoDisponivel.
limitesCredito.DetalhesValorUtilizadodetalhesValorUtilizado	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.DetalhesValorUtilizadodetalhesValorUtilizado.total	double	Valor total já utilizado.Não	Sim	Obrigatoriedade do objeto detalhesValorUtilizado Deve ser preenchido caso o atributo "valorUtilizado" seja maior que zero.
limitesCredito.DetalhesValorUtilizadodetalhesValorUtilizado.tipo	string	Tipo da origem de utilização do crédito.Não	Sim	Obrigatoriedade do objeto detalhesValorUtilizado Deve ser preenchido caso o atributo "valorUtilizado" seja maior que zero.

Exemplos

Sucesso:

{
"success": true,
"message": null,
"limitesCredito":
[
{
"saldoDisponível": 1000.00,
"idRetaguardaLimiteCredito": null,
"valorUtilizado": 3000.00,
"valorTotal": 4000.00,
"DetalhesValorUtilizadodetalhesValorUtilizado":
[
{
"":1000.00
"tipo": "Contas a receber"
},
{
"total":2000.00
"tipo": "Pedidos a faturar"
}
]
}
]
}

...

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.

...

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ãoSim	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ãoSim	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 67

Nova versão Atual

Chave