数据字典
数据字典
Dept部门信息
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
DeptNum | 部门编号 | Y | String | 1234 | 企业内部编号,华为云数字化差旅系统创建对应内部id | |
DeptName | 部门名称 | Y | String | 市场部 | 部门名称必须唯一;如不唯一,可以考虑加上部门编码信息区分 | |
DeptDescription | 部门描述 | Y | String | 市场部 | ||
UpperDeptNum | 上级部门编号 | Y | String | 5678 | 没有上级部门为空 |
Employee员工信息
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
TenantUserId | 租户用户id | N | String | 为企业的员工时必填;为企业的外部客户时不填 | ||
Name | 中文姓名 | N | String | 张三 | 中文姓名与英文姓名必填其一如果国内出差,必填。 | |
Surname | 英文姓 | N | String | 中文姓名与英文姓名必填其一如果国际出差,必填。 | ||
GivenName | 英文名 | N | String | 如果国际出差,必填。 | ||
Gender | 性别 | N | String | M:男(默认)F:女 | ||
Type | 乘客类型 | N | String | 0:成人(默认)1:儿童2:婴儿 | 机票信息需携带,酒店则不做要求 | |
AgeType | 乘客年龄段类型 | N | String | INF:婴儿 CHD:儿童 TEEN:青少年 ADT:成人 ELDER:老人 | 婴儿[0,2);儿童[2,12);青少年[12,18);成人[18,70);老人[70,∞) | |
Nationality | 国籍 | N | String | 156 | 预订国际机票和国际酒店必填,填写系统国家ID。 | |
Birthday | 生日 | N | String | 19881111 | YYYYMMDD | |
Mailbox | 邮箱 | N | String | zhangsan@huawei.com | 为企业的员工时必填,用于接收初始密码 | |
Cellphone | 手机号 | N | String | 13710001000 | 使用新增员工接口、变更员工接口、审批单同步接口时,手机号必填。 | |
MobileCountryCode | 手机号归属国家区号 | N | String | 10 | 86:中国 | 不带+号的手机号归属国家区号;若此字段未传值且Cellphone为中国大陆手机号,默认赋值为86:中国 |
Telephone | 座机电话 | N | String | 075528560000 | ||
CertificateInfoList | 证件信息 | N | List<CertificateInfo> | |||
DeptNum | 主部门编号 | N | String | 1234 | 主部门视为默认部门 | |
DeptName | 主部门名称 | N | String | 市场部 | 主部门视为默认部门,部门名称必须唯一;如不唯一,可以考虑加上部门编码信息区分 | |
DeptList | 部门列表 | N | List<Dept> | 部门列表 | 同步员工时使用 | |
EmployeeNum | 企业内部工号 | N | String | 12345 | ||
EmployeeUID | 企业内部用户ID | N | String | 20 | 区别于工号外的员工唯一ID标识 | |
Status | 状态 | N | String | 1 | 1 | 1:正常,2冻结 |
Role | 角色 | N | String | 2:员工 | 固定为2,暂时不用 | |
RoleGroupList | 角色组列表 | N | List<RoleGroup> | 角色组列表 | ||
EmployeeLevel | 员工差旅级别 | N | String | 1 | 在系统中配置的按数字大小排序的级别。如不传递,则以系统系统中配置的员工差旅级别为准。 | |
EmployeeVIPLevel | 员工VIP级别 | N | String | 2 | 1:VIP | 不支持员工VIP标识传递,仅供查询接口(/employee/detail/query)使用。 |
Remark | 备注 | N | String | 100字以内 | ||
NeedApproval | 是否需审批 | N | String | 0:不需要审批1:需要审批 | 对应后台“无TR代预定”标识。为0时,“无TR代预定”设置为1,支持本人无TR或者给他人无TR预定。为1时,“无TR代预定”设置为缺省值0,仅支持本人关联TR预定 | |
ExtInfo | 扩展字段 | N | String | {"data":"123"} | 同步时务必保证差旅平台内已创建所有扩展字段类型标识和中文名称;填写格式为{"扩展字段类型标识":"扩展字段类型值"} | |
BaseLocation | Base地信息 | N | CityInfo | Base地信息 | ||
PlatformUserId | 平台用户编号 | N | String | 仅供新增(/adduserinfo),修改(/modiuserinfo),查询接口(/employee/detail/query)使用。同企业下该值唯一,若员工平台用户编号已存在则不支持修改。 |
EmployeeDetail员工详情
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
CorpCode | 企业账号 | Y | String | 1000 | 系统提供的企业账号 | |
EmployeelList | 员工信息 | Y | List<Employee> | 包含TenantUserId/Name/EmployeeNum/EmployeeUID等字段 |
CertificateInfo证件信息
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
CertificateType | 证件类型 | Y | String | 1 身份证2 护照3 其他4 台湾通行证5 回乡证6 港澳通行证7 台胞证 | ||
CertificateNum | 证件号码 | Y | String | 35222519771081001X | ||
ExpiredDate | 有效期 | N | String | 20180811 | 证件类型为2时建议填写。作为护照失效日期。 | |
PassportIssueDate | 护照签发日期 | N | String | 20180811113019 | ||
PassportIssueCountry | 护照签发国家 | N | String | 填写系统国家ID。 | ||
PassportIssueProvince | 护照签发省份 | N | String | 字符串,比如"Jiangsu"。 |
CostCenter成本/项目信息
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
CostCenterType | 成本中心/项目类型 | Y | String | 0:成本中心(默认)1:项目 | ||
CostCenterName | 成本中心或项目名称 | Y | String | 财务结算项目 | ||
CostCenterNum | 成本中心或项目编码 | Y | String | 7896 | 企业内部编号 | |
Type | 项目类型 | N | String | 科研 | ||
StartDate | 项目开始日期 | N | String | 20180811 | ||
EndDate | 项目结束日期 | N | String | 20180911 | ||
ApproverList | 审批人列表 | Y | List<Employee> | 必须先维护员工信息,再维护成本中心信息。 | ||
DeptNumList | 属于此成本中心的部门列表 | N | List<string> | 必须先维护部门信息,再维护成本中心信息。如果CostCenterType类型是0,此字段必填 | ||
ExtInfo | 扩展字段 | N | String | {"data":"123"} | 企业自定义内容 |
Tr出差申请单信息
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
EnterpriseTrID | 企业客户系统审批单编号 | N | String | TA0315012116281300028 | ||
HtTrID | 华为云数字化差旅系统审批单编号 | Y | String | TA0315012116281300028 | ||
TravelPurpose | 出差目的 | N | String | |||
EnterpriseTrStatus | 企业出差申请单状态 | N | String | 保留字段,未生效。 | ||
TrStatus | Tr状态 | Y | String | 0:草稿1:待审批人审批2:待权签人审批3:驳回4:通过5:已关闭 | ||
TrCreator | 审批单创建人 | Y | Employee | |||
TrSubmitDate | TR提交日期 | Y | String | 20130423 | yyyyddmm | |
CustomerList | 差旅出差人信息 | N | List<Employee> | |||
DepartDate | 出发日期 | N | String | 20130423 | yyyyMMdd | |
EndDate | 结束日期 | N | String | 20130423 | yyyyMMdd | |
DepartCityInfo | 出发城市信息 | N | CityInfo | |||
DestinationList | 目的城市集合 | N | List<Destination> | |||
DeptApprover | 部门审批人 | N | Employee | |||
ApproveTime | 审批时间 | N | String | 20180811113019 | yyyyMMddHHmmss | |
Opinion | 审批意见 | N | String | 同意 | ||
BenefitInfoList | 差旅受益信息 | N | List<BenefitInfo> | 权签人审批信息 | ||
Remark | 备注 | N | String | |||
OperationLogList | 审批日志信息 | N | List<OperationLog> | 审批日志信息 |
CityInfo城市信息
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
CountryID | 国家或区域Id | Y | String | 156 | 以国家或地区编码和城市编码为准 | |
CountryEnglishName | 国家或区域英文名称 | N | String | Chinese | ||
CountryChineseName | 国家或区域中文名称 | N | String | 中国 | ||
CityID | 城市Id | Y | String | 156310100 | ||
CityEnglishName | 城市英文名称 | N | String | Shanghai | ||
CityChineseName | 城市中文名称 | N | String | 上海 |
Destination出行目的地信息
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
ArriveCityInfo | 到达城市信息 | Y | CityInfo | |||
ArriveDate | 到达时间 | Y | String | 20130423 | yyyyMMdd同步TR时,如果没有明确的城市到离时间,则填出差行程的起始和结束时间 | |
LeftDate | 离开时间 | Y | String | 20130424 | yyyyMMdd |
BenefitInfo受益部门项目信息
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
BenefitType | 受益类型 | Y | String | 0:成本中心1:项目2:部门 | ||
CostCenterNum | 成本中心编码 | Y | String | 5678 | ||
CostCenterName | 成本中心名称 | N | String | 企业侧的成本中心名称 | ||
ProjectCode | 项目编码 | N | String | 1234 | 为项目时受益项目编码 | |
ProjectName | 项目名称 | N | String | 为项目时受益项目名称 | ||
DeptNum | 部门编码 | N | String | 1234 | 为部门时受益部门编码 | |
DeptName | 部门名称 | N | String | 为部门时受益部门名称 | ||
Percentage | 分摊比例 | N | String | 50 | 0-100之间的数字。所有受益成本中心和项目的分摊比例相加必须等于100 | |
Approver | 权签人 | N | Employee | HW_000001 | ||
ApproveTime | 审批时间 | N | String | 20130423101011 | yyyyMMddHHmmss | |
Opinion | 审批意见 | N | String | 同意 | ||
CostCenterOne | 一级成本中心或项目编码 | N | String | |||
CostCenterTwo | 二级成本中心或项目编码 | N | String | |||
ExtInfo | N | String | {"data":"123"} | 扩展参数 |
ContactInfo联系人信息
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
ContactName | 联系人姓名 | N | String | 英文姓名之间用“/”间隔,比如,Zhang/sa” | ||
ContactMobile | 联系人手机 | N | String | |||
ContactMail | 联系人邮箱 | N | String |
Creator创建人信息
参数名 | 参数说明 | 必选 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
Type | 创建人类型 | Y | String | 1 | 0:员工1:操作员 | 为1时,EmployeeUID设置为操作员ID。 |
EmployeeNum | 工号 | N | String | |||
EmployeeUID | 用户ID | N | String | |||
Name | 姓名 | N | String |
RoleGroup角色组
参数名 | 参数说明 | 必选 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
Name | 角色组名 | Y | String | 职级 | ||
RoleList | 角色列表 | Y | List<Role> |
Role角色
参数名 | 参数说明 | 必选 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
Name | 角色名 | Y | String | 科长、职员 |
BusinessTraveler差旅出差人
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
Customer | 客户基本信息 | Y | Employee | |||
FlightCabinLimit | 舱位限定 | N | String | 0:头等舱1:商务舱2:经济舱3:高端经济舱9:不允许乘坐 若不传值,以系统的企业配置为准。 | ||
IairCabinLimit | 国际机票舱位限定 | N | String | 0:头等舱1:商务舱2:经济舱3:高端经济舱9:不允许乘坐 若不传值,以系统的企业配置为准。 | ||
TrainCabinLimit | 火车舱位限定 | N | String | 0:G商务座,10:G特等座,20:D商务座,30:D特等座,35:G优选一等座、D优选一等座,40:G一等座,50:高级软卧,60:D动卧,70:D一等座,80:软卧,90:软座,95:G二等卧、D二等卧,98:G多功能座,100:G二等座,110:硬卧,115:D多功能座,120:D二等座,130:硬座,999:不允许乘坐 若不传值,以系统的企业配置为准。通过系统企业配置,企业可以自定义火车票舱位限定的顺序。 | ||
TrainForbiddenCabinList | 火车禁止预定舱位列表 | N | List<String> | 256 | ["30A","50B"] | 0:G/C商务座,10:G/C特等座,20:D商务座,30A:D特等座,30B:D高级动卧,30C:特等软座,35:优选一等座,40:G一等座,50A:一人软包,50B:高级软卧,60A:G/D一等双软,60B:G/D 一等卧,60C:G/D 二等双软,60D:G/D 动卧,70:D 一等座,80A:软卧,80B:一等双软/一等卧,80C:二等双软,80D:二等卧,90A:G软座,90B:软座,90C:软卧代软座,90D:一等软座,95:G/D 二等卧,98:G 多功能座,100:G 二等座,110:硬卧,115:D 多功能座,120:D 二等座,130:硬座。 若不传值,则代表不限制坐席,可以与TrainCabinLimit共同使用。 |
HotelPriceLimitInfoList | 酒店限价列表 | N | List<HotelPriceLimitInfo> | 若与慧通系统的企业配置冲突,以慧通系统的企业配置为准。 | ||
CarDailyAmountLimit | 单日用车金额限制 | N | String | -1 | -1代表不限 若与慧通系统的企业配置冲突,以慧通系统的企业配置为准。 | |
CarSingleAmountLimit | 单次用车金额限制 | N | String | 100 | -1代表不限 若与慧通系统的企业配置冲突,以慧通系统的企业配置为准。 | |
CarExceedCurrency | 打车超标币种 | N | String | CNY | 若与慧通系统的企业配置冲突,以慧通系统的企业配置为准。 | |
CarExceedRideTypeList | 超标车型 | N | List<String> | ["ECONOMY","COMFORTABLE"] | ECONOMY:经济型 COMFORTABLE:舒适型 BUSINESS:商务型 LUXURY:豪华型 超标车型不支持向下兼容 若与慧通系统的企业配置冲突,以慧通系统的企业配置为准。 | |
ExtInfo | 出行人扩展信息 | N | String | {"settlementUnitCode":"123","settlementUnitName":""} | ||
BenefitInfo | 差旅受益信息 | N | BenefitInfo |
EmployeeBrief
参数名 | 参数说明 | 必选 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
Name | 姓名 | Y | String | |||
EmployeeNum | 企业内部工号 | N | String | 12345 |
HotelPriceLimitInfo
参数名 | 参数说明 | 必选 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
CityInfo | 目的地信息 | Y | CityInfo | 与差旅审批单行程保持一致 | ||
HotelLimitPrice | 酒店住宿标准 | Y | String | 100 | 若与系统的企业配置冲突,以系统的企业配置为准 | |
HotelPayCurrency | 酒店住宿标准货币 | Y | String | CNY | 如不传,默认为CNY | |
FloatingControlMode | 浮动管控模式 | N | String | STRICT:完全匹配(入住日期必须完全在浮动范围日期内才上浮);EASY:弱匹配(入住日期与浮动范围日期有交叉时,则全部入住日期上浮);DAILY:按匹配日期上浮(入住日期与浮动范围日期有交叉时,仅上浮交叉部分入住日期); | 不传默认不上浮 | |
FloatingRuleList | 浮动规则列表 | N | List<FloatingRule> | 不传默认不上浮 |
FloatingRule
参数名 | 参数说明 | 必选 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
StartDate | 开始时间 | Y | String | 0102 | 月份日期,数字格式,多条数据存在时,不能存在交集 | |
EndDate | 结束时间 | Y | String | 0304 | 月份日期,数字格式,多条数据存在时,不能存在交集 | |
FloatingMode | 浮动模式 | Y | String | PERCENTAGE | PERCENTAGE:百分比,RELATIVE_AMOUNT:固定额度 | |
FloatingValue | 浮动值 | Y | String | -1、20 | 浮动值,固定金额或者比例值,-1表示不限,20表示上浮20% |
Trip差旅行程
参数名 | 参数说明 | 必选 | 长度 | 参数类型 | 值举例 | 备注 |
---|---|---|---|---|---|---|
FromCountryId | 出发国ID | Y | String | |||
FromCityId | 出发城市ID | Y | String | 100 | ||
ArriveCountryId | 目的国ID | Y | String | |||
ArriveCityId | 目的城市ID | Y | String | |||
TakeoffDate | 出发日期 yyyyMMdd | Y | String |