Histórico da Página

...

...

4.1 Contrato de consulta de limite de crédito crédito online

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

...

4.2 Contrato de consulta de limite de crédito detalhado detalhado online

• 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:

Response:

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

• Adicionar o atributo "utilizaLimiteCredito" na API de POST de forma de pagamento (v3.2)  - Forma de pagamento#2612513
  • O atributo novo deve ser criado direto no data do payload, conforme exemplo abaixo:
    • Image Added
      • O novo campo será opcional e booleano.
        • O default desse campo será falso
          • Caso a retaguarda/erp não envie esse campo, o mesmo será considerado false para o Sync e o PDV.

...

4.4 Contrato descida de dado tabela loja

• Adicionar o atributo "limiteCreditoFormaPagamento" na API de POST de loja (v3.2)  - Cadastro de Loja#Vers%C3%A3o3.2

  4.5 Contrato utilização de saldo 

  • • O atributo novo deve ser criado direto na data do payload, conforme exemplo abaixo:
      • Image Added

  
  

  Campo	Tipo	Descrição	Obrigatório	Campo PDV	Observação
  limiteCreditoFormaPagamento	bool	Indica se a loja trabalha com limite de crédito por forma de pagamento.	Não	Tabela - loja campo - limite_credito_forma_pagamento	O default desse campo será falso. Caso a retaguarda/erp não envie esse campo, o mesmo será considerado false para o Sync e o PDV.

  4.5 Contrato de consulta de limite de crédito por forma de pagamento online

  • Endpoint: /api/pdvsyncserver/retaguarda/v2/processoonlinelimitecredito/{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
  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:

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

  Exemplos

  Sucesso:

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

  
  

  Erro:

  {
    "success": false,
    "message": "Cliente com XPTO não encontrado na base de dados da retaguarda"
  }

  
  

  4.6 Contrato de consumo/cancelamento de utilização de limite de crédito - INCOMPLETO - NÃO UTILIZAR

  • Endpoint: /api/pdvsyncserver/retaguarda/v2/processoonlinelimitecredito
  • Método: POST
  • 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
  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.

  {
      "idInquilino": "123",
      "limitePgamentoForma": true
      "Limitescredito": [
          {
              "cpfCnpj": "45512547836",
              "idRetaguardaLimiteCredito": "",
              "idRetaguardaLojaBaixa": "",
              "idRetaguardaUsuario": "12569",
              "saldoDetalhadoFormaPagamento": [
                  {
                      "valor": 500.00,
                      "idRetaguardaPagamentoForma": "BL"
                  },
                  {
                      "valor": 500.00,
                      "idRetaguardaPagamentoForma": "CH"
                  }
              ],
              "valorTotalBaixa": 1000.00
          }
      ],
      "idRetaguardaoperador": "125610",
      "motivo": "Consumo Limite crédito PDV",
      "numeroCaixa": "01",
      "numeroVenda": "1",
      "origemPDV": "PDVOmni",
      "serieVenda": "1",
      "tipoOperacao": "0"
  }4.6 Contrato cancelamento de venda 

  5. Premissas:

  
  

  6. Restrições:

  Nessa primeira versão não está sendo previsto o desenvolvimento de integração de pedidos com status de analise de credito, para o fluxo financeiro ode é feita a analise e liberação de limite de credito sobre pedidos pendentes. 

  
  

  7. Pontos de atenção: 

  • desenvolvimento na issue

    Jira
    server JIRA serverId 0c783de1-186e-383b-975c-a1acd7d76cb5 key DPDVSUPER-2560

    onde para calcular o valor do limite de crédito disponível, deverá ser feito da seguinte forma
    • (Limite de Crédito *  % Exceção) - Valor títulos em aberto - Valor venda pendente
  • Para QA, considerar:
    • cenários com e sem parâmetro da finalizadora (132)
    • cenários com cliente não cadastrado
    • cenários de limite de crédito de cliente:
      • cenários de margem da 132 (% máximo para exceder limite de crédito) passando e nao passando o limite
      • cenários de limite por cobrança 
      • cenários com titulo em aberto passando e nao passando o limite
      • cenários com venda pendente passando e nao passando o limite
      • cenários com cliente válido com a venda aberta
      • cenários com cliente válido com a venda fechada
      • cenários com cliente com saldo negativo
    • cenários de limite de crédito de cliente principal:
      • cenários de margem da 132 (% máximo para exceder limite de crédito) passando e não passando o limite
      • cenários de limite por cobrança 
      • cenários com titulo em aberto passando e não passando o limite
      • cenários com venda pendente passando e não passando o limite
      • cenários com cliente principal válido com a venda aberta
      • cenários com cliente principal válido com a venda fechada
      • cenários com cliente principal com saldo negativo
      • Cenários com limite de crédito com saldo com mais de 7 digitos 
    • comparar cenários com a 2030
  • verificar o fluxo para não validação do limite para cartão (crédito, débito, etc)
  • verificar qual parâmetro habilita o limite de crédito na cobrança no PDV e no Pedido: "Validar Limite de Crédito ECF" ou "Validar Limite de crédito", conforme 522

  ...