1、 通信约定
- 1.所有的调用都采用POST方式。
- 2.除了获取token接口外,都需要参数token(小写)
- 3.路径中不含127.0.0.1的参数路径前加前缀http://invoice.xinshui.com.cn,不是以JSON进行传送,表单方式提交值: 参数1=值1&参数2=值…… 方式传送,含有127.0.01的,都是以JSON进行传送。
- 4.Content-Type:application/x-www-form-urlencoded;charset=UTF-8。
- 5.返回值是以JSON形式返回,返回值中都有Result和Message节点,Result=1时,表示调用成功,0表示失败,Message,为调用信息。
- 6.参数都是用小写,如果文档自动转换成大写,请忽略大写。
- 7.需要进行base64加密的报文,比如:FPKJ中的data参数,JSON节点都用大写。
- 8.参数字段说明中,如果没有 “是否必需” 这一列,说明是必需要有的。
- 9.POSTMAN的具体调用如下:


- 所有用到Base64的地方,都采用utf-8字符集加密。
- token是需要放在head头部。
2、获取token
说明:
获取平台token,有效期为一年,每次新的登陆会停止原有的token,在调用业务api时,如果返回中有Code字段(c是大写),并且Code值在2001-2009范围 ,那么需要重新获取一次token。
路径:
/NEWKP/LOGIN/GetToken
参数:
UserName=[用户名]&Password1=[密码]
请求示例:
UserName=FANSHI&Password1=Aa123456
返回值:
{
"Result": "1",
"Message": "系统登陆成功。",
"ID": "[mOqngQUp9/IS5qvk5VuiUZoViBuHCN787eXqq0HcopVCdw43ZKyS8uz10lRwlsu7STs4ckgbKvaqZfvi5IRdYT5MvswRBUuWhijy0MtCyDZ/GLsg0wTSh//Jh Kt/6w9/n7FKCmhTFt1FRff4ESG8BgdEYVxGq/hg3P ssuWoIE=~1064deb4d310430490cfa8237e4d5d84~190ACA1704AF55AA9FE1E8DE908C11044820A1B6C0E56F1E]"
}
返回值说明:
1、获取到的ID,用于以下接口的header头的token参数。
2、获取到的ID,前后是有[]括起来的,请不要去掉中括号。
3、所有接口头部都需要加上token,如下图:

