Listar regras de tributação

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

GET/fiscal/regras-tributacao

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

Devolve data.regras, a lista das regras da transportadora autenticada — toda regra é da transportadora; a FleetPay não mantém camada própria por trás do cadastro. Precedência na emissão: regra com o tipo de serviço casado (tp_serv) vence qualquer regra só de rota; depois, rota exata vence curinga, e origem casada pesa mais que destino casado; a vigência filtra, e no empate vence a valid_from mais recente. Regra sem tp_serv vale para qualquer tipo.

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

Nenhum parâmetro declarado nesta operação.

Respostas

200 Resposta HTTP

Regras de tributação da transportadora autenticada.

`application/json`

FiscalTaxRuleListEnvelope ↗

dataobjectObrigatório

FiscalTaxRule ↗

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.

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