Eliminar una regla tributaria

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

DELETE/fiscal/regras-tributacao/{ruleId}

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

Elimina una regla de la transportista autenticada. Una regla inexistente o de otra transportista devuelve 404 regra_nao_encontrada: el gateway nunca utiliza 403 para confirmar la existencia de un recurso que no pertenece a la credencial.

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

ruleIdpath · integerObligatorio

Identificador entero de la regla, devuelto al crearla y en los listados.

Restricciones

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

Respuestas

200 Respuesta HTTP

Regla eliminada.

`application/json`

FiscalTaxRuleDeleteEnvelope ↗

dataobjectObligatorio

FiscalTaxRuleDeleteData ↗

environmentobjectObligatorio

Environment ↗

Headers

X-Request-Id

Identificador de correlación de la llamada.

401 Respuesta HTTP

Clave de API FleetPay ausente o no válida.

`application/json`

ErrorEnvelope ↗

errorobjectObligatorio

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlación de la llamada.

403 Respuesta HTTP

Ámbito fiscal deshabilitado en la clave, o clave sin transportista activo.

`application/json`

ErrorEnvelope ↗

errorobjectObligatorio

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlación de la llamada.

404 Respuesta HTTP

regra_nao_encontrada — la regla no existe o pertenece a otro transportista. Ambos casos devuelven deliberadamente la misma respuesta.

`application/json`

ErrorEnvelope ↗

errorobjectObligatorio

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlación de la llamada.

429 Respuesta HTTP

Límite por transportista excedido.

`application/json`

ErrorEnvelope ↗

errorobjectObligatorio

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlación de la llamada.

Retry-After

Segundos hasta un nuevo intento.

500 Respuesta HTTP

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