# 促销数据同步

# 万能促销活动(TP)活动方案

接口说明:推送万能促销活动的活动方案。当万能促销活动方案新建、修改、删除、终止上报和审批通过时都推送,所以同一条记录可能会推送多次。

请求方式: 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_plan_regular_sale
data <<请求数据体>> ,说明:格式为JSON格式数据

推送包体:


{
    "plan_type":5890360826000093762,
    "code":"CX202202252489",
    "form_id":8960641880654960061,
    "description":"qww",
    "plan_amount":2,
    "plan_name":"qw",
    "flow_status":"0",
    "execute_cycle":"2022-02-25 00:00:00~2022-03-31 00:00:00",
    "pay_type":1,
    "plan_status": "1",
    "extColumns": [
                    {
                    "ext_key": "DT",
                        "ext_col": "ext_2202230054",
                        "ext_value": "2022-02-23"
                    },
                    {
                    "ext_key": "文本框12",
                        "ext_col": "ext_2201060009",
                        "ext_value": "Text"
                    }
                 ]
}

参数说明:

参数 类型 必填 说明
code VARCHAR(100) 方案编码
status VARCHAR(30) 删除状态 1-未删除,0-已删除
plan_name VARCHAR(100) 方案名称
plan_type VARCHAR(100) 方案类型
description VARCHAR(4000) 方案说明
execute_cycle VARCHAR(100) 执行周期
form_id VARCHAR(100) 上报模板id
pay_type VARCHAR(100) 支付方式
extColumns List 自定义字段集合
extColumns.ext_key VARCHAR(100) 自定义字段名称
extColumns.ext_col VARCHAR(100) 自定义字段key
extColumns.ext_value VARCHAR(4000) 自定义字段值(当字段类型为客户单选、商品单选、人员选择时,值为id)
extColumns.ext_value_code VARCHAR(100) 自定义字段值编码(当字段类型为客户单选、商品单选、人员选择时有值)
extColumns.ext_value_name VARCHAR(4000) 自定义字段值名称(当字段类型为客户单选、商品单选、人员选择时有值)
extColumns.ext_value_source_code VARCHAR(4000) 自定义字段值三方编码(当字段类型为客户单选、商品单选、人员选择时有值)
flow_status VARCHAR(32) 审批状态 0-待审批,""-已审批,1-已审批,2-已打回,3-审批中
plan_amount VARCHAR(32) 方案总金额
plan_status VARCHAR(32) 方案状态。1:执行中,2:已终止,3:未开始,4:已结束

# 万能促销活动(TP)活动申请单

