接口说明
- 查询企业在滴滴企业版管理后台的部门或项目信息,用于校验、核对滴滴后台的数据
- 接口仅返回正常有效的部门或项目信息
基本信息
|
HTTP URL |
/river/BudgetCenter/get |
|---|---|
|
HTTP Method |
GET |
|
权限要求 |
|
请求头
|
参数名称 |
参数值 |
|---|---|
|
Content-Type |
application/x-www-form-urlencoded |
请求参数
|
字段名 |
字段说明 |
字段类型 |
必填 |
备注 |
|---|---|---|---|---|
|
client_id |
应用唯一标识 |
string |
Y |
滴滴开放平台创建应用时,由平台分配的唯一标识,用于识别调用方身份 |
|
access_token |
接口调用授权凭证 |
string |
Y |
授权认证后获取的访问令牌,用于校验接口调用权限;授权认证方式参见【接口认证-授权认证】 |
|
company_id |
租户唯一标识 |
string |
Y |
滴滴企业版租户唯一 ID,代表当前操作的企业主体 |
|
timestamp |
当前时间戳 |
int |
Y |
当前时间戳,精确到秒级 |
|
sign |
签名 |
string |
Y |
根据规则生成的接口签名,用于校验请求合法性与完整性;生成方式参见【接口认证-授权认证】 |
|
id |
滴滴侧部门/项目ID |
string |
N |
使用时,与out_budget_id字段二者选一即可 |
|
out_budget_id |
部门/项目外部编号 |
string |
N |
使用时,与id字段二者选一即可 |
|
type |
类型 |
int |
N |
枚举值数字: |
|
is_exact_name |
是否精确查询名称 |
int |
N |
枚举值数字: |
|
name |
名称 |
string |
N |
需查询的部门名称或项目名称 |
|
offset |
数据开始位置 |
int |
Y |
数据分页起始位置,从 0 开始计数,后续查询需为 length 的倍数 |
|
length |
数据条数(最大100条) |
int |
Y |
每页返回数据条数,最大值为 100,超过则按 100 条返回 |
|
is_need_limit_rule |
是否返回部门/项目限额规则列表 |
int |
N |
枚举值数字: |
请求示例
curl -X GET -H "Content-Type: application/x-www-form-urlencoded" https://api.es.xiaojukeji.com/river/BudgetCenter/get?client_id=client_id_test&access_token=141ea31466478eab2f1c1ddcca2675b989a16552×tamp=1566764837&id=1125904357323169&company_id=12345678980&offset=0&length=100&sign=fba8dfb887afe16cb71c50b26a5eae0e
响应参数
|
字段名 |
字段说明 |
字段类型 |
备注 |
|---|---|---|---|
|
errno |
错误编码 |
string |
数字 0 表示成功,非 0 表示失败 |
|
errmsg |
错误信息 |
string |
errno=0时为常量"SUCCESS",errno!=0时为错误信息 |
|
data |
部门/项目列表信息 |
object |
|
data数据格式
|
字段名 |
字段说明 |
字段类型 |
备注 |
|---|---|---|---|
|
total |
此次查询符合条件的部门/项目总数 |
int |
|
|
records |
部门/项目集合 |
array |
|
records数组元素格式
|
字段名 |
字段说明 |
字段类型 |
备注 |
|---|---|---|---|
|
id |
滴滴侧部门/项目ID |
string |
|
|
out_budget_id |
部门/项目外部编号 |
string |
合作方侧自定义的唯一标识,通过新增/修改接口传入 |
|
type |
类型 |
int |
枚举值数字: |
|
name |
部门/项目名称 |
string |
|
|
status |
状态 |
string |
枚举值数字: |
|
parent_id |
上级部门/项目滴滴侧ID |
long |
|
|
out_parent_id |
上级部门/项目外部编码 |
string |
|
|
member_used |
项目的可见范围 |
int |
枚举值数字: |
|
legal_entity_id |
项目所属公司主体ID |
string |
如果有多个,以英文逗号分开 |
|
out_legal_entity_id |
项目所属公司主体外部编码 |
string |
如果有多个,以英文逗号分开 |
|
member_num |
在使用人数 |
int |
|
|
leader_id |
主管 |
string |
部门主管或项目主管 |
|
leader_item_list |
主管列表 |
array |
部门主管或项目主管列表 |
|
is_limit_quota |
是否限额 |
int |
枚举值数字: |
|
budget_cycle |
限额预算周期 |
int |
枚举值数字: |
|
total_quota |
限额金额 |
number |
单位:元,0 表示不限额度,精确到两位小数 |
|
available_quota |
剩余额度 |
number |
单位:元,精确到两位小数 |
|
freeze_quota |
冻结金额 |
number |
单位:元,精确到两位小数 |
|
limit_rule_list |
限额规则列表 |
array |
具体字段参见 limit_rule_list限额规则 |
|
start_date |
项目开始日期 |
string |
当类型为项目时,此参数有效 |
|
expiry_date |
项目结束日期 |
string |
当类型为项目时,此参数有效 |
|
budget_extra_info |
项目拓展字段 |
string |
项目拓展字段,仅项目有数据时返回 |
leader_item_list
|
字段名 |
字段说明 |
字段类型 |
备注 |
|---|---|---|---|
|
leader_id |
主管ID |
string |
滴滴侧员工ID |
|
leader_name |
主管姓名 |
string |
|
|
leader_type |
主管类型 |
string |
枚举值英文: |
limit_rule_list
|
字段名 |
字段说明 |
字段类型 |
备注 |
|---|---|---|---|
|
rule_name |
限额规则名称 |
string |
限额规则在员工侧的展示名称 |
|
budget_cycle |
预算周期 |
int |
枚举值数字: |
|
is_accumulative |
是否累计 |
int |
枚举值数字: |
|
total_quota |
限额 |
number |
单位:元,0 表示不限额度,精确到两位小数 |
|
limit_management_scope |
限额管理范围 |
int |
枚举值数字: |
|
available_quota |
剩余额度 |
number |
单位:元,精确到两位小数 |
|
freeze_quota |
冻结金额 |
number |
单位:元,精确到两位小数 |
响应示例
{
"errno": 0,
"errmsg": "SUCCESS",
"data": {
"total": 32,
"records": [
{
"id": "6388733755640532997",
"name": "openapi1452169149",
"company_id": "4591398120721764364",
"status": "0",
"out_budget_id": "0",
"type": "1",
"budget_cycle": "1",
"is_limit_quota": "1",
"member_num": "0",
"total_quota": "1000.00",
"available_quota": "1000.00",
"parent_id": "1125968274945260",
"legal_entity_id": "",
"out_legal_entity_id": "",
"out_parent_id": "",
"budget_extra_info": "{\"test\":\"test1\"}",
"leader_item_list": [
{
"leader_id": "1125935173600502",
"leader_name": "郭蒙3",
"leader_type": "major"
},
{
"leader_id": "1125935066392161",
"leader_name": "郭蒙1",
"leader_type": "other"
},
{
"leader_id": "1125935140823459",
"leader_name": "郭蒙2",
"leader_type": "other"
}
],
"freeze_quota": "0.00",
"limit_rule_list": [
{
"rule_name": "成本中心限额(默认)",
"budget_cycle": 4,
"is_accumulative": 0,
"total_quota": 100.99,
"limit_management_scope": 0,
"available_quota": 100.99,
"freeze_quota": 0
}
]
}
]
}
}
错误码
错误码对应的文案描述仅为场景化说明,会根据业务优化、场景补充、表述规范等需求进行不定期更新(如细化提示、优化措辞等),不建议将文案内容用于精准匹配逻辑,避免后续文案变更影响系统稳定性
|
错误码 |
错误信息 |
错误原因以及处理方案 |
|---|---|---|
|
10001 |
timestamp 过期 |
原因:请求携带的时间戳超出有效时效,接口拒绝处理 |
|
10002 |
IP 不在白名单中,本次请求 IP: |
原因:发起请求的服务器 IP 未配置在滴滴接口白名单内,接口做了 IP 访问限制 |
|
10003 |
参数错误 |
原因:请求传入的参数存在格式、值类型、必填项缺失等错误 |
|
10003 |
offset非有效值 |
原因:offset 参数不是 length 的倍数,数值不符合接口分页规则 |
|
12001 |
参数错误 (未正确传输 company_id) |
原因:核心参数 company_id 未传、传空或格式不符合接口要求 |
|
12002 |
该托管关系不存在,无权操作 |
原因:当前请求的主体与滴滴侧的托管合作关系未建立 / 已失效,无对应操作权限 |
|
19999 |
签名失败 |
原因:请求的 sign 签名值生成规则错误、参数拼接错误或密钥不一致,签名校验未通过 |
|
400 |
非法的 client_id |
原因:传入的 client_id 无效、未注册或与接口分配的 client_id 不匹配 |
|
403 |
无权访问该接口 |
原因:当前 client_id 未获取该接口的访问权限,接口做了权限管控 |
|
408 |
参数错误,未正确传输 timestamp |
原因:timestamp 参数未传、传空或格式不符合接口要求(如非数字、位数错误) |
|
410 |
client_id 不一致 |
原因:请求中携带的 client_id 与签名、access_token 关联的 client_id 不匹配 |
|
412 |
client_id 和 access_token 为必填项 |
原因:请求未传入 client_id 或 access_token,两个均为接口必填参数 |
|
415 |
不支持 http 协议 |
原因:使用了 HTTP 协议发起请求,接口仅支持 HTTPS 安全协议 |
|
50102 |
网络请求结果错误(获取成本中心列表失败 0) |
原因:接口内部调用获取成本中心列表的服务失败,可能是滴滴侧服务临时异常或关联数据不存在 |
其他信息参见:通用错误解决方案
使用建议
- 分页查询:使用
offset和length进行分页,offset必须是length的倍数 - 查询条件:
- 按 ID 查询:使用
id或out_budget_id - 按名称查询:使用
name,配合is_exact_name控制精确/模糊 - 按类型查询:使用
type筛选部门(1)或项目(2)
- 按 ID 查询:使用
- 限额规则:建议使用
is_need_limit_rule=1获取限额规则列表(limit_rule_list) - 状态筛选:接口只能查询有效(启用中)的部门
版本记录
|
日期 |
更新人 |
更新内容 |
上线时间 |
|---|---|---|---|
|
2023.11.07 |
陈继诗 |
迁移文档 |
|
|
2023.12.08 |
陈继诗 |
records数组增加budget_extra_info |
2024.01.04 |
|
2024.07.23 |
陈继诗 |
增加leader_item_list |
2024.08.22 |
|
2025.06.18 |
杨露佳 |
新增out_legal_entity_id,out_parent_id |
2025.06.18 |
|
2026.02.09 |
郭相均、谢朱莉 |
限额相关升级 |
2026.02.09 |
|
2026.04.07 |
谢朱莉 |
更新文档字段描述 |
|