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

# Get fiscalization rules for a country

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

> **Deprecated.**

Returns country-specific fiscalization rules for building forms. The response always includes the full section list; `fields` is filtered by the optional `sectionKey` query param (default `registration`).

## Query parameters

- `country` string, required
- `sectionKey` string

## Response `200`

Successfully retrieved fiscalization rules

- FiscalizationRegistrationRulesResponse
  - `country` CountryInfo, required
    - `code` string, required — ISO 3166-1 alpha-2 country code
    - `name` string, required — Country name
  - `fields` FieldDefinition[], required
    - `path` string, required — Field path (e.g., "name", "tax_id.code", "addresses")
    - `label` string, required — Display label for the field
    - `type` 'text' | 'email' | 'password' | 'file' | 'select' | 'boolean' | 'array' | 'object', required — Field input type
    - `category` 'company' | 'tax' | 'address' | 'contact' | 'supplementary' | 'custom' — Field grouping category
    - `sectionKey` string — Key of the RulesSection that hosts this field. Defaults to "registration" when absent. Nested fields inside arrays/objects inherit the parent's section and should omit this attribute.
    - `required` boolean, required — Whether field is required
    - `primary` boolean — Indicates primary tax ID field
    - `validation` 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).
    - `data` FieldData
      - `placeholder` string — Input placeholder text
      - `help` string — Help text for the field
      - `alternatives` string[] — Alternative accepted formats (e.g., CPF for CNPJ fields)
    - `options` SelectOption[]
      - `value` string, required
      - `label` string, required
    - `item` ArrayItemDefinition
      - `type` 'object', required
      - `fields` FieldDefinition[], required
    - `properties` object — Object properties for object type fields
    - `default` union
      - string
      - boolean
      - number
    - `description` string — Field description
  - `sections` RulesSection[] — Ordered list of UI sections that host the country's fields. The frontend uses this list to render sub-navigation; each field references a section via its sectionKey. When absent, all fields belong to an implicit "registration" section.
    - `key` string, required — Stable identifier for the section (e.g., "registration", "customization.branding", "customization.invoicing").
    - `label` string, required — Display label for the section (translated)
    - `description` string — Help text for the section
    - `immutableAfterRegistration` boolean, required — Whether the fields in this section become read-only once the property reaches REGISTERED status. The registration section is true; post-registration customization sections are false.
    - `order` integer — Display order (lower first)
  - `examples` object — Example values for common fields
  - `requires` CountryRequirements
    - `credentials` Requirement
      - `required` boolean, required — Whether this step is required for this country
      - `description` string — Human-readable description of what this step involves
      - `fields` RequirementField[] — Field definitions for the UI form (only present when the step has configurable fields)
        - `name` string, required — Field name used in the API request
        - `type` 'text' | 'password' | 'file', required — Field input type
        - `required` boolean — Whether this field is required
        - `label` string — Display label for the field
        - `description` string — Help text or description for the field
        - `accept` string — Accepted file types (for file fields, e.g., ".p12,.pfx,.pem")
    - `certificate` Requirement
      - `required` boolean, required — Whether this step is required for this country
      - `description` string — Human-readable description of what this step involves
      - `fields` RequirementField[] — Field definitions for the UI form (only present when the step has configurable fields)
        - `name` string, required — Field name used in the API request
        - `type` 'text' | 'password' | 'file', required — Field input type
        - `required` boolean — Whether this field is required
        - `label` string — Display label for the field
        - `description` string — Help text or description for the field
        - `accept` string — Accepted file types (for file fields, e.g., ".p12,.pfx,.pem")
    - `series` Requirement
      - `required` boolean, required — Whether this step is required for this country
      - `description` string — Human-readable description of what this step involves
      - `fields` RequirementField[] — Field definitions for the UI form (only present when the step has configurable fields)
        - `name` string, required — Field name used in the API request
        - `type` 'text' | 'password' | 'file', required — Field input type
        - `required` boolean — Whether this field is required
        - `label` string — Display label for the field
        - `description` string — Help text or description for the field
        - `accept` string — Accepted file types (for file fields, e.g., ".p12,.pfx,.pem")
    - `taxMapping` Requirement
      - `required` boolean, required — Whether this step is required for this country
      - `description` string — Human-readable description of what this step involves
      - `fields` RequirementField[] — Field definitions for the UI form (only present when the step has configurable fields)
        - `name` string, required — Field name used in the API request
        - `type` 'text' | 'password' | 'file', required — Field input type
        - `required` boolean — Whether this field is required
        - `label` string — Display label for the field
        - `description` string — Help text or description for the field
        - `accept` string — Accepted file types (for file fields, e.g., ".p12,.pfx,.pem")
    - `paymentMethodMapping` Requirement
      - `required` boolean, required — Whether this step is required for this country
      - `description` string — Human-readable description of what this step involves
      - `fields` RequirementField[] — Field definitions for the UI form (only present when the step has configurable fields)
        - `name` string, required — Field name used in the API request
        - `type` 'text' | 'password' | 'file', required — Field input type
        - `required` boolean — Whether this field is required
        - `label` string — Display label for the field
        - `description` string — Help text or description for the field
        - `accept` string — Accepted file types (for file fields, e.g., ".p12,.pfx,.pem")
    - `itemMapping` Requirement
      - `required` boolean, required — Whether this step is required for this country
      - `description` string — Human-readable description of what this step involves
      - `fields` RequirementField[] — Field definitions for the UI form (only present when the step has configurable fields)
        - `name` string, required — Field name used in the API request
        - `type` 'text' | 'password' | 'file', required — Field input type
        - `required` boolean — Whether this field is required
        - `label` string — Display label for the field
        - `description` string — Help text or description for the field
        - `accept` string — Accepted file types (for file fields, e.g., ".p12,.pfx,.pem")
    - `operatorMapping` Requirement
      - `required` boolean, required — Whether this step is required for this country
      - `description` string — Human-readable description of what this step involves
      - `fields` RequirementField[] — Field definitions for the UI form (only present when the step has configurable fields)
        - `name` string, required — Field name used in the API request
        - `type` 'text' | 'password' | 'file', required — Field input type
        - `required` boolean — Whether this field is required
        - `label` string — Display label for the field
        - `description` string — Help text or description for the field
        - `accept` string — Accepted file types (for file fields, e.g., ".p12,.pfx,.pem")
    - `reports` ReportDefinition[] — Available reports for this country (e.g., SAF-T for PT)
      - `id` string, required — Unique report identifier (e.g., "saft")
      - `label` string, required — Display label for the report
      - `description` string — Detailed description of the report
      - `params` ReportParam[] — Parameters the user must provide to generate the report
        - `name` string, required — Parameter name (used as query param)
        - `type` 'integer' | 'text' | 'select', required — Parameter input type
        - `required` boolean, required
        - `label` string, required — Display label
        - `description` string — Help text

## Other responses

- `400` — Invalid country code
- `404` — Rules not found for country

---

[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)