Recurring Invoices

Create a recurring invoice

The template currency (meta.currency) must be one of the supported currencies (stored in canonical form); otherwise 400 UNSUPPORTED_CURRENCY (with currency). Each run creates the invoice through the invoice write and its rules.

post/recurring-invoices

Request

  • Base URL: https://api.lumabill.ch/v1
  • URL: https://api.lumabill.ch/v1/recurring-invoices
  • Auth: HTTP bearer

Request body

client_idstring uuid required
interval'monthly' | 'quarterly' | 'yearly' required
next_datestring date required
activeboolean

Example request

{
  "client_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "interval": "monthly",
  "next_date": "2025-06-01",
  "template": {
    "invoice_number": "INV-2025-0042",
    "client_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "status": "draft",
    "issue_date": "2025-05-01",
    "due_date": "2025-05-31",
    "currency": "CHF",
    "exchangeRate": 0.9412,
    "lines": [
      {
        "description": "Web development - May 2025",
        "quantity": 8,
        "price": 150,
        "vat_rate": 8.1
      }
    ],
    "notes": "Payment within 30 days.",
    "payment_terms": "30 days net"
  }
}

Response

Recurring invoice created

idstring uuid required
client_idstring uuid required
interval'monthly' | 'quarterly' | 'yearly' required
next_datestring date required

Date on which the next invoice will be generated

activeboolean required
created_atstring date-time required

Example response

{
  "id": "e5f6a7b8-5678-9abc-ef01-234567890123",
  "client_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "interval": "monthly",
  "next_date": "2025-06-01",
  "template": {
    "invoice_number": "INV-2025-0042",
    "client_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "status": "draft",
    "issue_date": "2025-05-01",
    "due_date": "2025-05-31",
    "currency": "CHF",
    "exchangeRate": 0.9412,
    "lines": [
      {
        "description": "Web development - May 2025",
        "quantity": 8,
        "price": 150,
        "vat_rate": 8.1
      }
    ],
    "notes": "Payment within 30 days.",
    "payment_terms": "30 days net"
  },
  "active": true,
  "created_at": "2025-01-01T00:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.