获取企业薪资项

获取公共薪资项, 包含分组信息
scope:hades:item:list

接口说明

获取指定企业的薪资项列表，按分组组织返回。包含启用和停用状态的薪资项。

接口信息

项目	说明
URL	`/open/api/v1/item/list`
Method	POST
Content-Type	application/json
权限标识	hades:item:list

请求参数

参数名	类型	必填	说明
corpId	String	是	企业ID

请求示例

{
  "corpId": "corp_001"
}

返回参数

返回类型：List<ItemResponse>

ItemResponse

参数名	类型	说明
itemGroupId	String	薪资项分组ID
itemGroupName	String	薪资项分组名称
children	List<ItemDetail>	该分组下的薪资项列表

ItemDetail

参数名	类型	说明
itemId	String	薪资项ID
itemName	String	薪资项名称
valueType	ValueType	数据类型（枚举值）
status	DataStatus	状态：normal-正常，stop-停用

返回示例

{
  "code": 0,
  "msg": "success",
  "data": [
    {
      "itemGroupId": "group_001",
      "itemGroupName": "基本薪资",
      "children": [
        {
          "itemId": "item_001",
          "itemName": "基本工资",
          "valueType": "NUMBER",
          "status": "normal"
        },
        {
          "itemId": "item_002",
          "itemName": "岗位津贴",
          "valueType": "NUMBER",
          "status": "stop"
        }
      ]
    }
  ]
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200list-Example

text/plain

示例

{
    "data": [
        {
            "itemGroupId": "", //分组id
            "itemGroupName": "", //分组名称
            "children": [ //薪资项
                {
                    "itemId": "", //薪资项ID
                    "itemName": "", //薪资项名称
                    /**
                     * 数据类型
                     * string :文本类型
                     * number :数字类型
                     * date :日期类型
                     */
                    "valueType": "",
                    /**
                     * 启/停状态
                     * normal :正常
                     * stop :停用
                     */
                    "status": ""
                }
            ]
        }
    ],
    "success": false,
    "errorCode": "",
    "errorMsg": ""
}

接口说明#

接口信息#

请求参数#

请求示例#

返回参数#

ItemResponse#

ItemDetail#

返回示例#

请求参数

请求示例代码

返回响应

接口说明

接口信息

请求参数

请求示例

返回参数

ItemResponse

ItemDetail

返回示例