TF Fiscal

其他电子凭证

NFCom 通信发票

5 个接口

NFCom API(型号 62,布局 1.00)支持开具、查询、取消电子通信服务发票(NFCom)并获取其 PDF(DANFE-COM)。NFCom 取代了旧的 21/22 型号,用于记录电信服务账单——电话、互联网、付费电视、数据。授权在全国统一环境(SVRS)完成。开具方数据会自动填充,来自公司档案(CNPJ、IE、公司名称和地址);访问密钥的技术字段(cNF、cDV、cUF、dhEmi、mod)由服务器计算。查询二维码(qrCodNFCom)也会自动生成。

端点方法说明
/api/nfcom/createPOST开具 NFCom
/api/nfcom/consultPOST查询 NFCom 状态
/api/nfcom/cancelPOST取消已授权的 NFCom
/api/nfcom/pdfPOST获取 NFCom 的 DANFE-COM(PDF)
/api/nfcom/get_listGET列出 NFCom(分页)
必须事先完成准入登记(credenciamento):开具 NFCom 要求开具方 CNPJ 已在其所在 UF 的税务局完成型号 62 的准入登记(该资质仅限电信服务提供商)。未完成准入登记时,税务局会以 cStat=203("Emissor não habilitado para emissão da NFCom")拒绝开具。测试环境与生产环境的准入登记是相互独立的步骤。
POST/api/nfcom/create

开具 NFCom

根据发送的请求体开具一张 NFCom。客户端只发送业务数据——开具方块(emit)会根据 token 对应公司的档案自动组装,访问密钥的技术字段由服务器计算。仅在生产环境(tpAmb=1)且 NFCom 被授权时才扣除额度。授权后,XML(nfcomProc)和 DANFE-COM(PDF)会生成并通过 URL 提供。

必需请求头

请求头类型说明
tokenstring开票公司的 Token
signstringMD5 签名:MD5(token + path + body + timestamp)
timestampstringUnix 时间戳(秒,5 分钟窗口)

Body — 根

字段类型说明
ideobjectNFCom 的标识(环境、系列号、应税事实所属期)
dest *object接收方/承接方数据
assinante *object服务订户数据(NFCom 布局中必填)
det *array计费项目——至少 1 项
totalobject合计块。可选——省略时根据项目计算
gFatobject账单数据(所属期、到期日、条形码)
infAdFiscostring税务机关关注的信息
infCplarray补充信息(文本列表)
autXMLarray被授权访问 XML 的 CNPJ/CPF(字符串列表)
请求中的必填字段: dest 含 xNome、CNPJ/CPF/idOutros 之一以及 enderDest(xLgr、nro、xBairro、cMun、xMun、CEP 为 8 位、UF);assinante.iCodAssinante;以及 det 中至少 1 项,含 xProd、cClass(NFCom 项目分类表的 7 位代码)、vItem 和 vProd。其余所有字段均为可选。

ide — 标识

字段类型说明
tpAmbint环境:1=生产,2=测试。默认:2
nNFlongNFCom 的顺序编号。可选——省略或为 0 时由服务器自动递增
dhEmistring开具日期/时间。可选——省略时由服务器生成
cMunFGlong应税事实发生地自治市的 IBGE 代码(7 位)。可选——默认:公司档案中的自治市
finNFComint用途:0=正常,3=替代,4=调整。默认:0
tpFatint计费类型:0=正常,1=集中,2=联合计费。默认:0
nSiteAutorizint授权站点(访问密钥的 1 位)。默认:0
indPrePagostring预付费服务指示符:适用时为 "1"

由服务器自动填充——无须发送: mod(固定为 62)、serie(公司中登记的 NFCom 系列;通过 /api/company/edit 的 serie_nfcom 配置)、cUF(从公司档案推导)、cNF(7 位数字代码)、cDV(访问密钥校验位)、tpEmis(正常)和 verProc。完整的 emit 块和 infNFComSupl(二维码)也由服务器组装。

dest — 接收方 / 承接方

字段类型说明
xNome *string接收方的姓名或公司名称
CNPJ ⚠string接收方 CNPJ(14 位)
CPF ⚠string接收方 CPF(11 位)
idOutros ⚠string其他身份证件(外国人等)
indIEDestintIE 指示符:1=纳税人,2=免税,9=非纳税人。默认:9
IEstring接收方的州登记号(为纳税人时)
enderDest *object接收方地址(见下方结构)

enderDest — 地址

字段类型说明
xLgr *string街道
nro *string门牌号
xCplstring补充信息
xBairro *string街区
cMun *long自治市 IBGE 代码(7 位)
xMun *string自治市名称
CEP *string邮政编码(8 位)
UF *stringUF 简称(2 个字母)
fonestring电话
emailstring电子邮箱

assinante — 服务订户

