开放平台

获取合同列表

接口说明

查询合同信息列表,并返回合同下的订单明细(orderInfo)。

请求信息

  • 请求 URL: http://lbl-open.thinkerx.com/api/lbl/get-contract-info

  • 请求方式: GET

请求参数

参数名必选类型说明备注
login_tokenstring通行证接口通过中间件鉴权,需携带有效通行证
buyer_addressstring项目地址支持模糊筛选(文档未明确,按常见查询行为处理)
group_codestring合同号精确或前缀查询取决于服务端实现
customer_namestring经销商名称建议 URL 编码后传递中文
start_date条件必选date开始时间(示例:2023-01-01当未传 group_code 时必填;建议格式 YYYY-MM-DD
end_datedate结束时间不传时默认等于 start_date;建议格式 YYYY-MM-DD,并保证 end_date >= start_date
factory_idstring单库工厂 id多工厂场景下建议传入
order_statusstring筛选条件:订单状态取值见「合同订单状态字典」
date_filter_columnstring筛选条件:时间筛选字段

可选值

create_time(创建时间)delivery_time(发货时间)finish_time(完成时间)、

due_date(交货日期)

source_idstring筛选条件:来源唯一值 id常与 source_type 组合使用
source_typestring筛选条件:来源类型具体枚举值文档未提供,需结合业务侧定义

customColumns 所返回的组属性(finance_order_group_attr按共享排头自动过滤:读取 config_jsname = orderGroup_column_config 的配置(与老板良「所有订单」Uisetting::actionSaveCommonColumn 保存的共享排头同源;多工厂时与 ConfigJsModel::getSqlConfig 一致,优先当前 factory_id),仅保留其中 classkclasscustomLoadLaterischecked 为真 的列对应的 name。若未读到有效配置,则返回该合同下全部组属性(不做 name 过滤)。批量写入自定义列值见文档 批量修改合同自定义列

参数校验规则

  1. start_dategroup_code 不能同时为空(至少传一个)。

  2. 当传 start_date 时,系统会将时间范围转换为当天 00:00:0023:59:59

  3. 仅按日期查询时,时间跨度不能超过 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,
		"panel_count":1,
		"material_group":[
                      "panel_data": [
                        {
                          "color_book": "",
                          "color": "T01",
                          "name": "多层实木",
                          "thick": "18.00",
                          "width": "1220",
                          "base_material": "18多层实木",
                          "count": 6,
                          "length": "2440",
                          "unit": "张",
                          "type": "panel",
                          "is_add": 0,
                          "spec": "1220*2440",
                          "price": "0",
                          "thing_id": "18"
                        }
                      ],
                      "edge_data": [
                        {
                          "color_book": "",
                          "color": "T01",
                          "thick": "18.00",
                          "width": "1.5",
                          "base_material": "1.5-18封边条",
                          "count": 1,
                          "length": "23.71",
                          "unit": "80米/卷",
                          "spec": "80米/卷",
                          "type": "edge",
                          "price": "13",
                          "is_add": 0,
                          "thing_id": "19"
                        }
                      ],
                      "addon_info": [
                        {
                          "name": "连接件",
                          "spec": "三合一",
                          "count": 48,
                          "unit": "个",
                          "note": "",
                          "price": "10",
                          "is_add": 0,
                          "thing_id": "30"
                        }
                      ]
                    ],
		"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": ""
	}]
}

返回参数

顶层字段

参数名类型说明备注
statusint状态码(0 成功,1 失败)建议以 status == 0 作为成功判断
messagestring返回信息失败时通常返回错误原因
dataarray合同数据列表成功时可为空数组

