Series

List active series by document type

Return the non-archived series of your company, optionally filtered by document_type and, for invoice series, by purpose (invoice_kind). Each invoice series carries its invoice_kind. Returns 422 series_invoice_kind_invalid for an unknown invoice_kind.

get/companies/{company}/series/active

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/series/active
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

Query parameters

document_type'invoice' | 'quote' | 'proforma' | 'delivery_note'
Example:invoice

Optional filter by document type. Without it, every active series of the company is returned.

invoice_kind'complete' | 'simplified' | 'corrective' | 'simplified_corrective'
Example:simplified

Restrict to invoice series of this purpose (only invoice series are returned). A value outside the list returns 422 series_invoice_kind_invalid.

Headers

Factuarea-Versionstring date
Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Response

Active document series, optionally filtered by document_type and, for invoice series, by invoice_kind.

Example response

{
  "data": [
    {
      "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a0e",
      "code": "F-2026",
      "name": "Facturas 2026",
      "document_type": "invoice",
      "invoice_kind": "complete",
      "prefix": "F-2026-",
      "number_format": "{code}-{YYYY}-{000}",
      "next_number": 46,
      "current_number": 45,
      "initial_number": 1,
      "counter_reset": "annual",
      "year_reset": true,
      "is_default": true,
      "is_active": true,
      "created_at": "2026-01-01T00:00:00Z",
      "updated_at": "2026-01-20T11:30:00Z"
    }
  ]
}

Changes

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