核注清单 (交易接口) (计划中)
创建核注清单(系统核注清单)
请求
- 接口路径：v1/voucher?filter={filter}&refNoCheck={refNoCheck}
- 请求方法：POST
- 请求头内容：
- Content-Type: application/json
- 请求Body内容
{
"requestId": "38bds",
"refNo": "客户单号",
"businessTypeId": "Z8",
"data": {
"head": {},
"goodsList": []
// 详细字段参考：核注清单数据模型
},
"auxData": {
}
}
| 属性 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| requestId | String | 非必填 | 请求ID: 确保幂等性，相同请求重发请用同一个请求ID 。空值代表不使用幂等 |
| refNo | String | 非必填 | 客户单号 |
| businessTypeId | String | 必填 | 业务类型: 看下文描述 |
| data | String | 必填 | 核注清单表单, 请查看核注清单数据模型 |
| auxData | JSON | 非必填 | 域外数据，用于高阶控制，内部使用 |
| filter | String | 非必填 | 对核注清单报文进行预处理: 具体接收的值请联系客户经理 |
| refNoCheck | Boolean | 非必填 | true=检查库内是否存在相同的客户单号，若已存在单号则拒绝创建，false=不检查（默认） |
- 业务类型：
- Z8 - 保税物流管理
- Z7 - 海关特殊监管区域
- B1 - 加工贸易手册
- 95 - 加工贸易账册
响应
-
HTTP状态: 200 代表调用成功
-
响应正文：
{
"success": true,
"message": null,
"result": "111",
"error": null
}
{
"success": false,
"message": "存在相同refNo",
"result": "12699",
"error": "DUP_REFNO"
}
| 属性 | 类型 | 说明 |
|---|---|---|
| success | Boolean | 创建是否成功 true成功 false 失败 |
| message | String | 创建失败返回错误消息 |
| result | String | 返回唯一内部编号 |
| error | String | 错误代码 |
error对应的代码:
| 编码 | 错误原因 |
|---|---|
| DUP_REFNO | 存在相同refNo |
创建核注清单(单一xml报文格式)
请求
- 接口路径：v1/voucher/sw-message?filter={filter}&refNoCheck={refNoCheck}
- 请求方法：POST
- 请求头内容：
- Content-Type: application/json
- 请求Body内容
{
"requestId": "38bds",
"refNo": "客户单号",
"businessTypeId": "Z8",
"data": "单一xml报文格式 base64编码",
"auxData": {
}
}
| 属性 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| requestId | String | 非必填 | 请求ID: 确保幂等性，相同请求重发请用同一个请求ID 。空值代表不使用幂等 |
| refNo | String | 非必填 | 客户单号 |
| businessTypeId | String | 必填 | 业务类型: 看下文描述 |
| data | String | 必填 | 单一xml报文格式 base64编码 |
| auxData | JSON | 非必填 | 域外数据，用于高阶控制，内部使用 |
| filter | String | 非必填 | 对核注清单报文进行预处理: 具体接收的值请联系客户经理 |
| refNoCheck | Boolean | 非必填 | true=检查库内是否存在相同的客户单号，若已存在单号则拒绝创建，false=不检查（默认） |
- 业务类型：
- Z8 - 保税物流管理
- Z7 - 海关特殊监管区域
- B1 - 加工贸易手册
- 95 - 加工贸易账册
响应
-
HTTP状态: 200 代表调用成功
-
响应正文：
{
"success": true,
"message": null,
"result": "111",
"error": null
}
{
"success": false,
"message": "存在相同refNo",
"result": "12699",
"error": "DUP_REFNO"
}
| 属性 | 类型 | 说明 |
|---|---|---|
| success | Boolean | 创建是否成功 true成功 false 失败 |
| message | String | 创建失败返回错误消息 |
| result | String | 返回唯一内部编号 |
| error | String | 错误代码 |
error对应的代码:
| 编码 | 错误原因 |
|---|---|
| DUP_REFNO | 存在相同refNo |
修改核注清单(系统核注清单格式)
请求
- 接口路径：v1/voucher/{id}?filter={filter}
- {id}为创建返回的核注清单内部编号
- 请求方法：PUT
- 请求头内容：
- Content-Type: application/json
- 请求Body内容
{
"refNo": "客户单号",
"data": {
"head": {},
"goodsList": []
// 详细字段参考：核注清单数据模型
}
}
| 属性 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| refNo | String | 非必填 | 客户单号 |
| data | String | 必填 | 核注清单表单, 请查看核注清单数据模型 |
| filter | String | 非必填 | 对核注清单报文进行预处理: 具体接收的值请联系客户经理 |
响应
-
HTTP状态: 200 代表调用成功
-
响应正文：
{
"success": true,
"message": null,
"result": 2,
"error": null
}
| 属性 | 类型 | 说明 |
|---|---|---|
| success | Boolean | 修改是否成功 true成功 false 失败 |
| message | String | 修改失败返回错误消息 |
| result | Integer | 修改成功返回当前核注清单的版本号 |
| error | N/A | 保留 |
修改核注清单 (单一报文格式)
请求
- 接口路径：v1/voucher/sw-message/{id}?filter={filter}
- {id}为创建返回的核注清单内部编号
- 请求方法：PUT
- 请求头内容：
- Content-Type: application/json
- 请求Body内容
{
"refNo": "客户单号",
"data": "单一xml报文格式 base64编码"
}
| 属性 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| refNo | String | 非必填 | 客户单号 |
| data | String | 必填 | 单一xml报文格式 base64编码 |
| filter | String | 非必填 | 对核注清单报文进行预处理: 具体接收的值请联系客户经理 |
响应
-
HTTP状态: 200 代表调用成功
-
响应正文：
{
"success": true,
"message": null,
"result": 2,
"error": null
}
| 属性 | 类型 | 说明 |
|---|---|---|
| success | Boolean | 修改是否成功 true成功 false 失败 |
| message | String | 修改失败返回错误消息 |
| result | Integer | 修改成功返回当前核注清单的版本号 |
| error | N/A | 保留 |
删除核注清单
请求
- 接口路径：v1/voucher/{id}
- {id}为创建返回的核注清单内部编号
- 请求方法：DELETE
- 请求Body内容：空
响应
-
HTTP状态: 200 代表调用成功
-
响应正文：
{
"success": true,
"message": null,
"result": null,
"error": null
}
| 属性 | 类型 | 说明 |
|---|---|---|
| success | Boolean | 删除核注清单是否成功执行 true成功 false 失败 |
| message | String | 删除核注清单失败返回错误消息 |
| result | N/A | 保留 |
| error | N/A | 保留 |
附：数据模型
核注清单数据模型
{
"head": {
"listStat": null, // 清单状态（系统自动反填。已申报、退单、改单、删单、审核通过）
"etpsInnerInvtNo": "YBG123", // 企业内部编号
"dclTypecd": "1", // 申报类型编号 1-备案申请 2-变更申请 3-删除申请
"seqNo": null, // 清单预录入统一编号
"bondInvtNo": null, // 保税清单编号
"putrecNo": "B12345678888", // 手(账)册编号
"chgTmsCnt": null, // 修改变更次数
"bizopEtpsSccd": "94123520MAS2JHWR1E", // 经营企业社会信用代码
"bizopEtpsno": "441XXXXXXX", // 经营企业编号
"bizopEtpsNm": "深圳市XXX有限公司", // 经营企业名称
"rvsngdEtpsSccd": "94123520MAS2JHWR1E", // 收发货企业社会信用代码 /加工单位
"rcvgdEtpsno": "441XXXXXXX", // 收货企业编号 /加工单位编码
"rcvgdEtpsNm": "深圳市XXX有限公司", // 收货企业名称
"dclEtpsSccd": "94123520MAS2JHWR1E", // 申报企业社会信用代码
"dclEtpsno": "441XXXXXXX", // 申报企业编号
"dclEtpsNm": "深圳市XXX有限公司", // 申报企业名称
"inputCode": "441XXXXXXX", // 录入企业编号
"inputCreditCode": "94123520MAS2JHWR1E", // 录入企业社会信用代码
"inputName": "深圳市XXX有限公司", // 录入单位名称
"inputTime": 1694476800000, // 录入日期
"invtDclTime": null, // 清单申报时间
"entryDclTime": null, // 报关单申报日期
"entryNo": null, // 对应报关单编号
"corrEntryDclEtpsSccd": "94123520MAS2JHWR1E", // 对应报关单申报单位社会统一信用代码
"corrEntryDclEtpsNo": "441XXXXXXX" // 对应报关单申报单位编码
"corrEntryDclEtpsNm": "深圳市XXX有限公司", // 对应报关单申报单位名称
"rltInvtNo": null, // 关联清单编号
"rltPutrecNo": "T5349W000609", // 关联备案编号(关联手(账)册备案号)
"rltEntryNo": null, // 关联报关单编号
"rltEntryBizopEtpssccd": null, // 关联报关单境内收发货人社会信用代码
"rltEntryBizopEtpsno": null, // 关联报关单境内收发货人编码
"rltEntryBizopEtpsNm": null, // 关联报关单境内收发货人名称
"rltEntryRvsngdEtpsSccd": null, // 关联报关单生产销售(消费使用)社会信用代码
"rltEntryRcvgdEtpsno": null, // 关联报关单生产销售(消费使用)单位编码
"rltEntryRcvgdEtpsNm": null, // 关联报关单生产销售(消费使用)单位名称
"rltEntryDclEtpsSccd": null, // 关联报关单申报单位社会统一信用代码
"rltEntryDclEtpsNm": null, // 关联报关单申报单位名称
"rltEntryDclEtpsno": null, // 关联报关单海关申报单位编码
"applyNo": null, // 申报表编号
"impexpPortcd": null, // 进出境关别
"dclPlcCuscd": null, // 申报地关区代码
"impexpMarkcd": "E", // 进出口标记代码（I：进口,E：出口）
"mtpckEndprdMarkcd": "E", // 料件成品标记代码（I：料件，E：成品）
"dclcusFlag": "1", // 是否报关标志（1.报关2.非报关）
"genDecFlag": "2", // 是否系统生成报关单 （1-生成， 2-不生成）
"dclcusTypecd": "2", // 报关类型代码（1.关联报关2.对应报关）
"decType": null, // 报关单类型
"entryStucd": null, // 报关状态（0：未放行，1：已放行）
"supvModecd": null, // 监管方式代码
"trspModecd": null, // 运输方式代码
"listType": null, // 流转类型
"vrfdedMarkcd": null, // 核扣标记代码（系统自动反填。0-未核扣 1-预核扣 2-已核扣 3-已核销）
"stshipTrsarvNatcd": null, // 启运/运抵国(地区）
"invtType": "0", // 清单类型
"prevdTime": null, // 预核扣时间
"formalVrfdedTime": null, // 正式核扣时间
"invtIochkptStucd": null, // 清单进出卡口状态代码
"icCardNo": null, // 申报人IC卡号
"passportUsedTypecd": null, // 核放单生成标志代码
"rmk": null, // 备注
"decRmk": null, // 报关单草稿
"sysId": "B1", // 95---加工贸易账册系统 B1---加工贸易手册系统 Z7---海关特殊监管区域管理系统 Z8---保税物流管理系统
"ediSendTime": null, // 发送单一窗口时间
"ediSendStatus": null, // 发单一窗口状态
"holdFlag": null, // 发送暂存状态
"delcareFlag": null, // 发送申报状态 true false
"swResponseInfo": null, // 单一窗口回执信息
"noticeDate": null, // 回执通知时间
"inputTimeString": null,
"invtDclTimeString": null,
"entryDclTimeString": null
},
"goodsList": [
{
"seqNo": "1", // 中心统一编号
"gdsSeqno": 1, // 商品序号
"impGdsSeqno": null, // 入区商品序号
"impBondInvtNo": null, // 入区清单编号
"putrecSeqno": null, // 备案序号-工厂 金关备案序号-仓库
"gdsMtno": null, // 商品料号
"gdecd": "0101210010", // 商品编码
"gdsNm": "马10", // 商品名称
"gdsSpcfModelDesc": null, // 商品规格型号
"dclUnitcd": "009", // 申报计量单位
"lawfUnitcd": "035", // 法定计量单位
"secdLawfUnitcd": "009", // 法定第二计量单位
"natcd": null, // 原产国(地区)
"dclUprcAmt": null, // 企业申报单价
"dclTotalAmt": null, // 企业申报总价
"usdStatTotalAmt": null, // 美元统计总金额
"dclCurrcd": null, // 币制
"lawfQty": null, // 法定数量
"secdLawfQty": null, // 第二法定数量
"wtSfVal": null, // 重量比例因子
"fstSfVal": null, // 第一比例因子
"secdSfVal": null, // 第二比例因子
"dclQty": null, // 申报数量
"grossWt": null, // 毛重
"netWt": null, // 净重
"useCd": null, // 用途代码
"lvyrlfModecd": null, // 征免方式
"ucnsVerno": null, // 单耗版本号
"entryGdsSeqno": 1, // 报关单商品序号
"applyTbSeqno": null, // 流转申报表序号
"clyMarkcd": null, // 归类标志 危化品标志
"destinationNatcd": null, // 最终目的国
"modfMarkcd": null, // 修改标志
"rmk": null, // 备注
"props": null // 拓展字段
}
]
}