核心接口
CFOP 操作代码
2 个接口
POST
/api/cfop/get查询 CFOP
按代码返回 NF-e 门户发布的官方 CFOP 表(技术公告 Informe Técnico 2023.002)中的一条记录,包含全部列:税务局的标题与说明性注释、有效期、表中的九个指示符,以及类型(入库或出库)、范围和分组。该表由平台维护:税务局发布新版本时,平台同步更新,集成方无需改动;versao 字段标明当前生效版本。参数通过 JSON 请求体传递。已废止的代码仍可查询,ativo = false。本接口免费。
必需请求头
| 请求头 | 类型 | 说明 |
|---|---|---|
| token | string | 开票公司令牌 |
| sign | string | MD5 签名 |
| timestamp | string | 秒级 Unix 时间戳 |
Body
| 字段 | 类型 | 说明 |
|---|---|---|
| cfop * | string | 4 位代码,可带点也可不带("5101" 或 "5.101") |
* 必填字段。
响应字段
| 字段 | 类型 | 说明 |
|---|---|---|
| cfop | string | 4 位代码,不含点 |
| descricao | string | 官方表的“Título do CFOP”(葡语标题) |
| nota_explicativa | string | 官方表的“Descrição (nota explicativa)”:说明哪些操作归入该代码(葡语) |
| serie | int | 首位数字:1、2、3(入库)或 5、6、7(出库) |
| tipo | string | entrada(入库)或 saida(出库) |
| abrangencia | string | intraestadual(州内,序列 1 和 5)、interestadual(州际,2 和 6)或 exterior(国外,3 和 7) |
| grupo | string | 官方表分组(5.100、5.200、5.400…) |
| grupo_descricao | string | 分组的官方标题(葡语) |
| vigencia_inicio | string | 生效起始日期(yyyy-mm-dd) |
| vigencia_fim | string | 失效日期(yyyy-mm-dd);为空表示暂无失效日期 |
| ind_nfe | int | 1 = 允许在 NF-e(模型 55)中使用 |
| ind_comunica | int | 1 = 通信服务 |
| ind_transp | int | 1 = 运输服务 |
| ind_devol | int | 1 = 退货(devolução) |
| ind_retor | int | 1 = 此前发出货物的退回(retorno) |
| ind_anula | int | 1 = 金额冲销(anulação) |
| ind_remes | int | 1 = 发货(remessa) |
| ind_comb | int | 官方表的燃料/润滑油指示符(0 = 否;1 和 2 按技术公告定义) |
| ind_exc_ibscbs | int | 官方表的 IBS/CBS 指示符(0 或 1),按原样透传 |
| ativo | bool | false = 已废止的代码(已到失效日期或已从表中移除),保留以支持历史单据 |
| versao | string | 当前生效的表版本(技术公告版本号) |
| fonte | string | 官方来源名称 |
POST
/api/cfop/listCFOP 列表
返回官方 CFOP 表,可按序列(首位数字)、类型和范围过滤,过滤条件通过 JSON 请求体传递。所有条件均可选、可组合;请求体为空({})时返回整张表(约 620 条,含全部列),适合填充下拉框或本地缓存,并在 versao 变化时刷新。条目始终按 CFOP 升序排列。序列本身已决定类型和范围(序列 5 一定是州内出库),因此三个条件存在重叠;互相矛盾的组合返回空列表。默认只返回有效代码。本接口免费。
必需请求头
| 请求头 | 类型 | 说明 |
|---|---|---|
| token | string | 开票公司令牌 |
| sign | string | MD5 签名 |
| timestamp | string | 秒级 Unix 时间戳 |
Body
| 字段 | 类型 | 说明 |
|---|---|---|
| serie | string | 首位数字:"1"、"2"、"3"、"5"、"6" 或 "7" |
| tipo | string | "entrada"(入库)或 "saida"(出库) |
| abrangencia | string | "intraestadual"、"interestadual" 或 "exterior" |
| incluir_inativos | string | 传 "1" 时同时返回已废止的代码(ativo = false) |
所有字段均为可选。不传任何字段时,请发送 {}。
每个 item 的字段与 /api/cfop/get 相同,含完整的说明性注释,始终按 CFOP 升序排列。versao 与 fonte 标识当前生效的表版本;total 为返回的条数。