Importar arquivos de NF-e

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

POST/fiscal/nfe/importacoes

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

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.

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

Nenhum parâmetro declarado nesta operação.

Corpo da Requisição

Obrigatório

`multipart/form-data`

arquivosarrayObrigatório

minItems1

maxItems20

Respostas

201 Resposta HTTP

Lote processado e relatório de importação criado.

`application/json`

NfeImportEnvelope ↗

dataobjectObrigatório

NfeImportBatch ↗

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.

422 Resposta HTTP

Payload inválido.

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