Skip to main content

Get Invoice

Este endpoint é responsável para fazer consultas de notas específicas ou de N notas, filtrado por um número de documento do vendedor. Com este endpoint é possível ao Distribuidor consultar as notas envidas, verificar seu status e a quantidade de pontos geradas nestas notas.

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

Corpo 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 emissor da nota fiscal.
    • invoice: ID da nota.

Exemplo de Requisição​

{ 
    "Campaign" : "BRBAY", 
    "ClientVersion" : "1.0.0", 
    "Culture" : "PT-BR", 
    "clientId" : "0B497529A1334B588725E9B3C578A5A9", 
    "clientSecret": "98F73F4FF9F4B76A76460C806B8E985", 
     "Parameters" : { 
        "document" : "93424620003073", 
        "invoice" : 31241 
    } 
}

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.