API开放平台

TIP

# 费用预付接口

# 预付款申请单新增接口

接口说明：预付款申请单新增接口，适应于万能促销活动（AP/CP）场景。

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/cuxiaoPrepayment/v1/addApply/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "code": "YFK000202",
    "name": "YKFXXX",
    "account": "XXX",
    "remark": "备注",
    "details": [
      {
        "activity_code": "",
        "activity_cm_id": "",
        "prepayment_amount":"",
        "ext_fields": [
          {
            "name": "自定义文本",
            "value": "文本"
          }
        ]
      }
    ]
}
说明： 本示例仅供参考，具体以参数说明为准。

请求说明

参数 类型 必填 说明
code varchar(100) 否 预付款单号，不传时系统默认生成，必须不重复
name varchar(100) 否 预付款名称
account varchar(100) 否 经办人，账号存在且未被停用
remark varchar(4000) 否 预付款备注
details List 否 明细列表
details.activity_code varchar(32) 是 申请单号，在系统存在，且申请单审批通过
details.activity_cm_id varchar(100) 否 活动申请明细行ID，在系统存在，且对应申请单审批通过，且该行未关闭
details.prepayment_amount varchar(100) 否 预付金额
details.ext_fields varchar(100) 否 预付款行自定义字段
details.ext_fields.name varchar(100) 否 预付款行自定义字段名
details.ext_fields.value varchar(100) 否 预付款行自定义字段值

响应示例：

{
    "msg_id": "X0001",
    "return_code": 0,
    "return_msg": "预付款申请新增成功！"
}

​ ​ ​ ​ ​

# 预付款申请单红冲接口

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/cuxiaoPrepayment/v1/reverseApply/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "code": "YFK202008100001",
    "account":"XXX",
    "reverse_time": "2021-01-01 09:05:09"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
code VARCHAR(100) 是 需要进行红冲的预付款单号
account VARCHAR(100) 是 红冲人账号，此预付款单的红冲人
reverse_time VARCHAR(100) 否 单据红冲时间，如果不传，则为接口传输日期

参数说明：

{
    "return_code": 0,
    "return_msg": "",
    "msg_id": "X0001",
    "response_data": null
}
参数 说明
return_code 响应编码
return_msg 响应信息
msg_id 消息ID

# 预付款申请单查询接口

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/cuxiaoPrepayment/v1/queryList/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
  "create_from": "2021-01-10 00:00:00",
  "create_to": "2021-10-20 23:59:59",
  "modify_from": "2021-01-20 00:00:00",
  "modify_to": "2021-10-20 23:59:59",
  "prepayment_code": "YFK200112101550",
  "activity_code": "SQ202105110002",
  "flow_status": "1",
  "recent_audit_from": "2021-11-29 00:00:00",
  "recent_audit_to": "2021-11-29 23:59:59",
  "page":"1",
  "rows":"100"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
create_from VARCHAR(32) 否 创建开始时间。格式：yyyy-MM-dd HH:mm:ss
create_to VARCHAR(32) 否 创建结束时间。格式：yyyy-MM-dd HH:mm:ss
modify_from VARCHAR(32) 否 修改开始时间。格式：yyyy-MM-dd HH:mm:ss
modify_to VARCHAR(32) 否 修改结束时间。格式：yyyy-MM-dd HH:mm:ss
prepayment_code varchar 否 预付款单号
activity_code varchar 否 活动申请单号
flow_status varchar 否 审批状态。0：待审批，1：已审批，2：被打回，3：审批中
recent_audit_from varchar 否 最近审批开始时间。格式：yyyy-MM-dd HH:mm:ss
recent_audit_to varchar 否 最近审批结束时间。格式：yyyy-MM-dd HH:mm:ss
page VARCHAR(10) 否 数据页码，不填默认第一页
rows VARCHAR(10) 否 页长，默认1000

响应示例：

{
    "return_code": 0,
    "return_msg": "",
    "msg_id": "X0001",
    "response_data":"<<DATA>>"
}

数据DATA示例:

[
  {
        "prepayment_code": "YFK2023060600000008",
        "prepayment_name": "71650002",
        "create_time": "2023-06-06 14:44:42",
        "creator_account": "ns",
        "creator_name": "xx",
        "prepayment_amount": "3.00",
        "flow_status": "0",
        "auditor_account": "",
        "auditor_name": "",
        "audit_time": "",
        "reverse_status": "",
        "reverser_account": "",
        "reverser_name": "",
        "reverse_time": "",
        "operator_name": "",
        "remark": "222"
  }
]

