Listar NF-e importadas

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

GET/fiscal/nfe

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

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

searchquery · stringOpcional

Emitente, destinatário, número ou chave de acesso.

Restrições

{
  "type": "string"
}

statusquery · Opcional

Restrições

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

pagequery · integerOpcional

Restrições

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

per_pagequery · integerOpcional

Restrições

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

Respostas

200 Resposta HTTP

Página de NF-e.

`application/json`

NfeListEnvelope ↗

dataobjectObrigatório

Nfe ↗Pagination ↗

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