Series

Retrieve a series

Retrieve a series by its id.

A series is never deleted through the API: DELETE and PUT on /v1/companies/{company}/series/{series} return 405 Method Not Allowed with error.code = "series_immutable" and header Allow: GET, PATCH. To retire a series use POST /v1/companies/{company}/series/{series}/archive; to change it, use PATCH /v1/companies/{company}/series/{series}, which keeps the fiscal guards of the numbering.

get/companies/{company}/series/{series}

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/series/{series}
  • 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).

seriesstring uuid required

Public identifier (UUID v7) of the document series.

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

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.