---
title: "Get available series rules for a country"
method: GET
path: "/fiscal-document/v1/fiscalization/series/rules"
tags: ["Fiscalization"]
---

# Get available series rules for a country

`GET /fiscal-document/v1/fiscalization/series/rules`

Returns the available document type prefixes and series types for the given country.
Used by the frontend to build the series registration UI.

## Query parameters

- `country` string, required

## Response `200`

Successfully retrieved series rules

- FiscalizationSeriesRulesResponse
  - `country` CountryInfo, required
    - `code` string, required — ISO 3166-1 alpha-2 country code
    - `name` string, required — Country name
  - `documentTypes` SeriesDocumentType[], required — Available series slots that require registration
    - `documentKind` string, required — Unique series slot identifier (e.g. INVOICE, INVOICE:NFSE)
    - `prefix` string, required — Series prefix hint (e.g. FT for Portugal, NFSE for Brazil)
    - `name` string, required — Display name (e.g., "Fatura (Standard Invoice)")
  - `seriesTypes` SeriesType[], required — Available series types for this environment
    - `code` string, required — Series type code (N, F, R)
    - `name` string, required — Series type name (e.g., Normal, Training, Recovery)
    - `description` string, required — Description of the series type
  - `seriesOptions` SeriesOptions
    - `prefixWithDocumentType` boolean — Whether the document type prefix is prepended to the series name
    - `requiresSeriesType` boolean — Whether this country requires series type selection (N/F/R)
    - `showValidationCode` boolean — Whether to display the validation code (e.g. AT ATCUD)
  - `dimensionGroups` SeriesDimensionGroup[] — Grouped series dimensions (gov doc → business types). When present, use 2-step selection.
    - `governmentDocument` GovernmentDocumentType, required
      - `key` string, required — Government document identifier (e.g. NFSE, NFCE)
      - `name` string, required — Display name (e.g. NFS-e, NFC-e)
    - `businessDocumentTypes` SeriesDocumentType[], required — Business document types available under this government document
      - `documentKind` string, required — Unique series slot identifier (e.g. INVOICE, INVOICE:NFSE)
      - `prefix` string, required — Series prefix hint (e.g. FT for Portugal, NFSE for Brazil)
      - `name` string, required — Display name (e.g., "Fatura (Standard Invoice)")
    - `nameValidation` FieldValidation
      - `pattern` string — Regex pattern for validation
      - `min` integer — Minimum length or items
      - `max` integer — Maximum length
      - `checksum` boolean — Whether field has checksum validation
      - `format` string — Display format mask (e.g., XX.XXX.XXX/XXXX-XX)
      - `message` string — Human-readable description of the rule, suitable for FE error messages (e.g. "NFS-e series must be 1-5 alphanumeric characters").
      - `example` string — A valid example value that can be shown as a placeholder hint (e.g. "ABC12" for NFS-e, "1" for NFC-e).

## Other responses

- `400` — Invalid or unsupported country code

---

[API](https://skmtc.net/cloudbeds/apis/cloudbeds-api.md) · [All operations](https://skmtc.net/cloudbeds/apis/cloudbeds-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cloudbeds/cloudbeds-api/revisions/2faa857793e8/schema)