Skip to main content
POST
Criar NF-e

Authorizations

X-Api-Key
string
header
required

Authorization By X-Api-Key inside request's header

Body

isFinalCustomer
boolean
required

Consumidor Final [indFinal]

integrationId
string | null

Identificador único da nota fiscal no sistema do cliente (máx. 36 caracteres).

Maximum string length: 36
effectiveDate
string<date-time>

Data de emissão [dhEmi]. Opcional: se omitida, é usada a data e hora em que a emissão é solicitada. Data futura é substituída por essa mesma data.

number
integer<int64> | null

Número da nota [nNF]. Opcional: se omitido, é usado o próximo número configurado na empresa.

additionalInformation
string | null

Informações adicionais [infCpl]

sendEmailToCustomer
boolean

Enviar e-mail para o cliente / tomador

issue
boolean
default:true

Padrão true: a nota é criada e enfileirada para emissão (status enqueued). Quando false, a nota fica como rascunho (status created), sem consumir numeração nem transmitir, o que permite gerar a pré-visualização do PDF; para emitir depois, use «Reemitir nota fiscal».

series
string | null

Série [serie]

printingType
enum<string> | null

Tipo de impressão [tpImp]

Valores possíveis:

  • none: Sem geração de DANFE
  • portrait: Retrato (orientação vertical)
  • landscape: Paisagem (orientação horizontal)
  • simplified: Simplificado
  • consumerInvoice: DANFE NFC-e (cupom fiscal eletrônico)
  • electronicMessage: Mensagem eletrônica
Available options:
none,
portrait,
landscape,
simplified,
consumerInvoice,
electronicMessage
operationType
enum<string> | null

Tipo de operação [tpNF]

Valores possíveis:

  • incoming: Entrada
  • outgoing: Saída
Available options:
incoming,
outgoing
purposeType
enum<string> | null

Finalidade [finNFe]

Valores possíveis:

  • normal: Normal
  • complement: Complemento
  • adjustment: Ajustamento
  • devolution: Devolução
  • credit: Crédito
  • debit: Débito
Available options:
normal,
complement,
adjustment,
devolution,
credit,
debit
issueType
enum<string> | null

Tipo de emissão [tpEmis]

Valores possíveis:

  • normal: Emissão normal (não em contingência)
  • fSIA: Contingência FS-IA — DANFE em formulário de segurança com impressão no verso
  • sCAN: Contingência SCAN — Sistema de Contingência do Ambiente Nacional (desativado)
  • ePEC: Contingência EPEC — Declaração Prévia de Emissão em Contingência
  • fSDA: Contingência FS-DA — DANFE em formulário de segurança sem impressão no verso
  • sVCAN: Contingência SVC-AN — SEFAZ Virtual de Contingência do Ambiente Nacional
  • sVCRS: Contingência SVC-RS — SEFAZ Virtual de Contingência do Rio Grande do Sul
  • offLine: Contingência off-line
  • website: Website do provedor (NFS-e)
  • aNNFS: Ambiente Nacional da NFS-e
  • alt: Ambiente alternativo do provedor (NFS-e)
Available options:
normal,
fsia,
scan,
epec,
fsda,
svcan,
svcrs,
offLine,
website,
annfs,
alt
operationNature
string | null

Natureza de Operação [natOp]

operationDate
string<date-time> | null

Data da Operação [dhSaiEnt]

destination
enum<string> | null

Destino [idDest]

Valores possíveis:

  • internal: Interna
  • interstate: Interestadual
  • international: Exterior
Available options:
internal,
interstate,
international
presenceType
enum<string> | null

Indicador de presença [indPres]

Valores possíveis:

  • none: Não se aplica (ex: NF-e complementar ou de ajuste)
  • presence: Operação presencial
  • internet: Operação não presencial via Internet
  • telephone: Operação não presencial via teleatendimento
  • delivery: Entrega em domicílio (NFC-e)
  • othersNonPresenceOperation: Operação não presencial — outros
Available options:
none,
presence,
internet,
telephone,
delivery,
othersNonPresenceOperation
receiver
object | null

Destinário [dest]

transport
object | null

Transporte [transp]

intermediary
object | null

Intermediador da Transação [infIntermed]

pickup
object | null

Local de Retirada [retirada]

delivery
object | null

Local de Entrega [entrega]

billing
object | null

Cobrança [cobr]

duplicates
object[] | null

Faturas

payments
object[] | null

Pagamentos [pag]

items
object[] | null

Itens da nota [det]

referencedDocuments
object[] | null

Documentos Fiscais Referenciados [NFref]

authorizedPersons
string[] | null

Pessoas autorizadas a acessar o XML da nota na SEFAZ [autXML] (máx. 10).

total
object | null

Totais [total]

accessKey
string | null

Chave de acesso [Id]

code
string | null

Código Numérico [cNF]

debitType
enum<string> | null

Tipo de Nota de Débito [tpNFDebito]

Valores possíveis:

  • creditTransferToCooperatives: Transferência de créditos para Cooperativas
  • creditReversalForExemptOrImmuneOutputs: Anulação de crédito por saídas imunes/isentas
  • unprocessedInvoiceDebitInAssessment: Débitos de notas fiscais não processadas na apuração
  • penaltyAndInterest: Multa e juros
  • creditTransferBySuccession: Transferência de crédito de sucessão
  • advancePayment: Pagamento antecipado
  • inventoryLoss: Perda em estoque
Available options:
creditTransferToCooperatives,
creditReversalForExemptOrImmuneOutputs,
unprocessedInvoiceDebitInAssessment,
penaltyAndInterest,
creditTransferBySuccession,
advancePayment,
inventoryLoss
creditType
enum<string> | null

Tipo de Nota de Crédito [tpNFCredito]

