Series

Create a series

Creates a document numbering series, optionally with number_format (e.g. {code}-{YYYY}-{00000}) and initial_number (>=1).

  • The same code can repeat across document types, not within one type.
  • Code, mask and purpose can be changed with PATCH until the first document is issued.
post/companies/{company}/series

Request

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

Headers

Idempotency-Keystring
Example:01928f10-7c0e-7c4a-9b7d-2f8a6e3c1d4b

Client-generated opaque key (up to 255 characters; UUID v7 recommended) that makes retries safe: the first response is cached and replayed for repeats without re-executing the mutation. Reusing a key with a different body returns 422 idempotency_key_reused; the values of secret fields (password, secret…) count as part of the body, so retrying with a corrected secret under the same key is a different request, never the replay of the earlier answer. See the Idempotency guide.

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.

Request body

codestring required
namestring nullable
document_type'invoice' | 'quote' | 'delivery_note' | 'proforma' | 'transport_document' required
prefixstring nullable
counter_reset'never' | 'annual' | 'monthly' | 'null' nullable
year_resetboolean nullable
number_formatstring nullable
initial_numberinteger nullable
invoice_kind'complete' | 'simplified' | 'corrective' | 'simplified_corrective' | 'null' nullable

Response

Series created successfully. The Location header contains the canonical URL of the newly created resource.

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.