单据查询(自定义查询)
- 接口:/common/customize/document/find
- Method:POST
- 数据格式:JSON
- 接口说明:
- 该接口为自定义单据查询接口,支持更灵活的查询条件和字段筛选
- 支持通过多种条件组合查询单据信息
- 支持自定义返回字段,优化查询性能
- 支持分页查询
参数
请求参数
基础查询参数
| 字段名称 |
字段类型 |
字段描述 |
默认值 |
是否必填 |
长度限制 |
| page_num |
Integer |
分页页数 |
1 |
TRUE |
/ |
| page_size |
Integer |
分页条数 |
20 |
TRUE |
/ |
时间范围查询参数
| 字段名称 |
字段类型 |
字段描述 |
默认值 |
是否必填 |
长度限制 |
| date_field_name |
String |
日期字段名 |
submit_date |
FALSE |
64 |
| start_datetime_timestamp |
Long |
开始时间戳(毫秒) |
|
FALSE |
13 |
| end_datetime_timestamp |
Long |
结束时间戳(毫秒) |
|
FALSE |
13 |
单据基本信息查询参数
| 字段名称 |
字段类型 |
字段描述 |
默认值 |
是否必填 |
长度限制 |
| document_num |
String |
单据号(模糊匹配) |
|
FALSE |
64 |
| document_nums |
Array |
单据号列表 |
|
FALSE |
/ |
| status |
String |
单据状态 |
|
FALSE |
64 |
| statuses |
Array |
单据状态列表 |
|
FALSE |
/ |
| type_codes |
Array |
单据类型编码列表 |
|
FALSE |
/ |
| branch_codes |
Array |
分公司编码列表 |
|
FALSE |
/ |
| description |
String |
描述 |
|
FALSE |
512 |
| external_id |
String |
外部ID |
|
FALSE |
64 |
组织架构查询参数
| 字段名称 |
字段类型 |
字段描述 |
默认值 |
是否必填 |
长度限制 |
| charge_department |
Array |
费用承担部门ID列表 |
|
FALSE |
/ |
| submit_department |
Array |
提交部门ID列表 |
|
FALSE |
/ |
| charge_user |
Array |
费用承担人ID列表 |
|
FALSE |
/ |
| charge_user_codes |
Array |
费用承担人编码列表 |
|
FALSE |
/ |
| submit_user |
Array |
提交人ID列表 |
|
FALSE |
/ |
| pay_user |
Array |
收款人ID列表 |
|
FALSE |
/ |
| created_by |
Array |
创建人ID列表 |
|
FALSE |
/ |
主数据关联查询参数
| 字段名称 |
字段类型 |
字段描述 |
默认值 |
是否必填 |
长度限制 |
| supplier_code |
String |
供应商编码 |
|
FALSE |
64 |
| currency_code |
Array |
币种列表 |
|
FALSE |
/ |
| gl_period |
Array |
财年期间列表 |
|
FALSE |
/ |
支付相关查询参数
| 字段名称 |
字段类型 |
字段描述 |
默认值 |
是否必填 |
长度限制 |
| pay_object |
String |
支付对象 |
|
FALSE |
64 |
其他查询参数
| 字段名称 |
字段类型 |
字段描述 |
默认值 |
是否必填 |
长度限制 |
| internal_type |
String |
内部类型 |
|
FALSE |
64 |
| header_columns |
Array |
返回的表头字段列表 |
|
FALSE |
/ |
自定义字段查询参数
支持 column1 ~ column50 的查询,每个自定义字段支持精确匹配查询方式:
示例:
| 字段名称 | 字段类型 | 字段描述 | 默认值 | 是否必填 | 长度限制 |
|---------|---------|---------|-------|---------|---------|
| column1 | Object | 自定义字段1 | | FALSE | / |
返回参数
分页信息
| 字段名称 |
字段类型 |
字段描述 |
| resCode |
String |
响应状态码 |
| resMsg |
String |
返回信息描述 |
| data |
Object |
返回数据 |
| data.page_num |
Integer |
当前页数 |
| data.page_size |
Integer |
每页条数 |
| data.total_page |
Integer |
总页数 |
| data.total_count |
Integer |
总条数 |
| data.page_info |
Array |
单据列表信息 |
单据头信息
以下字段在 data.page_info 路径下返回
| 字段名称 |
字段类型 |
字段描述 |
| id |
Integer |
单据ID |
| code |
String |
单据号 |
| status |
String |
单据状态 |
| header_type |
Object |
单据类型信息 |
| header_type.id |
Integer |
单据类型ID |
| header_type.code |
String |
单据类型编码 |
| header_type.type |
String |
单据类型名称 |
| header_type.internal_type |
String |
单据内部类型 |
| header_type.config_type_code |
String |
配置类型编码 |
| header_type.auto_close |
String |
是否自动关闭 |
| header_type.group_num |
Integer |
单据类型分组编号 |
| header_type.group_name |
String |
单据类型分组名称 |
| header_type.staff_flag |
String |
人员标记 |
| header_type.request_required_flag |
String |
申请单必填标记 |
| description |
String |
描述 |
| long_description |
String |
富文本描述 |
| finance_description |
String |
财务审核描述 |
| external_id |
String |
外部ID |
| journal_num |
String |
凭证号 |
| total_amount |
Decimal |
总金额(本位币) |
| total_claim_amount |
Decimal |
总发生金额(本位币) |
| advance_amount |
Decimal |
总借款金额(本位币) |
| total_pay_amount |
Decimal |
总付款金额(本位币) |
| currency_code |
String |
币种 |
| submit_date |
Long |
提交时间 |
| start_datetime |
Long |
开始时间 |
| end_datetime |
Long |
结束时间 |
| preapproved_date |
Long |
业务审批通过时间 |
| checked_date |
Long |
财务审核通过时间 |
| approved_date |
Long |
审批通过时间 |
| payment_date |
Long |
支付日期 |
| actual_payment_date |
Long |
实际支付日期 |
| close_date |
Long |
关闭时间 |
| creation_date |
Long |
创建时间 |
| last_update_date |
Long |
最近更新时间 |
| due_date |
Long |
到期日期 |
| gl_date |
Long |
过账日期 |
| gl_status |
String |
过账状态 |
| pay_status |
String |
支付状态 |
| pay_status_message |
String |
支付状态信息 |
| delivery_status |
String |
纸单状态 |
| pay_object |
String |
支付对象 |
| modify_status |
String |
修改状态 |
| credit_pay |
String |
信用支付标记 |
| review_flag |
String |
复核标记 |
| include_paper_invoice |
String |
包含纸质发票标记 |
组织架构信息
| 字段名称 |
字段类型 |
字段描述 |
| branch |
Object |
单据所属分公司信息 |
| branch.id |
Integer |
分公司ID |
| branch.code |
String |
分公司编码 |
| branch.department_name |
String |
分公司名称 |
| branch.company_name |
String |
公司名称 |
| branch.tax_number |
String |
税号 |
| branch.language |
String |
语种 |
| submit_department |
Object |
提交部门信息(字段与branch一致) |
| charge_department |
Object |
费用承担部门信息(字段与branch一致) |
人员信息
| 字段名称 |
字段类型 |
字段描述 |
| submit_user |
Object |
提交人信息 |
| submit_user.id |
Integer |
用户ID |
| submit_user.code |
String |
用户工号 |
| submit_user.employee_number |
String |
员工号 |
| submit_user.user_name |
String |
用户名 |
| submit_user.full_name |
String |
全名 |
| submit_user.email_address |
String |
邮箱 |
| submit_user.mobile |
String |
手机号 |
| charge_user |
Object |
费用承担人信息(字段与submit_user一致) |
| pay_user |
Object |
收款人信息(字段与submit_user一致) |
| created_by |
Object |
创建人信息(字段与submit_user一致) |
| auditor |
Object |
审核人信息(字段与submit_user一致) |
主数据信息
| 字段名称 |
字段类型 |
字段描述 |
| project |
Object |
项目信息 |
| project.id |
Integer |
项目ID |
| project.code |
String |
项目编码 |
| project.project_name |
String |
项目名称 |
| supplier_vo |
Object |
供应商信息 |
| supplier_vo.id |
Integer |
供应商ID |
| supplier_vo.code |
String |
供应商编码 |
| supplier_vo.supplier_name |
String |
供应商名称 |
| supplier_vo.enabled_flag |
String |
启用标记 |
| customer |
Object |
客户信息 |
| customer.id |
Integer |
客户ID |
| customer.code |
String |
客户编码 |
| customer.customer_name |
String |
客户名称 |
| customer.enabled_flag |
String |
启用标记 |
| external_person |
Object |
外部人员信息 |
| asset |
Object |
资产信息 |
| asset_type |
Object |
资产类型信息 |
| asset_location |
Object |
资产地点信息 |
| lease_asset |
Object |
租赁资产信息 |
| gl_period_vo |
Object |
财年期间信息 |
| gl_period_vo.id |
Integer |
财年期间ID |
| gl_period_vo.level_name |
String |
期间等级名称 |
| gl_period_vo.period_status |
String |
期间状态 |
| gl_period_vo.start_date |
Long |
期间开始日期 |
| gl_period_vo.end_date |
Long |
期间结束日期 |
银行账号信息
| 字段名称 |
字段类型 |
字段描述 |
| branch_account |
Object |
公司银行账号信息 |
| branch_account.id |
Integer |
银行账号ID |
| branch_account.code |
String |
银行账号 |
| branch_account.bank_name |
String |
银行名称 |
| branch_account.bank_code |
String |
银行代码 |
| branch_account.account_name |
String |
账户名 |
| branch_account.bank_branch |
String |
支行名称 |
| branch_account.bank_address |
String |
银行地址 |
| user_account |
Object |
用户银行账号信息(字段与branch_account类似) |
| supplier_account |
Object |
供应商银行账号信息(字段与branch_account类似) |
| customer_account |
Object |
客户银行账号信息(字段与branch_account类似) |
| external_person_account |
Object |
外部人员银行账号信息(字段与branch_account类似) |
| customized_account |
Object |
自定义账号信息(字段与branch_account类似) |
城市信息
| 字段名称 |
字段类型 |
字段描述 |
| destination_city |
Object |
出发城市信息 |
| destination_city.id |
Integer |
城市ID |
| destination_city.country |
String |
国家 |
| destination_city.code |
String |
城市编码 |
| destination_city.city_name |
String |
城市名称 |
| destination_city.english_name |
String |
英文名称 |
| destination_city.short_name |
String |
城市简称 |
| destination_city_to |
Object |
到达城市信息(字段与destination_city一致) |
| destination_cities |
Array |
多目的地城市信息列表(字段与destination_city一致) |
自定义字段信息
| 字段名称 |
字段类型 |
字段描述 |
| column1 ~ column200 |
Object |
自定义字段值 |
| column1_vo ~ column200_vo |
Object |
自定义字段关联对象 |
附件信息
| 字段名称 |
字段类型 |
字段描述 |
| attachments |
Array |
附件列表 |
| attachments.id |
Integer |
附件ID |
| attachments.attachment_url |
String |
附件URL |
| attachments.file_name |
String |
文件名 |
| attachments1 ~ attachments50 |
Array |
自定义附件分组列表(字段与attachments一致) |
单据行信息
以下字段在 data.page_info.claim_lines 路径下返回
| 字段名称 |
字段类型 |
字段描述 |
| id |
Integer |
单据行ID |
| header_id |
Integer |
单据头ID |
| line_num |
Integer |
行号 |
| expense_id |
Integer |
消费记录ID |
| type_id |
Integer |
费用类型ID |
| internal_type |
String |
内部类型 |
| receipt_currency |
String |
票据币种 |
| exchange_rate |
Decimal |
汇率 |
| claim_amount |
Decimal |
发生金额 |
| tax_amount |
Decimal |
税额 |
| net_amount |
Decimal |
净额 |
| comments |
String |
行描述 |
| finance_comments |
String |
财务审核描述 |
| long_comments |
String |
富文本描述 |
| exp_type |
Object |
费用类型信息 |
| exp_type.id |
Integer |
费用类型ID |
| exp_type.type_code |
String |
费用类型编码 |
| exp_type.type |
String |
费用类型名称 |
| exp_type.category |
String |
费用类别 |
| exp_type.internal_type |
String |
内部类型 |
| charge_user |
Object |
行费用承担人信息(与头的charge_user字段一致) |
| cost_center |
Object |
成本中心信息(与头的charge_department字段一致) |
| project |
Object |
项目信息(与头的project字段一致) |
| tax_code |
Object |
税率信息 |
| tax_code.id |
Integer |
税率ID |
| tax_code.code |
String |
税率编码 |
| tax_code.tax_rate |
Decimal |
税率 |
| dr_account |
Object |
借方会计科目信息 |
| dr_account.id |
Integer |
会计科目ID |
| dr_account.code |
String |
会计科目编码 |
| dr_account.account_name |
String |
会计科目名称 |
| dr_account.enabled_flag |
String |
启用标记 |
| cr_account |
Object |
贷方会计科目信息(字段与dr_account一致) |
| pay_method |
Object |
支付方式信息 |
| pay_method.id |
Integer |
支付方式ID |
| pay_method.pay_method |
String |
支付方式名称 |
| pay_method.factor |
String |
支付因子 |
| pay_method.description |
String |
描述 |
| attachment |
Object |
行附件信息 |
| column1 ~ column50 |
Object |
行自定义字段 |
自定义行信息
以下字段在 data.page_info.custom_line 路径下返回,用于返回自定义行信息
预算行信息
以下字段在 data.page_info.budget_line 路径下返回,用于返回预算行信息
审批流信息
以下字段在 data.page_info.workflow_paths 路径下返回
| 字段名称 |
字段类型 |
字段描述 |
| id |
Integer |
审批流ID |
| header_id |
Integer |
单据头ID |
| approve_type |
String |
审批类型 |
| workflow_step |
String |
审批步骤 |
| workflow_type |
String |
审批流类型 |
| status |
String |
审批状态 |
| open_date |
Long |
审批开始时间 |
| end_date |
Long |
审批结束时间 |
| user_id |
Integer |
审批人ID |
| step_source |
String |
步骤来源 |
| error_code |
String |
错误代码 |
关联单据信息
| 字段名称 |
字段类型 |
字段描述 |
| header_links |
Array |
前序单据列表(字段与单据头信息一致) |
| header_back_links |
Array |
后序单据列表(字段与单据头信息一致) |
示例
请求示例
{
"page_num": 1,
"page_size": 20,
"start_datetime_timestamp": 1672502400000,
"end_datetime_timestamp": 1704038399000,
"date_field_name": "submit_date",
"statuses": [
"submitted",
"approved"
],
"type_codes": [
"T001",
"T014"
],
"branch_codes": [
"D001",
"D002"
],
"supplier_code": "S001",
"charge_user_codes": [
"U001",
"U002"
],
"header_columns": [
"id",
"code",
"status",
"total_amount",
"submit_date"
]
}
返回示例
{
"resCode": 200000,
"resMsg": "success",
"data": {
"page_num": 1,
"page_size": 20,
"total_page": 5,
"total_count": 95,
"page_info": [
{
"id": 123456,
"code": "EXP0000012345",
"status": "approved",
"header_type": {
"id": 1001,
"code": "T001",
"type": "差旅报销",
"internal_type": "claim",
"config_type_code": "gl_none",
"auto_close": "N",
"group_num": 10,
"group_name": "差旅报销",
"staff_flag": "Y",
"request_required_flag": "Y"
},
"description": "北京出差报销",
"total_amount": 3580.50,
"total_claim_amount": 3580.50,
"advance_amount": 2000.00,
"total_pay_amount": 1580.50,
"currency_code": "CNY",
"submit_date": 1672588800000,
"start_datetime": 1672502400000,
"end_datetime": 1672675200000,
"approved_date": 1672761600000,
"payment_date": 1672848000000,
"submit_user": {
"id": 10001,
"code": "U001",
"employee_number": "E001",
"user_name": "zhangsan@example.com",
"full_name": "张三",
"email_address": "zhangsan@example.com",
"mobile": "13800138000"
},
"charge_user": {
"id": 10001,
"code": "U001",
"employee_number": "E001",
"user_name": "zhangsan@example.com",
"full_name": "张三",
"email_address": "zhangsan@example.com",
"mobile": "13800138000"
},
"pay_user": {
"id": 10001,
"code": "U001",
"employee_number": "E001",
"user_name": "zhangsan@example.com",
"full_name": "张三",
"email_address": "zhangsan@example.com",
"mobile": "13800138000"
},
"branch": {
"id": 1,
"code": "D001",
"department_name": "北京分公司",
"company_name": "北京分公司",
"tax_number": "91110000000000000X",
"language": "zh_CN"
},
"submit_department": {
"id": 100,
"code": "D100",
"department_name": "研发部",
"language": "zh_CN"
},
"charge_department": {
"id": 100,
"code": "D100",
"department_name": "研发部",
"language": "zh_CN"
},
"project": {
"id": 1000,
"code": "P001",
"project_name": "XX项目"
},
"destination_city": {
"id": 1,
"country": "China",
"code": "BJS",
"city_name": "北京",
"english_name": "Beijing",
"short_name": "bj"
},
"destination_city_to": {
"id": 2,
"country": "China",
"code": "SHA",
"city_name": "上海",
"english_name": "Shanghai",
"short_name": "sh"
},
"claim_lines": [
{
"id": 500001,
"header_id": 123456,
"line_num": 1,
"internal_type": "train",
"receipt_currency": "CNY",
"exchange_rate": 1.0000,
"claim_amount": 553.50,
"tax_amount": 45.69,
"net_amount": 507.81,
"comments": "北京-上海高铁票",
"exp_type": {
"id": 2001,
"type_code": "T001",
"type": "火车票",
"category": "交通",
"internal_type": "train"
},
"tax_code": {
"id": 1,
"code": "9%",
"tax_rate": 0.09
},
"pay_method": {
"id": 1,
"pay_method": "个人支付",
"factor": "1",
"description": "员工个人支付"
}
},
{
"id": 500002,
"header_id": 123456,
"line_num": 2,
"internal_type": "hotel",
"receipt_currency": "CNY",
"exchange_rate": 1.0000,
"claim_amount": 1800.00,
"tax_amount": 101.89,
"net_amount": 1698.11,
"comments": "上海酒店住宿",
"exp_type": {
"id": 2002,
"type_code": "T002",
"type": "酒店住宿",
"category": "住宿",
"internal_type": "hotel"
},
"tax_code": {
"id": 2,
"code": "6%",
"tax_rate": 0.06
},
"pay_method": {
"id": 1,
"pay_method": "个人支付",
"factor": "1",
"description": "员工个人支付"
}
}
],
"workflow_paths": [
{
"id": 80001,
"header_id": 123456,
"approve_type": "submit",
"workflow_step": "部门经理审批",
"workflow_type": "approve",
"status": "approved",
"open_date": 1672588800000,
"end_date": 1672675200000,
"user_id": 10002
},
{
"id": 80002,
"header_id": 123456,
"approve_type": "approve",
"workflow_step": "财务审批",
"workflow_type": "approve",
"status": "approved",
"open_date": 1672675200000,
"end_date": 1672761600000,
"user_id": 10003
}
],
"header_links": [
{
"id": 123400,
"code": "REQ0000012340",
"status": "approved",
"header_type": {
"code": "RT001",
"type": "差旅申请"
}
}
],
"header_back_links": [
{
"id": 123500,
"code": "PAY0000012350",
"status": "approved",
"header_type": {
"code": "P001",
"type": "付款单"
}
}
]
}
]
}
}