Valores possíveis:

  • finesAndInterest: Multa e juros
  • appropriation: Apropriação de crédito presumido de IBS sobre o saldo devedor na ZFM (art. 450, § 1º, LC 214/25)
Available options:
finesAndInterest,
appropriation
govPurchase
object | null

Grupo de Compra Governamental [gCompraGov]

govOperationType
enum<string> | null

Tipo de operação com o ente governamental [tpOperGov]

Valores possíveis:

  • supply: Fornecimento
  • receipt: Recebimento do pagamento, conforme fato gerador do IBS/CBS (Art. 10 § 2º)
Available options:
supply,
receipt

Response

OK

id
string<uuid>

ID da NF

integrationId
string | null

ID de integração

status
enum<string>

Status

Valores possíveis:

  • created: Criada — aguarda emissão explícita via issue ou gatilho automático (ex: afterPayment)
  • enqueued: Enfileirada para processamento junto à SEFAZ ou Prefeitura
  • received: Recebido
  • authorized: Autorizado
  • inContingent: Em contingência
  • rejected: Rejeitado
  • canceled: Cancelado
  • denied: Denegado
  • removed: Removido
  • disabled: Inutilizado
Available options:
created,
enqueued,
received,
authorized,
inContingent,
rejected,
canceled,
denied,
removed,
disabled
model
enum<string>

Modelo

Valores possíveis:

  • productInvoice: NF-e
  • consumerInvoice: NFC-e
  • serviceInvoice: NFS-e
Available options:
productInvoice,
consumerInvoice,
serviceInvoice
environmentType
enum<string>

Ambiente

Valores possíveis:

  • production: Produção
  • development: Homologação
  • simulation:
Available options:
production,
development,
simulation
issuedOn
string<date-time> | null

Data de emissão [dhEmi]

effectiveDate
string<date-time> | null

Data usada como emissão da nota. Após a emissão, tem o mesmo valor de issuedOn.

receiver
object | null

Cliente

company
object | null

Empresa

order
object | null

Dados da venda

authorization
object | null

Dados da autorização

cancellation
object | null

Dados do cancelamento

amount
number<double>

Valor total da NF

number
integer<int64> | null

Número

processingDetail
object | null

Detalhes do processamento

isFromApi
boolean

Emitida via API pública

accessKey
string | null
series
string | null
operationType
enum<string>

Tipo de operação da nota fiscal

Valores possíveis:

  • incoming: Entrada
  • outgoing: Saída
Available options:
incoming,
outgoing
printingType
enum<string>

Formato de impressão do DANFE

Valores possíveis:

  • none: Sem geração de DANFE
  • portrait: Retrato (orientação vertical)
  • landscape: Paisagem (orientação horizontal)
  • simplified: Simplificado
  • consumerInvoice: DANFE NFC-e (cupom fiscal eletrônico)
  • electronicMessage: Mensagem eletrônica
Available options:
none,
portrait,
landscape,
simplified,
consumerInvoice,
electronicMessage
issueType
enum<string>

Forma de emissão da NF-e

Valores possíveis:

  • normal: Emissão normal (não em contingência)
  • fSIA: Contingência FS-IA — DANFE em formulário de segurança com impressão no verso
  • sCAN: Contingência SCAN — Sistema de Contingência do Ambiente Nacional (desativado)
  • ePEC: Contingência EPEC — Declaração Prévia de Emissão em Contingência
  • fSDA: Contingência FS-DA — DANFE em formulário de segurança sem impressão no verso
  • sVCAN: Contingência SVC-AN — SEFAZ Virtual de Contingência do Ambiente Nacional
  • sVCRS: Contingência SVC-RS — SEFAZ Virtual de Contingência do Rio Grande do Sul
  • offLine: Contingência off-line
  • website: Website do provedor (NFS-e)
  • aNNFS: Ambiente Nacional da NFS-e
  • alt: Ambiente alternativo do provedor (NFS-e)
Available options:
normal,
fsia,
scan,
epec,
fsda,
svcan,
svcrs,
offLine,
website,
annfs,
alt
purposeType
enum<string>

Valores possíveis:

  • normal: Normal
  • complement: Complemento
  • adjustment: Ajustamento
  • devolution: Devolução
  • credit: Crédito
  • debit: Débito
Available options:
normal,
complement,
adjustment,
devolution,
credit,
debit
pickup
object | null
delivery
object | null
debitType
enum<string> | null

Valores possíveis:

  • creditTransferToCooperatives: Transferência de créditos para Cooperativas
  • creditReversalForExemptOrImmuneOutputs: Anulação de crédito por saídas imunes/isentas
  • unprocessedInvoiceDebitInAssessment: Débitos de notas fiscais não processadas na apuração
  • penaltyAndInterest: Multa e juros
  • creditTransferBySuccession: Transferência de crédito de sucessão
  • advancePayment: Pagamento antecipado
  • inventoryLoss: Perda em estoque
Available options:
creditTransferToCooperatives,
creditReversalForExemptOrImmuneOutputs,
unprocessedInvoiceDebitInAssessment,
penaltyAndInterest,
creditTransferBySuccession,
advancePayment,
inventoryLoss
creditType
enum<string> | null

Valores possíveis:

  • finesAndInterest: Multa e juros
  • appropriation: Apropriação de crédito presumido de IBS sobre o saldo devedor na ZFM (art. 450, § 1º, LC 214/25)
Available options:
finesAndInterest,
appropriation
govPurchase
object | null
govOperationType
enum<string> | null

Valores possíveis:

  • supply: Fornecimento
  • receipt: Recebimento do pagamento, conforme fato gerador do IBS/CBS (Art. 10 § 2º)
Available options:
supply,
receipt
contingency
object | null
authorizedPersons
string[] | null