Skip to main content
POST
Importar Nota Fiscal de Serviço
Chame primeiro com preview=true para conferir os registros lidos do arquivo sem gravar. Só depois envie preview=false para efetivar a importação.
O corpo espera um arquivo Excel (.xlsx) enviado em base64. Erros de layout do arquivo vêm em 400.

Authorizations

Authorization
string
header
required

Envie o token retornado por /v2/autenticar no header Authorization, no formato Bearer {token}.

Query Parameters

preview
boolean
default:false

Se true, apenas valida e retorna um preview dos registros lidos do arquivo, sem gravar os dados.

Body

multipart/form-data

Arquivo de importação em lote (multipart/form-data).

ArquivoExcel
file
required

Arquivo Excel (.xlsx) com os dados a importar.

Response

Requisição processada. O envelope de resposta é sempre HTTP 200; falhas de importação por registro são reportadas no campo errors/summary, não como HTTP 400. Quando preview=true, data traz a pré-visualização dos registros lidos do arquivo em vez do resultado da gravação.

Envelope padrão de resposta dos endpoints de importação em lote. Sempre retornado com HTTP 200, mesmo quando há registros não importados — o resultado por registro fica em data/errors.

success
boolean

true somente quando não há erros e ao menos um registro foi importado.

Example:

true

summary
object

Resumo da importação.

data
object[]

Registros importados com sucesso.

errors
object[]

Registros/mensagens de erro dos itens que falharam na importação.