← HomeFleetPay / Schema

FiscalConfigurationData

Structure preserved from the versioned API contract.

Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.

state_registrationstring | nullRequired

rntrcstring | nullRequired

pattern"^\\d{8}$"

rntrc_valid_untilstring | null · dateRequired

cte_numberingobjectRequired

The fiscal provider assigns the CT-e series and number; there is no local series.

city_codestring | nullRequired

pattern"^\\d{7}$"

enderecoobject | nullRequired

Default company fiscal address, also used for issuance; null when not registered.

Original JSON Definition (Portuguese Descriptions)

{
  "type": "object",
  "required": [
    "state_registration",
    "rntrc",
    "rntrc_valid_until",
    "cte_numbering",
    "city_code",
    "endereco"
  ],
  "properties": {
    "state_registration": {
      "type": [
        "string",
        "null"
      ]
    },
    "rntrc": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^\\d{8}$"
    },
    "rntrc_valid_until": {
      "type": [
        "string",
        "null"
      ],
      "format": "date"
    },
    "cte_numbering": {
      "type": "object",
      "description": "Série e número do CT-e são do provedor fiscal; não há série local.",
      "required": [
        "authority",
        "series_configurable"
      ],
      "properties": {
        "authority": {
          "type": "string",
          "enum": [
            "provider"
          ]
        },
        "series_configurable": {
          "type": "boolean",
          "enum": [
            false
          ]
        }
      }
    },
    "city_code": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^\\d{7}$"
    },
    "endereco": {
      "type": [
        "object",
        "null"
      ],
      "description": "Endereço fiscal padrão da empresa, o mesmo que a emissão usa; `null` quando não cadastrado.",
      "properties": {
        "logradouro": {
          "type": [
            "string",
            "null"
          ]
        },
        "numero": {
          "type": [
            "string",
            "null"
          ]
        },
        "complemento": {
          "type": [
            "string",
            "null"
          ]
        },
        "bairro": {
          "type": [
            "string",
            "null"
          ]
        },
        "municipio": {
          "type": [
            "string",
            "null"
          ]
        },
        "uf": {
          "type": [
            "string",
            "null"
          ]
        },
        "cep": {
          "type": [
            "string",
            "null"
          ]
        },
        "codigo_municipio": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    }
  }
}