Actualizar configuración fiscal del transportista

Parámetros, estructura de datos y respuestas del contrato versionado.

PUT/fiscal/configuracao

updateFiscalConfigurationBase de Pruebas: https://api.fleetpay.site/v1

Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.

Actualiza solo los campos proporcionados. Envía null para borrar un campo opcional.

Autenticación

[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]

La disponibilidad depende del entorno, los permisos habilitados y el proveedor. Esta referencia no ejecuta solicitudes ni recibe credenciales.

Parámetros

No hay parámetros declarados para esta operación.

Cuerpo de la Solicitud

Obligatorio

`application/json`

FiscalConfigurationUpdate ↗

state_registrationstring | nullOpcional

Inscripción tributaria estatal, normalizada en mayúsculas.

maxLength20

rntrcstring | nullOpcional

Registro Nacional de Transportistas de Carga por Carretera de Brasil, con 8 dígitos.

pattern"^\\d{8}$"

rntrc_valid_untilstring | null · dateOpcional

Fecha de vencimiento del RNTRC en formato YYYY-MM-DD.

city_codestring | nullOpcional

Código IBGE del municipio, con 7 dígitos.

pattern"^\\d{7}$"

enderecoobjectOpcional

Dirección fiscal de la empresa, emisora del CT-e/MDF-e. Sin ella, la vista previa del CT-e se rechaza con "Endereço da empresa não cadastrado" (dirección de la empresa no registrada).

Respuestas

200 Respuesta HTTP

Configuración fiscal del transportista autenticado.

`application/json`

FiscalConfigurationEnvelope ↗

dataobjectObligatorio

Fallo interno sin detalles de las integraciones operativas.

`application/json`

ErrorEnvelope ↗

errorobjectObligatorio

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlación de la llamada.

Definición Completa de la Operación

{
  "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": []
}