← HomeFleetPay / API

List tax rules

Parameters, data structure and responses from the versioned contract.

GET/fiscal/regras-tributacao

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

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

Returns data.regras, the authenticated carrier's rules — every rule belongs to the carrier; FleetPay does not maintain a separate rule layer behind these records. Issuance precedence: a rule matching the service type (tp_serv) takes priority over any route-only rule; then an exact route takes priority over a wildcard, and an origin match outweighs a destination match. Validity dates filter the candidates; ties are resolved by the most recent valid_from. A rule without tp_serv applies to any type.

Authentication

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

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

Parameters

No parameters declared for this operation.

Responses

200 HTTP Response

Tax rules for the authenticated carrier.

`application/json`

FiscalTaxRuleListEnvelope ↗

dataobjectRequired

FiscalTaxRule ↗

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.

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