# 企业成本中心接入

# 1 创建成本中心接口

# 接口说明

名称	描述
功能	企业通过该接口，可以添加成本中心到美团企业版系统
HTTP方法	POST
请求方	第三方平台
响应方	美团企业版平台
url	$API_HOST/cost/create
method	cost.create

# 公共参数

详见：公共参数说明-公共请求参数

# 业务参数

名称	类型	是否必填	示例	说明
costNo	String	是	cost_code	成本中心编码
costName	String	是	成本中心名字	成本中心名字
customField1	String	否	自定义字段1	成本中心自定义字段1
customField2	String	否	自定义字段2	成本中心自定义字段2
customField3	String	否	自定义字段3	成本中心自定义字段3
customField4	String	否	自定义字段4	成本中心自定义字段4
customField5	String	否	自定义字段5	成本中心自定义字段5
parentId	String	否	1	成本中心父级ID
suitableType	Integer	否	2	成本中心适用类型(1:全员可用;2:部分适用)
managerStaffIds	List	否	[1,2]	成本中心负责人

# 业务响应

名称	类型	是否非空	示例	说明
costId	Long	是	170609	成本中心id

# 示例结果

业务请求

{
    "method":"cost.create",
    "ts":1512963578,
    "entId":1,
    "costNo": "organization_1",
    "costName": "成本中心1",
    "customField1": "自定义字段1",
    "customField2": "自定义字段2",
    "customField3": "自定义字段3",
    "customField4": "自定义字段4",
    "customField5": "自定义字段5",
    "parentId": 1,
    "suitableType": 2,
    "managerStaffIds": [1,2]
}

业务响应

{
    "msg": "",
    "data": {
        "costId": 170609
    },
    "status": 0
}

# 2 更新成本中心

# 接口说明

名称	描述
功能	企业通过该接口，可以对成本中心进行修改
HTTP方法	POST
请求方	第三方平台
响应方	美团企业版平台
url	$API_HOST/cost/update
method	cost.update

# 公共参数

详见：公共参数说明-公共请求参数

# 业务参数

名称	类型	是否必填	示例	说明
costId	Long	是	123	成本中心id
costNo	String	是	cost_code	成本中心编码
costName	String	是	新成本中心	新的成本中心名字
customField1	String	否	自定义字段1	成本中心自定义字段1
customField2	String	否	自定义字段2	成本中心自定义字段2
customField3	String	否	自定义字段3	成本中心自定义字段3
customField4	String	否	自定义字段4	成本中心自定义字段4
customField5	String	否	自定义字段5	成本中心自定义字段5
suitableType	Integer	否	适用类型	成本中心适用类型(1:全员可用;2:部分适用)
managerStaffIds	List	否	[1]	成本中心负责人

# 业务响应

名称	类型	是否非空	示例	说明
data	boolean	是	true	操作是否成功

# 示例结果

业务请求

{
    "method":"cost.update",
    "ts":1512963578,
    "entId":1,
    "costId": 170609,
    "costNo": "organization_2",
    "costName": "成本中心2",
    "customField1": "new自定义字段1",
    "customField2": "new自定义字段2",
    "customField3": "new自定义字段3",
    "customField4": "new自定义字段4",
    "customField5": "new自定义字段5",
    "suitableType": 2,
    "managerStaffIds": [1,2]
}

业务响应

{
    "msg": "",
    "data": true,
    "status": 0
}

# 3 查询成本中心

# 接口说明

名称	描述
功能	企业通过该接口，可以对成本中心进行查询
HTTP方法	POST
请求方	第三方平台
响应方	美团企业版平台
url	$API_HOST/cost/query
method	cost.query

# 公共参数

详见：公共参数说明-公共请求参数

# 业务参数

名称	类型	是否必填	示例	说明
costNo	String	否	123	成本中心编码
costName	String	否	成本中心	成本中心名字
pageNo	Integer	否	1	分页页码<=10
pageSize	Integer	否	20	分页大小 <=100
parentId	String	否	1	成本中心父级ID
statuses	List	否	ONLINE	成本中心状态

# 业务响应

名称	类型	是否非空	示例	说明
totalCount	Integer	是	100	成本中心总数
costItemVOS	List<CostItemVO>	是	见CostItemVO字段说明	成本中心列表

CostItemVO字段说明

名称	类型	是否非空	示例	说明
costId	Long	是	170609	成本中心ID
costNo	String	是	123	成本中心唯一标识
costName	String	是	成本中心	成本中心名字
customField1	String	否	自定义字段1	成本中心自定义字段1
customField2	String	否	自定义字段2	成本中心自定义字段2
customField3	String	否	自定义字段3	成本中心自定义字段3
customField4	String	否	自定义字段4	成本中心自定义字段4
customField5	String	否	自定义字段5	成本中心自定义字段5
creator	String	是	创建者	创建者
createTime	String	是	2020-06-09 11:11:11	创建时间
parentId	Long	否	1	成本中心父级ID
costLevel	Integer	否	1	成本中心层级
status	String	否	ONLINE	成本中心状态(ONLINE:上线，PAUSE:暂停)
managerStaffIds	List	否	[1,2]	成本中心负责人

