查询业务实例列表（台账）
该接口用于查询“台账-自定义台账”的数据
接口说明
接口方式
POST
请求地址
/api/openapi/custom/search
请求参数
| 字段名 |
变量名 |
必填 |
类型 |
描述 |
示例值 |
| 业务对象ID |
definitionCode |
是 |
string |
业务对象ID |
SF231231 |
| 业务对象实例编码 |
bizCode |
否 |
string |
业务对象实例编码，与参与人参数不可同时为空 |
001 |
| 参与人 |
participants |
否 |
stringArray |
参与人工号数组，与业务对象实例编码不可同时为空 |
["e123","e124"] |
| 分页号 |
pageNo |
否 |
int |
从 1 开始 |
1 |
| 分页大小 |
pageSize |
否 |
int |
默认 20，最大值 20 |
20 |
请求示例
{
"definitionCode":"SF231231",
"bizCode":"001",
"participants":["e123","e124"]
}
响应参数
| 字段名 |
变量名 |
必填 |
类型 |
描述 |
示例值 |
| 接口状态码 |
code |
是 |
string |
ACK 为接口操作成功，NACK 为接口操作失败 |
ACK |
| 接口错误码 |
errorCode |
否 |
string |
code 为 NACK 时返回，作为具体错误内容描述 |
999996 |
| 接口数据 |
data |
否 |
array |
code 为 ACK 是返回，分页数据接口 |
见下表格 (分页结构) |
分页结构
| 字段名 |
变量名 |
必填 |
类型 |
描述 |
示例值 |
| 是否还有下一页数据 |
hasNextPage |
是 |
bool |
true 下一页还有数据，false 下一页没有数据 |
true |
| 列表数据 |
list |
否 |
array |
本次分页返回的数据 |
见下表格(数据格式) |
数据结构
| 字段名 |
变量名 |
必填 |
类型 |
描述 |
示例值 |
| 名称 |
name |
是 |
string |
名称 |
测试 |
| 业务对象实例编码 |
bizCode |
是 |
string |
业务对象实例编码 |
001 |
| 核算币种 |
accountCurrency |
否 |
string |
核算币种 |
CNY |
| 公司抬头编码 |
legalEntityCode |
否 |
string |
公司抬头编码 |
425325324123 |
| 公司抬头 |
legalEntityName |
是 |
string |
公司抬头 |
00 |
| 往来单位编码 |
tradingPartnerCode |
是 |
string |
往来单位编码 |
123 |
| 往来单位 |
tradingPartnerName |
是 |
string |
往来单位 |
往来单位 |
| 自定义对象值 |
customObjectInfo |
是 |
json |
自定义对象值 |
{"CF329":"111"} |
响应示例
{
"code":"ACK",
"data": {
"hasNextPage": true,
"list": [
{
"name": "001",
"bizCode": "001",
"accountCurrency": "核算币种",
"legalEntityCode": "公司抬头code",
"legalEntityName": "公司抬头name",
"tradingPartnerCode": "往来单位code",
"tradingPartnerName": "往来单位",
"customObjectInfo": {
"CF329": [
{
"amount": 35,
"currency": "HKD",
"amountStr": "HKD35.00"
},
{
"amount": 24.5,
"currency": "",
"amountStr": "24.50"
}
],
"CF330": [
{
"amount": 46,
"currency": "HKD",
"amountStr": "HKD46.00"
},
{
"amount": 32.2,
"currency": "",
"amountStr": "32.20"
}
]
}
}
]
}
}
修改记录
2023-04-20 新增查询业务实例列表接口文档