获取合同列表
接口说明
查询合同信息列表,并返回合同下的订单明细(orderInfo)。
请求信息
请求 URL:
http://lbl-open.thinkerx.com/api/lbl/get-contract-info请求方式:
GET
请求参数
| 参数名 | 必选 | 类型 | 说明 | 备注 |
|---|---|---|---|---|
| login_token | 是 | string | 通行证 | 接口通过中间件鉴权,需携带有效通行证 |
| buyer_address | 否 | string | 项目地址 | 支持模糊筛选(文档未明确,按常见查询行为处理) |
| group_code | 否 | string | 合同号 | 精确或前缀查询取决于服务端实现 |
| customer_name | 否 | string | 经销商名称 | 建议 URL 编码后传递中文 |
| start_date | 条件必选 | date | 开始时间(示例:2023-01-01) | 当未传 group_code 时必填;建议格式 YYYY-MM-DD |
| end_date | 否 | date | 结束时间 | 不传时默认等于 start_date;建议格式 YYYY-MM-DD,并保证 end_date >= start_date |
| factory_id | 否 | string | 单库工厂 id | 多工厂场景下建议传入 |
| order_status | 否 | string | 筛选条件:订单状态 | 可选值:had_confirm、had_confirmcus、had_delivery、had_soon、make_doing、make_done、make_ready、not_confirm、not_sent |
| date_filter_column | 否 | string | 筛选条件:时间筛选字段 | 可选值:create_time、delivery_time、finish_time |
| source_id | 否 | string | 筛选条件:来源唯一值 id | 常与 source_type 组合使用 |
| source_type | 否 | string | 筛选条件:来源类型 | 具体枚举值文档未提供,需结合业务侧定义 |
customColumns 所返回的组属性(finance_order_group_attr)按共享排头自动过滤:读取 config_js 中 name = orderGroup_column_config 的配置(与老板良「所有订单」Uisetting::actionSaveCommonColumn 保存的共享排头同源;多工厂时与 ConfigJsModel::getSqlConfig 一致,优先当前 factory_id),仅保留其中 class 或 kclass 为 customLoadLater 且 ischecked 为真 的列对应的 name。若未读到有效配置,则返回该合同下全部组属性(不做 name 过滤)。批量写入自定义列值见文档 批量修改合同自定义列。
参数校验规则
start_date与group_code不能同时为空(至少传一个)。当传
start_date时,系统会将时间范围转换为当天00:00:00到23:59:59。仅按日期查询时,时间跨度不能超过 365 天。
返回示例
{
"status": 0,
"message": "ok",
"data": [
{
"id": 1923,
"group_code": "FG20260320-3",
"money_sum": 100000,
"customer_name": "成都刘总",
"create_time": "2026-03-20 14:26:52",
"due_date": "2026-03-27 00:00:00",
"buyer_address": "天府三街502",
"note": null,
"order_status": "not_confirm",
"custime": null,
"fintime": null,
"start_time": null,
"finish_time": null,
"delivery_time": null,
"source_type": null,
"source_id": null,
"order_type": 0,
"orderInfo": [
{
"finance_group_id": 1923,
"id": 4081,
"order_code": "20260320-13",
"product_name": "门板",
"customer_name": "成都刘总",
"height": null,
"room": null,
"width": null,
"color": null,
"count": null,
"money_sum": 100000,
"handler": "",
"status": "had_delivery",
"cabinet_spec": null,
"back_spec": null,
"cabinet_name": null,
"note": null,
"buyer_address": "天府三街502",
"zhankaimianji": "0",
"houdu": null,
"zhankaimianjiback": "0"
}
],
"customColumns": [
{
"name": "custom_field_key",
"label": "展示名称",
"value": "单元格值",
"color": ""
}
],
"marks": ""
}
]
}返回参数
顶层字段
| 参数名 | 类型 | 说明 | 备注 |
|---|---|---|---|
| status | int | 状态码(0 成功,1 失败) | 建议以 status == 0 作为成功判断 |
| message | string | 返回信息 | 失败时通常返回错误原因 |
| data | array | 合同数据列表 | 成功时可为空数组 |
合同数据(data[])
| 参数名 | 类型 | 说明 | 备注 |
|---|---|---|---|
| id | int | 合同 id | 主键 |
| group_code | string | 合同编号 | 业务唯一编号 |
| money_sum | string/number | 合同金额 | 示例里为 number,文档表述为 string,建议按字符串兼容处理 |
| customer_name | string | 经销商名称 | |
| create_time | datetime | 创建时间 | 典型格式 YYYY-MM-DD HH:mm:ss |
| due_date | datetime/null | 预计交货日期 | 允许为 null |
| buyer_address | string | 项目地址 | |
| note | string/null | 备注 | 示例中出现,原“合同数据说明”未列出,已补充 |
| order_status | string | 订单状态 | 示例中出现,原“合同数据说明”未列出,已补充 |
| custime | datetime/null | 客服受理日期 | 允许为 null |
| fintime | datetime/null | 财务受理日期 | 允许为 null |
| start_time | datetime/null | 安排生产日期 | 允许为 null |
| finish_time | datetime/null | 完成日期 | 允许为 null |
| delivery_time | datetime/null | 交货日期 | 允许为 null |
| source_type | string/null | 来源类型 | 对应请求参数 source_type,可空 |
| source_id | string/null | 来源唯一值 id | 对应请求参数 source_id,可空 |
| order_type | int | 订单类型 | 业务枚举值,当前示例为 0 |
| orderInfo | array | 订单数据 | 见下方“订单数据” |
| customColumns | array | 合同组排头自定义列 | 数据来自 finance_order_group_attr;每条含 name、label、value、color。列范围由 config_js 共享排头 orderGroup_column_config 中已勾选的自定义列(customLoadLater)决定,与老板良「所有订单」共享排头保存逻辑一致;无有效排头配置时不按 name 过滤 |
| marks | string | 订单标签汇总 | 多个标签使用英文逗号拼接;无订单或无标签时为空字符串 "" |
自定义列(customColumns[])
| 参数名 | 类型 | 说明 | 备注 |
|---|---|---|---|
| name | string | 自定义列字段键 | 与 finance_order_group_attr.name 一致,且落在共享排头 orderGroup_column_config 中已启用的 customLoadLater 列上(若排头可解析) |
| label | string/null | 列标题/展示名 | 与 finance_order_group_attr.label 一致 |
| value | string/null | 单元格内容 | 与 finance_order_group_attr.value 一致 |
| color | string/null | 单元格颜色等扩展 | 与 finance_order_group_attr.color 一致 |
订单数据(orderInfo[])
| 参数名 | 类型 | 说明 | 备注 |
|---|---|---|---|
| finance_group_id | int | 所属合同 id | 对应合同层 id |
| id | int | 订单 id | 主键 |
| order_code | string | 订单编号 | |
| product_name | string | 产品名称 | |
| customer_name | string | 经销商名称 | |
| height | string/null | 高 | 尺寸单位以业务系统为准,允许为空 |
| room | string/null | 房间 | 新版接口增加字段,允许为空 |
| width | string/null | 宽 | 尺寸单位以业务系统为准,允许为空 |
| color | string/null | 颜色 | 允许为空 |
| count | string/number/null | 数量 | 允许为空;不同场景返回类型可能不同 |
| money_sum | string/number | 订单金额 | 有权限返回金额,无权限返回“无权限查看” |
| handler | string | 操作人 | |
| status | string | 订单状态 | 与 order_status 枚举同体系 |
| cabinet_spec | string/null | 柜体规格 | 允许为空 |
| back_spec | string/null | 背板规格 | 允许为空 |
| cabinet_name | string/null | 柜体名称 | 允许为空 |
| note | string/null | 备注 | 可空 |
| buyer_address | string | 项目地址 | 示例中出现,原“订单数据说明”未列出,已补充 |
| zhankaimianji | string/null | 展开面积 | 来自订单属性扩展字段 |
| houdu | string/null | 厚度 | 来自订单属性扩展字段 |
| zhankaimianjiback | string/null | 背板展开面积 | 来自订单属性扩展字段 |
状态码说明
| status | 含义 |
|---|---|
| 0 | 成功 |
| 1 | 失败 |
