← HomeFleetPay / API

Remove a tax rule

Parameters, data structure and responses from the versioned contract.

DELETE/fiscal/regras-tributacao/{ruleId}

deleteFiscalTaxRuleSandbox Base: https://api.fleetpay.site/v1

Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.

Deletes a rule belonging to the authenticated carrier. A nonexistent rule or a rule belonging to another carrier returns 404 regra_nao_encontrada — the gateway never uses 403 to confirm the existence of a resource that does not belong to the credential.

Authentication

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

Availability depends on the environment, enabled scopes and provider. This reference does not execute requests or collect credentials.

Parameters

ruleIdpath · integerRequired

Integer rule ID, returned on creation and in listings.

Constraints

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

Responses

200 HTTP Response

Rule removed.

`application/json`

FiscalTaxRuleDeleteEnvelope ↗

dataobjectRequired

FiscalTaxRuleDeleteData ↗

environmentobjectRequired

Environment ↗

Headers

X-Request-Id

Call correlation identifier.

401 HTTP Response

FleetPay API key missing or invalid.

`application/json`

ErrorEnvelope ↗

errorobjectRequired

ErrorBody ↗

Headers

X-Request-Id

Call correlation identifier.

403 HTTP Response

Fiscal scope disabled for the key, or no active carrier associated with the key.

`application/json`

ErrorEnvelope ↗

errorobjectRequired

ErrorBody ↗

Headers

X-Request-Id

Call correlation identifier.

404 HTTP Response

regra_nao_encontrada — the rule does not exist or belongs to another carrier. Both cases deliberately return the same response.

`application/json`

ErrorEnvelope ↗

errorobjectRequired

ErrorBody ↗

Headers

X-Request-Id

Call correlation identifier.

429 HTTP Response

Per-carrier limit exceeded.

`application/json`

ErrorEnvelope ↗

errorobjectRequired

ErrorBody ↗

Headers

X-Request-Id

Call correlation identifier.

Retry-After

Seconds until another attempt.

500 HTTP Response

Internal failure without operational integration details.

`application/json`

ErrorEnvelope ↗

errorobjectRequired

ErrorBody ↗

Headers

X-Request-Id

Call correlation identifier.

Complete Operation Definition

{
  "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}"
}