单据列表查询
- 接口:/common/document/documentHeaderList
- Method:POST
- 数据格式:JSON
- 接口说明:
- 默认返回字段:
document_num、header_type_vo、submit_date、creation_date、submit_user_vo、created_by_vo、status、gl_status、pay_status、total_amount,其余字段均需调用方传入才会查询
- 提交时间范围为必填项,且时间跨度不能超过一年
参数
请求参数
| 字段名称 |
字段类型 |
字段描述 |
默认值 |
是否必填 |
长度 |
| bizId |
String |
唯一标识 |
|
FALSE |
36 |
| timestamp |
Long |
时间戳 |
|
FALSE |
13 |
| data |
Object |
请求数据 |
|
TRUE |
/ |
| data.page_num |
Integer |
分页页数 |
1 |
TRUE |
/ |
| data.page_size |
Integer |
分页条数(默认100条,最大100条) |
100 |
TRUE |
/ |
| data.select_columns |
Array |
额外查询的字段列表 |
|
FALSE |
/ |
| data.submit_date_from |
Long |
单据提交时间(毫秒时间戳) |
|
TRUE |
13 |
| data.submit_date_to |
Long |
单据提交时间(毫秒时间戳) |
|
TRUE |
13 |
| data.document_nums |
Array |
单据号列表 |
|
FALSE |
/ |
| data.statuses |
Array |
单据状态列表 |
|
FALSE |
/ |
| data.header_type_codes |
Array |
单据类型列表 |
|
FALSE |
/ |
| data.branch_codes |
Array |
单据所属分公司编码列表 |
|
FALSE |
/ |
| data.charge_user_codes |
Array |
单据报销人列表 |
|
FALSE |
/ |
| data.charge_department_codes |
Array |
费用承担部门列表 |
|
FALSE |
/ |
| data.submit_user_codes |
Array |
单据提交人列表 |
|
FALSE |
/ |
| data.submit_department_codes |
Array |
单据提交部门列表 |
|
FALSE |
/ |
| data.total_amount_from |
Decimal |
总金额范围 |
|
FALSE |
/ |
| data.total_amount_to |
Decimal |
总金额范围 |
|
FALSE |
/ |
| data.gl_date_from |
Long |
过账日期 (毫秒时间戳) |
|
FALSE |
13 |
| data.gl_date_to |
Long |
过账日期 (毫秒时间戳) |
|
FALSE |
13 |
| data.gl_statuses |
Array |
过账状态列表 |
|
FALSE |
/ |
| data.supplier_codes |
Array |
供应商列表 |
|
FALSE |
/ |
| data.approved_date_from |
Long |
审批通过日期 (毫秒时间戳) |
|
FALSE |
13 |
| data.approved_date_to |
Long |
审批通过日期 (毫秒时间戳) |
|
FALSE |
13 |
返回参数
| 字段名称 |
字段类型 |
字段描述 |
| resCode |
Integer |
响应状态码 |
| resMsg |
String |
返回信息描述 |
| data |
Object |
返回数据 |
| data.page_num |
Integer |
当前页数 |
| data.page_size |
Integer |
每页条数 |
| data.page_info |
Array |
单据信息 |
示例
请求数据
{
"bizId": "0fd4fcdb-fb8f-475f-a885-e5adc71ed747",
"timestamp": "1672588800000",
"data": {
"page_num": 1,
"page_size": 100,
"submit_date_from": 1704067200000,
"submit_date_to": 1735689599999,
"document_nums": ["EXP0000001234", "EXP0000001235"],
"statuses": ["submitted", "approved"],
"header_type_codes": ["EXPENSE", "TRAVEL"],
"branch_codes": ["C001"],
"charge_user_codes": ["user001"],
"charge_department_codes": ["dept001"],
"submit_user_codes": ["user002"],
"submit_department_codes": ["dept002"],
"total_amount_from": 100.00,
"total_amount_to": 10000.00,
"gl_date_from": 1704067200000,
"gl_date_to": 1735689599999,
"gl_statuses": ["pending"],
"select_columns": ["description"]
}
}
错误时返回数据
{
"resCode": 0,
"resMsg": "单据提交时间范围不能为空"
}
{
"resCode": 0,
"resMsg": "单据提交时间跨度不能超过一年"
}
成功时返回数据
{
"resCode": 200000,
"resMsg": "success",
"data": {
"page_size": 1,
"page_num": 1,
"page_info": [
{
"id": 1919765,
"code": "REQ0000025487",
"document_id": 1919764,
"internal_type": "request",
"total_amount": 2000.00,
"submit_date": 1735542480000,
"submit_user": {
"id": 223564,
"code": "yw1@qq.com",
"mobile": "2125551234",
},
"header_type_id": 144817,
"status": "approved",
"pay_status": "pending",
"created_by": {
"id": 223564,
"code": "yw1@qq.com",
"mobile": "2125551234"
},
"creation_date": 1735542460000,
"first_submit_date": 1735542480000,
"header_type": {
"id": 144817,
"code": "90636-1",
"type": "90636-1-申请单"
}
}
]
}
}