Listar NF-e importadas

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

GET/fiscal/nfe

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

Parámetros

searchquery · stringOpcional

Emisor, destinatario, número o clave de acceso.

Restricciones

{
  "type": "string"
}

statusquery · Opcional

Restricciones

{
  "$ref": "#/components/schemas/NfeStatus"
}

pagequery · integerOpcional

Restricciones

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

per_pagequery · integerOpcional

Restricciones

{
  "type": "integer",
  "minimum": 1,
  "maximum": 100,
  "default": 25
}

Respuestas

200 Respuesta HTTP

Página de resultados de NF-e.

`application/json`

NfeListEnvelope ↗

dataobjectObligatorio

Nfe ↗Pagination ↗

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": [
    "NF-e"
  ],
  "summary": "Listar NF-e importadas",
  "operationId": "listNfe",
  "parameters": [
    {
      "name": "search",
      "in": "query",
      "description": "Emitente, destinatário, número ou chave de acesso.",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "status",
      "in": "query",
      "schema": {
        "$ref": "#/components/schemas/NfeStatus"
      }
    },
    {
      "$ref": "#/components/parameters/Page"
    },
    {
      "$ref": "#/components/parameters/PerPage"
    }
  ],
  "responses": {
    "200": {
      "$ref": "#/components/responses/NfeListOk"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "403": {
      "$ref": "#/components/responses/Forbidden"
    },
    "429": {
      "$ref": "#/components/responses/RateLimited"
    },
    "500": {
      "$ref": "#/components/responses/InternalError"
    }
  },
  "method": "GET",
  "path": "/fiscal/nfe"
}