接口说明:推送万能促销活动TP的活动申请单。在活动申请提交、修改申请单提交、申请单审批时都会调用,所以对同一个活动(活动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_activity_regular_sale
data <<请求数据体>> ,说明:格式为JSON格式数据

请求示例:

{
    "id": "7220535393931890408",
    "applyCode": "SQ202202240001",
    "applyTime": "2022-02-24 15:36:31",
    "formDefinedId": null,
    "activityApplyFormId": "5695285449443912311",
    "planId": "6182287019499758708",
    "planCode": "CX202202107857",
    "planName": "常规带抄送",
  	"applyName": "",
  	"parentApplyCode": "",
    "applicantCode": "qq",
    "applicant": "qq互联企业",
    "applicantId": "212312313123",
    "applicantSourceCode": "id_3rd_001",
    "modifyTime": "2022-02-24 15:54:46",
    "auditTime": null,
    "activityStatus": "0",
    "auditId": "",
    "auditCode": "",
    "auditName": "",
    "auditSourceCode": "",
    "formDataId": null,
    "subList": [
        {
            "subId": "9105241690951694484",
            "cusId": "8221721067770538823",
            "cusSourceCode": null,
            "cusName": "QQ-mendian-AAA12=name",
            "cusCode": "QQ-mendian-AAA12",
            "dealerId": null,
            "dealerCode": null,
            "dealerName": null,
            "startDate": "2022-02-10",
            "endDate": "2022-03-31",
            "giftId": null,
            "giftName": null,
            "giftCode": null,
            "giftSourceCode": null,
            "giftUnitName": null,
            "giftUnitId": null,
            "giftPrice": null,
            "giftNum": null,
          	"settlementOrgName": "",
          	"pdRangeType": "",
          	"pdTypesName": "",
          	"pdBrandsName": "",
            "applyAmount": "10.00",
            "pdSalesVolume": null,
            "pdSale": null,
            "dealerSourceCode": null,
            "pdIds": "",
          	"pdCodes": "",
          	"pdSourceCodes": "",
            "pdUnitId": null,
            "pdUnitName": null,
            "pdSalesAmount": null,
            "payType": "现金",
            "subject": null,
          	"subjectCode":"",
            "period": null,
            "dimJson": null,
            "remark": "",
            "status": "1",
          	"itemName":"",
          	"inputStandard":"",
          	"inputNum":"",
          	"joinCmNum":"5",
            "extColumns": [
                {
                    "ext_key": "DT",
                    "ext_col": "ext_2202230054",
                    "ext_value": "2022-02-23"
                },
                {
                    "ext_key": "文本框12",
                    "ext_col": "ext_2201060009",
                    "ext_value": "Text"
                },
                {
                    "ext_key": "数值框1",
                    "ext_col": "ext_2201060010",
                    "ext_value": "123"
                },
                {
                    "ext_key": "人员选择",
                    "ext_col": "ext_2201060011",
                    "ext_value": "241241231235",
                    "ext_value_code": "zhangsan",
                    "ext_value_name": "张三",
                    "ext_value_source_code": "张三"
                },
                {
                    "ext_key": "日期12",
                    "ext_col": "ext_2201060012",
                    "ext_value": "2022-02-24"
                },
                {
                    "ext_key": "多选12",
                    "ext_col": "ext_2201060013",
                    "ext_value": "选项1#选项3"
                },
                {
                    "ext_key": "下拉12",
                    "ext_col": "ext_2201060014",
                    "ext_value": "B"
                }
            ],
            "dimInfoList":[
                    {
                        "dimName":"岗位",
                        "dimCode":"WD0005",
                        "dimValCode":"021",
                        "dimValName":"QQ岗位"
                    }
                ]
        }
    ]
}

参数说明:

参数 类型 必填 说明
id VARCHAR(32) 申请单id
applyCode VARCHAR(32) 申请单编号
applicant VARCHAR(32) 申请人姓名
applicantCode VARCHAR(32) 申请人账号
applicantId VARCHAR(32) 申请人id
applicantSourceCode VARCHAR(32) 申请人三方id
applyTime VARCHAR(32) 申请创建时间。格式:yyyy-MM-dd HH:mm:ss
projectCode VARCHAR(32) 项目编码,按项目申请时有值
projectName VARCHAR(100) 项目名称,按项目申请时有值
planId VARCHAR(32) 方案id
planCode VARCHAR(100) 方案编码
planName VARCHAR(100) 方案名称
projectApplyCode VARCHAR(32) 项目申请批号,按项目申请时有值
applyName VARCHAR(100) 申请名称
parentApplyCode VARCHAR(32) 父申请单号
modifyTime VARCHAR(32) 最近修改时间。格式:yyyy-MM-dd HH:mm:ss
auditId VARCHAR(100) 最近审批人ID
auditCode VARCHAR(100) 最近审批人员工账号
auditName VARCHAR(100) 最近审批人姓名
auditSourceCode VARCHAR(100) 最近审批人对应第三方系统的ID
auditTime VARCHAR(32) 最新审批时间。格式:yyyy-MM-dd HH:mm:ss
extColumns List 申请单自定义字段集合
extColumns.ext_key VARCHAR(100) 申请单自定义字段名称
extColumns.ext_col VARCHAR(100) 申请单自定义字段key
extColumns.ext_value VARCHAR(4000) 申请单自定义字段值(当字段类型为客户单选、商品单选、人员选择时 其值为id
extColumns.ext_value_code VARCHAR(100) 申请单自定义字段值编码(当字段类型为客户单选、商品单选、人员选择时有值)
extColumns.ext_value_name VARCHAR(4000) 申请单自定义字段值名称(当字段类型为客户单选、商品单选、人员选择时有值)
extColumns.ext_value_source_code VARCHAR(4000) 申请单自定义字段值三方id(当字段类型为客户单选、商品单选、人员选择时有值)
formDefinedId VARCHAR(32) 申请叠加表单模板ID
formDataId VARCHAR(32) 申请叠加表单数据ID
activityStatus VARCHAR(32) 审批状态:0:待审批,1:已审批,2:已打回,3:审批中
subList.extColumns List
subList.extColumns.ext_key VARCHAR(100) 自定义字段名称
subList.extColumns.ext_col VARCHAR(100) 自定义字段key
subList.extColumns.ext_value VARCHAR(4000) 自定义字段值
subList.extColumns.ext_value_code VARCHAR(100) 自定义字段值编码(当字段类型为客户单选、商品单选、人员选择时有值)
subList.extColumns.ext_value_name VARCHAR(4000) 自定义字段值名称(当字段类型为客户单选、商品单选、人员选择时有值)
subList List
subList.subId VARCHAR(32) 客户申请明细ID
subList.cusId VARCHAR(32) 客户id
subList.cusSourceCode VARCHAR(100) 客户SOURCE_CODE
subList.cusCode VARCHAR(100) 客户编码
subList.cusName VARCHAR(100) 客户名称
subList.dealerId VARCHAR(32) 费用代垫经销商ID
subList.dealerSourceCode VARCHAR(100) 费用代垫经销商SOURCE_CODE
subList.dealerCode VARHCAR(100) 费用代垫经销商编码
subList.dealerName VARCHAR(100) 费用代垫经销商
subList.cmManagerId VARCHAR(100) 费用负责人id
subList.cmManagerName VARCHAR(100) 费用负责人姓名
subList.cmManagerCode VARCHAR(100) 费用负责人账号
subList.cmManagerSourceCode VARCHAR(100) 费用负责人三方id
subList.cmManagerDept VARCHAR(100) 费用负责人部门名称
subList.startDate VARHCAR(32) 客户行活动开始时间。格式:yyyy-MM-dd
subList.endDate VARCHAR(32) 客户行活动结束时间。格式:yyyy-MM-dd
subList.pdIds VARCHAR(1000) 活动商品ID(支持多个,用英文下逗号分隔)
subList.pdCodes VARCHAR(1000) 活动商品编码(支持多个,用英文下逗号分隔)
subList.pdSourceCodes VARCHAR(1000) 活动商三方编码(支持多个,用英文下逗号分隔)
subList.pdUnitId VARCHAR(32) 商品单位ID
subList.pdUnitName VARCHAR(100) 商品单位
subList.pdSale VARCHAR(32) 商品售价
subList.pdSalesVolume VARCHAR(32) 预计销量
subList.pdSalesAmount VARCHAR(32) 预计销售额
subList.giftId VARCHAR(32) 赠品ID
subList.giftName VARCHAR(32) 赠品名称
subList.giftCode VARCHAR(32) 赠品编码
subList.giftSourceCode VARCHAR(32) 赠品三方id
subList.giftUnitId VARCHAR(32) 赠品单位ID
subList.giftUnitName VARCHAR(100) 赠品单位
subList.giftPrice VARCHAR(32) 赠品价格
subList.giftNum VARCHAR(32) 赠品数量
subList.exeRequire VARCHAR(100) 执行要求
subList.settlementOrgId VARCHAR(32) 结算单位id
subList.settlementOrgCode VARCHAR(32) 结算单位编码
subList.settlementOrgName VARCHAR(100) 结算单位
subList.settlementOrgSourceCode VARCHAR(100) 结算单位三方id
subList.pdRangeType VARCHAR(32) 活动商品范围:0-和方案的活动商品一致 1-指定商品类型或品牌 2-指定具体商品
subList.pdTypesName VARCHAR(4000) 活动商品类型(多个用英文下逗号分隔)
subList.pdBrandsName VARCHAR(4000) 活动品牌(多个用英文下逗号分隔)
subList.cmReceiveId VARCHAR(32) 收货方id
subList.cmReceiveCode VARCHAR(32) 收货方编码
subList.cmReceiveName VARCHAR(100) 收货方名称
subList.cmReceiveSourceCode VARCHAR(100) 收货方第三方id
subList.applyAmount VARCHAR(32) 申请金额
subList.subject VARCHAR(100) 科目名称
subList.subjectCode VARVHAR(100) 科目编码
subList.period VARCHAR(32) 期间
subList.payType VARCHAR(100) 支付方式
subList.remark VARCHAR(4000) 备注
subList.itemName VARCHAR(100) 付费项目名称
subList.inputNum VARCHAR(32) 投放数量
subList.inputStandard VARCHAR(32) 单位投放标准
subList.joinCmNum VARCHAR(32) 参与客户数
subList.extColumns List
subList.extColumns.ext_key VARCHAR(100) 申请行自定义字段名称
subList.extColumns.ext_col VARCHAR(100) 申请行自定义字段key
subList.extColumns.ext_value VARCHAR(4000) 申请行自定义字段值(当字段类型为客户单选、商品单选、人员选择时 其值为id)
subList.extColumns.ext_value_code VARCHAR(100) 申请行自定义字段值编码(当字段类型为客户单选、商品单选、人员选择时有值)
subList.extColumns.ext_value_name VARCHAR(4000) 申请行自定义字段值名称(当字段类型为客户单选、商品单选、人员选择时有值)
subList.extColumns.ext_value_source_code VARCHAR(4000) 申请行自定义字段值三方id(当字段类型为客户单选、商品单选、人员选择时有值)
subList.dimInfoList List 维度维值信息集合
subList.dimInfoList.dimCode VARCHAR(100) 维度编码
subList.dimInfoList.dimName VARCHAR(100) 维度名称
subList.dimInfoList.dimValCode VARCHAR(100) 维值编码
subList.dimInfoList.dimValName VARCHAR(100) 维值名称
subList.status VARCHAR(32) 删除状态 0-删除 1-未删除

参数说明:

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

# 万能促销活动(TP)申请单删除

接口说明:用户在365中删除万能促销活动TP申请单时会调用此接口。

请求方式: 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_activity_delete_regular_sale
data <<请求数据体>> ,说明:格式为JSON格式数据

请求示例:

{
    "activity_id": "1458948793149090911"
}

参数说明:

参数 类型 必填 说明
activity_id VARCHAR(32) 活动ID

参数说明:

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

# 万能促销活动(TP)申请单明细删除

接口说明:用户在活动方案中删除申请明细时会调用此接口。

请求方式: 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_cm_remove_regular
data <<请求数据体>> ,说明:格式为JSON格式数据

请求示例:

{
    "planId": "1459948793149090911",
    "removeCm": ["0268357183552766140"],
    "removeInfos": [{
      "cmId": "0268357183552766140",
      "cmCode": "CUS0022912",
      "cmName": "客户1",
      "cmSourceCode": "source_code_192378"
    }],
    "removeActivityCmIds":["1489357183552766140"],
    "reason": "错误理由",
    "removeTime": "2015-11-16 13: 50: 18",
    "userId": "6288027684278203306",
    "userName": "张三"
}

参数说明:

参数 类型 必填 说明
planId Int8 方案ID
removeCm List 移除的客户ID
removeCmInfos List 移除的客户详情
removeCmInfos.cmId VARCHAR(100) 移除的客户id
removeCmInfos.cmCode VARCHAR(100) 移除的客户编码
removeCmInfos.cmName VARCHAR(100) 移除的客户名称
removeCmInfos.cmSourceCode VARCHAR(100) 移除的客户三方id
removeActivityCmIds List 移除的申请明细行ID
reason VARCHAR(4096) 移除理由
removeTime VARCHAR(32) 操作时间。格式:yyyy-MM-dd HH:mm:ss
userId Int8 操作人ID
userName VARCHAR(100) 操作人姓名
userCode VARCHAR(100) 操作人编码
userSourceCode VARCHAR(100) 操作人三方编码

参数说明:

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

# 万能促销活动(TP)活动上报记录

接口说明:推送万能促销活动的活动上报记录。当万能促销活动上报记录提交、记录评价和复评都推送,所以同一条上报记录可能会推送多次。

请求方式: 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_report_regular_sale
data <<请求数据体>> ,说明:格式为JSON格式数据

请求示例:

{
      "id": "6309024315330045514",
      "code": "JCF202111113454",
      "plan_name":"方案名称",
      "activity_cus_id": "4789759081208984580",
      "cm_id": "7345266233482427241",
      "cm_name": "小店87",
      "cm_code": "CUS000087",
      "cm_source_code": "",
      "record_id": "6858701150506850097",
      "sye_id": "7573427476093814157",
      "source_code": "",
      "sye_name": "xwj14",
      "sye_code": "xwj14",
      "arrive_lla": "江苏省南京市建邺区荷塘路",
      "arrive_pos_offset": "",
      "comment_status": "未评价",
      "record_sys_id": "",
      "record_source_code": "",
      "record_sys_name": "",
      "record_sys_code": "",
      "comment_time": "",
      "comment_text": "",
      "re_comment_status": "未评价",
      "re_comment_text": "",
      "re_record_sys_id": "",
      "re_record_source_code": "",
      "re_record_sys_name": "",
      "re_record_sys_code": "",
      "re_comment_time": "",
      "visit_implement_id": "",
      "form_define_id": "5351617790943416943",
      "data_id": "5510726260281485832",
      "record_time": "2021-11-17 16:24:02",
      "status": "1",
      "ai_status": "0"
    }

参数说明:

参数 类型 必填 说明
id VARCHAR(32) 方案id
code VARCHAR(100) 方案编码
plan_name VARCHAR(100) 方案名称
activity_cus_id VARCHAR(32) 活动申请明细ID
cm_id VARCHAR(32) 客户ID
cm_name VARCHAR(200) 客户名称
cm_code VARCHAR(32) 客户编码
cm_source_code VARCHAR(32) 客户source_code
record_id VARCHAR(32) 上报记录ID
sye_id VARCHAR(32) 上报人ID(勤策的ID)
source_code VARCHAR(32) 上报人唯一标识(source_code)
sye_name VARCHAR(100) 上报人姓名
sye_code VARCHAR(100) 上报人编码
arrive_lla VARCHAR(200) 上报地标信息。纠偏后的定位数据转换得到的地标信息
arrive_pos_offset NUMERIC(20,2) 和客户的偏差距离(米)。纠偏后的位置和客户纠偏后的位置的差值,当客户位置为空时,偏差距离为空
record_audit_form_id VARCHAR(32) 评价表单模板ID
comment_status VARCHAR(32) 初评状态(未评价/合格/不合格)
record_sys_id VARCHAR(32) 初评人ID(勤策的ID)
record_sys_code VARCHAR(100) 评价人编码
record_source_code VARCHAR(32) 初评人唯一标识(source_code)
record_sys_name VARCHAR(100) 初评人姓名
comment_time VARCHAR(32) 初评时间 (yyyy-MM-dd HH:mm:ss)
comment_text VARCHAR(100) 初评意见
first_comment_data_id VARCHAR(32) 初评表单数据ID
re_comment_status VARCHAR(32) 复评状态(未评价/合格/不合格)
re_comment_text VARCHAR(100) 复评意见
re_record_sys_id VARCHAR(32) 复评人ID(勤策的ID)
re_record_source_code VARCHAR(32) 复评人唯一标识(source_code)
re_record_sys_name VARCHAR(100) 复评人姓名
re_record_sys_code VARCHAR(100) 复评人编码
re_comment_time VARCHAR(32) 复评时间 (yyyy-MM-dd HH:mm:ss)
re_comment_data_id VARCHAR(32) 复评表单数据ID
visit_implement_id VARCHAR(32) 拜访记录ID
form_define_id VARCHAR(32) 上报表单模板ID
data_id VARCHAR(32) 上报表单数据ID
record_time VARCHAR(32) 上报时间 (yyyy-MM-dd HH:mm:ss)
status VARCHAR(32) 删除状态。0:删除,1:正常
ai_status VARCHAR(32) AI评价结果。0:不合格,1:合格

参数说明:

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

# 万能促销活动(TP)活动检核记录

接口说明:推送万能促销活动的活动检核记录,当万能促销活动检核提交时推送。

请求方式: 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_check_record_regular_sale
data <<请求数据体>> ,说明:格式为JSON格式数据

请求示例:

{
  "plan_id": "6445147899449803186",
  "plan_code": "CX202312048362",
  "plan_name": "",
  "activity_id": "9000198688039876999",
  "activity_code": "SQ202301060003",
  "activity_name": "",
  "detail_id": "4633868379900151647",
  "record_id": "5241891625803771680",
  "check_status": "1",
  "check_reason": "",
  "create_time": "2023-06-28 11:18:36",
  "emp_id": "6612621181315705500",
  "emp_source_code": "",
  "emp_name": "张三",
  "emp_code": "zhangsan",
  "cm_id": "5648775155194538306",
  "cm_source_code": "",
  "cm_name": "",
  "cm_code": "",
  "visit_implement_id": "7127420880237049147",
  "check_data_id": "5527536066870713568",
  "check_form_id": "5169892863426871104"
}

参数说明:

参数 类型 必填 说明
plan_id VARCHAR(32) 活动方案ID
plan_code VARCHAR(32) 活动方案编码
plan_name VARCHAR(32) 活动方案名称
activity_id VARCHAR(32) 申请单ID
activity_code VARCHAR(100) 申请单号
activity_name VARCHAR(32) 申请名称
detail_id VARCHAR(32) 申请明细ID
record_id VARCHAR(32) 检核记录ID
check_status CHAR(1) 检核状态。0:不合格,1:合格
check_reason VARCHAR(1000) 不合格理由
create_time VARCHAR(32) 创建时间。格式:yyyy-MM-dd HH:mm:ss
emp_id VARCHAR(32) 创建人ID(勤策的ID)
emp_source_code VARCHAR(100) 创建人唯一标识(source_code)
emp_name VARCHAR(32) 创建人姓名
emp_code VARCHAR(32) 创建人编码
cm_id VARCHAR(32) 客户(门店)ID(勤策的ID)
cm_source_code VARCHAR(200) 客户(门店)唯一标识(source_code)
cm_name VARCHAR(200) 客户(门店)名称
cm_code VARCHAR(200) 客户(门店)编码
visit_implement_id VARCHAR(32) 拜访记录ID
check_data_id VARCHAR(32) 检核表单数据ID
check_form_id VARCHAR(32) 检核表单ID

参数说明:

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

# 万能促销活动(AP/CP)申请单

接口说明:推送“万能促销活动(AP/CP)”场景的活动申请单。在活动申请提交、修改申请单提交、申请单审批时都会调用,所以对同一张申请单(申请单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_activity_ap_cp
data <<请求数据体>> ,说明:格式为JSON格式数据

请求示例:

{
    "applyFormName":"申请单模板AAA",
    "activityId":"5460676379219624403",
    "activityCode":"SQ2931892831",
    "applicantCode": "shun",
    "applicantName":"顺",
    "applyTime":"2022-02-11 15:36:06",
    "modifyTime":"2022-02-11 15:36:06",
    "auditTime":"2022-02-11 15:36:06",
    "activityStatus":"1",
    "auditId": "",
    "auditCode": "",
    "auditName": "",
    "auditSourceCode": "",
    "status":"1",
    "applyName":"申请名称AAA",
    "managerCode":"hts",
    "cmCode":"cuz001",
    "cmName":"客户001",
    "supplierCode":"sup001",
    "supplierName":"供应商001",
    "holdAddress":"上海",
    "areaCode":"area001",
    "areaName":"活动场地001",
    "dealerCode":"cuz100",
    "dealerName":"经销商100",
    "startDate":"2023-05-01",
    "endDate":"2023-05-31",
    "expectArriveNum":"10",
    "pdNames":"商品001,商品002",
    "pdCodes":"pd001,pd002",
    "pdUnitName":"瓶",
    "activityPrice":"21.99",
    "pdSalesVolume":"2100.00",
    "pdSalesAmount":"100",
    "assignFormId":"54123128471131403",
    "formDataId":"74718361488193105",
    "extColumns": [
                {
                  "ext_key": "DT",
                    "ext_col": "ext_2202230054",
                    "ext_value": "2022-02-23"
                },
                {
                  "ext_key": "文本框12",
                    "ext_col": "ext_2201060009",
                    "ext_value": "2113aaa"
                },
                 {
                   "ext_key": "人员单选01",
                    "ext_col": "ext_2201062918",
                    "ext_value": "8982234750855725016",
                    "ext_value_name": "黄体顺",
                    "ext_value_code": "hts",
                    "ext_value_source_code": "hts"
                 }
            ],
    "subList": [
                 {
                   "activityCmId": "7135551781356453533",
                   "cmCode":"cuz001",
                   "cmName":"客户001",
                   "supplierCode":"sup001",
                   "supplierName":"供应商001",
                   "areaCode":"area001",
                   "areaName":"活动场地001",
                   "dealerCode":"cuz100",
                   "dealerName":"经销商100",
                   "holdAddress":"上海",
                   "startDate":"2023-05-01",
                   "endDate":"2023-05-31",
                   "applyAmount": "2.00",
                   "subjectName": "KM001",
                   "subjectCode": "科目001",
                   "period": "2023-01",
                   "dimJson": "[{\"dim_post_code\":\"021\",\"dim_post\":\"6113071556135396461\",\"dim_post_name\":\"QQ岗位\"}]",
                   "payType":"现金",
                   "remark": "备注信息",
                  "extColumns": [
                                   {
                                     "ext_key": "DT",
                                       "ext_col": "ext_2202230054",
                                       "ext_value": "2022-02-23"
                                   },
                                   {
                                     "ext_key": "文本框12",
                                       "ext_col": "ext_2201060009",
                                       "ext_value": "2113aaa"
                                   },
                                    {
                                      "ext_key": "人员单选01",
                                       "ext_col": "ext_2201062918",
                                       "ext_value": "8982234750855725016",
                                       "ext_value_name": "黄体顺",
                                       "ext_value_code": "hts"
                                    }
                               ],
                   "dimInfoList":[
                       {
                           "dimName":"岗位",
                           "dimCode":"WD0005",
                           "dimValCode":"021",
                           "dimValName":"QQ岗位"
                       }
                   ]
                 }
               ]
}

参数说明:

参数 类型 必填 说明
applyFormName VARCHAR(100) 申请单模板名称
activityId VARCHAR(32) 申请单ID
activityCode VARCHAR(32) 申请单号
applicantId VARCHAR(32) 申请人id
applicantCode VARCHAR(32) 申请人登录账号
applicantName VARCHAR(100) 申请人姓名
applicantSourceCode VARCHAR(100) 申请人三方id
applyTime VARCHAR(32) 申请单创建时间。格式:yyyy-MM-dd HH:mm:ss
modifyTime VARCHAR(32) 最近修改时间。格式:yyyy-MM-dd HH:mm:ss
auditId VARCHAR(100) 最近审批人ID
auditCode VARCHAR(100) 最近审批人员工账号
auditName VARCHAR(100) 最近审批人姓名
auditSourceCode VARCHAR(100) 最近审批人对应第三方系统的ID
auditTime VARCHAR(32) 最近审批时间。格式:yyyy-MM-dd HH:mm:ss
activityStatus VARCHAR(32) 审批状态。0:待审批,1:已审批,2:已打回,3:审批中,4:已作废
status CHAR(1) 删除状态:0-是 1-否
applyName VARCHAR(100) 申请名称
managerId VARCHAR(32) 负责人id
managerName VARCHAR(32) 负责人姓名
managerSourceCode VARCHAR(32) 负责人三方id
managerCode VARCHAR(32) 负责人登录账号
cmId VARCHAR(32) 客户id
cmCode VARCHAR(32) 客户编码
cmSourceCode VARCHAR(32) 客户三方id
cmName VARCHAR(100) 客户姓名
areaCode VARCHAR(32) 活动场地编码
areaName VARCHAR(100) 活动场地名称
dealerId VARCHAR(32) 费用代垫经销商id
dealerCode VARCHAR(32) 费用代垫经销商编码
dealerName VARCHAR(100) 费用代垫经销商名称
dealerSourceCode VARCHAR(100) 费用代垫经销商三方编码
supplierId VARCHAR(32) 供应商id
supplierCode VARCHAR(32) 供应商编码
supplierName VARCHAR(100) 供应商名称
supplierSourceCode VARCHAR(100) 供应商三方id
holdAddress VARCHAR(100) 举办地址
startDate VARCHAR(100) 执行开始日期。格式:YYYY-MM-DD
endDate VARCHAR(100) 执行结束日期。格式:YYYY-MM-DD
expectArriveNum VARCHAR(32) 预计到场人数
pdCodes VARCHAR(100) 活动商品编码多选用,分隔
pdNames VARCHAR(100) 活动商品名称多选用,分隔
pdSourceCodes VARCHAR(100) 活动商品三方id多选用,分隔
pdUnitName VARCHAR(100) 商品单位名称
activityPrice VARCHAR(32) 活动价
pdSalesAmount VARCHAR(32) 预计销售额
pdSalesVolume VARCHAR(32) 预计销量
assignFormId VARCHAR(32) 申请叠加表单模板ID
formDataId VARCHAR(32) 申请叠加表单数据ID
extColumns List 申请单自定义字段集合
extColumns.ext_key VARCHAR(100) 申请单自定义字段名称
extColumns.ext_col VARCHAR(100) 申请单自定义字段key
extColumns.ext_value VARCHAR(4000) 申请单自定义字段值
extColumns.ext_value_code VARCHAR(100) 自定义字段值编码(当字段类型为客户单选、商品单选、人员选择时有值)
extColumns.ext_value_name VARCHAR(100) 自定义字段值名称(当字段类型为客户单选、商品单选、人员选择时有值)
subList List 列表
subList.activityCmId VARCHAR(32) 客户申请明细ID
subList.cmId VARCHAR(32) 客户id
subList.cmCode VARCHAR(32) 客户编码
subList.cmName VARCHAR(100) 客户姓名
subList.cmSourceCode VARCHAR(100) 客户三方id
subList.areaCode VARCHAR(32) 活动场地编码
subList.areaName VARCHAR(100) 活动场地名称
subList.dealerId VARCHAR(32) 费用代垫经销商id
subList.dealerCode VARCHAR(32) 费用代垫经销商编码
subList.dealerName VARCHAR(100) 费用代垫经销商名称
subList.dealerSourceCode VARCHAR(100) 费用代垫经销商三方id
subList.supplierId VARCHAR(32) 供应商id
subList.supplierCode VARCHAR(32) 供应商编码
subList.supplierSourceCode VARCHAR(32) 供应商三方id
subList.holdAddress VARCHAR(32) 举办地址
subList.supplierName VARCHAR(100) 供应商名称
subList.startDate VARCHAR(100) 执行开始日期。格式:YYYY-MM-DD
subList.endDate VARCHAR(100) 执行结束日期。格式:YYYY-MM-DD
subList.payModeName VARCHAR(100) 支付方式名称
subList.remark VARCHAR(4000) 备注
subList.subjectName VARCHAR(100) 预算科目名称
subList.subjectCode VARCHAR(100) 预算科目编码
subList.period VARCHAR(32) 预算期间
subList.applyAmount VARCHAR(32) 申请金额
subList.extColumns List 申请单自定义字段集合
subList.extColumns.ext_key VARCHAR(100) 申请行自定义字段名称
subList.extColumns.ext_col VARCHAR(100) 申请行自定义字段key
subList.extColumns.ext_value VARCHAR(4000) 申请行自定义字段值
subList.extColumns.ext_value_code VARCHAR(100) 自定义字段值编码(当字段类型为客户单选、商品单选、人员选择时有值)
subList.extColumns.ext_value_name VARCHAR(100) 自定义字段值名称(当字段类型为客户单选、商品单选、人员选择时有值)
subList.extColumns.ext_value_source_code VARCHAR(100) 自定义字段值三方id(当字段类型为客户单选、商品单选、人员选择时有值)
subList.dimJson VARCHAR(32) 维度json
subList.dimInfoList List 维度维值信息集合
subList.dimInfoList.dimCode VARCHAR(100) 维度编码
subList.dimInfoList.dimName VARCHAR(100) 维度名称
subList.dimInfoList.dimValCode VARCHAR(100) 维值编码
subList.dimInfoList.dimValName VARCHAR(100) 维值名称
subList.status VARCHAR(32) 删除状态 0-删除 1-未删除

参数说明:

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

# 万能促销活动(AP/CP)上报记录

接口说明:推送万能促销活动(AP/CP)场景的上报记录。在上报记录提交、修改上报记录提交、删除上报记录、初评和复评时都会调用,所以对同一条上报记录,该接口可能会调用多次。

请求方式: 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_report_ac
data <<请求数据体>> ,说明:格式为JSON格式数据

请求示例:

{
  "comment_time": "2023-06-28 11:18:36",
  "re_comment_status": "合格",
  "last_modify_time": null,
  "re_comment_user_id": "9000198688039876999",
  "re_comment_user_name": "zt",
  "reporter_name": "小明",
  "reporter_code": "ssl",
  "reporter_id": "5241891625803771680",
  "activity_id": 5992791736592753121,
  "re_comment_user_source_code": null,
  "re_comment_text": "111122233",
  "report_form_template_id": "6612621181315705500",
  "re_comment_user_code": "zt",
  "comment_text": "1111222",
  "address": "江苏省南京市玄武区北京东路42-2号",
  "reporter_source_code": null,
  "address_dev": 7099289.000000,
  "comment_user_id": "9000198688039876999",
  "comment_user_code": "zt",
  "comment_status": "合格",
  "apply_line_id": 5527536066870713568,
  "report_form_data_id": "5169892863426871104",
  "comment_user_source_code": null,
  "comment_user_name": "zt",
  "report_time": "2023-06-27 14:38:51",
  "report_id": "7590946101051059800",
  "re_comment_time": "2023-06-28 11:19:12",
  "status": "1"
}

参数说明:

参数 类型 必填 说明
report_id VARCHAR(32) 上报记录ID
report_time VARCHAR(32) 上报时间
reporter_id VARCHAR(32) 上报人ID
reporter_code VARCHAR(32) 上报人账号
reporter_name VARCHAR(100) 上报人姓名
reporter_source_code VARCHAR(32) 上报人对应外部数据ID
report_form_template_id VARCHAR(32) 上报表单模板ID
report_form_data_id VARCHAR(100) 上报表单数据ID
last_modify_time VARCHAR(32) 最近修改时间
status VARCHAR(32) 删除状态。0:删除,1:正常
address VARCHAR(200) 上报地标信息。纠偏后的定位数据转换得到的地标信息
address_dev NUMERIC(20,2) 偏差距离(米)。优先和活动场地的位置比对,当活动场地和客户位置都为空时,偏差距离为空
activity_id VARCHAR(32) 申请单ID
apply_line_id VARCHAR(32) 申请明细ID
comment_time VARCHAR(32) 初评时间。格式:yyyy-MM-dd HH:mm:ss
comment_user_id VARCHAR(32) 初评人ID
comment_user_code VARCHAR(32) 初评人账号
comment_user_name VARCHAR(100) 初评人姓名
comment_user_source_code VARCHAR(100) 初评人对应外部数据ID
comment_status VARCHAR(32) 初评结果
comment_text VARCHAR(100) 初评意见
re_comment_time VARCHAR(32) 复评时间。格式:yyyy-MM-dd HH:mm:ss
re_comment_user_id VARCHAR(32) 复评人ID
re_comment_user_code VARCHAR(32) 初评人账号
re_comment_user_name VARCHAR(100) 复评人姓名
re_comment_user_source_code VARCHAR(100) 复评人对应外部数据ID
re_comment_status VARCHAR(32) 复评结果
re_comment_text VARCHAR(100) 复评意见

参数说明:

{
    "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_plan_tasting
data <<请求数据体>> ,说明:格式为JSON格式数据

推送包体:

{
        "end_date":"2021-11-12",
        "record_form_name":"上报模板-单行文本",
        "plan_type":"品鉴会类型",
        "code":"CX202110091116",
        "flow_status":"0",
        "name":"tasting-t-1",
        "description":"A",
        "id":"9157715392064344233",
        "exts":[
            {
                "ext_key":"多选必填启用默认BC",
                "ext_value":"B#C"
            },
            {
                "ext_key":"日期必填启用",
                "ext_value":"2021-10-09"
            }
        ],
        "start_date":"2021-10-09",
        "status":"1",
        "plan_status": "1"
    }

参数说明:

参数 类型 必填 说明
id VARCHAR(32) 方案id
code VARCHAR(100) 方案编码
name VARCHAR(100) 方案名称
description VARCHAR(4000) 方案说明
plan_type VARCHAR(100) 方案类型
record_form_name VARCHAR(100) 上报模板名称
start_date VARCHAR(32) 方案执行开始日期。格式:yyyy-MM-dd HH:mm:ss
end_date VARCHAR(32) 方案执行结束日期。格式:yyyy-MM-dd HH:mm:ss
exts List 方案扩展字段列表
exts.ext_key VARCHAR(32) 方案扩展字段key值
exts.ext_value TEXT 方案扩展字段value值
status VARCHAR(1) 删除状态。0:已删除,1:正常
flow_status VARCHAR(1) 审批状态。9:待提交,0:处理中,1:已批准,2:已打回,3:审批中
plan_status VARCHAR(32) 方案状态。1:执行中,2:已终止,3:未开始,4:已结束

# 品鉴会申请记录

接口说明:在品鉴会申请提交、申请单修改提交、申请单删除、申请单审批、在活动方案中删除申请记录、在手机端活动执行-申请列表中移除品鉴会时会调用此接口

请求方式: 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_apply_record_tasting
data <<请求数据体>> ,说明:格式为JSON格式数据

请求示例:

{
		"hostTime": "中午",
		"hostName": "啊啊啊是",
		"dealerCode": "CUS000054",
		"feastEndDate": "2022_04_10",
		"planName": "hts-宴席",
		"customerCode": "CUS010305",
		"remark": "阿萨",
		"applyRecordCode": "SQ202204130004",
		"activityPdList": [
			{
				"productCode": "1001000097",
				"productId": "513215312317853432",
				"productSourceCode": "1001000097",
				"useTypeName": "公司赞助",
				"basicUnit": "件",
				"applyNum": 3,
				"productName": "BC端宴会==码中台"
			}
		],
		"deleteStatus": "1",
		"customerId": "6806582156885106531",
		"extFieldsInfo": "[{\"column\":\"自定义字段名\",\"key\":\"ext_2203280067\",\"value\":\"hhh\"}]",
		"applicantId": "7002401310724831087",
		"approvalStatus": "1",
		"feastType": "公司年会",
		"dealerName": "法人刘昭",
		"executorId": "8717688507269859633",
		"dealerId": "5102106230943924527",
		"applicantName": "shun",
		"applicantCode": "shun",
		"applicantSourceCode": "shun",
		"applyRecordId": "7719558126269131824",
		"planCode": "CX202204133826",
		"feastStartDate": "2022_04_07",
		"hostContact": "13689748942",
		"customerName": "0529测试三要素",
		"customerSourceCode": "sourceCode001",
		"executorName": "安安01",
		"executorCode": "anan01",
		"executorSourceCode": "anan01_sourcecode",
		"createTime": "2022_04-13 14:26:39",
    	"auditId": "",
    	"auditCode": "",
    	"auditName": "",
    	"auditSourceCode": "",
		"auditTime": "2022_04-14 09:52:25",
		"lastModifyTime": "2022_04-14 09:52:25",
		"hostAddress": "aaaa",
		"predictJoinNum": 2
	}

参数说明:

参数 类型 必填 说明
applyRecordId VARCHAR(32) 申请记录ID
applyRecordCode VARCHAR(100) 申请单号
applicantId VARCHAR(32) 申请人ID
applicantName VARCHAR(100) 申请人名称
applicantCode VARCHAR(100) 申请人编码
applicantSourceCode VARCHAR(100) 申请人三方id
createTime VARCHAR(32) 创建时间。格式:yyyy-mm-dd hh24:mi:ss
auditId VARCHAR(100) 最近审批人ID
auditSourceCode VARCHAR(100) 最近审批人对应第三方系统的ID
auditCode VARCHAR(100) 最近审批人员工账号
auditName VARCHAR(100) 最近审批人姓名
auditTime VARCHAR(32) 最近审批时间。格式:yyyy-mm-dd hh24:mi:ss
lastModifyTime VARCHAR(32) 最近修改时间。格式:yyyy-mm-dd hh24:mi:ss
approvalStatus VARCHAR(32) 审批状态。0:待审批,1:已审批,2:已打回,3:审批中,4:已作废
deleteStatus VARCHAR(32) 删除状态。1:未删除,0:已删除
planCode VARCHAR(100) 方案编码
planName VARCHAR(100) 方案名称
customerId VARCHAR(32) 客户ID
customerCode VARCHAR(100) 客户编码
customerName VARCHAR(100) 客户名称
customerSourceCode VARCHAR(100) 客户三方id
customerAddr VARCHAR(1000) 客户地址
hotelName VARCHAR(100) 酒店名称
hotelAddress VARCHAR(100) 酒店地址
hotelContact VARCHAR(100) 酒店电话
activityDate VARCHAR(100) 活动日期。格式:yyyy-mm-dd
activityTime VARCHAR(100) 活动时间。AM:上午,NOON:中午,NIGHT:晚上
executorId VARCHAR(32) 执行人ID
executorName VARCHAR(100) 执行人姓名
executorCode VARCHAR(100) 执行人编码
executorSourceCode VARCHAR(100) 执行人三方id
predictJoinNum NUMERIC 预计参与人数。最大15位数字
isOwnJoin VARCHAR(100) 是否有我方人员参加。1:是,0:否
remark VARCHAR(1000) 备注
extFieldsInfo VARCHAR(1000) 自定义字段,格式为list,一个自定义字段有三个column、key、value
activityPdList List 商品列表明细
activityPdList.productCode VARCHAR(100) 商品编码
activityPdList.productId VARCHAR(100) 商品id
activityPdList.productSourceCode VARCHAR(100) 商品三方id
activityPdList.productName VARCHAR(100) 商品名称
activityPdList.applyNum NUMERIC 预计数量。最大20位数字
activityPdList.basicUnit 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_apply_record_feast
data <<请求数据体>> ,说明:格式为JSON格式数据

请求示例:

{
		"hostTime": "中午",
		"hostName": "啊啊啊是",
		"dealerCode": "CUS000054",
		"feastEndDate": "2022_04_10",
		"planName": "hts-宴席",
		"customerCode": "CUS010305",
		"remark": "阿萨",
		"applyRecordCode": "SQ202204130004",
		"activityPdList": [
			{
				"productCode": "1001000097",
				"productId": "6534312543423",
				"useTypeName": "公司赞助",
				"basicUnit": "件",
				"applyNum": 3,
				"productName": "BC端宴会==码中台",
				"productSourceCode": "sourcecode_p1",
        "originalApplyNum": 1,
        "originalUnitName": "箱"
			}
		],
		"deleteStatus": "1",
		"customerId": "6806582156885106531",
		"extFieldsInfo": "[{\"column\":\"自定义字段名\",\"key\":\"ext_2203280067\",\"value\":\"hhh\"}]",
		"applicantId": "7002401310724831087",
		"approvalStatus": "1",
    	"auditId": "",
    	"auditCode": "",
    	"auditName": "",
    	"auditSourceCode": "",
		"feastType": "公司年会",
		"dealerName": "法人刘昭",
		"executorId": "8717688507269859633",
		"dealerId": "5102106230943924527",
		"applicantName": "shun",
		"applicantCode": "shun",
		"applicantSourceCode": "shun",
		"applyRecordId": "7719558126269131824",
		"planCode": "CX202204133826",
		"feastStartDate": "2022_04_07",
		"hostContact": "13689748942",
		"customerName": "0529测试三要素",
		"customerSourceCode": "cus_01_sourcecode01",
		"executorName": "安安01",
		"executorCode": "anan01",
		"executorSourceCode": "anan01_sourcecode01",
		"createTime": "2022_04-13 14:26:39",
		"auditTime": "2022_04-14 09:52:25",
		"lastModifyTime": "2022_04-14 09:52:25",
		"hostAddress": "aaaa",
		"predictJoinNum": 2,
        "currentPosition": {
                "address": "江苏省南京市建邺区沙洲街道康文路康缘智汇港附近",
                "longitude": 118.73077,
                "latitude": 31.983762
              }
	}

参数说明:

参数 类型 必填 说明
applyRecordId VARCHAR(32) 申请记录ID
applyRecordCode VARCHAR(100) 申请单号
applicantId VARCHAR(32) 申请人ID
applicantName VARCHAR(100) 申请人名称
applicantCode VARCHAR(100) 申请人编码
applicantSourceCode VARCHAR(100) 申请人三方id
createTime VARCHAR(32) 创建时间。格式:yyyy-mm-dd hh24:mi:ss
auditId VARCHAR(100) 最近审批人ID
auditCode VARCHAR(100) 最近审批人员工账号
auditName VARCHAR(100) 最近审批人姓名
auditSourceCode VARCHAR(100) 最近审批人对应第三方系统的ID
auditTime VARCHAR(32) 最近审批时间。格式:yyyy-mm-dd hh24:mi:ss
lastModifyTime VARCHAR(32) 最近修改时间。格式:yyyy-mm-dd hh24:mi:ss
approvalStatus VARCHAR(32) 审批状态。0:待审批,1:已审批,2:已打回,3:审批中,4:已作废
deleteStatus VARCHAR(32) 删除状态。1:未删除,0:已删除
planCode VARCHAR(100) 方案编码
planName VARCHAR(100) 方案名称
feastType VARCHAR(32) 宴席类型
feastStartDate VARCHAR(32) 宴席开始日期。格式:yyyy-mm-dd
feastEndDate VARCHAR(32) 宴席结束日期。格式:yyyy-mm-dd
hostTime VARCHAR(32) 举办时段
hostName VARCHAR(100) 举办人姓名
hostContact VARCHAR(32) 举办人联系电话
hostAddress VARCHAR(100) 举办地址
predictJoinNum NUMERIC 预计开展桌数
executorId VARCHAR(32) 执行人ID
executorName VARCHAR(100) 执行人姓名
executorCode VARCHAR(100) 执行人编码
executorSourceCode VARCHAR(100) 执行人三方id
customerId VARCHAR(32) 供货方ID
customerCode VARCHAR(100) 供货方编码
customerName VARCHAR(100) 供货方名称
customerSourceCode VARCHAR(100) 供货方三方id
dealerId VARCHAR(32) 费用代垫经销商ID
dealerCode VARCHAR(100) 费用代垫经销商编码
dealerName VARCHAR(100) 费用代垫经销商名称
dealerSourceCode VARCHAR(100) 费用代垫经销商三方id
remark VARCHAR(1000) 备注
extFieldsInfo VARCHAR(1000) 自定义字段,格式为list,一个自定义字段有三个column、key、value
activityPdList List 商品列表明细
activityPdList.productId VARCHAR(100) 商品id
activityPdList.productCode VARCHAR(100) 商品编码
activityPdList.productName VARCHAR(100) 商品名称
activityPdList.productSourceCode VARCHAR(100) 商品三方id
activityPdList.applyNum NUMERIC 基本单位数量。最大20位数字
activityPdList.basicUnit VARCHAR(32) 基本单位
activityPdList.useTypeName VARCHAR(100) 用酒类型
activityPdList.originalApplyNum VARCHAR(32) 录入单位数量。最大20位数字
activityPdList.originalUnitName NUMERIC 录入单位
currentPosition Object 实时位置信息
currentPosition.address VARCHAR(32) 举办地点地标
currentPosition.longitude NUMERIC 经度
currentPosition.latitude NUMERIC 纬度

参数说明:

{
    "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_report_feast
data <<请求数据体>> ,说明:格式为JSON格式数据

请求示例:

{
  "activity_id": "8337818076394260610",
  "activity_code": "SQ202203080009",
  "record_id": "5095203842926411926",
  "sye_id": "7136146755608045854",
  "source_code": "hy",
  "sye_name": "韩煜",
  "sye_source_code": "hanyu_source_code",
  "report_terminal": "MOBILE",
  "wx_name": "",
  "wx_open_id": "",
  "wx_mobile": "",
  "arrive_lla": "",
  "arrive_pos_offset": 10.00,
  "form_define_id": "6009237159914380366",
  "data_id": "9066002301057603178",
  "create_time": "2022-03-15 10:40:50",
  "modify_time": "2022-03-15 10:48:32",
  "actual_tables": 1,
  "status": "1",
  "reportPdList": [
    {
      "unit_name": "瓶",
      "use_type_name": "公司赞助",
      "pd_num": 2,
      "pd_name": "红药水",
      "pd_code": "SP202109150005"
    },
    {
      "unit_name": "把",
      "use_type_name": "客户购买",
      "pd_num": 10,
      "pd_name": "蓝药水",
      "pd_code": "pd_002"
    },
    {
      "unit_name": "把",
      "use_type_name": "公司赞助",
      "pd_num": 3,
      "pd_name": "蓝药水",
      "pd_code": "pd_002"
    }
  ]
}

参数说明:

参数 类型 必填 说明
activity_id VARCHAR(100) 活动申请ID
activity_code VARCHAR(32) 活动申请单号
record_id VARCHAR(32) 上报记录ID
sye_id VARCHAR(32) 上报人ID(勤策的ID)
source_code VARCHAR(32) 上报人唯一标识(source_code)
sye_name VARCHAR(32) 上报人姓名
sye_source_code VARCHAR(32) 上报人三方id
report_terminal VARCHAR(100) 上报终端(手机端、电脑端、微信端)
wx_name VARCHAR(100) 微信昵称
wx_open_id VARCHAR(32) 微信openid
wx_mobile VARCHAR(32) 微信手机号
arrive_lla VARCHAR(32) 上报地标信息。纠偏后的定位数据转换得到的地标信息
arrive_pos_offset VARCHAR(32) 和客户的偏差距离(米)。纠偏后的位置和客户纠偏后的位置的差值,当客户位置为空时,偏差距离为空
form_define_id VARCHAR(100) 上报表单模板ID
data_id VARCHAR(32) 上报表单数据ID
create_time VARCHAR(100) 创建时间。格式:yyyy-mm-dd hh24:mi:ss
modify_time VARCHAR(100) 修改时间。格式:yyyy-mm-dd hh24:mi:ss
actual_tables NUMERIC 实际桌数
status VARCHAR(32) 删除状态。0:删除,1:正常
reportPdList List 商品列表明细
reportPdList.pd_code VARCHAR(100) 实际使用商品编码
reportPdList.pd_name VARCHAR(100) 商品名称
reportPdList.pd_num NUMERIC 数量
reportPdList.unit_name VARCHAR(32) 单位
reportPdList.use_type_name VARCHAR(100) 用酒类型

参数说明:

{
    "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_report_comment_feast
data <<请求数据体>> ,说明:格式为JSON格式数据

请求示例:

[
  {
    "activity_id": "5006720526795851408",
    "activity_code": "SQ202202150006",
    "record_id": "5566516156928682871",
    "comment_step": "1",
    "comment_status": "0",
    "comment_user_id": "9095203782926465726",
    "comment_user_source_code": "zhangsan_source_code",
    "comment_user_name": "张三",
    "comment_user_code": "zhangsan",
    "comment_time": "2022-03-15 10:48:32",
    "comment_text": "",
    "comment_form_id": "5095203842926411926",
    "comment_data_id": "9066002301057603178"
  }
]

参数说明:

参数 类型 必填 说明
activity_id VARCHAR(100) 活动申请ID
activity_code VARCHAR(32) 活动申请单号
record_id VARCHAR(32) 上报记录ID
comment_step VARCHAR(32) 评价类型:1-初评、2-复评
comment_status VARCHAR(32) 评价状态(合格/不合格)
comment_user_id VARCHAR(32) 评价人ID(勤策的ID)
comment_user_source_code VARCHAR(32) 评价人唯一标识(source_code)
comment_user_name VARCHAR(100) 评价人姓名
comment_user_code VARCHAR(100) 评价人编码
comment_time VARCHAR(32) 评价时间。格式:yyyy-MM-dd HH:mm:ss
comment_text VARCHAR(100) 评价意见
comment_form_id VARCHAR(32) 评价表单模板ID
comment_data_id VARCHAR(32) 评价表单数据ID

参数说明:

{
    "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_plan
data <<请求数据体>> ,说明:格式为JSON格式数据

推送包体:

{
	"end_date": "2020-11-13 00:00:00",
	"type_name": "无需兑付方案",
	"code": "CX202011135990",
	"check_form_name": "888",
	"close_case_type": "1",
    "expense_enter_type":"3",
    "off_season_month":"4,5",
    "busy_season_month":"6",
	"description": "方案说明",
	"field_name": "1113",
	"name": "扩展字段测试(勿动)",
	"id": "6311697027928720275",
	"form_name": "123",
	"exts": [{
        "ext_key": "自定义字段1",
        "ext_value": ""
    }, {
        "ext_key": "自定义字段2",
        "ext_value": "1113"
    }],
	"start_date": "2020-11-13 00:00:00",
	"status": "0",
	"flow_status": "1",
    "evaluate_by_input": "0",
    "plan_status": "1"
}

参数说明:

参数 类型 必填 说明
id VARCHAR(32) 方案id
code VARCHAR(100) 方案编码
name VARCHAR(100) 方案名称
type_name VARCHAR(100) 方案类型
form_name VARCHAR(100) 上报模板名称
field_name VARCHAR(100) 上报审核模板名称
start_date VARCHAR(32) 方案执行开始日期。格式:yyyy-MM-dd HH:mm:ss
end_date VARCHAR(32) 方案执行结束日期。格式:yyyy-MM-dd HH:mm:ss
check_form_name VARCHAR(100) 检核模板名称
close_case_type VARCHAR(1) 结案方式。1:单次结案,2:月度结案,3:季度结案,4:半年度结案
status VARCHAR(1) 删除状态。0:删除,1:正常
expense_enter_type VARCHAR(1) 费用录入方式。1:录入执行周期内总费用,2:录入月费用(所有月份相同),3:录入月费用(分淡旺季)
off_season_month VARCHAR(100) 淡季月份。有多个月份时,逗号分隔
busy_season_month VARCHAR(100) 旺季月份。有多个月份时,逗号分隔
exts List 方案扩展字段列表
exts.ext_key VARCHAR(32) 方案扩展字段key值
exts.ext_value text 方案扩展字段value值
flow_status VARCHAR(1) 审批状态。9:待提交,0:处理中,1:已批准,2:已打回,3:审批中
evaluate_by_input VARCHAR(1) 是否按付费项目评价。1:是,0:否
plan_status VARCHAR(32) 方案状态。1:执行中,2:已终止,3:未开始,4:已结束

# 付费陈列和市场活动申请单

接口说明:推送付费陈列和市场活动的活动申请单。在活动申请提交、修改申请单提交、申请单审批时都会调用,所以对同一个活动(活动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_activity
data <<请求数据体>> ,说明:格式为JSON格式数据

请求示例:

{
    "end_date":"2020-05-15",
    "activity_name":"SQ202004130035",
    "plan_type":"表单-字段组合",
    "create_time":"2020-04-13 15:12:25",
    "modify_time":"2020-04-16 11:19:59",
    "plan_code":"CX202004099284",
    "cm":[
        {
            "end_date":"2020-05-15",
            "code":"CUS010251",
            "protocol_id":"",
            "target_sale_quota":"",
            "target_sale_quota_month":"",
            "target_sale_quota_off":"",
            "target_sale_quota_busy":"",
            "off_season_shot":"",
            "busy_season_shot":"",
            "linkman_mobile":"",
            "linkman":"",
            "inputList":[
                {
                    "protocol_pay_money":2000,
                    "item_describe":"SKU数:123;排面数:213123",
                    "name":"0147-new",
                    "extColumns": [
                		{
                    		"ext_col": "exdf_927196",
                    		"ext_key": "单行文本框",
                    		"ext_value": "单行HY"
                		},
                		{
                    		"ext_col": "exdf_893191",
                    		"ext_key": "多行自定义",
                    		"ext_value": "多行HY"
                		},
                		{
                    		"ext_col": "exdf_915699",
                    		"ext_key": "数值",
                    		"ext_value": "选项1"
                		},
                		{
                    		"ext_col": "exdf_176760",
                    		"ext_key": "多选",
                    		"ext_value": ""
                		}
            		],
                    "item_desc_array":[
                        {
                            "label_name":"SKU数",
                            "label_val_show":"10"
                        },
                        {
                            "label_name":"排面数",
                            "label_val_show":"10"
                        }
                    ],
                    "pd_data":[
                        {
                            "pd_id":"5239771055067925102",
                            "pd_name":"NEW-多个价格-基本单位+辅助单位",
                            "pd_code":"NEW",
                            "pro_unit_name":"",
                            "item_value":"",
                            "item_value_month":"",
                            "item_value_off":"",
                            "item_value_busy":"",
                            "pd_spec":"规格1",
                            "pd_sales_price":"11.00",
                            "item_type":"商品"
                        },
                        {
                            "pd_id":"0",
                            "pd_name":"",
                            "pd_code":"",
                            "pro_unit_name":"",
                            "item_value":"2000.00",
                            "item_value_month":"",
                            "item_value_off":"",
                            "item_value_busy":"",
                            "pd_spec":"",
                            "pd_sales_price":"",
                            "item_type":"现金"
                        }
                    ]
                }
            ],
            "show_content":"电子签章-高级版-使用范围:QQ1下级--柠云",
            "name":"111111",
            "id":"5893917317653168258",
            "addr":"",
            "protocol_code":"XY20200413000042",
            "start_date":"2020-04-13",
            "status":"1",
            "remark":"客户行备注"
        }
    ],
    "form_data_id":8232510941689130139,
    "plan_name":"Android系统校验-6.5.2",
    "audit_time":"2020-04-13 18:42:43",
    "audit_id":"-10000",
    "audit_name":"管理员",
    "audit_code":"code",
    "audit_source_code":"",
    "assign_form":7507485083472022385,
    "has_activity":"1",
    "modifyier_id":"7592966989935850147",
    "modifyier_name":"张三",
    "modifyier_code":"zhangsan",
    "modifyier_source_code":"zhangsan111",
    "creator_id":"7592966989935850147",
    "creator_name":"张三",
    "creator_code":"zhangsan",
    "creator_source_code":"third-zhangsan111",
    "name":"Android系统校验-6.5.2",
    "id":"7837369179309678060",
    "audit_reason":"04-13-测试",
    "districtIds":[

    ],
    "plan_id":"7570251468539066775",
    "activity_status":"0",
    "status":"1",
    "start_date":"2020-04-09"
}

请求说明

参数 类型 必填 说明
id int8 申请单ID
status char1 状态。1:正常,0:删除
creator_id int8 创建人id(勤策id)
creator_code varchar(32) 创建人编码(账号)
creator_name varchar(32) 创建人姓名
creator_source_code varchar(32) 创建人三方id
create_time varchar(32) 创建时间。格式:yyyy-MM-dd HH:mm:ss
modifyier_id int8 修改人id(勤策id)
modifyier_code varchar(32) 修改人编码(账号)
modifyier_name varchar(32) 修改人姓名
modifyier_source_code varchar(32) 修改人三方id
modify_time varchar(32) 修改时间。格式:yyyy-MM-dd HH:mm:ss
plan_id int8 促销方案ID
plan_code varchar(100) 促销方案编码
plan_name varchar(100) 促销方案名称
plan_type varchar(100) 促销方案类型
start_date varchar(32) 开始日期。格式:yyyy-MM-dd
end_date varchar(32) 结束日期。格式:yyyy-MM-dd
activity_name varchar(100) 活动申请名称
activity_code varchar(100) 活动申请编码
activity_status char(1) 活动状态。0:待审批,1:已审批,2:已打回,3:审批中,9:待提交,4:已作废
audit_id int8 审核人
audit_code varchar(32) 审核人员工编码
audit_name varchar(32) 审核人员工姓名
audit_source_code varchar(32) 审核人员工三方id
audit_time varchar(32) 审核时间。格式:yyyy-MM-dd HH:mm:ss
audit_reason varchar(1000) 审批意见
has_activity varchar(1) 是否需要申请。1:需要申请,2:不需要申请
assign_form int8 申请单叠加表单模板ID
form_data_id int8 申请叠加表单数据ID
cm List
cm.protocol_id varchar(100) 活动申请明细ID
cm.id int8 参与门店的Id
cm.code varchar(32) 参与门店的编码
cm.name varchar(100) 参与门店的名称
cm.show_content varchar(100) 甲方配置中的公司名称
cm.linkman varchar(100) 客户主联系人姓名
cm.linkman_mobile varchar(32) 客户主联系人手机号
cm.addr varchar(4000) 客户详细地址
cm.target_sale_quota varchar(1000) 销售目标金额
cm.start_date varchar(32) 活动申请执行开始日期,格式:yyyy-MM-dd
cm.end_date varchar(32) 活动申请执行结束日期,格式:yyyy-MM-dd
cm.protocol_code varchar(100) 协议编号
cm.target_sale_quota_month varchar(1000) 月销售目标金额。方案上选择的申请费用录入方式为“录入月费用(所有月份都相同)”时有值
cm.target_sale_quota_off varchar(1000) 淡季月目标销额。方案上选择的申请费用录入方式为“录入月费用(分淡旺季)”时有值
cm.target_sale_quota_busy varchar(1000) 旺季月目标销额。方案上选择的申请费用录入方式为“录入月费用(分淡旺季)”时有值
cm.off_season_shot varchar(100) 淡季月份。方案上选择的申请费用录入方式为“录入月费用(分淡旺季)”时有值
cm.busy_season_shot varchar(100) 旺季月份。方案上选择的申请费用录入方式为“录入月费用(分淡旺季)”时有值
cm.status varchar(1) 活动明细删除状态
cm.remark VARCHAR(4000) 客户申请行备注
cm.inputList List
cm.inputList.name varchar(100) 付费项目名称
cm.inputList.extColumns List
cm.inputList.extColumns.ext_col varchar(100) 自定义字段code
cm.inputList.extColumns.ext_key varchar(100) 自定义字段名称
cm.inputList.extColumns.ext_value varchar(1000) 自定义字段值
cm.inputList.item_describe varchar(1000) 付费项目执行要求
cm.inputList.item_desc_array List 执行要求字段列表
cm.inputList.item_desc_array.label_name varchar(100) 执行要求字段名称
cm.inputList.item_desc_array.label_val_show varchar(100) 执行要求字段显示值
cm.inputList.protocol_pay_money varchar(100) 协议兑付金额,当兑付商品时,是按数量*商品牌价的合计
cm.inputList.pd_data List
cm.inputList.pd_data.item_type varchar(1) 兑付方式。1:现金,2:商品
cm.inputList.pd_data.pd_id varchar(100) 兑付商品ID
cm.inputList.pd_data.pd_code varchar(100) 商品编码
cm.inputList.pd_data.pd_name varchar(100) 商品名称
cm.inputList.pd_data.pd_spec varchar(4000) 规格属性
cm.inputList.pd_data.pro_unit_name varchar(32) 协议兑付商品单位
cm.inputList.pd_data.item_value varchar(100) 协议兑付金额/数量
cm.inputList.pd_data.item_value_month VARCHAR(1000) 月协议兑付金额/数量 方案上选择的申请费用录入方式为“录入月费用(所有月份都相同)”时有值
cm.inputList.pd_data.item_value_off VARCHAR(1000) 淡季月协议兑付金额/数量 方案上选择的申请费用录入方式为“录入月费用(分淡旺季)”时有值
cm.inputList.pd_data.item_value_busy VARCHAR(1000) 旺季月协议兑付金额/数量 方案上选择的申请费用录入方式为“录入月费用(分淡旺季)”时有值
cm.inputList.pd_data.pd_sales_price varchar(100) 商品牌价

参数说明:

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

# 付费陈列和市场活动申请单删除

接口说明:用户在365中删除活动时,会调用此接口。 请求方式: 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_activity_delete
data <<请求数据体>> ,说明:格式为JSON格式数据

请求示例:

{
    "activity_id": "5232948793149090911"
}

参数说明:

参数 类型 必填 说明
activity_id VARCHAR(32) 活动ID

参数说明:

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

# 付费陈列和市场活动申请明细删除

接口说明:用户在365中移除促销活动的参与门店时,会调用此接口。

请求方式: 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_cm_remove
data <<请求数据体>> ,说明:格式为JSON格式数据

请求示例:

{
    "plan_id": "5232948793149090911",
    "remove_cm": [
        {
            "id": "9034357183552766140",
            "cm_code": "CUS00001",
            "cm_name": "门店1",
            "cm_source_code": "cm_source_code_001",
            "activity_id": "6288027684278203306",
			"detail_id":""
        }
    ],
    "reason": "这些门店检查过了",
    "remove_time": "2015-11-16 13: 50: 18",
    "user_id": "6288027684278203306",
    "user_name": "王五",
    "user_code": "wangwu",
    "user_source_code": "ww_0029"
}

参数说明:

参数 类型 必填 说明
plan_id Int8 方案ID
remove_cm List
remove_cm.activity_id Int8 申请单ID
remove_cm.detail_id VARCHAR(32) 申请明细ID
remove_cm.id Int8 门店ID
remove_cm.cm_code VARCHAR(32) 门店编码
remove_cm.cm_name VARCHAR(32) 门店名称
remove_cm.cm_source_code VARCHAR(32) 门店三方id
remove_cm.id Int8 门店ID
reason VARCHAR(4096) 移除理由
remove_time VARCHAR(32) 操作时间。格式:yyyy-MM-dd HH:mm:ss
user_id Int8 操作人ID
user_name VARCHAR(100) 操作人姓名
user_code VARCHAR(100) 操作人
user_source_code VARCHAR(100) 操作三方id

参数说明:

{
    "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_sign_b
data <<请求数据体>> ,说明:格式为JSON格式数据

请求示例:

{
    "protocol_id": "5959303241377469352",
    "b_sign_url": "https://contract.waiqin365.com/7320333869003283336/cuxiao_contract/202002/origin/5487947973756444218.pdf?Expires=1586855291&OSSAccessKeyId=LTAIgEPwnBa8n2Q6&Signature=sh47%2FIVShnRL9XmMzad%2F8wvmbFE%3D"
}

参数说明:

参数 类型 必填 说明
protocol_id VARCHAR(32) 活动申请明细ID
b_sign_url text 乙方签署后的协议URL

参数说明:

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

# 付费陈列和市场活动上报记录

接口说明:用户在手机端上报促销记录的时候,勤策会调用此接口发送数据到第三方URL

请求方式: 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_record
data <<请求数据体>> ,说明:格式为JSON格式数据

请求示例:

{
    "plan_id": "7226626906295451231",
    "plan_code": "11.11",
    "plan _name ": "双十一大促",
    "activity_id ": "5277027684278203306",
    "activity_name ": "江苏区决战双十一",
    "activity_code ": "code_12323",
	"detail_id":"",
    "record_id": "5232948793149090911",
    "record_status ": "1",
    "create_time": "2015-11-15 13:50:18",
	"report_source_code": "2",
    "emp_id": " 5277027684278203306",
    "emp_name": "张三",
    "emp_code": "zhangsan",
    "cm_id": " 5277027684278203306",
    "cm_name": "大润发龙江店",
    "cm_code": "",
    "cm_source_code": "source_code111",
    "data_id": "5277027684278203306",
    "form_define_id": "form_define_id",
    "ai_status": "0"
}

参数说明:

参数 类型 必填 说明
plan_id VARCHAR(32) 促销方案ID
plan_code VARCHAR(100) 促销方案编码
plan_name VARCHAR(100) 促销方案名称
activity_id VARCHAR(32) 活动ID
activity_name VARCHAR(100) 活动名称
activity_code VARCHAR(32) 活动申请编号
detail_id VARCHAR(100) 申请明细ID
record_id VARCHAR(32) 上报记录的ID
record_status CHAR(1) 核准状态0合格 1不合格
create_time VARCHAR(32) 创建时间。格式: yyyy-MM-dd HH:mm:ss
report_source_code CHAR(1) 上报来源。1:客户自主上报,2:业代上报
emp_id VARCHAR(32) 上报人ID(勤策的ID)
emp_source_code VARCHAR(32) 上报人唯一标识(source_code 三方id)
emp_name VARCHAR(100) 上报人姓名
emp_code VARCHAR(100) 上报人编码
arrive_lla VARCHAR(200) 上报地标信息。纠偏后的定位数据转换得到的地标信息
arrive_pos_offset NUMERIC(20,2) 和客户的偏差距离(米)。纠偏后的位置和客户纠偏后的位置的差值,当客户位置为空时,偏差距离为空
cm_id VARCHAR(32) 客户(门店)ID(勤策的ID)
cm_source_code VARCHAR(200) 客户(门店)唯一标识(source_code 三方id)
cm_name VARCHAR(200) 客户(门店)名称
cm_code VARCHAR(200) 客户(门店)编码
visit_implement_id VARCHAR(32) 拜访记录ID
data_id VARCHAR(32) 表单数据id
form_define_id VARCHAR(32) 表单id
ai_status VARCHAR(32) AI评价结果。0:不合格,1:合格

参数说明:

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

# 付费陈列和市场活动上报记录评价

接口说明:上级主管在活动上报记录评价时,勤策会按照此接口调用第三方url将评价的结果发送过去。 请求方式: 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_record_examine
data <<请求数据体>> ,说明:格式为JSON格式数据

请求示例:

{
	"id": 7901803402635456979,
	"audit_form_data": 6442960492716362645,
	"comment_user_name": "老板",
	"comment_user": 6427485500721322085,
	"comment_user_code": "boss",
	"comment_user_source_code": "6427485500721322085",
	"examine_date": "2019-10-17",
	"comment_text": "",
	"comment_status": "0",
    "pay_evaluate_data": [{
        "comment_text": "",
        "item_name": "端架陈列",
        "comment_status": "0"
    }],
	"record_audit_form_id": 8970563588807467141,
	"comment_step": "1"
}

参数说明:

参数 类型 必填 说明
id Int8 上报记录的ID
comment_step VARCHAR(1) 初评/复评标识。1:初评,2:复评
comment_status VARCHAR(32) 评价状态。0:合格,1:不合格
comment_text VARCHAR(100) 评价批注
pay_evaluate_data List 付费评价数据列表
pay_evaluate_data.comment_text VARCHAR(1000) 不合格理由
pay_evaluate_data.item_name VARCHAR(100) 付费项目
pay_evaluate_data.comment_status VARCHAR(1) 合格状态。1:不合格,0:合格
comment_user VARCHAR(32) 评价人ID
comment_user_name VARCHAR(32) 评价人姓名
comment_user_code VARCHAR(32) 评价人编码
comment_user_source_code VARCHAR(32) 评价人三方id
examine_date VARCHAR(32) 评价时间。格式:yyyy-MM-dd hh:mm:ss
record_audit_form_id Int8 评价模板ID
audit_form_data Int8 评价表单记录ID

参数说明:

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

# 付费陈列和市场活动检核记录

接口说明:用户在手机端活动检核的时候,勤策会调用此接口发送数据到第三方URL

请求方式: 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_check
data <<请求数据体>> ,说明:格式为JSON格式数据

请求示例:

{
    "plan_id": "7226626906295451231",
    "plan_code": "11.11",
    "plan _name ": "双十一大促",
    "activity_id ": "5277027684278203306",
    "activity_name ": "江苏区决战双十一",
	"detail_id":"",
    "record_id": "5232948793149090911",
    "record_status ": "1",
    "comment_text": "陈列不整齐",
    "pay_evaluate_data": [{
        "comment_text": "陈列不整齐",
        "item_name": "端架陈列",
        "comment_status": "1"
    }],
    "create_time": "2015-11-15 13:50:18",
    "emp_id": " 5277027684278203306",
    "emp_name": "张三",
    "emp_code": "zhangsan",
    "emp_source_code": "source_zhangsan",
    "cm_id": " 5277027684278203306",
    "cm_name": "大润发龙江店",
    "cm_code": "大润发龙江店",
    "cm_source_code": "",
    "data_id": " 5277027684278203306",
    "check_define_id": " 5277027684278203306"
}

参数说明:

参数 类型 必填 说明
plan_id VARCHAR(32) 促销方案ID
plan_code VARCHAR(100) 促销方案编码
plan_name VARCHAR(100) 促销方案名称
activity_id VARCHAR(32) 活动ID
activity_name VARCHAR(100) 活动名称
detail_id VARCHAR(100) 申请明细ID
record_id VARCHAR(32) 检核记录的ID
record_status CHAR(1) 检核状态。0:合格,1:不合格
comment_text VARCHAR(1000) 不合格理由
pay_evaluate_data List 付费评价数据列表
pay_evaluate_data.comment_text VARCHAR(1000) 不合格理由
pay_evaluate_data.item_name VARCHAR(100) 付费项目
pay_evaluate_data.comment_status VARCHAR(1) 合格状态。1:不合格,0:合格
create_time VARCHAR(32) 创建时间。格式: yyyy-MM-dd HH:mm:ss
emp_id VARCHAR(32) 上报人ID(勤策的ID)
emp_source_code VARCHAR(100) 上报人唯一标识(source_code三方id)
emp_name VARCHAR(32) 上报人姓名
emp_code VARCHAR(32) 上报人编码
cm_id VARCHAR(32) 客户(门店)ID(勤策的ID)
cm_source_code VARCHAR(200) 客户(门店)唯一标识(source_code三方id))
cm_code VARCHAR(200) 客户(门店)编码
cm_name VARCHAR(200) 客户(门店)名称
visit_implement_id VARCHAR(32) 拜访记录ID
data_id VARCHAR(32) 表单数据id
check_define_id VARCHAR(32) 表单id

参数说明:

{
    "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_close_apply
data <<请求数据体>> ,说明:格式为JSON格式数据

推送包体:


{
    "audit_time":"2021-06-21 20:24",
    "close_apply_code":"JA202106210001",
    "close_apply_id":"6217718455120623075",
    "create_time":"2021-06-21 20:24",
    "creator_id":"6837814635165396941",
    "detailList":[
        {
            "activity_cm_id":"7759614063985582139",
            "actual_sales_quota":"",
            "close_cycle":"2021-05-18~2021-06-17",
            "cm_code":"CUS010267",
            "cm_id":"5323379110327494049",
            "cm_name":"1232",
            "itemList":[
                {
                    "cash_value":"8.00",
                    "item_name":"会员店",
                    "pd_code":"",
                    "pd_id":"",
                    "pd_name":"",
                    "pd_unit":"",
                    "pd_value":""
                },
                {
                    "cash_value":"21.00",
                    "item_name":"五星",
                    "pd_code":"",
                    "pd_id":"",
                    "pd_name":"",
                    "pd_unit":"",
                    "pd_value":""
                },
                {
                    "cash_value":"",
                    "item_name":"三星",
                    "pd_code":"",
                    "pd_id":"",
                    "pd_name":"",
                    "pd_unit":"",
                    "pd_value":""
                }
            ],
            "pay_record_id":"8243661372315420848",
            "target_sale_quota":"1.92"
        }
    ],
    "plan_code":"CX202012187419",
    "plan_id":"4728479377320271173",
    "plan_name":"2021年全国市场核心终端建设活动"
}

参数说明:

参数 类型 必填 说明
close_apply_id VARCHAR(32) 结案单ID
close_apply_code VARCHAR(32) 结案单号
create_time VARCHAR(100) 创建时间。格式:yyyy-mm-dd hh24:mi
creator_id VARCHAR(32) 结案单创建人ID。自动结案的创建人为“系统”
plan_id VARCHAR(32) 方案ID
plan_code VARCHAR(32) 方案编码
plan_name VARCHAR(100) 方案名称
detailList List
detailList.pay_record_id VARCHAR(32) 结案明细ID
detailList.close_cycle VARCHAR(100) 结案周期。单次结案时,显示申请时的执行周期;分期时,显示当前分期的执行周期
detailList.activity_cm_id VARCHAR(32) 申请明细ID
detailList.cm_id VARCHAR(32) 客户ID
detailList.cm_code VARCHAR(32) 客户编码
detailList.cm_name VARCHAR(200) 客户名称
detailList.target_sale_quota VARCHAR(1000) 目标销额。分期结案时,是当前分期的目标销额
detailList.actual_sales_quota VARCHAR(1000) 实际销额。分期结案时,是当前分期周期内的实际销额
detailList.itemList List
detailList.itemList.item_name VARCHAR(100) 付费项目
detailList.itemList.pd_id VARCHAR(32) 实际结案商品ID(兑商品时有值)
detailList.itemList.pd_code VARCHAR(100) 实际结案商品编码(兑商品时有值)
detailList.itemList.pd_name VARCHAR(100) 实际结案商品名称(兑商品时有值)
detailList.itemList.pd_value VARCHAR(1000) 实际结案商品数量(兑商品时有值)
detailList.itemList.pd_unit VARCHAR(100) 实际结案商品单位(兑商品时有值)
detailList.itemList.cash_value VARCHAR(1000) 现金(元)

# 进场费活动方案

接口说明:在活动方案创建、修改、删除、终止上报和审批通过时向第三方系统推送数据。

请求方式: 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_plan_entrance_fee
data <<请求数据体>> ,说明:格式为JSON格式数据

推送包体:

{
        "end_date":"2021-11-12",
        "record_form_name":"上报模板-单行文本",
        "plan_type":"进场费类型",
        "code":"CX202110091116",
        "flow_status":"0",
        "name":"进场费",
        "description":"A",
        "id":"9157715392064344233",
        "exts":[
            {
                "ext_key":"多选必填启用默认BC",
                "ext_value":"B#C"
            },
            {
                "ext_key":"日期必填启用",
                "ext_value":"2021-10-09"
            }
        ],
        "start_date":"2021-10-09",
        "status":"1",
        "plan_status": "1"
    }

参数说明:

参数 类型 必填 说明
id VARCHAR(32) 方案id
code VARCHAR(100) 方案编码
name VARCHAR(100) 方案名称
description VARCHAR(4000) 方案说明
plan_type VARCHAR(100) 方案类型
record_form_name VARCHAR(100) 上报模板名称
start_date VARCHAR(32) 方案执行开始日期。格式:yyyy-MM-dd HH:mm:ss
end_date VARCHAR(32) 方案执行结束日期。格式:yyyy-MM-dd HH:mm:ss
exts List 方案扩展字段列表
exts.ext_key VARCHAR(32) 方案扩展字段key值
exts.ext_value TEXT 方案扩展字段value值
status VARCHAR(1) 删除状态。0:已删除,1:正常
flow_status VARCHAR(1) 审批状态。9:待提交,0:处理中,1:已批准,2:已打回,3:审批中
plan_status VARCHAR(32) 方案状态。1:执行中,2:已终止,3:未开始,4:已结束

# 进场费申请单

接口说明:推送进场费的活动申请单。在活动申请提交、修改申请单提交、申请单审批时都会调用,所以对同一个活动(活动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_activity_entrance
data <<请求数据体>> ,说明:格式为JSON格式数据

请求示例:

{
    "applyCode": "SQ202111040012",
    "applyId": "6004353746709837221",
    "assignForm": "7806275268583491837",
    "auditStatus": "",
    "auditId": "",
    "auditCode": "",
    "auditName": "",
    "auditSourceCode": "",
    "auditTime": "2021-11-04 19:38:50",
    "createTime": "2021-11-04 19:37:08",
    "creatorId": "7011544141518850838",
    "creatorName": "张三",
    "creatorCode": "zhangsan",
    "creatorSourceCode": "zhangsan_urcecode",
    "efCmDetailDto": [
        {
            "applyExt": [
                {
                    "ext_key": "ext_2110270041",
                    "ext_value": "text"
                },
                {
                    "ext_key": "ext_2110270047",
                    "ext_value": "ngjwkeg"
                }
            ],
            "budgetDimInfo": "[]",
            "cmAcId": "6302352245437721460",
            "cmCode": "CUS000014",
            "cmId": "5215745781710813559",
            "cmName": "王阳客户",
            "cmSourceCode": "",
            "dealerCode": "10019200",
            "dealerName": "qqnew经销商--河南省副食品有限公司焦作分公司",
            "dealerSourceCode": "",
            "efWaresDto": [
                {
                    "pdCode": "",
                    "pdEntranceFee": "34.00",
                    "pdId": "7320333869023283637",
                    "pdName": "",
                    "pdPurchase": "43.00",
                    "pdRemark": "",
                    "pdSale": "43.00",
                    "pdSourceCode": ""
                }
            ],
            "entranceStoreNum": "4",
            "executeEndDate": "2021-11-04 00:00:00",
            "executeStartDate": "2021-11-01 00:00:00",
            "payModeName": "现金",
            "period": "",
            "remark": "4he",
            "singleStoreEntranceFee": "77.00",
            "status": "1",
            "storeTotalEntranceFee": "309.00",
            "subjectName": "科目",
            "upperDealerId": "5981981052594876297"
        }
    ],
    "formDataId": "5697466446687567936",
    "modifyTime": "2021-11-04 19:38:50.561",
    "planCode": "JCF202111019606",
    "planId": "8093604252026303903",
    "planName": "20211101"
}

参数说明:

参数 类型 必填 说明
planId VARCHAR(32) 方案id
planCode VARCHAR(100) 方案编码
planName VARCHAR(100) 方案名称
applyId VARCHAR(32) 申请单ID
applyCode VARCHAR(32) 申请单编号
creatorId VARCHAR(32) 申请人ID
creatorName VARCHAR(32) 申请人姓名
creatorCode VARCHAR(32) 申请人编码
creatorSourceCode VARCHAR(32) 申请人三方id
createTime VARCHAR(32) 申请创建时间。格式:yyyy-MM-dd HH:mm:ss
modifyTime VARCHAR(32) 修改时间。格式:yyyy-MM-dd HH:mm:ss
status CHAR(1) 状态, 0-删除 1-正常
auditStatus VARCHAR(100) 审批状态。0:待审批,1:已审批,2:已打回,3:审批中,9:待提交,4:已作废
auditId VARCHAR(100) 最近审批人ID
auditCode VARCHAR(100) 最近审批人员工账号
auditName VARCHAR(100) 最近审批人姓名
auditSourceCode VARCHAR(100) 最近审批人对应第三方系统的ID
auditTime VARCHAR(32) 最近审核时间。格式:yyyy-MM-dd HH:mm:ss
assignForm VARCHAR(32) 申请单叠加表单模板ID
formDataId VARCHAR(32) 申请叠加表单数据ID
efCmDetailDto List
efCmDetailDto.cmAcId VARCHAR(32) 客户申请明细ID
efCmDetailDto.cmId VARCHAR(32) 客户id
efCmDetailDto.cmSourceCode VARCHAR(100) 客户SOURCE_CODE
efCmDetailDto.cmCode VARCHAR(100) 客户编码
efCmDetailDto.cmName VARCHAR(100) 客户名称
efCmDetailDto.upperDealerId VARCHAR(32) 费用代垫经销商ID
efCmDetailDto.dealerSourceCode VARCHAR(100) 费用代垫经销商SOURCE_CODE
efCmDetailDto.dealerCode VARCHAR(100) 费用代垫经销商编码
efCmDetailDto.dealerName VARCHAR(100) 费用代垫经销商名称
efCmDetailDto.executeStartDate VARCHAR(100) 客户行活动开始时间 格式:yyyy-MM-dd HH:mm:ss
efCmDetailDto.executeEndDate VARCHAR(100) 客户行活动结束时间 格式:yyyy-MM-dd HH:mm:ss
efCmDetailDto.entranceStoreNum VARCHAR(100) 进场门店数
efCmDetailDto.singleStoreEntranceFee VARCHAR(100) 单店进场费
efCmDetailDto.storeTotalEntranceFee VARCHAR(100) 申请总金额
efCmDetailDto.subjectName VARCHAR(100) 科目
efCmDetailDto.period VARCHAR(100) 期间
efCmDetailDto.budgetDimInfo VARCHAR(4000) 维度json
efCmDetailDto.payModeName VARCHAR(100) 支付方式
efCmDetailDto.remark VARCHAR(4000) 备注
efCmDetailDto.applyExt List
efCmDetailDto.applyExt.ext_key VARCHAR(100) 自定义字段名称
efCmDetailDto.applyExt.ext_value VARCHAR(4000) 自定义字段值
efCmDetailDto.status VARCHAR(32) 删除状态
efCmDetailDto.efWaresDto List
efCmDetailDto.efWaresDto.pdId VARCHAR(100) 商品ID
efCmDetailDto.efWaresDto.pdSourceCode VARCHAR(100) 商品SOURCE_CODE
efCmDetailDto.efWaresDto.pdCode VARCHAR(100) 商品编码
efCmDetailDto.efWaresDto.pdName VARCHAR(100) 商品名称
efCmDetailDto.efWaresDto.pdEntranceFee VARCHAR(100) 进场费
efCmDetailDto.efWaresDto.pdPurchase VARCHAR(100) 客户进货价
efCmDetailDto.efWaresDto.pdSale VARCHAR(100) 零售价
efCmDetailDto.efWaresDto.pdRemark VARCHAR(4000) 商品行备注

参数说明:

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

# 进场费申请单删除

接口说明:用户在365中删除进场费申请单时会调用此接口。

请求方式: 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_activity_delete_entrance
data <<请求数据体>> ,说明:格式为JSON格式数据

请求示例:

{
    "activity_id": "5232948793149090911"
}

参数说明:

参数 类型 必填 说明
activity_id VARCHAR(32) 活动ID

参数说明:

{
    "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_cm_remove_entrance
data <<请求数据体>> ,说明:格式为JSON格式数据

请求示例:

{
    "plan_id": "5232948793149090911",
    "remove_cm": [
        {
            "id": "9034357183552766140",
            "cm_code": "zhangsan",
            "cm_name": "zhangsan",
            "cm_source_code": "zhangsan_sourcecode",
            "activity_id": "6288027684278203306",
			"detail_id":""
        }
    ],
    "reason": "这些门店检查过了",
    "remove_time": "2015-11-16 13: 50: 18",
    "user_id": "6288027684278203306",
    "user_name": "王五",
    "user_code": "wangwu",
    "user_source_code": "wangwu_sourcecode"
}

参数说明:

参数 类型 必填 说明
plan_id Int8 方案ID
remove_cm List
remove_cm.activity_id Int8 申请单ID
remove_cm.detail_id VARCHAR(32) 申请明细ID
remove_cm.id Int8 门店ID
remove_cm.cm_code VARCHAR(32) 门店编码
remove_cm.cm_name VARCHAR(32) 门店名称
remove_cm.cm_source_code VARCHAR(32) 门店三方id
reason VARCHAR(4096) 移除理由
remove_time VARCHAR(32) 操作时间。格式:yyyy-MM-dd HH:mm:ss
user_id Int8 操作人ID
user_name VARCHAR(100) 操作人姓名
user_code VARCHAR(100) 操作人编码
user_source_code VARCHAR(100) 操作人三方id

参数说明:

{
    "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_report_entrance_fee
data <<请求数据体>> ,说明:格式为JSON格式数据

请求示例:

{
      "id": 6309024315330045514,
      "code": "JCF202111113454",
      "activity_cus_id": 4789759081208984580,
      "cm_id": 7345266233482427241,
      "cm_name": "小店87",
      "cm_code": "CUS000087",
      "cm_source_code": "",
      "pd_list": [{
        "pd_code": "1000001",
        "pd_name": "雪花啤酒勇闯天涯8度",
        "pd_entrance_fee": 11.00,
        "retail_price": 11.00
      }],
      "record_id": 6858701150506850097,
      "sye_id": 7573427476093814157,
      "sye_code": "wangwu",
      "source_code": "",
      "sye_name": "xwj14",
      "arrive_lla": "江苏省南京市建邺区荷塘路",
      "arrive_pos_offset": "",
      "comment_status": "未评价",
      "record_sys_id": "",
      "record_sys_code": "",
      "record_source_code": "",
      "record_sys_name": "",
      "comment_time": "",
      "comment_text": "",
      "re_comment_status": "未评价",
      "re_comment_text": "",
      "re_record_id": "",
      "re_record_code": "",
      "re_record_source_code": "",
      "re_record_name": "",
      "re_comment_time": "",
      "visit_implement_id": "",
      "form_define_id": 5351617790943416943,
      "data_id": 5510726260281485832,
      "record_time": "2021-11-17 16:24:02",
      "status": "正常"
}

参数说明:

参数 类型 必填 说明
id VARCHAR(32) 方案id
code VARCHAR(100) 方案编码
activity_cus_id VARCHAR(32) 活动申请明细ID
cm_id VARCHAR(32) 客户ID
cm_name VARCHAR(200) 客户名称
cm_code VARCHAR(32) 客户编码
cm_source_code VARCHAR(32) 客户source_code
pd_list List 实际进场商品
pd_list.pd_code VARCHAR(1000) 进场商品编码
pd_list.pd_name VARCHAR(100) 进场商品名称
pd_list.pd_entrance_fee VARCHAR(100) 协议进场价格(申请时的价格)
pd_list.retail_price VARCHAR(100) 实际进场价格(上报时采集的价格)
record_id VARCHAR(32) 上报记录ID
sye_id VARCHAR(32) 上报人ID(勤策的ID)
sye_code VARCHAR(32) 上报人编码(勤策的编码)
source_code VARCHAR(32) 上报人唯一标识(source_code)
sye_name VARCHAR(100) 上报人姓名
arrive_lla VARCHAR(200) 上报地标信息。纠偏后的定位数据转换得到的地标信息
arrive_pos_offset NUMERIC(20,2) 和客户的偏差距离(米)。纠偏后的位置和客户纠偏后的位置的差值,当客户位置为空时,偏差距离为空
comment_status VARCHAR(32) 评价状态("":未评价/1:合格/0:不合格)
record_sys_id VARCHAR(32) 评价人ID(勤策的ID)
record_sys_code VARCHAR(32) 评价人编码(勤策的编码)
record_source_code VARCHAR(32) 评价人唯一标识(source_code)
record_sys_name VARCHAR(100) 评价人姓名
comment_time VARCHAR(32) 评价时间 (yyyy-MM-dd HH:mm:ss)
comment_text VARCHAR(100) 评价意见
re_comment_status VARCHAR(32) 复评状态("":未评价/1:合格/0:不合格)
re_comment_text VARCHAR(100) 复评意见
re_record_id VARCHAR(32) 复评人ID(勤策的ID)
re_record_code VARCHAR(32) 复评人编码(勤策的编码)
re_record_source_code VARCHAR(32) 复评人唯一标识(source_code)
re_record_name VARCHAR(100) 复评人姓名
re_comment_time VARCHAR(32) 复评时间 (yyyy-MM-dd HH:mm:ss)
visit_implement_id VARCHAR(32) 拜访记录ID
form_define_id VARCHAR(32) 上报表单模板ID
data_id VARCHAR(32) 上报表单数据ID
record_time VARCHAR(32) 上报时间 (yyyy-MM-dd HH:mm:ss)
status VARCHAR(32) 删除状态。0:删除,1:正常

参数说明:

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