Skip to main content

Invoice

Este endpoint é responsável por receber dados da Nota Fiscal (NF).

Método: POST
URI do Endpoint: https://integration-loyalt.orbia.nom.co/prwapi/accrual-invoice/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, para este endpoint, utilize "1.0.0".
  • culture (string): Idioma associado ao cadastro do distribuidor, ex.: "pt-BR".
  • campaign (string): Identificador fixo da campanha, utilize "BRBAY".
  • parameters (object): Objeto contendo os dados da Nota Fiscal:
    • sellerDocument (string): CNPJ/CPF do distribuidor parceiro da NF (sem formatação).
    • customerDocument (string): CNPJ/CPF do comprador da NF (sem formatação).
    • externalId (string): Identificador externo da NF.
    • invoiceXML (string): XML completo da NF.

Exemplo de Requisição​

{
  "clientId": "XXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "clientSecret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "clientVersion": "1.0.0",
  "culture": "pt-BR",
  "campaign": "BRBAY",
  "parameters": {
    "sellerDocument": "12345678901234",
    "customerDocument": "56789012345678",
    "externalId": "ABC123",
    "invoiceXML": "<XML da NF>"
  }
}

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