Fiscalization

Get fiscalization rules for a country

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

get/fiscal-document/v1/fiscalization/registration/rules

Request

Base URL
https://api.cloudbeds.com
URL
https://api.cloudbeds.com/fiscal-document/v1/fiscalization/registration/rules
Auth
- HTTP bearer
- or OAuth 2
  Authorization code: https://api.cloudbeds.com/auth/oauth/authorize
  Token URL: https://api.cloudbeds.com/auth/oauth/token scopes: read:reservation

Query parameters

countrystring required

ISO 3166-1 alpha-2 country code (e.g., BR, PL, MX)

sectionKeystring

Filter fields to the given section. Default registration. Pass the key of any section declared in the rules (e.g. customization.invoicing) to fetch its fields only.

channelCodestring

Fiscal channel to scope the rules and requirements to (e.g. SR for Italy Smart Receipts / Documento Commerciale). Omit for the default channel (e.g. Italy SDI / FatturaPA); unknown channels fall back to the country's default rules.

Response

Successfully retrieved fiscalization rules

examplesobject

Example values for common fields

Example response

{
  "country": {
    "code": "BR",
    "name": "Brazil"
  },
  "fields": [
    {
      "path": "name",
      "label": "Legal Name",
      "sectionKey": "customization.invoicing",
      "requiredIf": {
        "field": "taxId",
        "pattern": "^[^123]"
      }
    }
  ],
  "sections": [
    {
      "key": "customization.invoicing",
      "label": "Invoice generation"
    }
  ],
  "requires": {
    "reports": [
      {
        "id": "saft",
        "label": "SAF-T Report",
        "description": "Export SAF-T file for submission to Autoridade Tributária",
        "params": [
          {
            "name": "year",
            "label": "Year",
            "description": "Fiscal year (e.g., 2024)"
          }
        ]
      }
    ]
  }
}

Changes

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