Skip to main content
POST
Criar NFC-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
issuedOn
string<date-time> | null

Data de emissão [dhEmi]

effectiveDate
string<date-time>

Data de competência [dCompet]

number
integer<int64> | null

Número da NF [nNF]

status
enum<string>

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
additionalInformation
string | null

Informações adicionais [infCpl]

sendEmailToCustomer
boolean

Enviar e-mail para o cliente / tomador

series
string | null

Série [serie]

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
operationType
enum<string>

Tipo de operação da nota fiscal

Valores possíveis:

  • incoming: Entrada
  • outgoing: Saída
Available options:
incoming,
outgoing
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
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
operationNature
string | null

Natureza de Operação [natOp]

operationDate
string<date-time> | null

Data da Operação [dhSaiEnt]

destination
enum<string>

Valores possíveis:

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

Indicador de presença do comprador no estabelecimento comercial

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
transport
object
intermediary
object
billing
object
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
accessKey
string | null

Chave de acesso [Id]

code
string | null

Código Numérico [cNF]

debitType
enum<string>

Tipo de Nota de Débito — NT 2025.002 Reforma Tributária

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>

Tipo de Nota de Crédito — NT 2025.002 Reforma Tributária

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
govOperationType
enum<string>

Tipo de operação com o ente governamental — NT 2025.002 Reforma Tributária

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>

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>

Valores possíveis:

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

Valores possíveis:

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

Data de emissão

effectiveDate
string<date-time> | null

Data de competência

receiver
object
company
object
order
object
authorization
object

Dados de autorização da nota fiscal

amount
number<double>

Valor total da NF

number
integer<int64> | null

Número

processingDetail
object
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
debitType
enum<string>

Tipo de Nota de Débito — NT 2025.002 Reforma Tributária

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>

Tipo de Nota de Crédito — NT 2025.002 Reforma Tributária

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
govOperationType
enum<string>

Tipo de operação com o ente governamental — NT 2025.002 Reforma Tributária

Valores possíveis:

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