# 收款计划接口
# 新增收款计划
接口说明: 1、通过查询对象配置 (opens new window)接口,获得对象对应的fieldList --> 字段列表结构信息 2、详细字段入参规范说明参见 附录六:aPaaS字段类型样式说明 (opens new window) 3、部分预置字段的特殊逻辑,参考 fields特殊参数说明、slave_fields.ig_payment_received_trend、slave_fields.ig_payment_received_detail特殊参数说明
请求方式: POST(HTTPS)
**请求地址:
** https://openapi.qince.com/api/ig/v1/paymentPlanAdd/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
fields | VARCHAR | 是 | JSON格式字符串。格式:{字段key:value}, (非特殊字段数据格式参见附录六) |
slave_fields | VARCHAR | 是 | JSON格式字符串。数据中传入id为编辑,无id为新增, 格式:{对象key:[{字段key:字段值}]}(非特殊字段数据格式参见附录六) |
is_trigger | boolean | 否 | 是否触发工作流;true:触发,false:不触发 |
trigger_employee | VARCHAR(32) | 否 | 是否触发工作流为true的时候必填,员工id |
check_rule | boolean | 否 | 是否校验验证规则和查重规则;true:校验,false:不校验 |
fields特殊参数说明:
字段名称 | 字段key | 字段类型 | 必填 | 特殊说明 |
---|---|---|---|---|
客户 | customer | 客户 | 是 | 系统客户模板id |
计划收款金额 | planned_amount | 金额 | 是 | 收款金额 |
计划收款日期 | planned_date | 日期 | 是 | 日期格式 |
应收单 | accounts_receivable | 关联关系 | 否 | 需关联的应收单id |
币种 | currency_type | 单选框 | 否 | 未开启多币种时,不需要传,无论币种字段传入什么值均不接收; 开启多币种后,币种字段不传默认为本位币,传值取传入的值; |
slave_fields.ig_payment_received_trend 特殊参数说明:
字段名称 | 字段key | 字段类型 | 必填 | 特殊说明 |
---|---|---|---|---|
结算方式 | settlement_type | 单选 | 是 | 对应系统结算方式(线下) |
响应示例:
{
"msg_id": "X000001",
"return_code": 0,
"return_msg": "",
"response_data": "6066483328179541690"
}
异常示例:
{
"msg_id": "X000001",
"return_code": 1,
"return_msg": "保存失败!"
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
msg_id | String | 请求消息ID |
return_code | int | 响应编码。0:成功,1:失败。其他详见附录错误码说明 (opens new window) |
return_msg | String | 响应说明 |
return_data | String |
# 查询收款计划
接口说明 1、通过查询对象配置 (opens new window)接口,获得对象对应的fieldList --> 字段列表结构信息 2、请求入参操作符,详见附录操作符说明 (opens new window) 3、字段出参规范说明参见 附录六:aPaaS字段类型样式说明 (opens new window)
请求方式: POST(HTTPS)
**请求地址:
** https://openapi.qince.com/api/ig/v1/paymentPlanQuery/{ openid }/{ timestamp }/{ digest }/{ msg_id }
在线调试
请求示例:
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
page | INT | 是 | 页数,默认值为1 |
rows | INT | 是 | 条数,默认值为100 |
sorts | List | 是 | 排序,默认按创建时间倒序排序 |
sorts.field_key | VARCHAR(30) | 是 | 排序字段 |
sorts.type | VARCHAR(4) | 是 | 排序类型:asc 正序,desc 倒序 |
query_group | List | 是 | 查询条件列表 |
query_group.connector | List | 是 | 组内查询条件,条件AND或OR |
query_group.filters | VARCHAR(4) | 是 | 组内查询条件 |
query_group.filters.field_key | VARCHAR(32) | 是 | 字段key |
query_group.filters.operator | VARCHAR(10) | 是 | 操作符,详见附录操作符说明 (opens new window) |
query_group.filters.field_values | List | 是 | 字段值集合 |
响应示例:
{
"msg_id": "X000001",
"return_code": 0,
"return_msg": "",
"response_data": "<<DATA>>"
}
数据DATA示例:
[
{
"field_QxaDA__c": {
"format": "YYYY-MM-DD",
"value": "2025-03-13"
},
"field_T08db__c": "222",
"field_TtFXb__c": "222",
"field_dWPHL__c": [
{
"code": "91CIFbjO",
"label": "选项1",
"status": "1"
}
],
"id": "9222626961451321265",
"field_pOceu__c": "1",
"lock_status": {
"code": "UNLOCK",
"label": "未锁定"
},
"field_whz1e__c": "222",
"create_time": {
"format": "YYYY-MM-DD HH:mm:ss",
"value": "2025-03-13 15:23:46"
},
"approval_status": {
"code": "APPROVED",
"label": "已通过"
},
"source_type": {
"code": "LROPFXCJ",
"label": "自建"
},
"field_3kgN5__c": {
"code": "nPFlJR4S",
"label": "选项1"
},
"name": "0313cs02",
"creator_id": {
"name": "x1",
"id": "6611719441804418541",
"status": "1"
},
"field_GOITb__c": {
"format": "YYYY-MM-DD",
"value": "2025-03-13"
},
"field_8JouQ__c": {
"code": "true",
"label": "是"
},
"status": {
"code": "NORMAL",
"label": "正常"
},
"modify_time": {
"format": "YYYY-MM-DD HH:mm:ss",
"value": "2025-03-13 15:23:46"
},
"field_Dxf38__c": "1.00",
"field_Y4dFC__c": "00005",
"business_type": {
"code": "busitype_default__c",
"id": "8438431948543484993"
},
"modifyier_id": {
"name": "x1",
"id": "6611719441804418541",
"status": "1"
},
"department": {
"name": "IP16",
"id": "10",
"status": "1"
},
"owner": {
"name": "x1",
"id": "6611719441804418541",
"status": "1"
},
"field_MhfYa__c": {
"format": "YYYY-MM-DD HH:mm",
"value": "2025-03-13 15:23"
},
"field_ujceN__c": "222"
}
]
异常示例:
{
"msg_id": "X000001",
"return_code": 1,
"return_msg": "查询失败!"
}
# 推送收款计划
推送说明:参见 推送aPaaS对象数据变更 (opens new window) 请求示例:
{
"appId": 200004,
"data": {
"objectKey": "ig_payment_plan",
"owner": {
"name": "gm",
"id": "8300537268794337524",
"status": "1"
},
"planned_amount": "10.00",
"lock_status": {
"code": "UNLOCK",
"label": "未锁定"
},
"create_time": {
"format": "YYYY-MM-DD HH:mm:ss",
"value": "2025-07-02 13:52:20"
},
"first_payment_time": {
"format": "YYYY-MM-DD HH:mm"
},
"approval_status": {
"code": "APPROVED",
"label": "已通过"
},
"modify_time": {
"format": "YYYY-MM-DD HH:mm:ss",
"value": "2025-07-02 13:52:20"
},
"received_amount": "0.00",
"planned_ratio": "0.0011",
"source_type": {
"code": "LROPFXCJ",
"label": "自建"
},
"accounts_receivable": {
"name": "AR2025070200010",
"id": "6023487390397473349",
"status": "1"
},
"receivable_amount": "9000.00",
"last_payment_time": {
"format": "YYYY-MM-DD HH:mm"
},
"business_type": {
"code": "busitype_default__c",
"id": "6828349927558862841",
"label": "默认业务类型",
"status": "1"
},
"modifyier_id": {
"name": "gm",
"id": "8300537268794337524",
"status": "1"
},
"creator_id": {
"name": "gm",
"id": "8300537268794337524",
"status": "1"
},
"name": "PP2025070200006",
"id": "7203809467203730246",
"department": {
"name": "RMIG",
"id": "10",
"status": "1"
},
"planned_date": {
"format": "YYYY-MM-DD",
"value": "2025-07-02"
},
"status": {
"code": "NORMAL",
"label": "正常"
},
"customer": {
"objectKey": "bas_cm_dealer",
"name": "江苏万帮4S",
"objectName": "经销商",
"id": "5636794923394770871",
"status": "1"
}
},
"dataFormat": "json",
"dataId": "7203809467203730246",
"dataSource": "biz",
"dataType": "apaas_data_change_event",
"tenantId": 5457613360890366827,
"version": "v1"
}