合同数据(data[]

参数名类型说明备注
idint合同 id主键
group_codestring合同编号业务唯一编号
money_sumstring/number合同金额示例里为 number,文档表述为 string,建议按字符串兼容处理
customer_namestring经销商名称
create_timedatetime创建时间典型格式 YYYY-MM-DD HH:mm:ss
due_datedatetime/null预计交货日期允许为 null
buyer_addressstring项目地址
notestring/null备注示例中出现,原“合同数据说明”未列出,已补充
order_statusstring合同订单状态取值见下方「合同订单状态字典」
custimedatetime/null客服受理日期允许为 null
fintimedatetime/null财务受理日期允许为 null
start_timedatetime/null安排生产日期允许为 null
finish_timedatetime/null完成日期允许为 null
delivery_timedatetime/null交货日期允许为 null
source_typestring/null来源类型对应请求参数 source_type,可空
source_idstring/null来源唯一值 id对应请求参数 source_id,可空
order_typeint订单类型业务枚举值,当前示例为 0
panel_count
int板材数量默认 0
material_grouparray 材料信息见下方“材料信息”
orderInfoarray订单数据见下方“订单数据”
customColumnsarray合同组排头自定义列数据来自 finance_order_group_attr;每条含 namelabelvaluecolor。列范围由 config_js 共享排头 orderGroup_column_config 中已勾选的自定义列(customLoadLater)决定,与老板良「所有订单」共享排头保存逻辑一致;无有效排头配置时不按 name 过滤
marksstring订单标签汇总多个标签使用英文逗号拼接;无订单或无标签时为空字符串 ""

合同订单状态字典

合同层 order_status、订单层 orderInfo[].status 使用同一套状态码(与老板良 StatusModel 一致):

状态码含义
not_sent未转正
had_refuse拒绝
had_offer未核单
not_confirm客服未受理
had_confirmcus财务未审核
had_technical技术已审核
had_confirm生产待安排
make_ready生产已安排
make_doing正在生产
make_done完成生产
had_soon待出库
had_delivery已出库
not_delivery未出库

请求参数 order_status 筛选时常用:not_sentnot_confirmhad_confirmcushad_confirmmake_readymake_doingmake_donehad_soonhad_delivery

自定义列(customColumns[]

参数名类型说明备注
namestring自定义列字段键finance_order_group_attr.name 一致,且落在共享排头 orderGroup_column_config 中已启用的 customLoadLater 列上(若排头可解析)
labelstring/null列标题/展示名finance_order_group_attr.label 一致
valuestring/null单元格内容finance_order_group_attr.value 一致
colorstring/null单元格颜色等扩展finance_order_group_attr.color 一致

材料信息(material_group[]

参数名类型说明备注
panel_data[]
array板材信息见下方item

panel_data->color颜色

panel_data->name板材名称

panel_data->thick板材厚度

panel_data->width板材宽度

panel_data->count板材数量

panel_data->base_material基材

panel_data->length板材长度

panel_data->unit单位

panel_data->spec规格

panel_data->price板材单价
edge_data[]array封边信息见下方item

edge_data->color封边颜色

edge_data->thick封边宽度

edge_data->width封边厚度

edge_data->base_material基材

edge_data->count封边数量

edge_data->length封边长度

edge_data->unit单位

edge_data->spec规格

edge_data->price封边单价
addon_info[]array五金信息见下方item

addon_info->name五金名称

addon_info->spec五金规格

addon_info->count五金数量

addon_info->unit单位

addon_info->price五金单价

订单数据(orderInfo[]

参数名类型说明备注
finance_group_idint所属合同 id对应合同层 id
idint订单 id主键
order_codestring订单编号
product_namestring产品名称
customer_namestring经销商名称
heightstring/null尺寸单位以业务系统为准,允许为空
roomstring/null房间新版接口增加字段,允许为空
widthstring/null尺寸单位以业务系统为准,允许为空
colorstring/null颜色允许为空
countstring/number/null数量允许为空;不同场景返回类型可能不同
money_sumstring/number订单金额有权限返回金额,无权限返回“无权限查看”
handlerstring操作人
statusstring订单状态与合同 order_status 同字典,见「合同订单状态字典」
cabinet_specstring/null柜体规格允许为空
back_specstring/null背板规格允许为空
cabinet_namestring/null柜体名称允许为空
notestring/null备注可空
buyer_addressstring项目地址示例中出现,原“订单数据说明”未列出,已补充
zhankaimianjistring/null展开面积来自订单属性扩展字段
houdustring/null厚度来自订单属性扩展字段
zhankaimianjibackstring/null背板展开面积来自订单属性扩展字段

状态码说明

status含义
0成功
1失败



新格尔累计为
7368555
位用户提供服务

客服热线

联系电话:400-1567-080

微信咨询

扫码在线咨询
企微官网客服在线随时答复

公众号

扫一扫
关注官方公众号

抖音号

扫一扫
关注官方抖音号