Pular para o conteúdo principal

Faturar pedido

Endpoints Disponíveis​

  • PUT /v1/orders/invoiced/{orderNumber} - Criar faturamento

Criar faturamento​

PUT /v1/orders/invoiced/{orderNumber}​

  • Authorization: Basic Auth contendo a chave pública e secreta disponibilizadas para o cliente.
    • Exemplo: Basic <base64-encoded-credentials>
  • x-contractAccountId: Identificador da conta do contrato do cliente.
    • Exemplo: x-contractAccountId: 9f36a666-acd5-4987-a47f-3de247f65d82

Exemplo de Autorização​

Para gerar o valor de Authorization, você precisa codificar suas credenciais (public_key:secret_key) em base64. Por exemplo, se sua chave pública for public_key e sua chave secreta for secret_key, você deve codificar public_key:secret_key em base64.

echo -n 'public_key:secret_key' | base64

Parâmetros da requisição​

  • orderNumber (int): Número do pedido.

Corpo da Requisição​

O corpo da requisição deve conter os seguintes campos:

CampoTipoNullableDescrição
IssuanceDatedatetimeNãoData e hora do faturamento (formato: YYYY-MM-DD HH:MM:SS)
NumberstringNãoNúmero da NF.
ValueintNãoValor do pedido.

Exemplo de Corpo da Requisição​

{
  "IssuanceDate": "2025-01-15 10:30:00",
  "Number": "NF-001234",
  "Value": 15890
}

Respostas​

  • 200: Retorna sucesso da operação.
  • 400: Retorna erro de requisição inválida. Isso geralmente ocorre devido a dados de entrada mal formatados ou faltando.
  • 500: Retorna erro interno do servidor. Indica problemas no processamento da requisição no servidor.

Exemplo de Resposta para Sucesso (200)​

{ "operationId": "402fe685-2060-432b-ac57-223eb2e680f3" }

Notificação via webhook​

Após o faturamento, uma notificação é enviada via webhook com eventType: 129 (Order_InvoiceCreated).