# 预算费控

# 核销单新增接口(付费陈列)

请求方式: POST(HTTPS
请求地址: https://openapi.waiqin365.com/api/cuxiao/verify/v1/saveVerify/{openid}/{timestamp}/{digest}/{msg_id} 在线调试
请求示例:

{
    "plan_code": "CX202103293722",
    "creator": "test",
    "business_date": "2021-04-21",
    "verify_data": [
        {
            "activity_code": "SQ202104010001",
            "activity_detail_id": 7547546183825121319,
            "amount": "100.00",
            "verify_remark": "备注1",
            "pay_mode": "现金",
            "rebate_account": ""
        },
        {
            "activity_code": "SQ202104090002",
            "activity_detail_id": 6916424039566956578,
            "amount": "200.00",
            "verify_remark": "备注2",
            "pay_mode": "货补返利",
            "rebate_account": "一号账户"
        }
    ]
}
说明: 本示例仅供参考,具体以参数说明为准。

参数说明:

参数 类型 必填 说明
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": "HX2022090800001",
    "plan_code": "CX2022012701",
    "batch_code": "HXB202303030001",
    "name": "核销单名称",
    "account": "DM",
    "rows": [
        {
            "apply_code": "SQ20220127180401",
            "actual_cost_manager_id": "实际费用负责人",
            "actual_cm_code":"实际核销客户",
            "actual_dealer_code":"实际代垫经销商",
            "account_unit": "实际结算单位",
            "unit_discount": "23",
            "row_id": "456456456",
            "amount": "100.00",
            "remark": "",
            "pay_mode": "现金",
            "rebate_account": "费用池",
            "capital_account": "资金池",
            "gifts": [
                {
                    "pd_name": "白酒",
                    "pd_code": "CP000001",
                    "num": 1
                }
            ],
            "ext_fields": [
               {
                   "field_name": "文本",
                   "field_value": "自定义备注"
               }
            ]
        }
    ]
}
说明: 本示例仅供参考,具体以参数说明为准。

参数说明:

参数 类型 必填 说明
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": "HX2022090800001",
  "apply_code":"SQ202203080012",
  "verify_name":"ap/cp核销测试",
  "account": "yz",
  "verify_charge_person":"yangzhi",
  "dept_id":"4832911787427664392",
  "actual_sales_num":"2",
  "actual_sales_amount":"5",
  "verifyHeadExt":{
    "ext_2303140243":"测试"
  },
  "rows": [
    {
      "row_id": "4650176515720515135",
      "amount": "100.00",
      "pay_mode": "现金",
      "rebate_account": "费用池",
      "capital_account": "资金池",
      "gifts": [
        {
          "pd_name": "蓝药水",
          "pd_code": "pd_002",
          "num": 2
        }
      ],
      "actual_cm_code":"CUS000002",
      "actual_dealer_code":"CUS000026",
      "verify_remark": "",
      "ext_fields": [
        {
          "field_name": "文本框-无",
          "field_value": "自定义备注1"
        }
      ]
    }
  ]
}
说明: 本示例仅供参考,具体以参数说明为准。

参数说明:

参数 类型 必填 说明
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} 在线调试
请求示例:

{
  "activity_code": "SQ202111120002",
  "code":"AHX0089798",
  "creator": "test",
  "create_date": "2021-11-12",
  "business_date": "2021-11-12",
  "verify_data": [
    {
      "activity_detail_id": 4967594324087205762,
      "amount": "600",
      "verify_remark": "备注1",
      "pay_mode_name": "现金",
      "rebate_account": ""
    },
    {
      "activity_detail_id": 7520594854182052191,
      "amount": "800",
      "verify_remark": "备注1",
      "pay_mode_name": "现金",
      "rebate_account": ""
    }
  ]
}
说明: 本示例仅供参考,具体以参数说明为准。

参数说明:

参数 类型 必填 说明
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": "JCF202201116907",
  "creator": "test",
  "verify_data": [
    {
      "activity_code": "SQ202112120001",
      "activity_detail_id": 4967594324087205762,
      "verify_amount": "600",
      "verify_remark": "备注1",
      "pay_mode": "现金",
      "rebate_account": ""
    },
    {
      "activity_detail_id": 7520594854182052191,
      "verify_amount": "800",
      "verify_remark": "备注1",
      "pay_mode_": "现金",
      "rebate_account": ""
    }
  ]
}
说明: 本示例仅供参考,具体以参数说明为准。

参数说明:

参数 类型 必填 说明
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": "直接创建核销单",
    "account": "zhangsan",
    "create_time": "2022-03-01 20:05:35",
    "bussiness_date": "2022-03-01",
    "dept_name": "销售一部",
    "verify_head_fields": [
        {
            "name": "理由",
            "value": "二月份核销"
        }
    ],
    "budget_rows": [
        {
            "subject_code": "KM202203010001",
            "subject_name": "科目",
            "period": "2022-02",
            "dim_data": {
                "维度": "维度值"
            },
            "customer_code": "KH202203010001",
            "customer_name": "客户",
            "dealer_code": "JXS202203010001",
            "dealer_name": "经销商",
            "pd_code": "PD202203010001",
            "pd_name": "商品",
            "amount": "100.00",
            "remark": "备注",
            "pay_mode_name": "转费用池",
            "rebate_account_name": "返利账户",
            "capital_account_name": "资金池账户",
            "ext_fields": [
                {
                    "name": "理由",
                    "value": "二月份核销"
                }
            ]
        }
    ]
}
说明: 本示例仅供参考,具体以参数说明为准。

