TF Fiscal

核心接口

公司管理

7 个接口

POST/api/company/create

注册新的开票公司

在分销商(b2b)账户下注册开票公司。当公司数据已有时使用此端点。要从数字证书自动提取数据,请使用 /api/company/v2/create。

必需请求头

请求头类型说明
tokenstring分销商令牌(b2b — 账户必须具有 isb2b=true)
signstringMD5 签名
timestampstring秒级 Unix 时间戳

Body

字段类型说明
标识
cnpj *string开票公司 CNPJ
name *string公司名称
ie *string州注册号(Inscrição Estadual)
invoice_type *string税务制度(例如:"simples_nacional"、"normal")
unit *string单位类型
emailstring公司电子邮件
地址
cep *string邮政编码
address *string街道地址
house_number *string地址门牌号
town *string街区
city *string城市
state *stringUF(州缩写)
数字证书
cert_content *stringA1 数字证书文件内容(.pfx/.p12 的 Base64)
cert_filestring已废弃,2026-09-01 起拒绝。证书 HTTPS URL
cert_pwd *string证书密码
编号和设置
serie *intNF-e 系列
number *int编号的初始值
运输 (MDF-e / CT-e / DC-e)
serie_mdfeintMDF-e 系列
number_mdfeintMDF-e 起始编号(编号从此处开始)
serie_cteintCT-e 系列
number_cteintCT-e 起始编号(编号从此处开始)
serie_dceintDC-e 系列
number_dceintDC-e 起始编号(编号从此处开始)
通信 (NFCom)
serie_nfcomintNFCom 系列
number_nfcomintNFCom 起始编号(编号从此处开始)
能源 (NF3e)
serie_nf3eintNF3e 系列
number_nf3eintNF3e 起始编号(编号从此处开始)
is_create_category_templateboolean自动创建默认税务类别。默认值:true

* 必填字段。

POST/api/company/v2/create

凭证书注册公司

/api/company/create 的简化版本:API 验证数字证书并通过内部查询自动提取公司名称、IE、地址等数据。只有 cnpj、cert_content 和 cert_pwd 是必填的。

必需请求头

请求头类型说明
tokenstring分销商令牌(b2b — 账户必须具有 isb2b=true)
signstringMD5 签名
timestampstring秒级 Unix 时间戳

Body

字段类型说明
cnpj *string开票公司 CNPJ
cert_content *stringA1 数字证书文件内容(.pfx/.p12 的 Base64)
cert_filestring已废弃,2026-09-01 起拒绝。证书 HTTPS URL
cert_pwd *string证书密码
is_create_category_templateboolean自动创建默认税务类别。默认值:true

* 必填字段。

POST/api/company/edit

编辑公司数据

更新开票公司数据。只发送要更改的字段 — 除 company_id 外,所有字段都是可选的。CNPJ 不可修改:发送会返回错误。更新 cep 时,系统自动解析 stateCode 和 ibge。当 cert_content 和 cert_pwd 一起发送时,证书在保存前会经过验证。

公司是以 NF-e 配置创建的(通过 /api/company/create)。要启用其他单证,请在此处完善登记:本接口还接受 NFC-e、NFS-e、MDF-e、CT-e 和 DC-e 字段(见下方各节)。只需发送公司将要开具的单证所对应的字段。

必需请求头

请求头类型说明
tokenstring公司令牌
signstringMD5 签名
timestampstring秒级 Unix 时间戳

Body

字段类型说明
company_id *string要编辑的公司 ID
namestring公司名称
invoice_typestring税务制度
iestring州注册号
unitstring单位类型
emailstring电子邮件
cepstring邮政编码(自动更新 stateCode 和 ibge)
addressstring街道地址
house_numberstring门牌号
townstring街区
citystring城市
statestringUF
cert_contentstringA1 数字证书文件内容(.pfx/.p12 的 Base64)
cert_filestring已废弃,2026-09-01 起拒绝。证书 HTTPS URL
cert_pwdstring新证书密码
serieint新 NF-e 系列
numberint新初始编号
aliasstring商号
telefonestring电话
complementostring地址补充
NFC-e
csc_idstring税务局的 CSC(纳税人安全代码)ID
cscstringCSC 令牌(与税务局共享的密钥)
serie_nfceintNFC-e 系列
number_nfceintNFC-e 下一个编号
NFS-e
imstring市政登记号(Inscrição Municipal)
codigo_municipio_nfsestring开具市政的 IBGE 代码
codigo_servico_nfsestring默认服务代码(LC 116)
cnae_nfsestring默认活动 CNAE
serie_nfseintNFS-e 系列
number_nfseintNFS-e 下一个编号
regime_especial_tributacaoint特殊税制代码
optante_simples_nacionalbool是否加入 Simples Nacional
运输 (MDF-e / CT-e / DC-e)
serie_mdfeintMDF-e 系列
number_mdfeintMDF-e 起始编号(编号从此处开始)
serie_cteintCT-e 系列
number_cteintCT-e 起始编号(编号从此处开始)
serie_dceintDC-e 系列
number_dceintDC-e 起始编号(编号从此处开始)
通信 (NFCom)
serie_nfcomintNFCom 系列
number_nfcomintNFCom 起始编号(编号从此处开始)
能源 (NF3e)
serie_nf3eintNF3e 系列
number_nf3eintNF3e 起始编号(编号从此处开始)

* 必填字段。发送 cnpj 会返回错误。其他所有字段均为可选 — 只需发送您想要更改的字段。

GET/api/company/get_list

获取公司列表

分页列出分销商(b2b)账户下的开票公司。参数通过 查询字符串 传递。

必需请求头

请求头类型说明
tokenstring分销商令牌(b2b — 账户必须具有 isb2b=true)
signstringMD5 签名(path 包含查询字符串)
timestampstring秒级 Unix 时间戳

查询字符串

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

* 必填字段。

GET/api/company/get_detail

获取公司详情

返回由 token 请求头标识的公司的完整数据,包括已注册的税务类别列表。不接受 body 或查询字符串。

必需请求头

请求头类型说明
tokenstring公司令牌
signstringMD5 签名
timestampstring秒级 Unix 时间戳
GET/api/company/get_cep_detail

通过 CEP 查询地址

解析巴西 CEP(邮政编码),返回 UF、IBGE 自治市代码和地址数据。用于填写公司和客户地址。需要分销商(b2b)账户。

必需请求头

请求头类型说明
tokenstring分销商令牌(b2b — 账户必须具有 isb2b=true)
signstringMD5 签名(path 包含查询字符串)
timestampstring秒级 Unix 时间戳

查询字符串

参数类型说明
cep *string巴西 CEP(8 位,可带或不带连字符)

* 必填字段。

GET/api/company/get_export_invoice_month_files

月度导出文件列表

返回当前年度(时区 America/Sao_Paulo)该公司已生成的每月导出文件列表。每个月最多可以有 4 个文件:1 个 Excel 电子表格(仅 Success 状态)+ 3 个 XML(按 Success、Canceled、Voided 状态各一个)。仅显示实际已导出的文件 — 使用 /api/invoice/get_xml 生成新文件。

必需请求头

请求头类型说明
tokenstring公司令牌
signstringMD5 签名
timestampstring秒级 Unix 时间戳

响应

字段类型说明
files[]array可用文件列表
files[].urlstringOSS 上的文件 URL
files[].yearint期间年份
files[].monthstring月份(1–12)
files[].typestring文件类型:"xlsx" 或 "xml"
files[].statusstring文件中发票的状态:"Success"、"Canceled" 或 "Voided"
files[].createdatetime文件生成时间