← HomeFleetPay / API

List imported NF-e documents

Parameters, data structure and responses from the versioned contract.

GET/fiscal/nfe

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

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

Authentication

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

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

Parameters

searchquery · stringOptional

Issuer, recipient, number or access key.

Constraints

{
  "type": "string"
}

statusquery · Optional

Constraints

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

pagequery · integerOptional

Constraints

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

per_pagequery · integerOptional

Constraints

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

Responses

200 HTTP Response

NF-e result page.

`application/json`

NfeListEnvelope ↗

dataobjectRequired

Nfe ↗Pagination ↗

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