单据查询
- 接口:plugin/claim/{companyCode}
- Method:POST
- 数据格式:JSON
- 接口说明:
警告: 该接口不再迭代, 仅做老项目运维,
新建项目和对接请勿使用该接口, 移步使用单据单张详情查询口
companyCode
为自定义字符串,需定制开发配置
status
为单个单据状态,statuses
为单据状态列表,优先级为status
> statuses
> 都不传(此时查询非deleted和cancelled状态的单据)
date_field_name
的取值有:
- 提交时间
submit_date
/ 开始时间start_datetime
/ 结束时间end_datetime
- 业务审批通过时间
preapproved_date
/ 财务审核通过时间checked_date
/ 审批通过时间approved_date
- 关闭时间
closed_date
/ 支付日期payment_date
/ 实际支付日期actual_payment_date
- 创建时间
creation_date
/ 最近更新时间last_update_date
参数
请求参数
字段名称 |
字段类型 |
字段描述 |
默认值 |
是否必填 |
长度限制 |
page_num |
Integer |
分页页数 |
1 |
TRUE |
/ |
page_size |
Integer |
分页条数 |
100 |
TRUE |
/ |
start_datetime |
Long |
date_field_name开始时间(毫秒时间戳) |
|
TRUE |
13 |
end_datetime |
Long |
date_field_name结束时间(毫秒时间戳) |
|
TRUE |
13 |
date_field_name |
String |
时间参数 |
submit_date |
FALSE |
64 |
document_nums |
Array |
单据号列表 |
|
FALSE |
/ |
status |
String |
单据状态 |
|
FALSE |
64 |
statuses |
Array |
单据状态列表 |
|
FALSE |
/ |
type_codes |
Array |
单据类型列表 |
|
FALSE |
/ |
branch_codes |
Array |
单据所属分公司编码列表 |
|
FALSE |
/ |
charge_user_codes |
Array |
单据报销人列表 |
|
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 路径下返回
字段名称 |
字段类型 |
字段描述 |
code |
String |
单据号 |
status |
String |
单据状态 |
delivery_status |
String |
纸单状态 |
pay_object |
String |
支付对象 |
pay_user |
Integer |
支付对象 |
pay_status |
String |
支付状态 |
preapproved_date |
Long |
业务审批通过时间 |
checked_date |
Long |
财务审核通过时间 |
approved_date |
Long |
审批通过时间 |
payment_date |
Long |
支付日期 |
actual_payment_date |
Long |
实际支付日期 |
close_date |
Long |
关闭时间 |
description |
String |
描述 |
finance_description |
String |
财务审核描述 |
long_description |
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 |
结束时间 |
project |
Object |
项目信息 |
project.code |
String |
项目编码 |
project.project_name |
String |
项目名称 |
submit_department |
Object |
单据提交部门 |
submit_department.code |
String |
单据提交部门编码 |
submit_department.department_name |
String |
单据提交部门名称 |
submit_department.tax_number |
String |
单据提交部门税号 |
submit_department.language |
String |
单据提交部门语种 |
charge_department |
Object |
费用承担部门信息(与submit_department字段保持一致) |
branch |
Object |
单据所属公司信息(与submit_department字段保持一致) |
submit_user |
Object |
单据提交人信息 |
submit_user.mobile |
String |
单据提交人手机号 |
submit_user.code |
String |
单据提交人员工号 |
submit_user.email_address |
String |
单据提交人邮箱 |
submit_user.full_name |
String |
单据提交人全名 |
submit_user.employee_number |
String |
单据提交人员工号 |
submit_user.user_name |
String |
单据提交人用户名 |
pay_user |
Object |
单据收款人信息(submit_user字段保持一致) |
charge_user |
Object |
报销人信息(与submit_user字段保持一致) |
created_by |
Object |
单据创建人信息(与submit_user字段保持一致) |
customer |
Object |
单据创建人信息(与submit_user字段保持一致) |
header_type |
Object |
单据类型信息 |
header_type.code |
String |
单据类型编码 |
header_type.type |
String |
单据类型名称 |
header_type.internal_type |
String |
单据属性类型 |
header_type.auto_close |
String |
是否自动关闭 |
header_type.group_num |
Integer |
单据类型分组编号 |
header_type.group_name |
String |
单据类型分组名称 |
destination_cities |
Array |
多到达城市信息 |
destination_cities.country |
String |
国家 |
destination_cities.city_name |
String |
城市名 |
destination_cities.short_name |
String |
城市名称缩写 |
destination_cities.english_name |
String |
城市英文名 |
destination_city_to |
Object |
到达城市信息(与destination_cities字段保持一致) |
destination_city |
Object |
出发城市信息(与destination_cities字段保持一致) |
deliveries |
Array |
纸单投递信息 |
deliveries.code |
String |
纸单编号 |
deliveries.delivery_date |
Long |
纸单投递日期 |
deliveries.received_date |
Long |
纸单收单日期 |
deliveries.rejected_date |
Long |
纸单退单日期 |
workflow_paths |
Array |
所有审批流信息 |
workflow_paths.approve_type |
String |
审批类型 |
workflow_paths.open_date |
String |
审批开始日期 |
workflow_paths.end_date |
String |
审批结束日期 |
current_workflow |
Object |
当前审批流信息 |
current_workflow.approve_type |
String |
审批类型 |
current_workflow.open_date |
String |
审批开始日期 |
current_workflow.end_date |
String |
审批结束日期 |
branch_account |
Object |
公司银行账号信息 |
branch_account.code |
String |
公司银行账号 |
branch_account.department_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 |
地址 |
branch_account.payer_account_area_code |
String |
招行地区吗 |
user_account |
Object |
收款用户银行账号信息 |
user_account.code |
String |
收款用户银行账号 |
user_account.bank_name |
String |
收款用户银行名称 |
user_account.bank_code |
String |
收款用户银行代码 |
user_account.account_name |
String |
收款用户银行户名 |
user_account.bank_branch |
String |
收款用户银行支行名称 |
user_account.bank_address |
String |
收款用户银行地址 |
user_account.enabled_flag |
String |
收款用户银行启用标志 |
user_account.employee_number |
String |
收款用户员工号 |
supplier_vo |
Object |
供应商信息 |
supplier_vo.code |
String |
供应商编码 |
supplier_vo.branch_code_flag |
String |
供应商分公司标记 |
supplier_vo.enabled_flag |
String |
供应商启用标记 |
supplier_account |
Object |
供应商银行信息 |
supplier_account.supplier_code |
String |
账户名对应供应商编码 |
supplier_account.code |
String |
供应商银行账号 |
supplier_account.bank_name |
String |
供应商银行名称 |
supplier_account.bank_code |
String |
供应商银行代码 |
supplier_account.account_name |
String |
供应商银行户名 |
supplier_account.bank_branch |
String |
供应商银行名称 |
supplier_account.bank_address |
String |
供应商银行地址 |
supplier_account.enabled_flag |
String |
供应商银行启用标志 |
customer |
Object |
客户信息 |
customer.code |
String |
客户编码 |
customer.enabled_flag |
String |
客户启用标记 |
customer_account |
Object |
客户银行信息 |
customer_account.customer_code |
String |
客户编码 |
customer_account.code |
String |
客户银行账号 |
customer_account.bank_name |
String |
客户银行名称 |
customer_account.bank_code |
String |
客户银行代码 |
customer_account.account_name |
String |
客户银行户名 |
customer_account.bank_branch |
String |
客户银行名称 |
customer_account.bank_address |
String |
客户银行地址 |
customer_account.enabled_flag |
String |
客户银行启用标志 |
gl_period_vo |
Object |
财年信息 |
gl_period_vo.level_name |
String |
财年等级 |
gl_period_vo.period_status |
String |
财年状态 |
gl_period_vo.start_date |
Long |
财年开始时间 |
gl_period_vo.start_date |
Long |
财年结束 |
attachments |
Array |
附件 |
attachments.attachment_url |
String |
附件S3地址 |
attachment_count |
Integer |
发票张数 |
column1-150 |
String |
自定义字段 |
column1Obj-column150Obj |
Object |
自定义字段关联信息 |
返回行参数
以下字段在 data.page_info.claim_lines 路径下返回
字段名称 |
字段类型 |
字段描述 |
exp_type |
Object |
行费用类型 |
exp_type.type_code |
String |
行费用类型编码 |
charge_user |
Object |
行报销人,与头charge_user格式一致 |
cost_center |
Object |
行成本中心,与头charge_department格式一致 |
project |
Object |
行项目,与头project格式一致 |
tax_code |
Object |
行税率税额 |
tax_code.tax_rate |
Decimal |
行税率 |
fin_tax_code |
Object |
行税率税额 |
fin_tax_code.tax_rate |
Decimal |
行财务审核税率 |
dr_account |
Object |
行借方会计科目 |
dr_account.code |
String |
会计科目编码 |
dr_account.structure_name |
String |
会计科目类型名称 |
dr_account.account_name |
String |
会计科目名称 |
dr_account.enabled_flag |
String |
是否启用 |
dr_account.category |
String |
类别 |
dr_account.alias_name |
String |
别名 |
dr_account.balance_type |
String |
预算类型 |
cr_account |
Object |
行贷方会计科目 |
tax_account |
Object |
行税借方科目 |
tax_cr_account |
Object |
行税贷方科目 |
destination_city |
Object |
行出发城市 |
destination_city_to |
Object |
行到达城市 |
attachment |
Object |
行附件 |
pay_method |
Object |
行支付方式 |
pay_method.factor |
String |
行支付因子 |
pay_user |
Object |
行收款人,与头charge_user格式一致 |
supplier |
Object |
行供应商,与头supplier格式一致 |
supplier_account |
Object |
行供应商,与头supplier_account格式一致 |
user_account |
Object |
行收款人银行信息,与头user_account格式一致 |
customer |
Object |
行客户,与头customer格式一致 |
customer_account |
Object |
行客户银行,与头customer_account格式一致 |
unit_vo |
Object |
单位主数据 |
unit_vo.code |
String |
单位主数据编码 |
unit_vo.enabled_flag |
String |
是否启用 |
unit_vo.description |
String |
详情 |
unit_vo.unit_name |
String |
单位名称 |
material_vo |
Object |
物料主数据 |
material_vo.code |
String |
物料主数据编码 |
material_vo.unit_code |
String |
物料主数据单位编码 |
material_vo.enabled_flag |
String |
是否启用 |
material_vo.description |
String |
详情 |
material_vo.material_name |
String |
物料名称 |
accumulation_type |
Object |
行费用计算方式 |
accumulation_type.enabled |
String |
行费用计算方式是否启用 |
accumulation_type.accumulation_type |
String |
行费用计算方式名称 |
serial |
Object |
行银行流水(参考银行流水接口) |
trans_serial_attachment |
Object |
行银行流水附件信息(参考银行流水附件接口) |
comments |
String |
行描述信息 |
finance_comments |
String |
行财务审核描述信息 |
long_comments |
String |
行富文本描述信息 |
其余参数
以下字段在 data.page_info 路径下返回
字段名称 |
字段类型 |
字段描述 |
header_links |
Array |
前序单据信息(与返回头参数字段段保持一致) |
header_back_links |
Array |
后序单据信息(与返回头参数字段段保持一致) |
示例
请求示例
{
"page_size": 100,
"page_num": 1,
"start_datetime": 1613995160000,
"end_datetime": 1616414360000,
"date_field_name": "submit_date",
"type_codes": [
"T001",
"T014"
],
"document_nums": [
"EXP0000000001",
"EXP0000000002"
],
"statuses": [
"submitted",
"approved"
],
"branch_codes": [
"130",
"D002"
],
"charge_user_codes": [
"U001"
]
}
返回示例
{
"resCode": 200000,
"resMsg": "success",
"data": {
"page_num": 1,
"total_page": 1,
"page_size": 100,
"total_count": 1,
"page_info": [
{
"id": 70491,
"column2": "6",
"column17": "s01",
"column23": "280.49",
"description": "去办理公司车辆油卡",
"code": "EXP0000007114",
"column17_obj": {
"value_meaning": "境内出差-参加公司组织的会议或培训(无补贴)",
"value_code": "s01",
"id": 134867,
"creation_date": 1576992318000,
"value_id": 830202,
"last_update_date": 1597057849000
},
"note": "",
"total_amount": 280.49,
"total_claim_amount": 280.49,
"advance_amount": 0.00,
"total_pay_amount": 280.49,
"currency_code": "CNY",
"project_name": "2",
"submit_department_id": 94692,
"charge_department_id": 94979,
"submit_user_id": 222846,
"charge_user_id": 222846,
"pay_user": {
"id": 222846,
"mobile": "",
"column1": "",
"code": "00184372",
"email_address": "xxx@xxx.com",
"full_name": "xxx",
"employee_number": "00184372",
"user_name": "xxx@xxx.com",
"department": {
"id": 94692,
"language": "zh_CN",
"code": "520",
"department_name": "义乌xxx有限公司",
"company_name": "义乌xxx有限公司"
}
},
"header_type_id": 144404,
"destination_city_to": {
"id": 189,
"country": "China",
"code": "杭州",
"english_name": "Hangzhou",
"short_name": "hz"
},
"claim_lines": [
{
"id": 172084,
"column5": "124",
"column20": "否",
"header_id": 70491,
"expense_id": 41311,
"type_id": 547590,
"internal_type": "train",
"receipt_currency": "CNY",
"exchange_rate": 1.0000000000,
"claim_amount": 124.00,
"tax_code_id": 4,
"tax_amount": 10.24,
"net_amount": 113.76,
"pay_method_id": 48925,
"project_name": "2",
"cost_center_id": 94979,
"tax_code": {
"id": 4,
"code": "9%",
"tax_rate": 0.0900000000
},
"exp_type": {
"id": 547590,
"type": "火车票",
"category": "交通",
"code": "T523",
"type_code": "T523",
"internal_type": "train"
},
"cost_center": {
"id": 94979,
"language": "zh_CN",
"code": "823877",
"department_name": "财务管理部"
},
"project": {
"id": 2,
"code": "000000",
"project_name": "常规预算"
},
"pay_method": {
"id": 48925,
"factor": 1,
"description": "员工个人支付",
"language": "zh_CN",
"pay_method": "个人支付"
}
}
],
"time_line": [],
"header_type": {
"id": 144404,
"code": "T001",
"type": "差旅报销",
"internal_type": "claim",
"config_type_code": "gl_none",
"autoClose": "N",
"group_num": 10,
"group_name": "差旅报销",
"staff_flag": "Y",
"request_required_flag": "Y"
},
"submit_user": {
"id": 222846,
"mobile": "",
"column1": "",
"code": "00184372",
"email_address": "xxx@xxx.com",
"full_name": "xxx",
"employee_number": "00184372",
"user_name": "xxx@xxx.com"
},
"project": {
"id": 2,
"code": "000000",
"project_name": "常规预算"
},
"charge_user": {
"id": 222846,
"mobile": "",
"column1": "",
"code": "00184372",
"email_address": "xxx@xxx.com",
"full_name": "xxx",
"employee_number": "00184372",
"user_name": "xxx@xxx.com"
},
"submit_department": {
"id": 94692,
"language": "zh_CN",
"code": "520",
"department_name": "义乌xxx有限公司",
"company_name": "义乌xxx有限公司",
"tax_number": "91330782MA29P1CL6C"
},
"charge_department": {
"id": 94979,
"language": "zh_CN",
"code": "823877",
"department_name": "财务管理部"
},
"destination_cities": [
{
"country": "China",
"city_name": "义乌",
"english_name": "Yiwu",
"short_name": "yw"
}
],
"header_links": [
{
"id": 70219,
"code": "REQ0000005328",
"note": "",
"advance_amount": 0.00,
"charge_department_id": 94979,
"pay_user": {
"id": 222846,
"mobile": "",
"column1": "",
"code": "00184372",
"email_address": "xxx@xxx.com",
"full_name": "xxx",
"employee_number": "00184372",
"user_name": "xxx@xxx.com"
},
"header_type_id": 144411,
"claim_lines": [],
"time_line": [],
"header_type": {
"id": 144411,
"code": "RT006",
"type": "差旅行程申请",
"internal_type": "request_travel",
"config_type_code": "gl_none",
"autoClose": "Y",
"group_num": 5,
"group_name": "差旅申请",
"staff_flag": "Y",
"request_required_flag": "N"
},
"charge_department": {
"id": 94979,
"language": "zh_CN",
"code": "823877",
"department_name": "财务管理部"
}
}
]
}
]
}
}