API FIDELIDADE - Fidelidade_Extrato

API FIDELIDADE - Fidelidade_Extrato

Fidelidade_Extrato


Este método é responsável por listar o extrato dos pontos fidelidade do banco de dados.

Parâmetros

Nome
Obrigatório
Tipo
Descrição
DATA_INI
Não
Data
Período para busca inicial AAAA-MM-DD
DATA_FIM
Não
Data
Período para busca final AAAA-MM-DD
LOJA
Não
String
Código da loja para busca do voucher/crédito de cliente
CLI_LOJA
Sim
String
Código da loja do cadastro do cliente
CODIGO
Sim
Integer
Código de cadastro do cliente
CPF
Não
Double
CPF do cadastro do cliente, obrigatório apenas quando não informado a loja e código do cliente
LOJA
Não
String
CPF correspondente ao cadastro de cliente
TIPO_CREDITO
Não
Integer
Busca por padrão do tipo de crédito 1 - Crédito cliente obrigatório informar o tipo para retorno dos dados  
1 - Crédito cliente ou 0 - Fidelidade
UTILIZADO
Não
String
Quando for voucher do tipo 0 - Fidelidade e o mesmo for utilizado=S ou N


BODY

Permite diversos tipos de consultas e filtros:

Por data inicial e final + tipo_credito

  1. {
  2.   "DATA_INI" : "2024-07-22",
  3.   "DATA_FIM": "2024-07-22",
  4.   "TIPO_CREDITO": 0 //Preencher com 0-Fidelidade ou 1-Crédito ao cliente (se vazio irá considerar sempre 1)
  5. }

- Por CPF + tipo_credito ou data inicial e final+CPF+tipo_credito

  1. {
  2.   "CPF": "23323650875",
  3.   "TIPO_CREDITO": 0 //Preencher com 0-Fidelidade ou 1-Crédito ao cliente (se vazio irá considerar sempre 1)
  4. }

  1. {
  2.   "DATA_INI" : "2020-07-01",
  3.   "DATA_FIM": "2024-07-18",
  4.   "CPF": "23323655698",
  5.   "TIPO_CREDITO": 0 //Preencher com 0-Fidelidade ou 1-Crédito ao cliente (se vazio irá considerar sempre 1)
  6. }


- Por cliente + tipo_credito ou data inicial e final+cliente+tipo_credito


  1. {
  2.   "CLI_LOJA": "99",
  3.   "CODIGO": 140828,
  4.   "TIPO_CREDITO": 0 //Preencher com 0-Fidelidade ou 1-Crédito ao cliente (se vazio irá considerar sempre 1)
  5. }


  1. {
  2.   "DATA_INI" : "2020-01-01",
  3.   "DATA_FIM": "2024-07-15",
  4.   "CLI_LOJA": "99",
  5.   "CODIGO": 140828,
  6.   "TIPO_CREDITO": 0 //Preencher com 0-Fidelidade ou 1-Crédito ao cliente (se vazio irá considerar sempre 1)
  7. }


- Por loja + tipo_credito ou data inicial e final+loja+tipo_credito


  1. {
  2.   "LOJA" : "05",
  3.   "TIPO_CREDITO" : 0 //Preencher com 0-Fidelidade ou 1-Crédito ao cliente (se vazio irá considerar sempre 1)
  4. }


  1. {
  2.   "DATA_INI" : "2020-07-01",
  3.   "DATA_FIM": "2024-07-18",
  4.   "LOJA" : "05",
  5.   "TIPO_CREDITO" : 0 //Preencher com 0-Fidelidade ou 1-Crédito ao cliente (se vazio irá considerar sempre 1)
  6. }


- Por data inicial e fim + tipo_credito+utilizado (específico quando tipo_credito = 0-Fidelidade)

  1. {
  2.   "DATA_INI" : "2024-01-01",
  3.   "DATA_FIM": "2024-07-18",
  4.   "TIPO_CREDITO"  : 0, //Preencher com 0-Fidelidade ou 1-Crédito ao cliente (se vazio irá considerar sempre 1)
  5.   "UTILIZADO": "N"
  6. }


JSON de Retorno: 