参数说明：

参数 类型 说明
prepayment_code VARCHAR(32) 预付款单号
prepayment_name VARCHAR(32) 预付款名称
create_time VARCHAR(100) 创建时间
creator_account VARCHAR(32) 创建人账号
creator_name VARCHAR(32) 创建人姓名
prepayment_amount VARCHAR(32) 预付款金额
flow_status VARCHAR(32) 审批状态。0：待审批，1：已审批，2：被打回，3：审批中
auditor_account VARCHAR(32) 最近审批人账号
auditor_name VARCHAR(32) 最近审批人姓名
audit_time VARCHAR(32) 最近审批时间
reverse_status VARCHAR(100) 红冲状态。1：被红冲，2：红冲
reverser_account VARCHAR(100) 红冲人账号
reverser_name VARCHAR(32) 红冲人姓名
reverse_time VARCHAR(32) 红冲时间
operator_name VARCHAR(32) 经办人
remark VARCHAR(32) 预付款备注

# 预付款申请单明细查询接口

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/cuxiaoPrepayment/v1/queryDetailList/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
  "prepayment_code": "YFK2023060600000008",
  "page":"1",
  "rows":"100"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
prepayment_code VARCHAR(32) 否 预付款单号
page VARCHAR(10) 否 数据页码，不填默认第一页
rows VARCHAR(10) 否 页长，默认1000

响应示例：

{
    "return_code": 0,
    "return_msg": "",
    "msg_id": "X0001",
    "response_data":"<<DATA>>"
}

数据DATA示例:

[
  {
        "id": "7443692480703869490",
        "prepayment_code": "YFK2023061300000010",
        "activity_code": "SQ202303220075",
        "activity_cm_id": "6033516322825915357",
        "activity_cm_amount": "1.01",
        "prepaid_amount": "0.10",
        "prepayment_amount": "0.10",
        "verified_amount": "0",
        "verifying_amount": "0",
        "ext_data": {
            "商品单选": {
              "name": "红药水",
              "code": "SP202109150005",
              "id": "8100596779352169588",
              "source_code": ""
            },
            "文本2": "4",
            "文本框1": "2",
            "单选1": "选项2",
            "客户单选": {
              "name": "hts001的门店002",
              "code": "CUS000033",
              "id": "8314693660311196859",
              "source_code": ""
            }
        }
  }
]

参数说明：

参数 类型 说明
id VARCHAR(32) 预付款行ID
prepayment_code VARCHAR(32) 预付款单号
activity_code VARCHAR(32) 申请单号
activity_cm_id VARCHAR(100) 申请行明细ID
activity_cm_amount VARCHAR(32) 申请金额
prepaid_amount VARCHAR(32) 已预付金额
prepayment_amount VARCHAR(32) 预付款金额
verified_amount VARCHAR(32) 已核销预付金额
verifying_amount VARCHAR(32) 核销中预付金额
ext_data VARCHAR(32) 预付款行自定义字段

# 预付款申请单推送接口

接口说明：推送预付款申请单。当预付款申请单新建提交、修改提交、审批通过、打回、红冲时都会推送，所以对同一个预付款申请单(预付款申请单ID相同)，该接口可能会调用多次。红冲的时候，由于会再生成一个新单，所以会有两条数据，会推送两次。

注：接口参数与预付款申请单查询接口返回元素一致，若文档未更新请参考查询接口返回数据

请求方式： POST（HTTPS）
请求地址： 第三方服务接口URL

请求参数：

参数名称 参数值
msgId 消息ID
dataId 数据ID
dataVersion 接口数据版本，如：001
dataFormat 数据格式：json
dataSource 数据来源。biz：业务功能产生，api：开放接口产生
timestamp 请求时间戳，如：1503276678552
status 数据同步状态。0：数据首次同步，2：数据失败同步
statusTime 上次同步失败时间。格式：yyyy-MM-dd HH:mm:ss
tenantId 企业ID，各注册企业在勤策中对应的唯一ID
digest 数据签名，md5(data|pushsecret|timestamp)
dataType cuxiao_verify_display
data <<请求数据体>> ，说明：格式为JSON格式数据

请求示例：

