List recurring invoices

Lists all recurring invoices for the authenticated user with filters and pagination.

Authorization

AuthorizationBearer <token>

API Key authentication.

Format: Authorization: Bearer beel_sk_<key>

Scopes: API Keys use the same scopes as OAuth2 tokens. Each key is created with specific scopes that limit which endpoints it can access. The required scope for each endpoint is documented in the operation's security section under OAuth2.

Obtaining Keys: API Keys are managed from the BeeL dashboard

Security: API Keys are secret credentials. Do not share them or store them in source code

In: header

Query Parameters

status?string

Value in"ACTIVE" | "PAUSED" | "COMPLETED"

customer_id?string

Formatuuid

page?integer

Page number (starts at 1)

Default1

Range1 <= value

limit?integer

Number of items per page

Default20

Range1 <= value <= 100

sortBy?string

Default"created_at"

Value in"name" | "next_generation" | "status" | "created_at"

sortOrder?string

Default"desc"

Value in"asc" | "desc"

Response Body

application/json

curl -X GET "https://app.beel.es/api/v1/recurring-invoices"

curl -X GET "https://app.beel.es/api/v1/recurring-invoices"

{
  "success": true,
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "frequency": "MONTHLY",
      "day_of_month": 0,
      "start_date": "2019-08-24",
      "end_date": "2019-08-24",
      "next_generation": "2019-08-24",
      "preview_days": 3,
      "status": "ACTIVE",
      "series_id": "0f6582ac-1e7e-41dc-a63a-24fccd074d0c",
      "series_code": "string",
      "invoice_type": "STANDARD",
      "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
      "recipient_fiscal_name": "string",
      "recipient_nif": "string",
      "lines": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "order": 0,
          "description": "string",
          "quantity": 0,
          "unit": "string",
          "unit_price": 0,
          "discount_percentage": 0,
          "tax_type": "string",
          "vat_rate": 0,
          "regime_key": "string",
          "equivalence_surcharge_rate": 0,
          "irpf_rate": 0
        }
      ],
      "payment_method": "string",
      "notes": "string",
      "verifactu_enabled": true,
      "send_automatically": true,
      "email_configuration": {
        "recipients": [
          "string"
        ],
        "cc": [
          "string"
        ],
        "subject": "string",
        "message": "string"
      },
      "generated_invoices": 0,
      "last_generation": "2019-08-24T14:15:22Z",
      "source_invoice_id": "0c7d5f47-8759-4ef4-82d5-705413539f77",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  },
  "pagination": {
    "current_page": 1,
    "total_pages": 5,
    "total_items": 87,
    "items_per_page": 20,
    "has_next": true,
    "has_previous": true
  }
}

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required"
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}

List recurring invoices

Authorization

Query Parameters

Response Body

200application/json

401application/json

application/json

application/json