数据字典
数据字典
Department部门信息
参数名 | 参数说明 | 必填 | 参数类型 | 长度 | 值举例 | 备注 |
---|---|---|---|---|---|---|
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:婴儿 | 机票信息需携带,酒店则不做要求 | |
nationality | 国籍 | N | String | 156 | 预订国际机票和国际酒店必填,填写系统国家ID。 | |
birthday | 生日 | N | String | 19881111 | YYYYMMDD | |
mailbox | 邮箱 | N | String | zhangsan@huawei.com | 为企业的员工时必填,用于接收初始密码 | |
cellphone | 手机号 | N | String | 13710001000 | 使用新增员工接口、变更员工接口、审批单同步接口时,手机号必填。 | |
telephone | 座机电话 | N | String | 075528560000 | ||
certificateInfoList | 证件信息 | N | List<CertificateInfo> | |||
deptNum | 企业内部部门编号 | N | String | 1234 | 待废弃字段,请优先使用DeptList | |
deptName | 企业内部部门名称 | N | String | 市场部 | 待废弃字段,请优先使用DeptList部门名称必须唯一;如不唯一,可以考虑加上部门编码信息区分。 | |
deptList | 部门列表 | N | List<Department> | 部门列表 | 同步员工时使用 | |
employeeNum | 企业内部工号 | N | String | 12345 | ||
employeeUID | 企业内部用户ID | N | String | 20 | 区别于工号外的员工唯一ID标识 | |
role | 角色 | N | String | 2:员工 | 固定为2,暂时不用 | |
roleGroupList | 角色组列表 | N | List<RoleGroup> | 角色组列表 | ||
employeeLevel | 员工差旅级别 | N | String | 1 | 在系统中配置的按数字大小排序的级别。如不传递,则以系统系统中配置的员工差旅级别为准。 | |
employeeVIPLevel | 员工VIP级别 | N | String | 2 | 1:VIP | 不支持员工VIP标识传递,仅供查询 |
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地信息 |
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特等座,40:G一等座,50:高级软卧,60:D动卧,70:D一等座,80:软卧,90:软座,100:G二等座,110:硬卧,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 |
Trip差旅行程
参数名 | 参数说明 | 必选 | 长度 | 参数类型 | 值举例 | 备注 |
---|---|---|---|---|---|---|
fromCountryId | 出发国ID | Y | String | |||
fromCityId | 出发城市ID | Y | String | 100 | ||
arriveCountryId | 目的国ID | Y | String | |||
arriveCityId | 目的城市ID | Y | String | |||
takeoffDate | 出发日期 yyyyMMdd | Y | String |