Atualizar configuração fiscal da transportadora

Parâmetros, estrutura de dados e respostas do contrato versionado.

PUT/fiscal/configuracao

updateFiscalConfigurationBase de Homologação: https://api.fleetpay.site/v1

Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.

Atualiza somente os campos informados. Envie null para limpar um campo opcional.

Autenticação

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

A disponibilidade depende do ambiente, dos escopos habilitados e do provedor. Esta referência não executa chamadas nem recebe credenciais.

Parâmetros

Nenhum parâmetro declarado nesta operação.

Corpo da Requisição

Obrigatório

`application/json`

FiscalConfigurationUpdate ↗

state_registrationstring | nullOpcional

Inscrição estadual, normalizada em maiúsculas.

maxLength20

rntrcstring | nullOpcional

Registro Nacional de Transportadores Rodoviários de Cargas com 8 dígitos.

pattern"^\\d{8}$"

rntrc_valid_untilstring | null · dateOpcional

Data de validade do RNTRC no formato YYYY-MM-DD.

city_codestring | nullOpcional

Código IBGE do município com 7 dígitos.

pattern"^\\d{7}$"

enderecoobjectOpcional

Endereço fiscal da empresa — o emitente do CT-e/MDF-e. Sem ele a prévia do CT-e recusa com "Endereço da empresa não cadastrado".

Respostas

200 Resposta HTTP

Configuração fiscal da transportadora autenticada.

`application/json`

FiscalConfigurationEnvelope ↗

dataobjectObrigatório

Falha interna sem detalhes de integrações operacionais.

`application/json`

ErrorEnvelope ↗

errorobjectObrigatório

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlação da chamada.

Definição Completa da Operação

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