Remover regra de tributação

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

DELETE/fiscal/regras-tributacao/{ruleId}

deleteFiscalTaxRuleBase 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.

Remove uma regra da transportadora autenticada. Regra inexistente ou regra de outra transportadora respondem 404 regra_nao_encontrada — o gateway nunca confirma por 403 aquilo que não pertence à credencial.

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

ruleIdpath · integerObrigatório

ID inteiro da regra, devolvido na criação e na listagem.

Restrições

{
  "type": "integer",
  "minimum": 1
}

Respostas

200 Resposta HTTP

Regra removida.

`application/json`

FiscalTaxRuleDeleteEnvelope ↗

dataobjectObrigatório

FiscalTaxRuleDeleteData ↗

environmentobjectObrigatório

Environment ↗

Headers

X-Request-Id

Identificador de correlação da chamada.

401 Resposta HTTP

Chave de API FleetPay ausente ou inválida.

`application/json`

ErrorEnvelope ↗

errorobjectObrigatório

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlação da chamada.

403 Resposta HTTP

Escopo fiscal desabilitado na chave, ou chave sem transportadora ativa.

`application/json`

ErrorEnvelope ↗

errorobjectObrigatório

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlação da chamada.

404 Resposta HTTP

regra_nao_encontrada — a regra não existe ou pertence a outra transportadora. Os dois casos respondem igual, de propósito.

`application/json`

ErrorEnvelope ↗

errorobjectObrigatório

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlação da chamada.

429 Resposta HTTP

Limite por transportadora excedido.

`application/json`

ErrorEnvelope ↗

errorobjectObrigatório

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlação da chamada.

Retry-After

Segundos até uma nova tentativa.

500 Resposta HTTP

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": [
    "Regras de tributação"
  ],
  "summary": "Remover regra de tributação",
  "operationId": "deleteFiscalTaxRule",
  "description": "Remove uma regra da transportadora autenticada. Regra inexistente ou regra de outra\ntransportadora respondem `404 regra_nao_encontrada` — o gateway nunca confirma por `403`\naquilo que não pertence à credencial.\n",
  "parameters": [
    {
      "name": "ruleId",
      "in": "path",
      "required": true,
      "description": "ID inteiro da regra, devolvido na criação e na listagem.",
      "schema": {
        "type": "integer",
        "minimum": 1
      }
    }
  ],
  "responses": {
    "200": {
      "$ref": "#/components/responses/FiscalTaxRuleDeleted"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "403": {
      "$ref": "#/components/responses/Forbidden"
    },
    "404": {
      "$ref": "#/components/responses/FiscalTaxRuleNotFound"
    },
    "429": {
      "$ref": "#/components/responses/RateLimited"
    },
    "500": {
      "$ref": "#/components/responses/InternalError"
    }
  },
  "method": "DELETE",
  "path": "/fiscal/regras-tributacao/{ruleId}"
}