根据工号查询员工详情
说明
该接口用于批量根据员工工号查询员工详情信息。
接口限制
1. 10次/秒;
2. 一次最多支持100个。
接口地址
/api/openapi/employee/details
请求类型
POST
请求参数
参数说明
参数名称 | 类型 | 是否必填 | 参数说明 |
---|---|---|---|
employeeIds | List<String(100)> | 是 | 员工工号列表 |
detailedAccountInfo | boolean | 否 | 是否包含详细的员工收款账号信息。true:返回详细的员工收款账号信息 |
参数样例
{
"employeeIds":["test123"],
"detailedAccountInfo":true
}
响应参数
参数说明
字段名称 | 字段类型 | 是否必填 | 字段说明 |
---|---|---|---|
employeeId | String(50) | 是 | 员工工号 |
employeeName | String(50) | 是 | 员工姓名 |
String(50) | 否 | 工作邮箱, 工作邮箱和工作手机号至少填写一个。 若该参数当前有值,传""视为清除原数据。 不填时视为维持原数据。 |
|
phoneNo | String(50) | 否 | 工作手机号, 工作邮箱和工作手机号至少填写一个。 若该参数当前有值,传""视为清除原数据。 不填时视为维持原数据。 |
employeeNickName | String(50) | 否 | 员工花名, 不填时视为维持原数据 填写空字符串时视为清除原数据 |
roleNames | List<String> | 否 | 员工角色名称,具体见设置页面‘角色与权限-角色名称’, 不填时视为维持原数据 填写空数组时视为清除原数据 |
departments | List<RTRoute> | 是 | 所属部门, 修改员工时不填视为维持原数据 |
residences | List<PlaceInfo> | 否 | 常驻地地址编码,见下表说明, 不填时视为维持原数据 填写空数组时视为清除原数据 |
customObject | CustomObject | 否 | 员工的自定义字段,不填时视为维持原数据 填写空对象时视为清除原数据 |
sendInvitation | boolean | 否 | 是否发送邀请通知(邮件或短信)。默认false。true情况下只有员工状态不属于已加入情况下才会发送且只会发送一次。( 如离职后,再入职,则需手动再在系统内发送邀请通知)。 链接有效期为15天。 |
status | String(16) | 否 | 在职状态,可填写ENABLE(在职),DISABLE(离职) 默认ENABLE |
hireDate | String (50) | 否 | 入职日期。格式yyyy-MM-dd。 不填时视为维持原数据 填写空字符串时视为清除原数据 |
defaultLegalEntityBizCode | String (50) | 否 | 默认公司编码, 不填时视为维持原数据 填写空字符串时视为清除原数据 |
classPositionBizCode | String(50) | 否 | 职级编码, 不填时视为维持原数据 填写空字符串时视为清除原数据 |
idInfo | List<IdInfo> | 否 | 证件信息, 不填时视为维持原数据 填写空数组时视为清除原数据 |
enName | EnName | 否 | 英文名, 不填时视为维持原数据 |
gender | String(10) | 否 | 性别,可填写MAN(男),WOMAN(女), 不填时视为维持原数据 填写空字符串时视为清除原数据 |
allowEmailAndPhoneBeNull | boolean | 否 | 允许邮箱或手机号为空, 默认false。true情况下不校验邮箱或手机号的必填性。 |
accounts | List<Account> | 否 | 个人账户,见下表 |
RTRoute 说明
字段名 | 类型 | 是否必填 | 字段说明 |
---|---|---|---|
businessCode | String | 是 | 部门编码 |
positionBizCode | String | 否 | 职位编码, 不填时视为维持原数据 填写空字符串时视为清除原数据 |
supervisorEmployeeId | String | 否 | 直接上级工号, 不填时视为维持原数据 填写空字符串时视为清除原数据 |
defaultDepartment | boolean | 否 | 默认部门(不填默认是false) |
PlaceInfo 说明
字段名 | 类型 | 是否必填 | 字段说明 |
---|---|---|---|
placeCode | String | 是 | 地址代码,如“330101” |
地址具体信息请查看每刻地址库
IdInfo 说明
字段名 | 类型 | 是否必填 | 字段说明 |
---|---|---|---|
idType | String | 是 | 证件类型,可选值 ID_CARD(身份证), GATResidencePermit(港澳台居民居住证), WGRResidenceIdCard(外国人永久居留身份证), GATMainlandPass(港澳居民来往内地通行证), TAIWAN_TravellingPass(台湾居民来往大陆通行证), Protection(护照) |
idNumber | String | 是 | 证件号码 |
EnName 说明
字段名 | 类型 | 是否必填 | 字段说明 |
---|---|---|---|
firstName | String | 是 | First Name |
middleName | String | 否 | Middle Name |
lastName | String | 否 | Last Name |
Account 说明
字段名 | 类型 | 是否必填 | 字段说明(国家表示这个字段为某些国家的特有字段) |
---|---|---|---|
bankAcctName | String | 是 | 账户名 |
bankAcctNumber | String | 是 | 账户号 |
paymentType | String | 是 | 账户类型 BANK(从公司银行账户付款) BANK_AUTOMATIC(从公司银行账户自动扣款) ALIPAY(从公司支付宝账户付款) CASH(从公司现金付款) THIRD_PARTY(第三方支付) MONEY_ORDER(通过承兑汇票付款) OTHER(其他) NONE(无) |
accountType | String | 是 | 账户性质 PERSONAL(对私账户) CORP(对公账户) |
bankCountry | String | 否 | 国家名称 |
bankName | String | 否 | 开户银行 |
bankLocation | String | 否 | 开户省市(地址编码,具体编码请咨询每刻研发) |
bankBranchNo | String | 否 | 联行号 |
bankBranchName | String | 否 | 分支行 |
certificationTypeName | String | 否 | 证件类型编码 |
identification | String | 否 | 证件号码 |
defaultAccount | Boolean | 否 | 默认收款账号 |
acceptCcyDetail | List<String> | 否 | 限定以下收款币种可用。币种映射表 |
remark | String | 否 | 备注 |
abroadBankCodeEN | String | 否 | BANK Code 泰国 台湾 |
ifsc | String | 否 | 印度 |
abroadBankNumber | String | 否 | abroadBankNumber 新西兰 |
bsb | String | 否 | BSB Number 澳大利亚 |
abroadBankBranchNo | String | 否 | 分支行编码 突尼斯-土耳其-丹麦-巴西-智利-哥伦比亚-南非-菲律宾-老挝 |
payeeDutyParagraph | String | 否 | 收款人税号 巴西-智利-哥伦比亚-摩洛哥-斯里兰卡-乌兹别克斯坦-格鲁吉亚-巴基斯坦 |
cbu | String | 否 | cbu 阿根廷 |
businessStructureOfBeneficiaryCompany | String | 否 | 收款人企业性质 哈萨克斯坦 |
abroadBankCode | String | 否 | 银行代码 乌兹别克斯坦 |
abroadBankAddress | String | 否 | 开户银行地址 |
abroadPayeeAddress | String | 否 | 收款人地址 |
edrpou | String | 否 | EDRPOU 乌克兰 |
bankCode | String | 否 | bankCode |
bankId | String | 否 | Bank ID 加拿大 |
cuit | String | 否 | CUIT No. 阿根廷 |
abroadPayeeAccountType | String | 否 | 收款人账户类型 巴西-智利-哥伦比亚-秘鲁-美国-巴基斯坦 |
dniPassport | String | 否 | DNI/PASSPORT 阿根廷 |
iban | String | 否 | iban |
customBranchFlag | String | 否 | customBranchFlag |
routingNumber | String | 否 | Routing Number 美国 罗马尼亚 |
branchTransitNumber | String | 否 | Branch Transit Number 加拿大 |
abroadBankBizCode | String | 否 | 银行编号 香港 |
identification | String | 否 | 证件号 中国 |
abroadPayeeType | String | 否 | 收款人类型 印度尼西亚 |
abroadBankBranchCode | String | 否 | 分行代码 乌克兰 |
swiftCode | String | 否 | SWIFT Code |
paymentTypeBizCode | String | 否 | 付款类型编码 乌兹别克斯坦 |
paymentPurposeCode | String | 否 | 付款用途代码 哈萨克斯坦 |
certificationTypeCode | String | 否 | 证件类型 中国 |
rnn | String | 否 | RNN 哈萨克斯坦 |
cci | String | 否 | CCI 秘鲁 |
bankIdentificationNumber | String | 否 | 银行识别号 巴西-智利-哥伦比亚-格鲁吉亚-巴基斯坦-菲律宾-老挝 |
dutyParagraph | String | 否 | 税号 俄罗斯 |
payeePhoneNumber | String | 否 | 收款人电话 加拿大 |
accountBizCode | String | 否 | 账户编码 |
参数样例
{
"code": "ACK",
"message": "",
"data": [
{
"employeeId": "test123",
"employeeName": "testName",
"employeeNickName": "花名",
"email": "test@maycur.com",
"phoneNo": "12345678911",
"roleNames": ["财务管理员","报表管理员"],
"departments": [
{
"businessCode": "部门编码111",
"positionBizCode": "职务编码",
"supervisorEmployeeId": "上级工号",
"defaultDepartment": true
}
],
"residences": [
{
"placeCode": "domestic-ZH3",
"includeChildPlace": false
}
],
"customObject": {},
"status": "ENABLE",
"hireDate": "2020-01-01",
"defaultLegalEntityBizCode": "默认抬头编码",
"classPositionBizCode": "p1",
"idInfo": {
"idType":"ID_CARD",
"idNumber":"xxxxxxxxxx"
},
"enName": {
"firstName": "111",
"middleName": "222",
"lastName": "3333"
},
"gender": "MAN",
"accounts": [{
"bankAcctName":"账户名",
"bankAcctNumber":"账户号",
"paymentType":"BANK",
"accountType":"PERSONAL",
"bankCountry": "CHINA", //国家名称
"bankName": "开户银行",
"bankLocation": "domestic-ZH3-ZH3_3",
"bankBranchNo": "联行号",
"bankBranchName": "分支行",
"certificationTypeName": "证件类型编码",
"identification": "证件号码",
"defaultAccount": false,//是否是默认首款账号
"acceptCcyDetail": [//限定首款币种可用
"CNY"
],
"remark": "备注",
"abroadBankCodeEN": null,
"ifsc": null,
"abroadBankNumber": null,
"bsb": null,
"abroadBankBranchNo": null,
"payeeDutyParagraph": null,
"cbu": null,
"businessStructureOfBeneficiaryCompany": null,
"abroadBankCode": null,
"abroadBankAddress": null,
"abroadPayeeAddress": null,
"edrpou": null,
"bankCode": null,
"bankId": null,
"cuit": null,
"abroadPayeeAccountType": null,
"dniPassport": null,
"iban": null,
"customBranchFlag": null,
"routingNumber": null,
"branchTransitNumber": null,
"abroadBankBizCode": null,
"abroadPayeeType": null,
"abroadBankBranchCode": null,
"swiftCode": null,
"paymentTypeBizCode": null,
"paymentPurposeCode": null,
"rnn": null,
"cci": null,
"bankIdentificationNumber": null,
"dutyParagraph": null,
"payeePhoneNumber": null
}]
}
],
"success": true
}
修改记录
2020-10-14 初始化
2020-11-06 接口查询逻辑修改
2020-11-10 添加controlProperties属性,非必须字段
2021-1-21 增加nameZh,nameEn 返回字段
2023-12-12 返回海外银行扩展字段
2023-12-26 返回账号的扩展字段