3、 报关单查询
/NEWKP/CKFP/BGDCX
说明:报关单查询
字段说明:
| 字段 | 是否必填项 | 字符类型 | 字符长度 | 描述 |
|---|---|---|---|---|
| qsrq | 开始日期 | |||
| jzrq | 截止日期 | |||
| gjz | 关键字(报关单、出境收货人)可不传 | |||
| spid | 终端ID | |||
| pagesize | 列数 | |||
| pageindex | 页数 | |||
| mxbz | 传1返回报关单产品明细 | |||
| token | token |
返回参数:
| 字段 | 字符类型 | 描述 |
| qysh | 销方税号 | |
| spid | 终端ID | |
| trafmode | 运输方式 | |
| wraptype | 包装种类 | |
| tradename | 销方名称 | |
| netwt | 净重(千克) | |
| entryid | 海关编号 | |
| billno | 提运单号 | |
| trademode | 监管方式 | |
| notes | 标记唛码及备注 | |
| ownercode | 境内货源地代码 | |
| voyageno | 航次号 | |
| ownername | 生产销售单位 | |
| transmode | 成交方式 | |
| declport | 出境关别 | |
| destinateport | 指运港 | |
| contrno | 合同协议号 | |
| trafname | 运输工具名称 | |
| grosswt | 毛重 | |
| ddate | 申报日期 | |
| iedate | 出口日期 | |
| tradecountry | 贸易国(地区) | |
| cusdecstatusname | 结关状态 | |
| ciqdecstatusname | 申报状态 | |
| consigneeename | 境外收发货人 | |
| custommastername | 离境口岸 | |
| destinationcountryname | 运抵国(地区) | |
| atttypecodename | 随附单证及编号 | |
| ieportname | 离境口岸 | |
| despportcode | 离境口岸代码 | |
| decltotal | 原币总价 | |
| tradecurr | 币种 | |
| tradecurrcode | 币制代码 | |
| fpmx | 明细 | |
| mxxh | 明细序号 | |
| gmodel | 规格型号 | |
| origincountry | 原产国(地区) | |
| gqty | 法定单位数量 | |
| gname | 商品名称 | |
| declprice | 单价 | |
| codet | 商品编号 | |
| qty1 | 第一单位数量 | |
| qty2 | 第二单位数量 | |
| unit1 | 第一单位 | |
| gunit | 法定单位 | |
| tradecurr | 币种 | |
| decltotal | 金额 | |
| rbmtotal | 人民币总价 | |
| unit2name | 第二单位 | |
| destinationcountryname | 最终目的国(地区) | |
| ciqcurr | 币种代码 | |
| cusorigincountry | 原产国(地区)代码 | |
| destinationcountry | 最终目的国(地区)代码 | |
| districtcodename | 境内货源地 | |
| districtcode | 境内货源地代码 | |
| dutymodename | 征免 |
请求体Body(完整的传入参数):
qsrq=2024-06-25&jzrq=2024-09-25&spid=6867a6cd047142c78bb6b098df4d12345&mxbz=1&token=[]
响应示例
{
"Result": "1",
"Message": "成功",
"total": 1,
"rows": [
{
"qysh": "91511529MA6774UG57",
"spid": "6867a6cd047142c78bb6b098df4d4733",
"trafmode": "水路运输",
"wraptype": "包/袋",
"seqno": "",
"tradename": "宜宾天之华纺织科技有限公司",
"otherrate": "0",
"insurrate": "21.57",
"insurcurr": "USD",
"insurmark": "3",
"netwt": "21500",
"entryid": "721720240174027401",
"billno": "A90EX01933",
"trademode": "一般贸易",
"notes": "",
"ownercode": "5114965423",
"voyageno": "W037",
"ownername": "宜宾天之华纺织科技有限公司",
"status": "",
"ieport": "7217",
"agentcode": "450968020A",
"transmode": "CIF",
"declport": "钦州港关",
"tradeco": "5114965423",
"contaid": "",
"destinateport": "金奈(印度)",
"packno": "860",
"edinote": "",
"contrno": "TZH20240528-267",
"trafname": "UN9871476",
"grosswt": "21672",
"rtxtype": "",
"ddate": "2024-06-13",
"aflag": "",
"feerate": "2800",
"feecurr": "USD",
"feemark": "3",
"iedate": "2024-06-19",
"districtcode": "",
"modnum": "",
"agentname": "广西钦州保税港区荣泰物流有限公司",
"preentryid": "E20240001280029407",
"tradecountry": "印度",
"cusdecstatusname": "结关",
"ciqdecstatusname": "已申报",
"tbsj": "2024-09-14 16:23:14",
"consigneeename": "SJV TEXTILE MILLS",
"custommastername": "钦州港关",
"ownerscc": "91511529MA6774UG57",
"cnsntradescc": "91511529MA6774UG57",
"ownerciqcode": "5100310033",
"custmregno": "5100310033",
"agentscc": "91450001MA5NF92C4M",
"declregno": "4500510054",
"cutmodename": "一般征税",
"destinationcountryname": "印度",
"contacount": "2",
"despportcodename": "钦州",
"entrytypename": "通关无纸化",
"markno": "N/M",
"consignorcode": "5100310033",
"dclrno": "72103982",
"declarename": "",
"dclrcntway": "",
"atttypecodename": "随附单证2:代理报关委托协议(电子)",
"ieportname": "钦州港关",
"custrafmode": "2",
"trademodecode": "0110",
"cutmode": "101",
"custradenationcode": "IND",
"custradecountry": "IND",
"arrivportcode": "IND084",
"despportcode": "450702",
"wraptypecode": "06",
"transmodecode": "1",
"decltotal": "49020",
"tradecurr": "美元",
"tradecurrcode": "USD",
"manualno": "",
"fpdm": "",
"fphm": "",
"kpbz": "待开票",
"hl": "7.1086",
"rmbtotal": "328406.16",
"fpbz": "",
"fpmx": [
{
"mxxh": "1",
"gno": "1",
"gmodel": "0|0|种类:单纱|非零售|成分含量:100%粘胶|纱线细度:148DTEX|股线注明股数:普梳、单纱、单股",
"origincountry": "中国",
"gqty": "21500",
"gname": "粘胶纱",
"declprice": "2.28",
"codet": "5510110000",
"qty1": "21500",
"codes": "",
"rmbprice": "0",
"qty2": "0",
"usdprice": "0",
"unit1": "千克",
"gunit": "千克",
"tradecurr": "美元",
"decltotal": "49020",
"rbmtotal": 348463.57,
"unit2name": "",
"destinationcountryname": "印度",
"ciqcurr": "USD",
"cusorigincountry": "CHN",
"destinationcountry": "IND",
"districtcodename": "宜宾",
"districtcode": "51149",
"dutymodename": "照章征税",
"dutymode": "1"
}
]
}
]
}
