state_registrationstring | nullOptionalState tax registration, normalized to uppercase.
maxLength20← HomeFleetPay / API
Update carrier fiscal configuration
Parameters, data structure and responses from the versioned contract.
PUT
/fiscal/configuracaoTechnical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.
Updates only the provided fields. Send null to clear an optional field.
Authentication
[
{
"oauth2": []
},
{
"chaveApi": []
}
]Availability depends on the environment, enabled scopes and provider. This reference does not execute requests or collect credentials.
Parameters
No parameters declared for this operation.
Request Body
Required
application/json
rntrcstring | nullOptionalBrazilian National Registry of Road Freight Carriers with 8 digits.
pattern"^\\d{8}$"rntrc_valid_untilstring | null · dateOptionalRNTRC expiration date in YYYY-MM-DD format.
city_codestring | nullOptionalMunicipality's IBGE code, with 7 digits.
pattern"^\\d{7}$"enderecoobjectOptionalCompany 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).
Responses
200 HTTP Response
Fiscal configuration of the authenticated carrier.
application/json
dataobjectRequiredenvironmentobjectRequiredHeaders
X-Request-IdCall correlation identifier.
401 HTTP Response
FleetPay API key missing or invalid.
Headers
X-Request-IdCall correlation identifier.
403 HTTP Response
Fiscal scope disabled for the key, or no active carrier associated with the key.
Headers
X-Request-IdCall correlation identifier.
422 HTTP Response
Invalid payload.
Headers
X-Request-IdCall correlation identifier.
429 HTTP Response
Per-carrier limit exceeded.
Headers
X-Request-IdCall correlation identifier.
Retry-AfterSeconds until another attempt.
500 HTTP Response
Internal failure without operational integration details.
Headers
X-Request-IdCall correlation identifier.
Complete Operation Definition
{
"tags": [
"Configuração"
],
"summary": "Atualizar configuração fiscal da transportadora",
"description": "Atualiza somente os campos informados. Envie null para limpar um campo opcional.",
"operationId": "updateFiscalConfiguration",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FiscalConfigurationUpdate"
}
}
}
},
"responses": {
"200": {
"$ref": "#/components/responses/FiscalConfigurationOk"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"422": {
"$ref": "#/components/responses/ValidationFailed"
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"500": {
"$ref": "#/components/responses/InternalError"
}
},
"method": "PUT",
"path": "/fiscal/configuracao",
"parameters": []
}