字段类型说明
iCodAssinante *string订户唯一识别代码(1–30 个字符)
tpAssinanteint订户类型:1=商业,2=工业,3=住宅,4=农业生产者,5=公共机构,6=电信服务提供商,7=外交使团,8=教堂与寺庙,99=其他。默认:1
tpServUtilint所用服务类型:1=电话,2=数据通信,3=付费电视,4=互联网接入,5=多媒体,6=其他,7=多种。默认:1
nContratostring订户合同编号

det[] — 计费项目

字段类型说明
cProdstring项目代码。可选——默认:顺序编号
xProd *string所计费服务/项目的描述
cClass *string项目分类代码(7 位——NFCom 项目分类表)
CFOPstring服务的 CFOP(项目含 ICMS 时必填)
uMedstring计量单位:1=分钟,2=MB,3=GB,4=UN。默认:4
qFaturadastring计费数量。默认:"1"
vItem *string项目单价
vProd *string项目总金额
vDescstring折扣金额
infAdProdstring项目附加信息
icmsobject项目的 ICMS 税务处理(见下方)
pisobject项目的 PIS(见下方)
cofinsobject项目的 COFINS(结构与 PIS 相同)
ibscbsobjectIBS/CBS——税制改革(见下方)

det[].icms — 项目的 ICMS

字段类型说明
cststringICMS 的 CST。默认:"00"(全额征税)
vBCstringICMS 计税基数
pICMSstringICMS 税率(%)
vICMSstringICMS 金额
simplesNacionalbooltrue = 开具方为简易税制(Simples Nacional)(ICMSSN 组)
semCSTbooltrue = 项目与 ICMS 无关(indSemCST;此时请勿填写 CFOP)

det[].pis / det[].cofins

字段类型说明
cststringPIS/COFINS 的 CST(01、02、06、07、08、09、49)。默认:"01"
vBCstring计税基数
pAliqstring税率(%)
valorstring税额

det[].ibscbs — IBS/CBS(税制改革)

字段类型说明
cststringIBS/CBS 的 CST(3 位)
cClassTribstring税务分类代码
vBCstring计税基数
pIBSUF / vIBSUFstring州 IBS 的税率和金额
pIBSMun / vIBSMunstring市 IBS 的税率和金额
vIBSstringIBS 总额
pCBS / vCBSstringCBS 的税率和金额

total — 合计(可选)

字段类型说明
vProdstring各项目之和。省略时自动计算
vBCstringICMS 计税基数合计
vICMSstringICMS 总额
vDescstring折扣合计
vNFstringNFCom 总额。默认:与 vProd 相同

gFat — 账单数据

字段类型说明
CompetFatstring账单所属期,格式 AAAAMM
dVencFatstring到期日,格式 AAAA-MM-DD
codBarrasstring账单条形码(仅数字,1–48 位)

* 必填字段。⚠ 接收方中,CNPJ、CPF 或 idOutros 至少须填一个。金额和税率以带小数点的字符串发送(例如:"99.90")。

POST/api/nfcom/consult

查询 NFCom 状态

根据访问密钥查询 NFCom 在全国统一环境(SVRS)中的当前状态。

必需请求头

请求头类型说明
tokenstring开票公司的 Token
signstringMD5 签名
timestampstringUnix 时间戳(秒)

Body

字段类型说明
chNFCom *stringNFCom 访问密钥(44 位)

* 必填字段。

POST/api/nfcom/cancel

取消 NFCom

取消一张已授权的 NFCom(事件 110111)。要求 NFCom 已被授权(已有协议号)且尚未取消。

必需请求头

请求头类型说明
tokenstring开票公司的 Token
signstringMD5 签名
timestampstringUnix 时间戳(秒)

Body

字段类型说明
chNFCom *stringNFCom 访问密钥(44 位)
xJust *string取消理由(按税务局要求至少 15 个字符)
nProt *stringNFCom 的授权协议号(16 位)

* 必填字段。

POST/api/nfcom/pdf

获取 NFCom PDF

返回 DANFE-COM 的 URL——NFCom 的 PDF 表现形式(订户账单),符合 MOC 附件 II。PDF 在授权时自动生成;当存储中尚不存在时,会根据 XML 按需生成。

必需请求头

请求头类型说明
tokenstring开票公司的 Token
signstringMD5 签名
timestampstringUnix 时间戳(秒)

Body

字段类型说明
chNFCom *stringNFCom 访问密钥(44 位)

* 必填字段。

GET/api/nfcom/get_list

NFCom 列表(分页)

分页列出公司的 NFCom。参数通过 查询字符串(query string)传递(不在 body 中)。

必需请求头

请求头类型说明
tokenstring开票公司的 Token
signstringMD5 签名(path 包含查询字符串)
timestampstringUnix 时间戳(秒)

查询字符串

参数类型说明
page *int页码(≥ 1)
page_size *int每页大小(1–50)

* 必填字段。