参数说明:

参数 类型 必填 说明
form_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.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

请求示例:

{
    "verificationCode": "HX2112101550",
    "verificationId": "12312412412",
    "creator": "zhanghao",
    "reverseTime": "2017-01-20 23:59:59",
    "businessDate": "2017-01-20"
}

响应示例:

{
    "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) 如果不传,则为接口传输日期

请求示例:

{
    "verify_code": "HX2112101550",
    "verify_id": "12313124124",
    "creator": "zhanghao",
    "reverse_time": "2022-01-29 10:35:47"
}

响应示例:

{
    "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": "8731929190966679987",
    "verify_code": "HX2112101550",
    "creator": "zhanghao",
    "reverse_time": "2022-01-29 10:35:47"
}

参数说明:

参数 类型 必填 说明
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

请求示例:

{
    "verify_code": "HX2112101550",
    "verify_id": "12313124124",
    "creator": "zhanghao",
    "reverse_time": "2022-01-05 10:35:47"
}

响应示例:

{
    "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

请求示例:

{
    "verify_code": "HX2112101550",
    "verify_id": "12313124124",
    "creator": "zhanghao",
    "reverse_time": "2017-01-20 23:59:59",
    "business_date": "2017-01-20"
}

响应示例:

{
    "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) 如果不传,则为接口传输日期

请求示例:

{
    "verify_code": "HX2112101550",
    "verify_id": "12313124124",
    "creator": "zhanghao",
    "reverse_time": "2017-01-20 23:59:59"
}

响应示例:

{
    "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": "CX202209196669",
    "customer_code": "CUS000012",
    "delivery_code": "DL000002",
    "order_code": "OD47999565667",
    "supplier_code": "CUS000020",
    "order_policy_code": "OPC0005900",
    "transfer_way": "2",
    "sale_amount": "100.21",
    "cost_amount": "80.56",
    "create_time": "2022-09-20 13:20:24",
    "pd_list": [
        {
            "name": "红药水",
            "is_gift": "1",
            "num":"2.2",
            "unit": "",
            "origin_amount":"60",
            "discounted_amount": "50",
            "cost_amount": "40"         
        }
    ],
    "creator_code": "xx"
}
说明: 本示例仅供参考,具体以参数说明为准。

参数说明:

参数 类型 必填 说明
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 审批意见

请求示例:

{
  "verify_code": "HX202302230009",
  "verify_id": "8492793042077160797",
  "auditor_id": "6369011522523875582",
  "auditor_code": "XXX",
  "verify_status": "1",
  "rows":[
    {
      "info_id":"7306873638940042364",
      "audit_amount":"40.00"
    },
    {
      "info_id":"7325904053459166476",
      "audit_amount":"20.00"
    }
  ],
  "opinion": "通过"
}

响应示例:

{
    "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:已打回

请求示例:

{
    "verify_code": "HX2112101550",
    "verify_id": "1231412412",
    "auditor": "zhanghao",
    "audit_time": "2022-01-20 23:59:59",
    "verify_status": "1"
}

响应示例:

{
    "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

请求示例:

{
  "verify_id": "12312312",
  "verify_code":"HX202303030003",
  "ext_head_list":[
    {
      "ext_key":"文本",
      "ext_value":"1123"
    }
  ],
  "ext_list":[
    {
      "cm_id":"4809137625405004710",
      "ext_key":"核销行人员",
      "ext_value":"1111"
    }
  ]
}

响应示例:

{
    "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

请求示例:

{
  "verify_id": "12312312",
  "verify_code":"HX202303030003",
  "ext_head_list":[
    {
      "ext_key":"文本",
      "ext_value":"1123"
    }
  ],
  "ext_list":[
    {
      "cm_id":"4809137625405004710",
      "ext_key":"人员/商品/客户",
      "ext_value":"1231312312(传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

请求示例:

{
  "verify_id": "12312312",
  "verify_code":"HX202303030003",
  "ext_head_list":[
    {
      "ext_key":"文本",
      "ext_value":"1123"
    }
  ],
  "ext_list":[
    {
      "cm_id":"4809137625405004710",
      "ext_key":"人员/商品/客户",
      "ext_value":"qweqw(传code)"

    }
  ]
}

响应示例:

{
    "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":"202306151513",
  "invoice_name": "openapi新增发票001",
  "invoice_type": "20220111165401",
  "invoice_date": "2023-06-15",
  "invoice_no": "NO-20230615001",
  "invoice_code": "CODE-20230615001",
  "drawer": "yz",
  "payee": "yz",
  "review": "yz",
  "checksum": "9527",
  "machine_number": "661905769875",
  "remark": "openapi测试发票备注001",
  "type": "1",
  "purchase_unit": {
    "taxpayer": "大大商贸",
    "tax_no": "989768671276131893",
    "address_tel": "东街19号 670003",
    "bank_account": "2023032214410001"
  },
  "sales_unit": {
    "tax_type": "1",
    "taxpayer": "EZ经销商客户",
    "tax_no": "",
    "address_tel": "水电费",
    "bank_account": "1322700987666"
  },
  "check_status":"0",
  "creator":"yangzhi",
  "create_time":"2023-06-15",
  "details": [
    {
      "sequ": "1",
      "taxable_name": "服务名称",
      "specifications":"40873",
      "unit": "箱",
      "num": 1,
      "unit_price": "20.00000000",
      "amount": "20.00",
      "tax_rate": "50",
      "tax_amount": "10",
      "total_amount": "30"
    }
  ]
}

参数说明:

参数 类型 必填 说明
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) 响应说明