{
      "prepayment_code": "YFK2023060600000008",
      "prepayment_name": "71650002",
      "create_time": "2023-06-06 14:44:42",
      "creator_account": "ns",
      "creator_name": "xx",
      "prepayment_amount": "3.00",
      "flow_status": "0",
      "auditor_account": "",
      "auditor_name": "",
      "audit_time": "",
      "reverse_status": "",
      "reverser_account": "",
      "reverser_name": "",
      "reverse_time": "",
      "operator_name": "",
      "remark": "222",
      "details": [
          {
            "id": "7443692480703869490",
            "prepayment_code": "YFK2023061300000010",
            "activity_code": "SQ202303220075",
            "activity_cm_id": "6033516322825915357",
            "activity_cm_amount": "1.01",
            "prepaid_amount": "0.10",
            "prepayment_amount": "0.10",
            "verified_amount": "0",
            "verifying_amount": "0",
            "ext_data": {
              "商品单选": {
                "name": "红药水",
                "code": "SP202109150005",
                "id": "8100596779352169588",
                "source_code": ""
              },
              "文本2": "4",
              "文本框1": "2",
              "单选1": "选项2",
              "客户单选": {
                "name": "hts001的门店002",
                "code": "CUS000033",
                "id": "8314693660311196859",
                "source_code": ""
              }
            }
          }
      ]
}

参数说明：

参数 类型 说明
prepayment_code VARCHAR(32) 预付款单号
prepayment_name VARCHAR(32) 预付款名称
create_time VARCHAR(100) 创建时间
creator_account VARCHAR(32) 创建人账号
creator_name VARCHAR(32) 创建人姓名
prepayment_amount VARCHAR(32) 预付款金额
flow_status VARCHAR(32) 审批状态。0：待审批，1：已审批，2：被打回，3：审批中
auditor_account VARCHAR(32) 最近审批人账号
auditor_name VARCHAR(32) 最近审批人姓名
audit_time VARCHAR(32) 最近审批时间
reverse_status VARCHAR(100) 红冲状态。1：被红冲，2：红冲
reverser_account VARCHAR(100) 红冲人账号
reverser_name VARCHAR(32) 红冲人姓名
reverse_time VARCHAR(32) 红冲时间
operator_name VARCHAR(32) 经办人
remark VARCHAR(32) 预付款备注
details List 明细行
details.id VARCHAR(32) 预付款行ID
details.prepayment_code VARCHAR(32) 预付款单号
details.activity_code VARCHAR(32) 申请单号
details.activity_cm_id VARCHAR(100) 申请行明细ID
details.activity_cm_amount VARCHAR(32) 申请金额
details.prepaid_amount VARCHAR(32) 已预付金额
details.prepayment_amount VARCHAR(32) 预付款金额
details.verified_amount VARCHAR(32) 已核销预付金额
details.verifying_amount VARCHAR(32) 核销中预付金额
details.ext_data VARCHAR(32) 预付款行自定义字段

参数说明：

{
    "return_code": 0,
    "return_msg": "",
    "msg_id": "X0001"
}
参数 说明
return_code 响应编码
return_msg 响应消息内容
msg_id 消息ID

# 预付款申请单删除

接口说明：推送预付款申请单。当预付款申请单删除时会调用此接口。

请求方式： POST（HTTPS）
请求地址： 第三方服务接口URL

请求参数：

参数名称 参数值
msgId 消息ID
dataId 数据ID
dataVersion 接口数据版本，如：001
dataFormat 数据格式：json
dataSource 数据来源。biz：业务功能产生，api：开放接口产生
timestamp 请求时间戳，如：1503276678552
status 数据同步状态。0：数据首次同步，2：数据失败同步
statusTime 上次同步失败时间。格式：yyyy-MM-dd HH:mm:ss
tenantId 企业ID，各注册企业在勤策中对应的唯一ID
digest 数据签名，md5(data|pushsecret|timestamp)
dataType cuxiao_prepayment_delete
data <<请求数据体>> ，说明：格式为JSON格式数据

请求示例：

{
    "prepayment_code": "YFK202105130005"
}

参数说明：

参数 类型 必填 说明
prepayment_code VARCHAR(32) 是 预付款单号

参数说明：

{
    "return_code": 0,
    "return_msg": "",
    "msg_id": "X0001"
}
参数 说明
return_code 响应编码
return_msg 响应消息内容
msg_id 消息ID

← mbo设置查询接口 →