← HomeFleetPay / API

Import NF-e files

Parameters, data structure and responses from the versioned contract.

POST/fiscal/nfe/importacoes

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

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

Accepts 1 to 20 XML, PDF or ZIP files, up to 10 MB each. With multipart/form-data, send each part using the name arquivos[] to form the arquivos array accepted by the API.

Authentication

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

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

Parameters

No parameters declared for this operation.

Request Body

Required

`multipart/form-data`

arquivosarrayRequired

minItems1

maxItems20

Responses

201 HTTP Response

Batch processed and import report created.

`application/json`

NfeImportEnvelope ↗

dataobjectRequired

NfeImportBatch ↗

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.

422 HTTP Response

Invalid payload.

`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": "Importar arquivos de NF-e",
  "description": "Aceita de 1 a 20 arquivos XML, PDF ou ZIP, com até 10 MB cada. No multipart/form-data, envie cada parte usando o nome `arquivos[]` para formar o array `arquivos` aceito pela API.",
  "operationId": "importNfe",
  "requestBody": {
    "required": true,
    "content": {
      "multipart/form-data": {
        "schema": {
          "type": "object",
          "required": [
            "arquivos"
          ],
          "properties": {
            "arquivos": {
              "type": "array",
              "minItems": 1,
              "maxItems": 20,
              "items": {
                "type": "string",
                "format": "binary"
              }
            }
          }
        },
        "encoding": {
          "arquivos": {
            "style": "form",
            "explode": true
          }
        }
      }
    }
  },
  "responses": {
    "201": {
      "$ref": "#/components/responses/NfeImportCreated"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "403": {
      "$ref": "#/components/responses/Forbidden"
    },
    "422": {
      "$ref": "#/components/responses/ValidationFailed"
    },
    "429": {
      "$ref": "#/components/responses/RateLimited"
    },
    "500": {
      "$ref": "#/components/responses/InternalError"
    }
  },
  "method": "POST",
  "path": "/fiscal/nfe/importacoes",
  "parameters": []
}