跳至主内容

prod

New

9:30-17:30

des

合规提示:

•使用数据服务的场景应当合理合规,如涉及个人隐私或商业机密,请您确保获得当事人的授权。

•在KYC场景中,推荐搭配使用身份证核验(IDV034)护照核验(PCB608)人脸比对核验(IVG000)等服务,确保实人认证授权。

•在KYB场景中,推荐搭配使用企业四要素认证(COM101)企业打款认证(COM084)法人短信认证(CLC001)等服务,确保企业认证授权。

•如需了解更多授权核验类产品请咨询您的专属客服~
  • -

    产品特点

    -

    Consulta NF-e DF API 是由巴西联邦数据处理服务(Serpro)提供的一项 RESTful API 服务,允许企业通过电子发票(NFe)访问 SPED 系统中关于 Nota Fiscal Eletrônica(电子发票)的相关信息。它支持按照发票访问、推送通知(Push)及监控事件流程,适用于高并发查询场景
  • -

    应用场景

    -

    企业税务合规​:实时验证供应商/客户发票真伪及状态。
    ​财务自动化​:集成ERP系统自动对账,匹配交易与发票数据。
    ​物流监控​:追踪发票签收状态(如manifestacaoDestinatario事件)。
    ​审计风控​:批量校验历史发票数据,识别异常交易。
  • -

    覆盖体量

    -

    ​全行业适用​:覆盖零售、制造、物流等所有需使用NFe的领域。
    ​高并发能力​:分阶段查询模式可处理海量请求(具体TPS未公开,但设计为政府级规模)。
  • -

    产品标签

    -

    电子发票查询,税务合规,政府数据服务

出入参数

羽山数据API产品详细介绍

分类 : 输入字段
名称说明
chave
秘钥
分类 : 返回字段
名称说明
nfeProc
电子发票处理数据
procEventosNFe
发票相关事件记录
versao
电子发票格式版本
protNFe
税务机关验证信息
infProt
验证信息详情
nProt
验证编号
digVal
数字签名值
dhRecbto
接收时间
Id
验证记录 ID
chNFe
发票密钥
xMotivo
处理结果说明
cStat
处理状态码
NFe
电子发票核心信息
infNFe
发票基本信息
ide
发票标识信息
cUF
州代码
cNF
发票代码
natOp
交易性质
mod
发票模式
serie
发票系列号
nNF
发票号码
dhEmi
开具时间
dhSaiEnt
发货 / 收货时间
tpNF
发票类型
idDest
目的地类型
cMunFG
税务管辖地代码
tpImp
打印类型
tpEmis
开具方式
cDV
校验位
tpAmb
环境类型
finNFe
发票用途
indFinal
最终消费者标识
indPres
购买方是否在场
procEmi
开具程序
verProc
开具程序版本
dhCont
确认时间
xJust
备注说明
indIntermed
是否有中介
NFref
关联发票信息
refNFe
关联电子发票密钥
emit
销售方信息
CNPJ
销售方企业税号
CPF
销售方个人税号
xNome
销售方全称
xFant
销售方简称 / 商号
enderEmit
销售方地址
xLgr
街道名称
nro
门牌号
xCpl
地址补充
xBairro
街区
cMun
城市代码
xMun
城市名称
UF
州缩写
CEP
邮政编码
cPais
国家代码
xPais
国家名称
fone
电话号码
IE
州内税号
IEST
州内分支机构税号
IM
市政税号
CNAE
经济活动代码
CRT
税务核算方式
avulsa
临时开票人信息
dest
购买方信息
retirada
提货信息
compra
采购信息

羽山数据API产品接入信息

报表设置

分类 : 业务异常(retcode)
名称说明
100000查无记录
分类 : 系统代码(retcode)
名称说明
000000交易成功(收费)
200000调用远程数据异常
200010账号不存在
200012未找到账号与产品的订购关系
200013该产品测试条数已用完,请联系羽山数据
200014加解密错误
err_012传入参数不正确
err_015数据源请求时出现异常

羽山数据API产品接入信息

报表设置

分类 : 1.对接信息
名称说明
IP白名单
本系统具有IP白名单限制,
需要先将自身服务器公网IP,
提供给羽山数据网络工程师配置。
协议
HTTP/HTTPS POST
编码格式
UTF8
HEAD: ACCT_ID
必填,开户后将获得接入账号APP_ID,如“test_user”
HEAD: CONTENT-TYPE
application/json
测试环境URL
http://122.152.195.249:21000/credit-gw/service
生产环境URL
https://api.yushanshuju.com/credit-gw/service
明文Request JSON样例
{  
"prod_id": "BRINV001",
"req_data": { 这里是业务入参 },
"req_time": 1545270159122,
"request_sn": "4df1e3c9583d40a9a57f63e4ab153189"
}
明文Request JSON样例说明
prod_id 为产品编号。
req_data 为业务入参,请参考下面详细信息。
req_time 为Linux 毫秒时间,可使用echo `date +%s`"000" 命令获得最新时间。
request_sn为请求单号,不可重复,需自行生成。
明文Response JSON样例
{
    "response_sn": "20190602020740639KIBG",
    "retdata": {
        "final_auth_result": "1"   },
    "version": "1.0",
    "request_sn": "4a5f3f52e5324a87b96e16c0585",
    "retmsg": "交易成功",
    "retdate": 1559412461182,
    "retcode": "000000"
}
明文Response JSON样例说明
response_sn 返回单号。 
retdata 返回业务json。
retmsg 返回描述。
retcode 系统代码。
技术支持
400-110-8298
分类 : 2.加解密方法
名称说明
私钥
登录系统或联系技术支持获得接入KEY,
加密JSON Request 和解密response密文时需要使用。
注意要严格保密使用,请勿外泄,如有遗失,自行负责!
请求报文加密算法
将request JSON明文aes-128-cbc 加密后base64编码,随后POST提交.
接收报文解密算法
将response JSON使用base64解码后,aes-128-cbc解密为明文.
分类 : 公共参数
名称说明
request_sn
请求序列号
acct_id
账号
prod_id
产品ID
req_data
传入参数
req_time
请求时间
response_sn
返回单号
retdata
返回参数
retcode
返回代码
retmsg
返回信息
retdate
返回时间戳