- Quando tipo do crédito for 0-FIDELIDADE

  1. {
  2.     "status": "ok",
  3.     "serverTime": "2024-07-22T16:35:32.000Z",
  4.     "versionCode": 5,
  5.     "method": "FIDELIDADE_EXTRATO",
  6.     "data": [
  7.         {
  8.             "loja": "99 - FABRICA",
  9.             "lojaCliente": "99",
  10.             "codigoCliente": 140828,
  11.             "nomeCliente": "Teste",
  12.             "cpf": "233.236.598-02    ",
  13.             "dataInc": "2024-07-17 00:00:00.000",
  14.             "pontos": 259,
  15.             "valor": 0,
  16.             "dataVnc": "2025-01-13 18:25:24.000",
  17.             "voucher": null,
  18.             "cliLoja": "99",
  19.             "codigo": 140828,
  20.             "vendaLoja": "99",
  21.             "vendaData": "2024-07-17 00:00:00.000",
  22.             "vendaControle": 14430,
  23.             "vendaTerminal": 0,
  24.             "modeloNf": "55",
  25.             "operacao": "A",
  26.             "tipoDoc": "N",
  27.             "numero": 10390,
  28.             "codMovimento": 1,
  29.             "movimento": "Venda",
  30.             "utilizada": "N",
  31.             "cdUsuario": "",
  32.             "nomeusuario": "",
  33.             "tipoCredito": "Fidelidade"
  34.         }
  35. }

- Quando o tipo do crédito for 1-Crédito ao cliente

  1. {
  2.     "status": "ok",
  3.     "serverTime": "2024-07-22T16:39:44.000Z",
  4.     "versionCode": 5,
  5.     "method": "FIDELIDADE_EXTRATO",
  6.     "data": [
  7.         {
  8.             "loja": "01 - PITICAS INTER",
  9.             "lojaCliente": "99",
  10.             "codigoCliente": 140828,
  11.             "nomeCliente": "YANIRA TAPIA",
  12.             "cpf": "233.236.508-75    ",
  13.             "dataInc": "2024-07-16 00:00:00.000",
  14.             "pontos": 0,
  15.             "valor": -29.9,
  16.             "dataVnc": "2099-01-01 00:00:00.000",
  17.             "voucher": "932974E23EE75923AAB8",
  18.             "cliLoja": "99",
  19.             "codigo": 140828,
  20.             "vendaLoja": "01",
  21.             "vendaData": "2024-07-16 00:00:00.000",
  22.             "vendaControle": 14380,
  23.             "vendaTerminal": 1,
  24.             "modeloNf": "65",
  25.             "operacao": "V",
  26.             "tipoDoc": "E",
  27.             "numero": 243,
  28.             "codMovimento": 3,
  29.             "movimento": "Resgate",
  30.             "utilizada": "N",
  31.             "cdUsuario": "99.1",
  32.             "nomeusuario": "PRESENCE",
  33.             "tipoCredito": "Crédito ao cliente"
  34.         },
  35.         {
  36.             "loja": "01 - PITICAS INTER",
  37.             "lojaCliente": "99",
  38.             "codigoCliente": 140828,
  39.             "nomeCliente": "YANIRA TAPIA",
  40.             "cpf": "233.236.508-75    ",
  41.             "dataInc": "2024-07-04 00:00:00.000",
  42.             "pontos": 0,
  43.             "valor": 1.5,
  44.             "dataVnc": "2099-01-01 00:00:00.000",
  45.             "voucher": "CE74E4D21227688A3833",
  46.             "cliLoja": "99",
  47.             "codigo": 140828,
  48.             "vendaLoja": null,
  49.             "vendaData": null,
  50.             "vendaControle": null,
  51.             "vendaTerminal": null,
  52.             "modeloNf": null,
  53.             "operacao": null,
  54.             "tipoDoc": null,
  55.             "numero": null,
  56.             "codMovimento": 5,
  57.             "movimento": "Ajuste",
  58.             "utilizada": "N",
  59.             "cdUsuario": "99.1",
  60.             "nomeusuario": "PRESENCE",
  61.             "tipoCredito": "Crédito ao cliente"
  62.         }
  63. }


    • Related Articles

    • Interface de Fidelidade - APIs de integração

      Sobre o produto - APIs de Fidelidade A Presence possui um conjunto de API's que disponibilizam o acesso externo ao Módulo de Fidelidade com o intuito de transmitir/receber dados dos processos específicos. O token de acesso à outras APIs não permite o ...

    • Presence API - Página Inicial

      Essa API permite o consumo de informações disponíveis nos sistemas Presence através de chamadas de serviço, bem como a inserção de dados nos sistemas. Para ter acesso aos métodos já existentes, ou solicitação da criação de novos métodos, consulte as ...

    • Presence API - INCLUIR_PRODUTO

      Inclusão de Produtos (Atualização e Inclusão) Este módulo é responsável por incluir produtos na base da dados. Parâmetros Campos Tipo Obrigatório Descrição codigo string(8) Não para inclusão, sim para alteração, quando codigoExterno ou codigoLegado ...

    • API FIDELIDADE - FIDELIDADE_SALDO

      FIDELIDADE_SALDO Este método é responsável por listar o saldo de pontos fidelidade do banco de dados. Parâmetros Nome Obrigatório Tipo Descrição CLI_LOJA Sim String Código de loja do cadastro de cliente CODIGO Sim Integer Código do cadastro de ...

    • API FIDELIDADE - FIDELIDADE_INCLUSAO_CREDITO

      FIDELIDADE_INCLUSAO_CREDITO Por meio deste método é possível incluir ou debitar créditos fidelidade. Campo Obrigatório Tipo Descrição loja Sim String Código da loja para inclusão do crédito clienteLoja Sim String Código de loja do cadastro de cliente ...