Skip to main content

Invoice Sent

Este endpoint é responsável por retornar as notas enviadas pelo distribuidor.

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

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): CNPJ/CPF do distribuidor parceiro da NF (sem formatação).
    • invoices (array of strings): Lista com os IDs das notas fiscais a serem consultadas.

Versões​

Para alterar as versões da API, é necessário atualizar o campo clientVersion com um dos valores abaixo:

  • V 1.0.0: Retorna as notas enviadas pelo distribuidor com data de envio, status e mensagem.
  • V 1.1.0: Retorna as notas enviadas pelo distribuidor com status e pontuações.

Exemplo de Requisição​

{
  "clientId": "XXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "clientSecret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "clientVersion": "1.0.0",
  "culture": "pt-BR",
  "campaign": "BRBAY",
  "parameters": {
    "document": "12345678901234",
    "invoices": [
      "INV001",
      "INV002",
      "INV003"
    ]
  }
}

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.