TF Fiscal

Outros documentos fiscais

NFCom

5 endpoints

A API de NFCom (modelo 62, leiaute 1.00) permite emitir, consultar, cancelar e obter o PDF (DANFE-COM) de Notas Fiscais Fatura de Serviços de Comunicação Eletrônica. A NFCom substitui os antigos modelos 21/22 e documenta a fatura de serviços de telecomunicação — telefonia, internet, TV por assinatura, dados. A autorização é feita no ambiente nacional único (SVRS). Os dados do emitente são preenchidos automaticamente a partir do cadastro da empresa (CNPJ, IE, razão social e endereço); os campos técnicos da chave de acesso (cNF, cDV, cUF, dhEmi, mod) são calculados pelo servidor. O QR-Code de consulta (qrCodNFCom) também é gerado automaticamente.

EndpointMétodoDescrição
/api/nfcom/createPOSTEmitir NFCom
/api/nfcom/consultPOSTConsultar situação da NFCom
/api/nfcom/cancelPOSTCancelar NFCom autorizada
/api/nfcom/pdfPOSTObter o DANFE-COM (PDF) da NFCom
/api/nfcom/get_listGETListar NFCom (paginado)
Credenciamento obrigatório: a emissão de NFCom exige que o CNPJ emissor esteja credenciado para o modelo 62 junto ao Fisco da sua UF (habilitação restrita a prestadores de serviços de telecomunicação). Sem o credenciamento, o Fisco rejeita a emissão com cStat=203 ("Emissor não habilitado para emissão da NFCom"). O credenciamento em homologação e em produção são etapas separadas.
POST/api/nfcom/create

Emitir NFCom

Emite uma NFCom a partir do corpo enviado. O cliente envia apenas os dados de negócio — o bloco do emitente (emit) é montado automaticamente a partir do cadastro da empresa do token, e os campos técnicos da chave de acesso são calculados pelo servidor. O débito de crédito ocorre somente em produção (tpAmb=1) e quando a NFCom é autorizada. Após a autorização, o XML (nfcomProc) e o DANFE-COM (PDF) são gerados e disponibilizados por URL.

Headers obrigatórios

HeaderTipoDescrição
tokenstringToken da empresa emissora
signstringAssinatura MD5: MD5(token + path + body + timestamp)
timestampstringUnix timestamp em segundos (janela de 5 minutos)

Body — raiz

CampoTipoDescrição
ideobjectIdentificação da NFCom (ambiente, série, competência do fato gerador)
dest *objectDados do destinatário/tomador
assinante *objectDados do assinante do serviço (obrigatório no leiaute da NFCom)
det *arrayItens faturados — mínimo 1
totalobjectTotalizador. Opcional — calculado a partir dos itens quando omitido
gFatobjectDados da fatura (competência, vencimento, código de barras)
infAdFiscostringInformações de interesse do Fisco
infCplarrayInformações complementares (lista de textos)
autXMLarrayCNPJs/CPFs autorizados a acessar o XML (lista de strings)
Campos obrigatórios na requisição: dest com xNome, um de CNPJ/CPF/idOutros e enderDest (xLgr, nro, xBairro, cMun, xMun, CEP com 8 dígitos, UF); assinante.iCodAssinante; e pelo menos 1 item em det com xProd, cClass (7 dígitos da tabela de classificação de itens da NFCom), vItem e vProd. Todos os demais campos são opcionais.

ide — Identificação

CampoTipoDescrição
tpAmbintAmbiente: 1=produção, 2=homologação. Default: 2
nNFlongNúmero sequencial da NFCom. Opcional — auto-incrementado pelo servidor quando omitido ou 0
dhEmistringData/hora de emissão. Opcional — gerada pelo servidor quando omitida
cMunFGlongCódigo IBGE do município do fato gerador (7 dígitos). Opcional — default: município do cadastro da empresa
finNFComintFinalidade: 0=Normal, 3=Substituição, 4=Ajuste. Default: 0
tpFatintTipo de faturamento: 0=Normal, 1=Centralizado, 2=Cofaturamento. Default: 0
nSiteAutorizintSite autorizador (1 dígito da chave). Default: 0
indPrePagostringIndicador de serviço pré-pago: "1" quando aplicável

Preenchidos automaticamente pelo servidor — não é necessário enviá-los: mod (fixo em 62), serie (série de NFCom cadastrada na empresa; configure em /api/company/edit via serie_nfcom), cUF (derivado do cadastro da empresa), cNF (código numérico de 7 dígitos), cDV (dígito verificador da chave), tpEmis (normal) e verProc. O bloco emit completo e o infNFComSupl (QR-Code) também são montados pelo servidor.

dest — Destinatário / Tomador

CampoTipoDescrição
xNome *stringNome ou razão social do destinatário
CNPJ ⚠stringCNPJ do destinatário (14 dígitos)
CPF ⚠stringCPF do destinatário (11 dígitos)
idOutros ⚠stringOutro documento de identificação (estrangeiro etc.)
indIEDestintIndicador de IE: 1=contribuinte, 2=isento, 9=não contribuinte. Default: 9
IEstringInscrição Estadual do destinatário (quando contribuinte)
enderDest *objectEndereço do destinatário (ver estrutura abaixo)

enderDest — Endereço

CampoTipoDescrição
xLgr *stringLogradouro
nro *stringNúmero
xCplstringComplemento
xBairro *stringBairro
cMun *longCódigo IBGE do município (7 dígitos)
xMun *stringNome do município
CEP *stringCEP (8 dígitos)
UF *stringSigla da UF (2 letras)
fonestringTelefone
emailstringE-mail

assinante — Assinante do serviço

