TIP
- 核销单新增接口(付费陈列)
- 核销单新增接口(万能促销活动(TP))
- 核销单新增接口(万能促销活动(AP/CP))
- 核销单新增接口(固定类费用)
- 核销单新增接口(进场费)
- 核销单新增接口(其他(直接创建核销))
- 核销单红冲接口(固定类费用)
- 核销单红冲接口(万能促销活动(TP))
- 核销单红冲接口(万能促销活动(AP/CP))
- 核销单红冲接口(进场费)
- 核销单红冲接口(付费陈列)
- 核销单红冲接口(其他(直接创建核销))
- 订单费用明细新增
- 核销单外部审批(万能促销活动(TP))
- 核销单状态回写接口
- 自定义字段更新(万能促销活动(TP))
- 自定义字段更新(万能促销活动(AP/CP))
- 自定义字段更新(直接创建核销)
- 发票新增
- 线上费用核销单新增
- 线上费用核销自定义字段更新
# 预算费控
# 核销单新增接口(付费陈列)
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/cuxiao/verify/v1/saveVerify/{openid}/{timestamp}/{digest}/{msg_id}
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
plan_code | varchar(100) | 是 | 需要核销的活动方案编码 |
creator | varchar(100) | 是 | 此核销单的创建人 |
business_date | date | 否 | 如果企业启用费用核算参数的时候此字段需要传值,如果未开启则不用传值 |
activity_code | varchar(100) | 否 | 需要核销的申请单编号 |
activity_detail_id | int | 是 | 需要核销的付费明细行ID,如果传了申请单编号,会校验申请单号下是否存在此付费明细行ID |
amount | int | 是 | 核销单的提交核销金额 |
verify_remark | varchar(4000) | 否 | 核销备注 |
pay_mode | varchar(100) | 是 | 需要传系统中存在的支付方式名称 |
rebate_account | varchar(100) | 否 | 如果支付方式为“货补返利”的时候,此字段必传。否则此字段传空 |
响应示例:
{
"msg_id": "X0001",
"return_code": 0,
"return_msg": "付费陈列核销单新增成功!"
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
msg_id | string | 请求消息ID |
return_code | int | 响应编码。0:成功,1:失败 |
return_msg | string | 响应说明 |
# 核销单新增接口(万能促销活动(TP))
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/cuxiaoVerify/v1/regularApply/{openid}/{timestamp}/{digest}/{msg_id}
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
code | VARCHAR(32) | 否 | 核销单号,不传时系统默认生成 |
plan_code | VARCHAR(100) | 是 | 方案编号 |
batch_code | VARCHAR(32) | 否 | 核销批次单号,不传时系统默认生成 |
name | VARCHAR(32) | 否 | 核销单名称 |
account | VARCHAR(100) | 是 | 创建人账号 |
rows | List | 列表 | |
rows.apply_code | VARCHAR(100) | 否 | 活动申请单号 |
rows.actual_cost_manager_id | VARCHAR(100) | 否 | 实际费用负责人 |
rows.actual_cm_code | VARCHAR(100) | 否 | 实际核销客户 |
rows.actual_dealer_code | VARCHAR(100) | 否 | 实际代垫经销商 |
rows.account_unit | VARCHAR(100) | 否 | 实际结算单位 |
rows.unit_discount | VARCHAR(100) | 否 | 实际单位折让 |
rows.row_id | BIGINT | 是 | 活动申请明细行ID |
rows.amount | NUMERIC(20, 2) | 是 | 本次核销金额 |
rows.remark | VARCHAR | 否 | 核销备注 |
rows.pay_mode | VARCHAR | 是 | 支付方式 |
rows.rebate_account | VARCHAR | 否 | 费用池账户。如果支付方式配置的返利方式为费用池的时候,此字段必传。否则此字段传空 |
rows.gifts | List | 否 | 实际赠送品项,如果支付方式配置的返利方式为赠品池的时候,需要传输商品明细 |
rows.capital_account | VARCHAR | 否 | 资金池账户。如果支付方式配置的返利方式为资金池的时候,此字段必传。否则此字段传空 |
rows.gifts.pd_name | VARCHAR | 是 | 商品名称 |
rows.gifts.pd_code | VARCHAR | 是 | 商品编码 |
rows.gifts.num | VARCHAR | 是 | 核销数量 |
rows.ext_fields | List | 否 | 扩展字段 |
rows.ext_fields.field_name | VARCHAR | 是 | 扩展字段名称 |
rows.ext_fields.field_value | VARCHAR | 是 | 扩展字段名称的值 |
响应示例:
{
"msg_id": "X0001",
"return_code": 0,
"return_msg": "万能促销活动核销单新增成功!"
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
msg_id | string | 请求消息ID |
return_code | int | 响应编码。0:成功,1:失败 |
return_msg | string | 响应说明 |
# 核销单新增接口(万能促销活动(AP/CP))
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/cuxiaoVerify/v1/apCpApply/{openid}/{timestamp}/{digest}/{msg_id}
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
verify_code | VARCHAR(100) | 否 | 核销单号,不传时系统默认生成 |
apply_code | VARCHAR(100) | 是 | 申请单号 |
verify_name | VARCHAR(100) | 是 | 核销单名称 |
account | VARCHAR(100) | 是 | 创建人账号 |
verify_charge_person | VARCHAR(100) | 是 | 核销负责人 |
dept_id | VARCHAR(100) | 是 | 所属部门 |
actual_sales_num | VARCHAR(100) | 否 | 实际销量 |
actual_sales_amount | VARCHAR(100) | 否 | 实际销额 |
verifyHeadExt | Object | 否 | 核销头自定义字段(格式:<字段名称,字段值>) |
rows | List | 是 | 列表 |
rows.row_id | BIGINT | 是 | 活动申请明细行ID |
rows.amount | NUMERIC(20, 2) | 是 | 本次核销金额 |
rows.pay_mode | VARCHAR(100) | 是 | 支付方式。(需要传系统中存在的支付方式名称) |
rows.rebate_account | VARCHAR(100) | 否 | 费用池账户。如果支付方式配置的返利方式为费用池的时候,此字段必传。否则此字段传空 |
rows.capital_account | VARCHAR(100) | 否 | 资金池账户。如果支付方式配置的返利方式为资金池的时候,此字段必传。否则此字段传空 |
rows.gifts | List | 否 | 实际赠送品项,如果支付方式配置的返利方式为赠品池的时候,需要传输商品明细 |
rows.gifts.pd_name | VARCHAR(100) | 否 | 商品名称 |
rows.gifts.pd_code | VARCHAR(100) | 否 | 商品编码 |
rows.gifts.num | NUMERIC(20, 2) | 否 | 核销数量 |
rows.actual_cm_code | VARCHAR(100) | 否 | 实际的客户的编码 |
rows.actual_dealer_code | VARCHAR(100) | 否 | 实际的费用代垫经销商的编码 |
rows.verify_remark | VARCHAR(1000) | 否 | 核销备注 |
rows.ext_fields | List | 否 | 扩展字段 |
rows.ext_fields.field_name | VARCHAR(100) | 否 | 扩展字段名称 |
rows.ext_fields.field_value | VARCHAR(1000) | 否 | 扩展字段名称的值 |
响应示例:
{
"msg_id": "X0001",
"return_code": 0,
"return_msg": "万能核销(AP/CP)核销单新增成功!"
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
msg_id | string | 请求消息ID |
return_code | int | 响应编码。0:成功,1:失败 |
return_msg | string | 响应说明 |
# 核销单新增接口(固定类费用)
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/cuxiao/fixAmount/verification/v1/saveFixAmountVerify/{openid}/{timestamp}/{digest}/{msg_id}
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
code | varchar(100) | 否 | 如果不传系统自动生成 |
activity_code | varchar(100) | 是 | 需要核销的申请单号 |
creator | varchar(100) | 是 | 此核销单的创建人 |
create_date | varchar(100) | 否 | 单据创建日期,如果不传,则为接口传输日期 |
business_date | date | 否 | 如果企业启用费用核算参数的时候此字段需要传值,如果未开启则不用传值 |
verify_data | List | 是 | 明细行 |
verify_data.activity_detail_id | int | 是 | 需要核销的付费明细行ID,如果传了申请单编号,会校验申请单号下是否存在此付费明细行ID |
verify_data.amount | int | 是 | 核销单的提交核销金额 |
verify_data.verify_remark | varchar(4000) | 否 | 核销备注 |
verify_data.pay_mode_name | varchar(100) | 是 | 需要传系统中存在的支付方式名称 |
verify_data.rebate_account | varchar(100) | 否 | 如果支付方式配置的需要关联费用池,此字段必传。否则此字段传空 |
响应示例:
{
"msg_id": "X0001",
"return_code": 0,
"return_msg": "固定金额核销单新增成功!"
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
msg_id | string | 请求消息ID |
return_code | int | 响应编码。0:成功,1:失败 |
return_msg | string | 响应说明 |
# 核销单新增接口(进场费)
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/cuxiaoVerify/v1/saveEntranceVerify/{openid}/{timestamp}/{digest}/{msg_id}
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
plan_code | varchar(100) | 是 | 需要核销的活动方案编码 |
creator | varchar(100) | 是 | 此核销单的创建人 |
verify_data | List | 是 | 明细行 |
verify_data.activity_code | varchar(100) | 否 | 需要核销的申请单编号 |
verify_data.activity_detail_id | int | 是 | 需要核销的付费明细行ID,如果传了申请单编号,会校验申请单号下是否存在此付费明细行ID |
verify_data.verify_amount | int | 是 | 核销单的提交核销金额 |
verify_data.verify_remark | varchar(4000) | 否 | 核销备注 |
verify_data.pay_mode | varchar(100) | 是 | 需要传系统中存在的支付方式名称 |
verify_data.rebate_account | varchar(100) | 否 | 如果支付方式配置的需要关联费用池,此字段必传。否则此字段传空 |
响应示例:
{
"msg_id": "X0001",
"return_code": 0,
"return_msg": "新增成功!"
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
msg_id | string | 请求消息ID |
return_code | int | 响应编码。0:成功,1:失败 |
return_msg | string | 响应说明 |
# 核销单新增接口(其他(直接创建核销))
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/cuxiaoVerify/v1/directApply/{openid}/{timestamp}/{digest}/{msg_id}
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
form_name | VARCHAR | 是 | 核销单模板名称。直接创建核销利用的核销单 |
verify_name | VARCHAR | 是 | 核销单名称。直接创建核销利用的核销单 |
account | VARCHAR | 是 | 创建人账号。此核销单的创建人 |
create_time | VARCHAR | 否 | 单据创建日期。格式:yyyy-MM-dd HH:mm:ss。如果不传,则为接口传输日期 |
bussiness_date | VARCHAR | 否 | 过账日期。格式:yyyy-MM-dd。如果企业启用费用核算参数的时候此字段需要传值,如果未开启则不用传值 |
verify_head_fields[].name | VARCHAR | 否 | 自定义字段的名称,自定义字段需要先在外勤365系统中维护 |
verify_head_fields[].value | VARCHAR | 否 | 自定义字段value值,如果对应多个选项值,以“,”分隔拼接 |
dept_name | VARCHAR | 是 | 此核销单所属部门 |
budget_rows | List | 列表 | |
budget_rows.subject_code | VARCHAR | 是 | 需要核销的预算科目编号 |
budget_rows.subject_name | VARCHAR | 是 | 需要核销的预算科目名称 |
budget_rows.period | VARCHAR | 是 | 预算扣减的期间 |
budget_rows.dim_data | VARCHAR | 是 | 预算维度信息,格式为:{"预算维度名称":"维值名称"},多个维度用逗号隔开 |
budget_rows.customer_code | VARCHAR | 是 | 客户编码 |
budget_rows.customer_name | VARCHAR | 是 | 客户名称 |
budget_rows.dealer_code | VARCHAR | 是 | 费用代垫经销商编码 |
budget_rows.dealer_name | VARCHAR | 是 | 费用代垫经销商名称 |
budget_rows.pd_code | VARCHAR | 是 | 商品编码 |
budget_rows.pd_name | VARCHAR | 是 | 商品名称 |
budget_rows.amount | VARCHAR | 是 | 核销单的提交核销金额 |
budget_rows.remark | VARCHAR | 否 | 核销备注 |
budget_rows.pay_mode_name | VARCHAR | 是 | 支付方式,需要传系统中存在的支付方式名称 |
budget_rows.rebate_account_name | VARCHAR | 否 | 费用池账户,如果支付方式配置的需要关联费用池,此字段必传。否则此字段传空。 |
budget_rows.capital_account_name | VARCHAR | 否 | 资金池账户,如果支付方式配置的需要关联资金池,此字段必传。否则此字段传空。 |
budget_rows.cuxiao_supplier_name | VARCHAR | 否 | 供应商名称 |
budget_rows.ext_fields.name | VARCHAR | 否 | 行自定义字段的名称,自定义字段需要先在外勤365系统中维护 |
budget_rows.ext_fields.value | VARCHAR | 否 | 自定义字段value值,如果对应多个选项值,以“,”分隔拼接 |
响应示例:
{
"msg_id": "X0001",
"return_code": 0,
"return_msg": "新增成功!"
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
msg_id | string | 请求消息ID |
return_code | int | 响应编码。0:成功,1:失败 |
return_msg | string | 响应说明 |
# 核销单红冲接口(固定类费用)
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/cuxiaoVerify/v1/reverseFixAmount/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
verificationCode | varchar | 是 | 核销单号 |
verificationId | varchar | 是 | 核销单id |
creator | VARCHAR(32) | 是 | 此核销单的红冲人 |
reverseTime | VARCHAR(32) | 否 | 单据红冲红冲时间,默认为当前时间。格式:yyyy-MM-dd HH:mm:ss |
businessDate | VARCHAR(32) | 否 | 红冲过账日期,企业启用费用核算参数的时必须传值。格式:yyyy-MM-dd |
请求示例:
响应示例:
{
"return_code": "0",
"return_msg": "",
"msg_id": "X000001"
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
msg_id | VARCHAR(32) | 消息ID |
return_code | VARCHAR(32) | 响应编码。0:成功,1:失败 |
return_msg | VARCHAR(100) | 响应说明 |
# 核销单红冲接口(万能促销活动(TP))
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/cuxiaoVerify/v1/reverseRegular/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
verify_code | varchar | 是 | 需要进行红冲的核销单号 |
verify_id | varchar | 是 | 核销单id |
creator | VARCHAR(32) | 是 | 此核销单的红冲人 |
reverse_time | VARCHAR(32) | 否 | 如果不传,则为接口传输日期 |
请求示例:
响应示例:
{
"return_code": "0",
"return_msg": "",
"msg_id": "X000001"
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
msg_id | VARCHAR(32) | 消息ID |
return_code | VARCHAR(32) | 响应编码。0:成功,1:失败 |
return_msg | VARCHAR(100) | 响应说明 |
# 核销单红冲接口(万能促销活动(AP/CP))
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/cuxiaoVerify/v1/reverseApCp/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
verify_id | varchar(100) | 否 | 需要进行红冲的核销单id,id和单号必须填一个 |
verify_code | varchar(100) | 否 | 需要进行红冲的核销单号,id和单号必须填一个 |
creator | VARCHAR(100) | 是 | 此核销单的红冲人 |
reverse_time | VARCHAR(100) | 否 | 如果不传,则为接口传输日期 |
响应示例:
{
"return_code": "0",
"return_msg": "",
"msg_id": "X000001"
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
msg_id | VARCHAR(100) | 消息ID |
return_code | VARCHAR(100) | 响应编码。0:成功,1:失败 |
return_msg | VARCHAR(100) | 响应说明 |
# 核销单红冲接口(进场费)
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/cuxiaoVerify/v1/reverseEntrance/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
verify_code | varchar | 是 | 核销单号 |
verify_id | varchar | 是 | 核销单id |
creator | VARCHAR(32) | 是 | 此核销单的红冲人 |
reverse_time | VARCHAR(32) | 否 | 单据红冲红冲时间,默认为当前时间。格式:yyyy-MM-dd HH:mm:ss |
请求示例:
响应示例:
{
"return_code": "0",
"return_msg": "",
"msg_id": "X000001"
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
msg_id | VARCHAR(32) | 消息ID |
return_code | VARCHAR(32) | 响应编码。0:成功,1:失败 |
return_msg | VARCHAR(100) | 响应说明 |
# 核销单红冲接口(付费陈列)
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/cuxiaoVerify/v1/reverseDisplay/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
verify_code | varchar | 是 | 核销单号 |
verify_id | varchar | 是 | 核销单id |
creator | VARCHAR(32) | 是 | 此核销单的红冲人 |
reverse_time | VARCHAR(32) | 否 | 单据红冲红冲时间,默认为当前时间。格式:yyyy-MM-dd HH:mm:ss |
business_date | VARCHAR(32) | 否 | 红冲过账日期,企业启用费用核算参数的时必须传值。格式:yyyy-MM-dd |
请求示例:
响应示例:
{
"return_code": "0",
"return_msg": "",
"msg_id": "X000001"
}
参数说明:
参数 | 类型 | 名称 | 备注 |
---|---|---|---|
msg_id | VARCHAR(32) | 消息ID | |
return_code | VARCHAR(32) | 响应编码。0:成功,1:失败 | |
return_msg | VARCHAR(100) | 响应说明 |
# 核销单红冲接口(其他(直接创建核销))
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/cuxiaoVerify/v1/reverseDirect/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
verify_code | varchar | 是 | 需要进行红冲的核销单号 |
verify_id | varchar | 是 | 核销单id |
creator | VARCHAR(32) | 是 | 此核销单的红冲人 |
reverse_time | VARCHAR(32) | 否 | 如果不传,则为接口传输日期 |
请求示例:
响应示例:
{
"return_code": "0",
"return_msg": "",
"msg_id": "X000001"
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
msg_id | VARCHAR(32) | 消息ID |
return_code | VARCHAR(32) | 响应编码。0:成功,1:失败 |
return_msg | VARCHAR(100) | 响应说明 |
# 订单费用明细新增
接口说明:订单费用明细新增接口
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/cuxiaoOrder/v1/orderCostAdd/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
plan_code | VARCHAR(100) | 是 | 营销活动的活动方案编码(必须是随单和后返) |
customer_code | VARCHAR(100) | 是 | 客户编码;随单执行时,必填;订单后返时,非必填; |
delivery_code | VARCHAR(100) | 是 | 发货单号 |
order_code | VARCHAR(100) | 否 | 关联订单编号 |
supplier_code | VARCHAR(100) | 否 | 供应商 |
order_policy_code | VARCHAR(100) | 否 | 促销策略编号 |
creator_code | VARCHAR(100) | 是 | 操作人账号 |
transfer_way | VARCHAR(32) | 是 | 传输方式;1代表按总额,2代表按明细;随单执行时,必填;订单后返时,非必填,传值时只能按总额; |
sale_amount | VARCHAR(100) | 否 | 销售金额;随单执行时,传输方式为按总额时,必传;传输方式为按明细时,无需传入,系统根据明细自动汇总。订单后返时,非必填。 |
cost_amount | VARCHAR(100) | 否 | 费用金额;随单执行时,传输方式为按总额时,必传;传输方式为按明细时,无需传入,系统根据明细自动汇总。订单后返时,非必填 |
create_time | VARCHAR(100) | 否 | 创建时间,如果不传,为系统当前的传输时间 |
pd_list | List | 否 | 明细列表;订单后返的不传明细 |
pd_list.name | VARCHAR(100) | 是 | 商品名称 |
pd_list.is_gift | VARCHAR(100) | 是 | 是否赠品 |
pd_list.num | VARCHAR(100) | 否 | 数量 |
pd_list.unit | VARCHAR(100) | 否 | 单位 |
pd_list.origin_amount | VARCHAR(100) | 否 | 优惠前金额 |
pd_list.discounted_amount | VARCHAR(1000) | 是 | 优惠后金额 |
pd_list.cost_amount | VARCHAR(32) | 是 | 费用金额 |
响应示例:
{
"return_code": "0",
"return_msg": "",
"msg_id": "X000001"
}
参数说明:
参数 | 类型 | 名称 | 备注 |
---|---|---|---|
msg_id | VARCHAR(32) | 消息ID | |
return_code | VARCHAR(32) | 响应编码。0:成功,1:失败 | |
return_msg | VARCHAR(100) | 响应说明 |
# 核销单外部审批(万能促销活动(TP))
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/cuxiaoVerify/v1/auditRegularVerify/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
verify_id | varchar | 否 | 核销单id,核销单ID和核销单号必须传一个,且核销单的审批状态为审批中 |
verify_code | varchar | 否 | 核销单号,核销单ID和核销单号必须传一个,且核销单的审批状态为审批中 |
auditor_id | varchar | 否 | 审批人账号id,审批人id和编码必须传一个,且在系统中存在未被停用 |
auditor_code | varchar | 否 | 审批人账号编码,审批人id和编码必须传一个,且在系统中存在未被停用 |
verify_status | varchar | 是 | 1:已通过;2:已打回 |
rows | List | 否 | 核销明细数组 |
rows.info_id | varchar | 否 | 核销行id,按照核销行id更新批复核销金额,批复核销金额有值时,必须传核销行id |
rows.audit_amount | varchar | 否 | 批复核销金额 |
opinion | varchar | 否 | 审批意见 |
resubmitType | varchar | 否 | 被打回重新提交策略 1-重新提交时回到打回节点,2-重新提交时重新审批 |
请求示例:
响应示例:
{
"return_code": "0",
"return_msg": "",
"msg_id": "X000001"
}
参数说明:
参数 | 类型 | 名称 | 备注 |
---|---|---|---|
msg_id | VARCHAR(32) | 消息ID | |
return_code | VARCHAR(32) | 响应编码。0:成功,1:失败 | |
return_msg | VARCHAR(100) | 响应说明 |
# 核销单状态回写接口
接口说明:支持“品鉴会”、“万能促销活动”、“直接创建核销”场景的审批状态回写。
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/cuxiaoVerify/v1/auditVerifyApply/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
verify_code | varchar | 是 | 核销单编码 |
verify_id | varchar | 是 | 核销单id |
auditor | VARCHAR(32) | 是 | 最后审批人的名称 |
audit_time | VARCHAR(32) | 否 | 如果不传,则为接口传输日期 |
verify_status | varchar | 是 | 1:已通过;2:已打回 |
请求示例:
响应示例:
{
"return_code": "0",
"return_msg": "",
"msg_id": "X000001"
}
参数说明:
参数 | 类型 | 名称 | 备注 |
---|---|---|---|
msg_id | VARCHAR(32) | 消息ID | |
return_code | VARCHAR(32) | 响应编码。0:成功,1:失败 | |
return_msg | VARCHAR(100) | 响应说明 |
# 自定义字段更新(万能促销活动(TP))
接口说明:支持核销单头行自定义字段的更新,传哪个字段就更新哪个字段。传的字段必须是系统中存在的自定义字段,其中,附件、图片不支持。支持的字段类型:客户、商品、人员、下拉框、单选框、多选框。
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/cuxiaoVerify/v1/extFiledUpdate/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
verify_code | varchar | 否 | 核销单编码 |
verify_id | varchar | 否 | 核销单id |
ext_head_list | list | 否 | 核销头列表 |
ext_key | VARCHAR(32) | 是 | 核销单头数据自定义字段名称 |
ext_value | VARCHAR(32) | 是 | 核销单头数据自定义字段值 |
ext_list | list | 否 | 核销行列表 |
ext_key | VARCHAR(32) | 是 | 核销单数据自定义字段名称 |
ext_value | VARCHAR(32) | 是 | 核销单数据自定义字段值 |
cm_id | VARCHAR(32) | 是 | 核销单行id |
请求示例:
响应示例:
{
"return_code": "0",
"return_msg": "",
"msg_id": "X000001"
}
参数说明:
参数 | 类型 | 名称 | 备注 |
---|---|---|---|
msg_id | VARCHAR(32) | 消息ID | |
return_code | VARCHAR(32) | 响应编码。0:成功,1:失败 | |
return_msg | VARCHAR(100) | <万能span style="color:gray;font-size:12px">响应说明 |
# 自定义字段更新(万能促销活动(AP/CP))
接口说明:支持核销单头行自定义字段的更新,传哪个字段就更新哪个字段。传的字段必须是系统中存在的自定义字段,其中,附件、图片不支持。支持的字段类型:客户、商品、人员、下拉框、单选框、多选框、文本框、多行文本框、数值框、日期、定位。
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/cuxiaoVerify/v1/apcpExtFiledUpdate/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
verify_code | varchar | 否 | 核销单编码 |
verify_id | varchar | 否 | 核销单id |
ext_head_list | list | 否 | 核销头列表 |
ext_key | VARCHAR(32) | 是 | 核销单头数据自定义字段名称 |
ext_value | VARCHAR(32) | 是 | 核销单头数据自定义字段值 |
ext_list | list | 否 | 核销行列表 |
ext_key | VARCHAR(32) | 是 | 核销单数据自定义字段名称 |
ext_value | VARCHAR(32) | 是 | 核销单数据自定义字段值(商品/客户/人员传id,多选单选传值格式”[{"name":"选项2安徽","id":"选项2安徽"},{"name":"选项3江苏","id":"选项3江苏"}]“) |
cm_id | VARCHAR(32) | 是 | 核销单行id |
请求示例:
响应示例:
{
"return_code": "0",
"return_msg": "",
"msg_id": "X000001"
}
参数说明:
参数 | 类型 | 名称 | 备注 |
---|---|---|---|
msg_id | VARCHAR(32) | 消息ID | |
return_code | VARCHAR(32) | 响应编码。0:成功,1:失败 | |
return_msg | VARCHAR(100) | 响应说明 |
# 自定义字段更新(直接创建核销)
接口说明:支持核销单头行自定义字段的更新,传哪个字段就更新哪个字段。传的字段必须是系统中存在的自定义字段,其中,附件、图片不支持。支持的字段类型:客户、商品、人员、下拉框、单选框、多选框、文本框、多行文本框、数值框、日期、定位。
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/cuxiaoDirectVerify/v1/extFiledUpdate/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
verify_code | varchar | 否 | 核销单编码 |
verify_id | varchar | 否 | 核销单id |
ext_head_list | list | 否 | 核销头列表 |
ext_key | VARCHAR(32) | 是 | 核销单头数据自定义字段名称 |
ext_value | VARCHAR(32) | 是 | 核销单头数据自定义字段值 |
ext_list | list | 否 | 核销行列表 |
ext_key | VARCHAR(32) | 是 | 核销单数据自定义字段名称 |
ext_value | VARCHAR(32) | 是 | 核销单数据自定义字段值(商品/客户/人员传code) |
cm_id | VARCHAR(32) | 是 | 核销单行id |
请求示例:
响应示例:
{
"return_code": "0",
"return_msg": "",
"msg_id": "X000001"
}
参数说明:
参数 | 类型 | 名称 | 备注 |
---|---|---|---|
msg_id | VARCHAR(32) | 消息ID | |
return_code | VARCHAR(32) | 响应编码。0:成功,1:失败 | |
return_msg | VARCHAR(100) | 响应说明 |
# 发票新增
接口说明::新增发票至发票池,支持增值税专用发票、增值税普通发票、增值税电子普通发票、增值税电子专用发票、电子发票(增值税专用发票)、电子发票(增值税普通发票)。
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/cuxiaoVerify/v1/invoiceAdd/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
source_code | VARCHAR(100) | 否 | 发票外部系统id |
invoice_name | VARCHAR(100) | 否 | 发票名称 |
invoice_type | VARCHAR(100) | 是 | 发票类型({"id":20220111165401,"name":"增值税专用发票"},{"id":20220111165402,"name":"增值税普通发票"},{"id":20220111165403,"name":"增值税电子普通发票"},{"id":20220111165404,"name":"增值税电子专用发票"},{"id":202305091095405,"name":"电子发票(增值税普通发票)"},{"id":202305091095406,"name":"电子发票(增值税专用发票)"}) |
invoice_date | VARCHAR(100) | 否 | 开票日期 |
invoice_no | VARCHAR(100) | 否 | 发票号码 |
invoice_code | VARCHAR(100) | 否 | 发票代码 |
drawer | VARCHAR(100) | 否 | 开票人 |
payee | VARCHAR(100) | 否 | 收款人 |
review | VARCHAR(100) | 否 | 复核人 |
checksum | VARCHAR(100) | 否 | 校验码 |
machine_number | VARCHAR(100) | 否 | 机器编号 |
remark | VARCHAR(100) | 否 | 备注 |
type | VARCHAR(1) | 是 | 发票主体类型(1:本企业;2:第三方) |
purchase_unit | Object | 否 | 购买方对象 |
purchase_unit.taxpayer | VARCHAR(100) | 否 | 购买方 |
purchase_unit.tax_no | VARCHAR(100) | 否 | 购买方纳税人识别号 |
purchase_unit.address_tel | VARCHAR(100) | 否 | 购买方地址/电话 |
purchase_unit.bank_account | VARCHAR(100) | 否 | 购买方开户行/账号 |
sales_unit | Object | 否 | 销售方对象 |
sales_unit.tax_type | VARCHAR(1) | 否 | 销售方类型(1:客户;0:第三方) |
sales_unit.taxpayer | VARCHAR(100) | 否 | 销售方 |
sales_unit.tax_no | VARCHAR(100) | 否 | 销售方纳税人识别号 |
sales_unit.address_tel | VARCHAR(100) | 否 | 销售方地址/电话 |
sales_unit.bank_account | VARCHAR(100) | 否 | 销售方开户行/账号 |
check_status | VARCHAR(1) | 否 | 验真状态(0:未验真;1:已验真;2:验真失败) |
creator | VARCHAR(100) | 是 | 发票上传人 |
create_time | VARCHAR(100) | 否 | 发票上传时间 |
details | List | 是 | 发票行 |
details.sequ | VARCHAR(100)(32) | 否 | 行号 |
details.taxable_name | VARCHAR(100)(32) | 否 | 货物或应税劳务、服务名称 |
details.specifications | List | 否 | 规格型号 |
details.unit | VARCHAR(100) | 否 | 单位 |
details.num | VARCHAR(100) | 否 | 数量 |
details.unit_price | VARCHAR(100) | 否 | 单价 |
details.amount | VARCHAR(100) | 是 | 金额 |
details.tax_rate | VARCHAR(100) | 是 | 税率 |
details.tax_amount | VARCHAR(100) | 是 | 税额 |
details.total_amount | VARCHAR(100) | 是 | 含税金额 |
响应示例:
{
"return_code": "0",
"return_msg": "",
"msg_id": "X000001"
}
参数说明:
参数 | 类型 | 名称 | 备注 |
---|---|---|---|
msg_id | VARCHAR(32) | 消息ID | |
return_code | VARCHAR(32) | 响应编码。0:成功,1:失败 | |
return_msg | VARCHAR(100) | 响应说明 |
# 线上费用核销单新增
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/cuxiaoVerify/v1/onlineCostApply/{openid}/{timestamp}/{digest}/{msg_id}
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
verify_code | VARCHAR(100) | 否 | 核销单号,不传时系统默认生成 |
apply_code | VARCHAR(100) | 是 | 申请单号 |
verify_name | VARCHAR(100) | 否 | 核销单名称 |
account | VARCHAR(100) | 是 | 创建人账号 |
supplier_code | VARCHAR(100) | 否 | 供应商编码 |
verify_head_ext | List | 否 | 核销头自定义字段 |
verify_head_ext.field_name | VARCHAR(100) | 否 | 核销头自定义字段name |
verify_head_ext.field_value | VARCHAR(100) | 否 | 核销头自定义字段code |
rows | List | 是 | 列表 |
rows.activity_cm_id | BIGINT | 是 | 活动申请明细行ID |
rows.amount | NUMERIC(20, 2) | 是 | 本次核销金额 |
rows.pay_mode | VARCHAR(100) | 是 | 支付方式。(需要传系统中存在的支付方式名称) |
rows.advance_data | List | 否 | 如果支付方式核销预付款的时候,此字段必传。否则此字段传空。 |
rows.advance_data.detail_id | VARCHAR(100) | 否 | 预付款行ID |
rows.advance_data.prepayment_code | VARCHAR(100) | 否 | 预付款单号 |
rows.advance_data.init_amount | NUMERIC(20, 2) | 否 | 本次核销预付款金额 |
rows.actual_sale_amount | NUMERIC(20, 2) | 否 | 实际销额 |
rows.expect_sale_ratio | NUMERIC(20, 2) | 否 | 实际费效比 |
rows.verify_remark | VARCHAR(1000) | 否 | 核销备注 |
rows.verify_ext | List | 否 | 扩展字段 |
rows.ext_fields.field_name | VARCHAR(100) | 否 | 扩展字段名称 |
rows.ext_fields.field_value | VARCHAR(1000) | 否 | 扩展字段名称的值 |
响应示例:
{
"msg_id": "X0001",
"return_code": 0,
"return_msg": "线上费用核销单新增成功!"
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
msg_id | string | 请求消息ID |
return_code | int | 响应编码。0:成功,1:失败 |
return_msg | string | 响应说明 |
# 线上费用核销自定义字段更新
接口说明:支持核销单头行自定义字段的更新,传哪个字段就更新哪个字段。传的字段必须是系统中存在的自定义字段,其中,附件、图片不支持。支持的字段类型:商品、人员、下拉框、单选框、多选框、文本框、多行文本框、数值框、日期、时间、日期时间、网址。
字段类型:商品、人员、下拉框、单选框、多选框需要做合法性校验,必填项为空不允许修改。
请求方式: POST(HTTPS)
请求地址: https://openapi.waiqin365.com/api/cuxiaoOnlineCost/v1/extFiledUpdate/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
verify_code | varchar | 否 | 核销单编码 |
verify_id | varchar | 否 | 核销单id |
ext_head_list | list | 否 | 核销头列表 |
ext_key | VARCHAR(32) | 是 | 核销单头数据自定义字段名称 |
ext_value | VARCHAR(32) | 是 | 核销单头数据自定义字段值 |
ext_list | list | 否 | 核销行列表 |
ext_key | VARCHAR(32) | 是 | 核销单数据自定义字段名称 |
ext_value | VARCHAR(32) | 是 | 核销单数据自定义字段值(商品/客户/人员传code) |
cm_id | VARCHAR(32) | 是 | 核销单行id |
请求示例:
响应示例:
{
"return_code": "0",
"return_msg": "",
"msg_id": "X000001"
}
参数说明:
参数 | 类型 | 名称 | 备注 |
---|---|---|---|
msg_id | VARCHAR(32) | 消息ID | |
return_code | VARCHAR(32) | 响应编码。0:成功,1:失败 | |
return_msg | VARCHAR(100) | 响应说明 |