Listar reglas tributarias

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

GET/fiscal/regras-tributacao

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

Devuelve data.regras, la lista de reglas de la transportista autenticada. Todas las reglas pertenecen a la transportista; FleetPay no mantiene una capa propia detrás del registro. Precedencia en la emisión: una regla que coincide con el tipo de servicio (tp_serv) tiene prioridad sobre cualquier regla basada solo en el recorrido; después, el recorrido exacto prevalece sobre el comodín y la coincidencia de origen pesa más que la de destino. La vigencia filtra las candidatas y, en caso de empate, gana la valid_from más reciente. Una regla sin tp_serv se aplica a cualquier tipo.

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.

Respuestas

200 Respuesta HTTP

Reglas tributarias del transportista autenticado.

`application/json`

FiscalTaxRuleListEnvelope ↗

dataobjectObligatorio

FiscalTaxRule ↗

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.

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": "Listar regras de tributação",
  "operationId": "listFiscalTaxRules",
  "description": "Devolve `data.regras`, a lista das regras da transportadora autenticada — toda regra é\nda transportadora; a FleetPay não mantém camada própria por trás do cadastro.\nPrecedência na emissão: regra com o tipo de serviço casado (`tp_serv`) vence qualquer\nregra só de rota; depois, rota exata vence curinga, e origem casada pesa mais que destino\ncasado; a vigência filtra, e no empate vence a `valid_from` mais recente. Regra sem\n`tp_serv` vale para qualquer tipo.\n",
  "responses": {
    "200": {
      "$ref": "#/components/responses/FiscalTaxRulesOk"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "403": {
      "$ref": "#/components/responses/Forbidden"
    },
    "429": {
      "$ref": "#/components/responses/RateLimited"
    },
    "500": {
      "$ref": "#/components/responses/InternalError"
    }
  },
  "method": "GET",
  "path": "/fiscal/regras-tributacao",
  "parameters": []
}