API e Endpoints

API RESTful completa com endpoints síncronos e assíncronos.

POST /api/v1/billing/generate

Gera Billing Orders de forma síncrona (até 50 Orders)

Request Body

{
  "orderIds": ["guid1", "guid2"],
  "billingPeriod": {
    "startDate": "2025-01-01",
    "endDate": "2025-01-31"
  },
  "options": {
    "validateOnly": false,
    "sendToERP": false
  }
}

Response (Success)

{
  "success": true,
  "jobId": "job-12345",
  "billingOrders": [{
    "billingOrderId": "guid-bo-1",
    "billingOrderNumber": "BO-2025-001",
    "totalAmount": 15000.00
  }],
  "summary": {
    "ordersProcessed": 2,
    "billingOrdersCreated": 1,
    "executionTimeMs": 2340
  }
}

Outros Endpoints

POST/api/v1/billing/generate-async

Processa até 1000 Orders em background. Retorna Job ID.

GET/api/v1/billing/jobs/{jobId}

Consulta o estado e resultado de um job assíncrono.

POST/api/v1/billing/validate

Valida se todas as Orders podem ser mapeadas sem criar registos.

Esta página foi útil?

A sua avaliação ajuda-nos a melhorar a documentação