Verificar acceso y disponibilidad fiscal

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

GET/fiscal/status

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

Autenticación

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

La disponibilidad depende del entorno, los permisos habilitados y el proveedor. Esta referencia no ejecuta solicitudes ni recibe credenciales.

Primera Consulta

curl --request GET \
  https://api.fleetpay.site/v1/fiscal/status \
  --header "Authorization: Bearer $FLEETPAY_API_KEY" \
  --header "Accept: application/json"

Parámetros

No hay parámetros declarados para esta operación.

Respuestas

200 Respuesta HTTP

Acceso fiscal disponible para el transportista.

`application/json`

StatusEnvelope ↗

dataobjectObligatorio

StatusData ↗

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": [
    "Serviço"
  ],
  "summary": "Verificar acesso e prontidão fiscal",
  "operationId": "getFiscalStatus",
  "responses": {
    "200": {
      "$ref": "#/components/responses/StatusOk"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "403": {
      "$ref": "#/components/responses/Forbidden"
    },
    "429": {
      "$ref": "#/components/responses/RateLimited"
    },
    "500": {
      "$ref": "#/components/responses/InternalError"
    }
  },
  "method": "GET",
  "path": "/fiscal/status",
  "parameters": []
}