LinkPix
Referência da API

Faturas

Criar e gerenciar faturas com cálculo automático

Faturas (Invoices)

Crie e gerencie faturas com cálculo automático de valores.

Criar Fatura

POST /api/v1/invoices
{
  "client_id": "uuid-do-cliente",
  "issue_date": "2026-01-12",
  "due_date": "2026-02-12",
  "items": [
    {
      "description": "Desenvolvimento de Website",
      "quantity": 1,
      "unit_price": 5000
    }
  ],
  "tax_rate": 0,
  "discount_rate": 10,
  "notes": "Obrigado pela preferência!"
}

Campos obrigatórios:

  • client_id - UUID do cliente
  • issue_date - Data de emissão (YYYY-MM-DD)
  • due_date - Data de vencimento
  • items - Array com pelo menos 1 item

Os valores (subtotal, impostos, descontos, total) são calculados automaticamente!

Listar Faturas

GET /api/v1/invoices?page=1&limit=50&status=sent

Filtros disponíveis:

  • status - draft, sent, cancelled
  • payment_status - pending, partial, paid, overdue
  • client_id - Filtrar por cliente

Buscar Fatura

GET /api/v1/invoices/:id

Retorna a fatura completa com cliente, itens e pagamentos.

Atualizar Fatura

PATCH /api/v1/invoices/:id
{
  "status": "sent",
  "payment_status": "paid",
  "amount_paid": 5000,
  "paid_at": "2026-01-15T10:30:00Z"
}

Deletar Fatura

DELETE /api/v1/invoices/:id

Apenas faturas com status draft podem ser deletadas. Para outras, use PATCH para alterar o status para cancelled.

On this page