Skip to main content

Invoice Buyer

Retorna as notas enviadas pelo distribuidor

Este endpoint é responsável por receber o retorno do processo de acúmulo sobre as Notas Fiscais (NFs) enviadas via integração, usando como parâmetro de entrada o CPF ou CNPJ do comprador.

Método: GET
URI do Endpoint: https://integration-loyalt.orbia.nom.co/prwapi/accrual-invoice/invoice-buyer

Parâmetros da Requisição​

A requisição deve conter os seguintes parâmetros:

  • clientId (string): Identificador do cliente, fornecido pela Orbia.
  • clientSecret (string): Chave secreta do cliente, fornecida pela Orbia.
  • clientVersion (string): Versão da API, utilize um dos valores indicados na seção "Versões".
  • culture (string): Idioma associado ao cadastro do distribuidor, ex.: "pt-BR".
  • campaign (string): Identificador fixo da campanha, utilize "BRBAY".
  • parameters (object):
  • document (string): Documento do comprador da nota fiscal.
  • Page (integer): Página de pesquisa para a paginação (não pode ser menor ou igual a 0, e não pode ser vazio).
  • invoices (array of strings): IDs das notas fiscais para serem filtradas (filtro opcional).

Exemplo de Requisição​

{
  "clientId": "XXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "clientSecret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "clientVersion": "x.x.x",
  "culture": "pt-BR",
  "campaign": "BRBAY",
  "Parameters": {
    "document": "<string>",
    "Page": 1,
    "invoices": ["46908"]
  }
}

Retorno esperado:​

  • Status da NF do cliente (no acúmulo) por parceiro;
  • Data do status;
  • Pontos gerados por parceiro (se gerou).

Só permitir retorno de NF do produtor se a nota foi enviada por aquele ERP.

Realizar paginação da consulta.

Exemplo de Retorno​

{ 
  "items": [ 
    { 
      "externalId": "8840", 
      "message": "Ok", 
      "date": "29/12/2022 14:28:51", 
      "invoicePartnerId": 46908, 
      "accrualPoints": [ 
        { 
          "partner": "Impulso Bayer", 
          "invoiceStatusPartner": "Recusado", 
          "messageStatus": "CPF/CNPJ do destinatário da nota fiscal não coincide com o cadastro do participante!", 
          "points": 0 
        } 
      ] 
    } 
  ], 
  "currentPage": 1, 
  "itemsPerPage": 30, 
  "totalPages": 1, 
  "totalItems": 29, 
  "pageFirstItem": 1, 
  "pageLastItem": 29 
}

Cómo Testar o Endpoint​

Para testar este endpoint, você pode usar ferramentas como Postman ou cURL. Siga as instruções abaixo:

  1. Abra o Postman.

  2. Selecione o método GET e insira a URL do endpoint.

  3. No corpo da requisição, insira o JSON do exemplo fornecido.

  4. Envie a requisição e observe a resposta.

Importante

Para um teste bem-sucedido, certifique-se de que você tem as credenciais corretas (se necessário) e que o corpo da requisição está corretamente formatado conforme o exemplo.

Este documento serve como um guia básico para entender e testar o endpoint específico. Ajuste as seções conforme necessário para se adequar ao seu ambiente de negócios e práticas de desenvolvimento.