审批管理
审批管理
差旅审批单列表查询
差旅审批单查询接口用于企业客户在系统创建审批单时,查询系统中的审批单信息,用于审批单数据初始化。
接口URL
/tr_list/query
请求参数定义
参数名 | 参数说明 | 必选 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
Version | 版本号 | Y | String | 3.0 | 固定为3.0。 | |
MsgID | 唯一标识 | Y | String | 1000120150511190411000001 | 企业账号+消息方向+YYYYMMDDHHMMSS+NNNNNN | |
CorpCode | 操作企业账号 | Y | String | 企业账号 | ||
TenantUserId | 操作人帐号 | Y | String | HW_000001 | 1、如果是系统维护,写"sysadmin" 2、如果是普通员工维护,写员工id | |
StartCreateTime | 创建审批单开始时间 | N | String | 20130423 | yyyyMMdd。如果调用者置空且StartCloseTime为空,则默认当天,并且从00:00开始 | |
EndCreateTime | 创建审批单截止时间 | N | String | 20130424 | yyyyMMdd。如果调用者置空且EndCloseTime为空,则默认当天,并且以23:59结束最长查询一个月的数据 | |
StartCloseTime | 关闭审批单的开始时间 | N | String | 20130423 | ||
EndCloseTime | 关闭审批单的结束时间 | N | String | 20130424 | ||
ReimburseStatus | 报销状态 | N | List<String> | 1:报销中2:未报销3:已报销 | ||
ApproveStatus | 审批状态 | N | List<String> | DRAFT 草稿WAIT_APPROVE 待审批APPROVED 已审批REJECT 已驳回CANCEL 已取消CLOSE 已关闭 | 超过结束日期的审批单自动变为已关闭 | |
PageIndex | 查询的页码 | Y | String | |||
Size | 每页条数 | Y | String | 建议20,上限50 |
响应参数定义
参数名 | 参数说明 | 必选 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
ResultCode | 返回码 | Y | String | 0 | 0表示成功,其他值为失败。 | |
Description | 描述 | Y | String | Success | 描述信息,出错时为错误信息即错误原因。 | |
PageIndex | 当前的页码 | N | String | |||
Size | 每页条数 | N | String | |||
Total | 总记录数 | N | String | |||
TrInfoList | 审批单列表 | N | List<TrInfo> |
TrInfo
参数名 | 参数说明 | 必选 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
EnterpriseTrID | 企业客户系统的审批单编号 | Y | String | TA0315012116281300028 | ||
TrCreatorName | 申请人姓名 | Y | EmployeeBrief | |||
ApplyTime | 申请时间 | Y | String | 20180811113019 | yyyyMMddHHmmss | |
ApplyType | 申请类型 | Y | List<String> | 0:为本人申请(默认) 1:为他人申请2:为客户 | ||
IncludeOffline | 是否包含线下 | N | String | 0:不包含1:包含 | ||
RelationType | 关联类型 | Y | String | 0:成本中心1:项目 | ||
TravelPurpose | 出差目的 | N | String | |||
DepartDate | 出发日期 | Y | String | 20180811 | yyyyMMdd如果企业有差旅管控需求,出发时间、出发城市信息、差旅目的地、差旅出差人信息必填 | |
EndDate | 出差截止日期 | Y | String | 20180811 | yyyyMMdd | |
DepartCityName | 出发城市名称 | Y | String | |||
DestinationNameList | 差旅目的地 | Y | List<String> | |||
TravellerNameList | 差旅出差人姓名 | Y | List<EmployeeBrief> | |||
ApproveStatus | 审批状态 | N | String | RAFT 草稿WAIT_APPROVE 待审批APPROVED 已审批REJECT 已驳回CANCEL 已取消CLOSE 已关闭 | ||
ApproveTime | 审批时间 | N | String | yyyyMMddHHmmss | 精确到秒 | |
OverStandard | 是否超标申请 | N | Boolean | true | ||
OverStandardReason | 超标原因 | N | String | 陪领导出差 |
样例
请求
{
"Version": "3.0",
"MsgID": "0008120220929071248283828",
"CorpCode": "0008",
"TenantUserId": "sysadmin",
"StartCreateTime":"20220901",
"EndCreateTime":"20220930",
"StartCloseTime":"20220901",
"EndCloseTime":"20220930",
"ReimburseStatus":[
"2"
],
"ApproveStatus":[
"APPROVED",
"CLOSE"
],
"PageIndex":"1",
"Size":"20"
}
响应
{
"ResultCode":"0",
"Description":"成功",
"PageIndex":"1",
"Size":"20",
"Total":"200",
"TrInfoList":[
{
"EnterpriseTrID":"TA0612029901",
"TrCreatorName":{
"Name":"张三",
"EmployeeNum":"00123456"
},
"ApplyTime":"20220911113019",
"ApplyType":[
"0",
"1"
],
"TravelPurpose":"1001/调用",
"DepartDate":"20220901",
"EndDate":"20220929",
"DepartCityName":"北京",
"DestinationNameList":[
"上海",
"南京"
],
"TravellerNameList":[
{
"Name":"张三",
"EmployeeNum":"00123456"
},
{
"Name":"李四",
"EmployeeNum":"00123457"
}
],
"ApproveStatus":"APPROVED",
"ApproveTime":"20220911133019",
"RelationType":"1",
"OverStandardReason":"陪同领导",
"OverStandard":true,
"IncludeOffline":"1"
}
]
}
使用说明
使用/tr_list/query,请求填写审批单创建或结束的开始时间和截止时间,然后逐步分页获取审批单简要信息,如果需要更多明细,请使用 /tr_detail/query,获取详情。
差旅审批单查询增量
差旅审批单数据用户初始化完之后,增加同步发生变化的审批单。
接口URL
/tr_list/increment
请求参数定义
参数名 | 参数说明 | 必选 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
Version | 版本号 | Y | String | 3.0 | 固定为3.0。 | |
MsgID | 唯一标识 | Y | String | 1000120150511190411000001 | 企业账号+消息方向+YYYYMMDDHHMMSS+NNNNNN | |
CorpCode | 操作企业账号 | Y | String | 企业账号 | ||
TenantUserId | 操作人帐号 | Y | String | HW_000001 | 1、如果是系统维护,写"sysadmin" 2、如果是普通员工维护,写员工id | |
ApproveStatus | 审批状态 | N | List<String> | DRAFT 草稿WAIT_APPROVE 待审批APPROVED 已审批REJECT 已驳回CANCEL 已取消CLOSE 已关闭 | ||
StartModified | 最后修改起始日期 | N | String | 20130423 | yyyyMMdd。如果调用者置空,则默认当天开始 | |
EndModified | 最后修改截止时间 | N | String | 20130424 | yyyyMMdd。最长查询时间跨度为一个月的数据 | |
PageIndex | 查询的页码 | Y | String | |||
Size | 每页条数 | Y | String | 建议20,上限50 |
响应参数定义
参数名 | 参数说明 | 必选 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
ResultCode | 返回码 | Y | String | 0 | 0表示成功,其他值为失败。 | |
Description | 描述 | Y | String | Success | 描述信息,出错时为错误信息即错误原因。 | |
PageIndex | 当前的页码 | N | String | |||
Size | 每页条数 | N | String | |||
Total | 总记录数 | N | String | |||
TrInfoList | 审批单列表 | N | List<TrInfo> |
样例
请求
{
"Version": "3.0",
"MsgID": "0008120220929071248283828",
"CorpCode": "0008",
"TenantUserId": "sysadmin",
"ApproveStatus":[
"APPROVED",
"CLOSE"
],
"StartModified":"20220901",
"EndModified":"20220930",
"PageIndex":"1",
"Size":"20"
}
响应
{
"ResultCode":"0",
"Description":"成功",
"PageIndex":"1",
"Size":"20",
"Total":"200",
"TrInfoList":[
{
"EnterpriseTrID":"TA0612029901",
"TrCreatorName":{
"Name":"张三",
"EmployeeNum":"00123456"
},
"ApplyTime":"20220911113019",
"ApplyType":[
"0",
"1"
],
"TravelPurpose":"1001/调用",
"DepartDate":"20220901",
"EndDate":"20220929",
"DepartCityName":"北京",
"DestinationNameList":[
"上海",
"南京"
],
"TravellerNameList":[
{
"Name":"张三",
"EmployeeNum":"00123456"
},
{
"Name":"李四",
"EmployeeNum":"00123457"
}
],
"ApproveStatus":"APPROVED",
"ApproveTime":"20220911133019",
"RelationType":"1",
"OverStandardReason":"陪同领导",
"OverStandard":true,
"IncludeOffline":"1"
}
]
}
使用说明
初始化数据同步完之后,继续使用/tr_list/increment,请求填写最后修改时间。为了规避漏单场景,接口返回数据会按最后修改时间倒序排列,所以需要调用方分页从后往前翻,正向翻页会导致审批单变化而导致漏单。
差旅审批单详情查询
接口URL
/tr_detail/query
请求参数定义
参数名 | 参数说明 | 必选 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
Version | 版本号 | Y | String | 3.0 | 固定为3.0。 | |
MsgID | 唯一标识 | Y | String | 1000120150511190411000001 | 企业账号+消息方向+YYYYMMDDHHMMSS+NNNNNN | |
CorpCode | 操作企业账号 | Y | String | 企业账号 | ||
TenantUserId | 操作人帐号 | Y | String | HW_000001 | 1、如果是系统维护,写"sysadmin" 2、如果是普通员工维护,写员工id | |
EnterpriseTrID | 企业客户系统的审批单编号 | Y | String |
响应参数定义
参数名 | 参数说明 | 必选 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
ResultCode | 返回码 | Y | String | 0 | 0表示成功,其他值为失败。 | |
Description | 描述 | Y | String | Success | 描述信息,出错时为错误信息即错误原因。 | |
TravelApprove | 审批单详情 | Y | TravelApprove |
TravelApprove
参数名 | 参数说明 | 必选 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
EnterpriseTrID | 企业客户系统的审批单编号 | Y | String | TA0315012116281300028 | ||
TrCreator | 申请人 | Y | Employee | |||
ApplyTime | 申请时间 | Y | String | 20180811113019 | yyyyMMddHHmmss | |
ApplyType | 申请类型 | Y | List<String> | 0:为本人申请(默认) 1:为他人申请2:为客户3:为家属(探亲) | ||
ServiceMask | 服务项 | N | String | 10 | 1111110000 | 格式为MMMMMM,第一位标识国内机票第二位标识国际机票第三位标识国内酒店第四位标识国际酒店第五位标识国内火车票第六位标识差旅用车其余4位为扩展位,暂没有实际含义1表示开通,0表示不开通;若与企业开通的服务项冲突,以企业服务项为主,比如企业未开通国内机票服务,即时接口中第一位为1也不会生效。如果ServiceMask为空,则默认以企业服务项为主。如111000标识国内机票、国际机票、国内酒店业务开通。 |
TravelPurpose | 出差目的 | N | String | 1001/调研,1002/培训 | 目的编码/目的描述,多个用英文逗号分隔 | |
Remark | 出差备注 | N | String | 用户填写的出差备注 | ||
DepartDate | 出发日期 | Y | String | 20180811 | yyyyMMdd如果企业有差旅管控需求,出发时间、出发城市信息、差旅目的地、差旅出差人信息必填 | |
DepartCityInfo | 出发城市信息 | Y | CityInfo | |||
DestinationList | 差旅目的地 | Y | List<Destination> | |||
BusinessTravelerList | 差旅出差人信息 | Y | List<BusinessTraveler> | |||
ApproveStatus | 审批状态 | N | String | RAFT 草稿WAIT_APPROVE 待审批APPROVED 已审批REJECT 已驳回CANCEL 已取消CLOSE 已关闭 | ||
ApproveTime | 审批时间 | N | String | yyyyMMddHHmmss | 精确到秒 | |
BenefitInfoList | 差旅受益信息 | N | List<BenefitInfo> | |||
BudgetInfoList | 差旅预算 | N | List<BudgetInfo> | |||
OverStandard | 是否超标申请 | N | Boolean | true | ||
OverStandardReason | 超标原因 | N | String | 陪领导出差 | ||
RelationType | 关联类型 | Y | String | 0:成本中心1:项目 | ||
OperationLogList | 审批操作日志 | N | List<OperationLog> | |||
ExtInfo | 审批单拓展字段 | N | String | { "actualTravelDays": 3 } |
OperationLog审批操作日志信息
参数名 | 参数说明 | 必选 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
Name | 操作人姓名 | N | String | 张三 | ||
EmployeeNum | 操作人工号 | N | String | |||
OperationTime | 操作时间 | N | String | 20130423101011 | yyyyMMddHHmmss | |
OperationType | 操作类型 | N | String | SUBMIT | SUBMIT:提交申请,DELETE:删除申请,CANCEL:撤销申请,AGREE:同意申请,REJECT:驳回申请,MODIFY:修改申请,CLOSE:关闭申请, AUTO_APPROVE:自动通过 | |
Remark | 备注 | N | String | 补录单无需审批自动通过 | ||
OperationRole | 操作人角色 | N | String | CREATOR | CREATOR:创建人,APPROVER:审批人 |
BudgetInfo
参数名 | 参数说明 | 必选 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
BudgetType | 预算科目 | Y | String | TOTAL("总额")AIR("机票")HOTEL("住宿")TRAIN("火车票")OTHER_INTRANSIT("其他在途费用")SOCIAL_ACTIVITY("交际费用")BUSINESS_SUBSIDY("出差补助")OTHER("其他费用") | ||
BugdetName | 预算科目名称 | Y | String | |||
Amount | 金额 | Y | String | |||
Currency | 币种 | Y | String | 默认:CNY |
样例
请求
{
"Version": "3.0",
"MsgID": "0008120220929071248283828",
"CorpCode": "0008",
"TenantUserId": "sysadmin",
"EnterpriseTrID":"TA0612029901"
}
响应
{
"ResultCode":"0",
"Description":"操作成功",
"TravelApprove":{
"EnterpriseTrID":"TA612016830",
"TrCreator":{
"TenantUserId":"26215236521",
"Name":"周强",
"Surname":"",
"GivenName":"",
"Gender":"M",
"Type":"0",
"Nationality":"CN",
"Birthday":"19900101",
"Mailbox":"",
"Cellphone":"15256929999",
"Telephone":"",
"DeptNum":"3000006",
"DeptName":"信息管理本部",
"EmployeeNum":"10000238",
"EmployeeUID":"ID012206210909263390",
"Role":"2",
"Remark":null
},
"ApplyTime":"20220823165139",
"ApplyType":[
"1"
],
"ServiceMask":"1111111111",
"TravelPurpose":"1001/调研",
"DepartDate":"20220823",
"DepartCityInfo":{
"CountryID":"156",
"CountryEnglishName":"China",
"CountryChineseName":"中国",
"CityID":"156440100",
"CityEnglishName":"Guangzhou",
"CityChineseName":"广州"
},
"DestinationList":[
{
"ArriveCityInfo":{
"CountryID":"156",
"CountryEnglishName":"China",
"CountryChineseName":"中国",
"CityID":"156320100",
"CityEnglishName":"Nanjing",
"CityChineseName":"南京"
},
"ArriveDate":"20220823",
"LeftDate":"20220824"
}
],
"BusinessTravelerList":[
{
"Customer":{
"TenantUserId":"26215236521",
"Name":"张厦",
"Surname":null,
"GivenName":null,
"Gender":"M",
"Type":"0",
"Nationality":"CN",
"Birthday":null,
"Mailbox":null,
"Cellphone":"18755314839",
"Telephone":"",
"CertificateInfoList":[
{
"CertificateType":"1",
"CertificateNum":"320025199009011111"
}
],
"DeptNum":"370000",
"DeptName":"总经理办公室",
"EmployeeNum":"10000044",
"EmployeeUID":"ID012206210909253387",
"Role":"2",
"Remark":null
},
"FlightCabinLimit":"1",
"IairCabinLimit":"FIRST",
"TrainCabinLimit":null,
"HotelPriceLimitInfoList":[
],
"CarDailyAmountLimit":"-1",
"CarSingleAmountLimit":"100",
"CarExceedCurrency":"CNY",
"CarExceedRideType":"COMFORTABLE,BUSINESS,LUXURY",
"BenefitInfo":null
},
{
"Customer":{
"TenantUserId":"26215236522",
"Name":"周强",
"Surname":"",
"GivenName":"",
"Gender":"M",
"Type":"0",
"Nationality":"CN",
"Birthday":null,
"Mailbox":"",
"Cellphone":"15256925782",
"Telephone":"",
"CertificateInfoList":[
{
"CertificateType":"1",
"CertificateNum":"510400198106300537"
}
],
"DeptNum":"3000006",
"DeptName":"信息管理本部",
"EmployeeNum":"10000238",
"EmployeeUID":"ID012206210909263390",
"Role":"2",
"Remark":null
},
"FlightCabinLimit":"1",
"TrainCabinLimit":null,
"HotelPriceLimitInfoList":[
],
"CarDailyAmountLimit":"-1",
"CarSingleAmountLimit":"100",
"CarExceedCurrency":"CNY",
"CarExceedRideType":"COMFORTABLE,BUSINESS,LUXURY",
"BenefitInfo":null
}
],
"ApproveStatus":"CLOSE",
"ApproveTime":"20220823165139",
"BenefitInfoList":[
{
"BenefitType":"0",
"CostCenterNum":"001",
"CostCenterName":"信息管理本部",
"ProjectCode": "项目编码",
"ProjectName": "项目名称",
"DeptNum": "部门编码",
"DeptName": "部门名称",
"Percentage":"100",
"Opinion":"测试",
"ExtInfo":"{\"DepartmentCode\":\"3000006\",\"DepartmentName\":\"信息管理本部\"}"
}
],
"BudgetInfoList":[
{
"BudgetType":"TRAFFIC",
"BugdetName":"交通",
"Amount":"3800.00",
"Currency":"CNY"
},
{
"BudgetType":"HOTEL",
"BugdetName":"住宿",
"Amount":"500.00",
"Currency":"CNY"
},
{
"BudgetType":"BUSINESS_SUBSIDY",
"BugdetName":"出差补助",
"Amount":"0.00",
"Currency":"CNY"
},
{
"BudgetType":"OTHER",
"BugdetName":"其他费用",
"Amount":"0.00",
"Currency":"CNY"
}
],
"RelationType":"DEPARTMENT",
"OverStandardReason":null,
"OverStandard":false,
"Remark":"测试",
"OperationLogList":[
{
"Name":"颜敏",
"EmployeeNum":"10234118",
"OperationTime":"20130423101011",
"OperationType":"MODIFY",
"OperationRole":"APPROVER",
"Remark":"企业已配置修改单无需审批"
}
],
"ExtInfo": "{\"actualTravelDays\":3}"
}
}
审批结果通知
客户自有审批系统审批完成后,调用慧通审批结果通知接口,告之审批结果。
接口URL
/approve_result
请求参数定义
参数名 | 参数说明 | 必选 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
Version | 版本号 | Y | String | 3.0 | 固定为3.0。 | |
MsgID | 唯一标识 | Y | String | 1000120150511190411000001 | 企业账号+消息方向+YYYYMMDDHHMMSS+NNNNNN | |
CorpCode | 操作企业账号 | Y | String | 企业账号 | ||
TenantUserId | 操作人帐号 | Y | String | HW_000001 | 1、如果是系统维护,写"sysadmin" 2、如果是普通员工维护,写员工id | |
OutApprovalNo | 客户审批单号 | N | String | T133431213 | ||
ApprovalNo | 慧通审批单号 | N | String | TA0612275920 | 优先匹配慧通单号,若为空匹配客户审批单号 | |
ApproveResult | 审批结果:同意AGREE,驳回REJECT | Y | String | AGREE | ||
ApproveTime | 审批时间 | N | String | 20240124191834 | yyyyMMddHHmmss | |
Opinion | 审批意见 | N | String | 同意 |
响应参数定义
参数名 | 参数说明 | 必选 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
ResultCode | 返回码 | Y | String | 0 | 0表示成功,其他值为失败。 | |
Description | 描述 | N | String | Success | 描述信息,出错时为错误信息即错误原因。 |
样例
请求
{
"Version": "3.0",
"MsgID": "0008120220929071248283828",
"CorpCode": "0008",
"TenantUserId": "sysadmin",
"OutApprovalNo": "A12345",
"ApprovalNo": "TA0612275920",
"ApproveResult": "AGREE",
"ApproveTime": "20240124191834",
"Opinion": "同意"
}
响应
{
"ResultCode": "0",
"Description": "成功"
}