# 示例结果

业务请求

{
    "method":"cost.query",
    "ts":1512963578,
    "entId":1,
    "costNo": "test1",
    "costName": "成本中心",
    "pageNo": 1,
    "pageSize": 20,
    "parentId": 1,
    "statuses": "ONLINE"
}

业务响应

{
    "status": 0,
    "msg": "成功",
    "data": {
        "totalCount": 1,
        "costItemVOS": [
            {
                "costId": 170609,
                "costNo": "test1",
                "costName": "成本中心1",
                "customField1": "自定义字段1",
                "customField2": "自定义字段2",
                "customField3": "自定义字段3",
                "customField4": "自定义字段4",
                "customField5": "自定义字段5",
                "creator": "100200-api",
                "createTime": "2020-02-05 16:08:36",
                "parentId": 1,
                "costLevel": 2,
                "status": "ONLINE",
                "managerStaffIds": [1,2]
            }
        ]
    }
}

# 4 更新成本中心状态

# 接口说明

名称	描述
功能	企业通过该接口，可更新成本中心状态
HTTP方法	POST
请求方	第三方平台
响应方	美团企业版平台
url	$API_HOST/cost/updateStatus
method	cost.update.status

# 业务参数

名称	类型	是否必填	示例	说明
costId	Long	是	170609	成本中心id
status	String	是	ONLINE	成本中心状态(ONLINE:上线，PAUSE:暂停

# 业务响应

名称	类型	是否非空	示例	说明
data	boolean	是	true	操作是否成功

# 示例结果

业务请求

{
  "method":"cost.update.status",
  "ts":1512963578,
  "entId":1,
  "costId": 170609,
  "status": "ONLINE"
}

业务响应

{
    "status": 0,
    "msg": "成功",
    "data": true
}

# 5 新增成本中心绑定关系

# 接口说明

名称	描述
功能	企业通过该接口，可以为成本中心绑定员工
HTTP方法	POST
请求方	第三方平台
响应方	美团企业版平台
url	$API_HOST/cost/createBind
method	cost.create.bind

# 公共参数

详见：公共参数说明-公共请求参数

# 业务参数

名称	类型	是否必填	示例	说明
costId	Long	是	170609	成本中心id
staffId	Long	是	1121	员工ID

# 业务响应

名称	类型	是否非空	示例	说明
data	boolean	是	true	操作绑定成功

# 示例结果

业务请求

{
  "method":"project.create.bind",
  "ts":1512963578,
  "entId":1,
  "costId": 1572215906057064470,
  "staffId": 123
}

业务响应

{
    "status": 0,
    "msg": "成功",
    "data": true
}

# 6 解除成本中心绑定关系

# 接口说明

名称	描述
功能	企业通过该接口，可以为成本中心解绑员工
HTTP方法	POST
请求方	第三方平台
响应方	美团企业版平台
url	$API_HOST/cost/deleteBind
method	cost.delete.bind

# 公共参数

详见：公共参数说明-公共请求参数

# 业务参数

名称	类型	是否必填	示例	说明
costId	Long	是	170609	成本中心id
staffId	Long	是	1121	员工ID

# 业务响应

名称	类型	是否非空	示例	说明
data	boolean	是	true	操作解绑成功

# 示例结果

业务请求

{
  "method":"project.delete.bind",
  "ts":1512963578,
  "entId":1,
  "costId": 1572215906057064470,
  "staffId": 123
}

业务响应

{
    "status": 0,
    "msg": "成功",
    "data": true
}

# 7 查询成本中心绑定关系

# 接口说明

名称	描述
功能	企业通过该接口，可以查询成本中心绑定关系
HTTP方法	POST
请求方	第三方平台
响应方	美团企业版平台
url	$API_HOST/cost/queryBind
method	cost.query.bind

# 公共参数

详见：公共参数说明-公共请求参数

# 业务参数

名称	类型	是否必填	示例	说明
costId	Long	否	170609	成本中心id
staffId	Long	否	1121	员工ID
pageNo	Integer	否	1	分页页码<=10
pageSize	Integer	否	20	分页大小 <=100

# 业务响应

名称	类型	是否非空	示例	说明
totalCount	Integer	是	100	成本中心关系总数
costBindVOS	List<CostBindItemVO>	是	CostBindItemVO	成本中心关系列表

CostBindItemVO字段说明

名称	类型	是否非空	示例	说明
costId	Long	是	170609	成本中心ID
staffId	Long	是	123	员工ID
creator	String	是	创建者	创建者
createTime	String	是	2020-06-09 11:11:11	创建时间

# 示例结果

业务请求

{
    "method":"cost.query.bind",
    "ts":1512963578,
    "entId":1,
    "costId": 170609,
    "staffId": 123,
    "pageNo": 1,
    "pageSize": 20
}

业务响应

{
    "status": 0,
    "msg": "成功",
    "data": {
        "totalCount": 1,
        "costItemVOS": [
            {
                "costId": 170609,
                "staffId": 123,
                "creator": "100200-api",
                "createTime": "2020-02-05 16:08:36"
            }
        ]
    }
}

← 企业员工扩展信息接口企业项目接口 →