CampoTipoDescrição
iCodAssinante *stringCódigo único de identificação do assinante (1–30 caracteres)
tpAssinanteintTipo de assinante: 1=Comercial, 2=Industrial, 3=Residencial, 4=Produtor rural, 5=Órgão público, 6=Prestador de serviço de telecom, 7=Missões diplomáticas, 8=Igrejas e templos, 99=Outros. Default: 1
tpServUtilintTipo de serviço utilizado: 1=Telefonia, 2=Comunicação de dados, 3=TV por assinatura, 4=Acesso à Internet, 5=Multimídia, 6=Outros, 7=Vários. Default: 1
nContratostringNúmero do contrato do assinante

det[] — Itens faturados

CampoTipoDescrição
cProdstringCódigo do item. Opcional — default: número sequencial
xProd *stringDescrição do serviço/item faturado
cClass *stringCódigo de classificação do item (7 dígitos — tabela de classificação de itens da NFCom)
CFOPstringCFOP da prestação (obrigatório quando o item tem ICMS)
uMedstringUnidade de medida: 1=Minuto, 2=MB, 3=GB, 4=UN. Default: 4
qFaturadastringQuantidade faturada. Default: "1"
vItem *stringValor unitário do item
vProd *stringValor total do item
vDescstringValor do desconto
infAdProdstringInformações adicionais do item
icmsobjectTributação de ICMS do item (ver abaixo)
pisobjectPIS do item (ver abaixo)
cofinsobjectCOFINS do item (mesma estrutura do PIS)
ibscbsobjectIBS/CBS — Reforma Tributária (ver abaixo)

det[].icms — ICMS do item

CampoTipoDescrição
cststringCST do ICMS. Default: "00" (tributação integral)
vBCstringBase de cálculo do ICMS
pICMSstringAlíquota do ICMS (%)
vICMSstringValor do ICMS
simplesNacionalbooltrue = emitente do Simples Nacional (grupo ICMSSN)
semCSTbooltrue = item sem relação com o ICMS (indSemCST; não informe CFOP nesse caso)

det[].pis / det[].cofins

CampoTipoDescrição
cststringCST do PIS/COFINS (01, 02, 06, 07, 08, 09, 49). Default: "01"
vBCstringBase de cálculo
pAliqstringAlíquota (%)
valorstringValor do tributo

det[].ibscbs — IBS/CBS (Reforma Tributária)

CampoTipoDescrição
cststringCST do IBS/CBS (3 dígitos)
cClassTribstringCódigo de classificação tributária
vBCstringBase de cálculo
pIBSUF / vIBSUFstringAlíquota e valor do IBS estadual
pIBSMun / vIBSMunstringAlíquota e valor do IBS municipal
vIBSstringValor total do IBS
pCBS / vCBSstringAlíquota e valor da CBS

total — Totalizador (opcional)

CampoTipoDescrição
vProdstringSomatório dos itens. Calculado quando omitido
vBCstringBase de cálculo total do ICMS
vICMSstringValor total do ICMS
vDescstringTotal de descontos
vNFstringValor total da NFCom. Default: igual a vProd

gFat — Dados da fatura

CampoTipoDescrição
CompetFatstringCompetência da fatura no formato AAAAMM
dVencFatstringData de vencimento no formato AAAA-MM-DD
codBarrasstringCódigo de barras da fatura (somente dígitos, 1–48)

* Campo obrigatório. ⚠ No destinatário, pelo menos um de CNPJ, CPF ou idOutros é obrigatório. Valores monetários e alíquotas são enviados como string com ponto decimal (ex.: "99.90").

POST/api/nfcom/consult

Consultar situação da NFCom

Consulta a situação atual da NFCom no ambiente nacional (SVRS) a partir da chave de acesso.

Headers obrigatórios

HeaderTipoDescrição
tokenstringToken da empresa emissora
signstringAssinatura MD5
timestampstringUnix timestamp em segundos

Body

CampoTipoDescrição
chNFCom *stringChave de acesso da NFCom (44 dígitos)

* Campo obrigatório.

POST/api/nfcom/cancel

Cancelar NFCom

Cancela uma NFCom autorizada (evento 110111). Requer que a NFCom tenha sido autorizada (possua protocolo) e ainda não esteja cancelada.

Headers obrigatórios

HeaderTipoDescrição
tokenstringToken da empresa emissora
signstringAssinatura MD5
timestampstringUnix timestamp em segundos

Body

CampoTipoDescrição
chNFCom *stringChave de acesso da NFCom (44 dígitos)
xJust *stringJustificativa do cancelamento (mínimo 15 caracteres por exigência Fisco)
nProt *stringProtocolo de autorização da NFCom (16 dígitos)

* Campo obrigatório.

POST/api/nfcom/pdf

Obter PDF da NFCom

Retorna a URL do DANFE-COM — a representação em PDF da NFCom (conta do assinante), conforme o MOC Anexo II. O PDF é gerado automaticamente na autorização; quando ainda não existe no armazenamento, é gerado sob demanda a partir do XML.

Headers obrigatórios

HeaderTipoDescrição
tokenstringToken da empresa emissora
signstringAssinatura MD5
timestampstringUnix timestamp em segundos

Body

CampoTipoDescrição
chNFCom *stringChave de acesso da NFCom (44 dígitos)

* Campo obrigatório.

GET/api/nfcom/get_list

Listar NFCom (com paginação)

Lista as NFCom da empresa com paginação. Parâmetros passados via query string (não no body).

Headers obrigatórios

HeaderTipoDescrição
tokenstringToken da empresa emissora
signstringAssinatura MD5 (path inclui a query string)
timestampstringUnix timestamp em segundos

Query string

ParâmetroTipoDescrição
page *intNúmero da página (≥ 1)
page_size *intTamanho da página (1–50)

* Campo obrigatório.