← HomeFleetPay / Schema

FiscalConfigurationUpdate

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.

Carrier fiscal fields. All are optional; send null to clear a value. The CT-e series is not configurable: the fiscal provider assigns the series and number, and sending cte_serie in the body returns 422.

state_registrationstring | nullOptional

State tax registration, normalized to uppercase.

maxLength20

rntrcstring | nullOptional

Brazilian National Registry of Road Freight Carriers with 8 digits.

pattern"^\\d{8}$"

rntrc_valid_untilstring | null · dateOptional

RNTRC expiration date in YYYY-MM-DD format.

city_codestring | nullOptional

Municipality's IBGE code, with 7 digits.

pattern"^\\d{7}$"

enderecoobjectOptional

Company fiscal address — the CT-e/MDF-e issuer. Without it, the CT-e preview is rejected with "Endereço da empresa não cadastrado" (company address not registered).

Original JSON Definition (Portuguese Descriptions)

{
  "type": "object",
  "description": "Campos fiscais da transportadora. Todos são opcionais; envie null para limpar um valor.\nA série do CT-e não é configurável: série e número são atribuídos pelo provedor fiscal,\ne `cte_serie` no corpo responde `422`.\n",
  "properties": {
    "state_registration": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 20,
      "description": "Inscrição estadual, normalizada em maiúsculas."
    },
    "rntrc": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^\\d{8}$",
      "description": "Registro Nacional de Transportadores Rodoviários de Cargas com 8 dígitos."
    },
    "rntrc_valid_until": {
      "type": [
        "string",
        "null"
      ],
      "format": "date",
      "description": "Data de validade do RNTRC no formato YYYY-MM-DD."
    },
    "city_code": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^\\d{7}$",
      "description": "Código IBGE do município com 7 dígitos."
    },
    "endereco": {
      "type": "object",
      "description": "Endereço fiscal da empresa — o emitente do CT-e/MDF-e. Sem ele a prévia do CT-e\nrecusa com \"Endereço da empresa não cadastrado\".\n",
      "required": [
        "logradouro",
        "numero",
        "bairro",
        "municipio",
        "uf",
        "cep"
      ],
      "properties": {
        "logradouro": {
          "type": "string",
          "maxLength": 255
        },
        "numero": {
          "type": "string",
          "maxLength": 20
        },
        "complemento": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 100
        },
        "bairro": {
          "type": "string",
          "maxLength": 100
        },
        "municipio": {
          "type": "string",
          "maxLength": 60
        },
        "uf": {
          "type": "string",
          "pattern": "^[A-Z]{2}$"
        },
        "cep": {
          "type": "string",
          "pattern": "^\\d{8}$"
        },
        "codigo_municipio": {
          "type": [
            "string",
            "null"
          ],
          "pattern": "^\\d{7}$"
        }
      }
    }
  }
}