管理API对接文档（2024版）

最近更新时间：

接口说明

注意
  1. 部门数量上限是2000，如贵司超过2000个部门，请联系相应的对接同学添加白名单进行扩展
  2. 部门添加时，请不要并发操作，防止部门添加失败
  3. 请求时无需中文转义
说明
  • 新建接口后，可以使用查询接口对齐信息
  • 建议保存新建之后返回的滴滴部门或项目的ID作为唯一主键，用于修改或删除的判断。


基本信息

HTTP URL

/river/BudgetCenter/add

HTTP Method

POST

权限要求


请求头

参数名称

参数值

Content-Type

application/json

请求参数

字段名

字段说明

字段类型

必填

备注

client_id

申请应用时分配的AppKey

string

Y


access_token

授权后的access token

string

Y


company_id

企业ID

string

Y


timestamp

当前时间戳(精确到秒级)

int

Y


sign

签名

string

Y


type

类型

int

Y

枚举值数字 1 部门 2 项目

name

部门/项目名称

string

Y

不大于 200 字符

budget_cycle

预算周期

int

Y

枚举值数字 0：不限额；1：自然月 2：自然季度 3：自然年（其中23只对部门生效，需要设置白名单，须联系客户经理）

total_quota

总金额

string

Y

单位元 0表示不限额度 金额管控只支持正整数

out_budget_id

编号

string

N

type = 1 时必填；type = 2 非必填； 长度限制：≤ 64 字符

leader_id

主管ID

string

N

人员同步时返回的memberid leader_id和leader_employee_id 时，优先处理leader_id，多个用英文逗号分开，第一个是主要主管，后续是其他主管，最多30个

leader_employee_id

主管员工编号

string

N

主管工号，json字符串，第一个是主要主管，后续是其他主管，最多30个，leader_id存在时不生效，举例：[111,2222,44444]

parent_id

上级部门/项目 ID

string

N

新建部门时返回的部门ID
type = 1 非必填，传0为顶级部门ID
type=2 默认为
parent_id优先级大于 out_parent_id和 out_parent_name

out_parent_id

上级部门/项目外部CODE

string

N

type = 1 非必填，不传默认为顶级部门code
type=2 默认为空，项目需要out_parent_id和out_parent_name一起传递，作为唯一值校验。

out_parent_name

上级部门/项目外部名称

string

N

type = 1 非必填，不传默认为顶级部门code
type=2 默认为空 ，项目需要out_parent_id和out_parent_name一起传递，作为唯一值校验。

member_used

使用范围

int

N

枚举值数字 type=2时生效
0 ：全员可见
1：项目成员内可见
2：公司主体内可见
不传默认为0 (枚举 2需要设置白名单，须联系客户经理。报错误码10001)

start_date

项目开始日期

string

N

默认为空 格式：yyyy-MM-dd type=2时生效

expiry_date

项目结束日期

string

N

默认为空 格式：yyyy-MM-dd type=2时生效

legal_entity_id

公司主体ID

string

N

多个用英文逗号分开
字段不传不生效
如果对应的公司主体id已经停用或者不存在 返回错误码10001 type=2时生效

budget_extra_info

项目扩展信息的自定义字段

string

N

项目扩展信息的自定义字段；最长不大于 500 字符；(必须为json字符串，json解析后不能为空)；非必填
仅对项目（type=2）生效，部门传了不生效


请求示例

curl -X POST -H "content-type:application/json" \
-d '{
    "client_id":"client_id_test",
    "access_token":"1e79178d3bfeb40be24404a3048f541f34dd6268",
    "timestamp":1583484681,
    "company_id":"12345678980",
    "name":"\u56fd\u5e86\u884c\u52a8",
    "type":2,
    "budget_cycle":1,
    "total_quota":0,
    "budget_extra_info": "{\"test\":\"test1\"}",
    "sign":"b517f48fcbe57a2d66dcefd560452da1"
}' \
https://api.es.xiaojukeji.com/river/BudgetCenter/add

响应参数

字段名

字段说明

字段类型

备注

errno

错误编码

string

数字 0 表示成功，非0 表示失败

errmsg

错误信息

string

errno=0时为常量"SUCCESS"，errno!=0时为错误信息

data

返回数据

object



data数据格式

字段名

字段说明

字段类型

备注

id

部门或项目ID

string




响应示例

正常示例

{
    "errno":0,
    "errmsg":"success",
    "data":{
        "id":"6415496924215922706"
    }
}

异常示例


错误码

通用错误解决方案

版本记录

日期

更新人

更新内容

上线时间

2023.11.07

陈继诗

迁移文档


2023.11.10

陈继诗

请求增加leader_employee_id字段，增加out_parent_id字段，out_parent_name

2024.01.04

2023.12.08

陈继诗

请求增加budget_extra_info

2024.01.04

2024.07.23

陈继诗

leader_id，leader_employee_id支持传多个

2024.08.22