Invoice Series

List invoice series

Retrieves all invoice series for the user

GET
/v1/configuration/series

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

active?boolean

Filter by active/inactive series

document_type?string

Filter by document type (SIN_ASIGNAR series are always included)

Value in"SIN_ASIGNAR" | "FACTURA_ORDINARIA" | "FACTURA_SIMPLIFICADA" | "FACTURA_RECTIFICATIVA"

Response Body

application/json

application/json

application/json

curl -X GET "https://app.beel.es/api/v1/configuration/series"
{
  "success": true,
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "document_type": "SIN_ASIGNAR",
      "name": "Main Series",
      "code": "FAC",
      "description": "Series for standard invoices",
      "format": "{CODIGO}-{YYYY}-{NUM:4}",
      "counter_reset": "NEVER",
      "initial_number": 1,
      "active": true,
      "default_series": false,
      "created_at": "2019-08-24T14:15:22Z",
      "next_number": 0,
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required"
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}
{
  "success": false,
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error"
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}

Get default series status per document type GET

Reports whether the user has a default invoice series for each `DocumentType` relevant to automatic invoicing flows (Stripe Connect, etc.). Used by integration setup screens to surface missing defaults at config time, preventing webhooks from being skipped at runtime with `failure.payment.skip.missing_default_series`. Environment is resolved via RLS from the request context — no input needed.

Mark series as default POST

Marks an invoice series as the user's default. **Business rules:** - Only one series can be default per user - The series must be active (cannot mark an inactive series) - The previous default series is automatically unmarked **Note:** This operation is idempotent - calling it multiple times with the same series has no additional effects.