飞书开放平台 Server API 文档

主题

查询成本分摊报表汇总数据 ​

根据算薪期间和成本分摊方案id获取成本分摊汇总数据。调用接口前，需在payroll 系统中打开「财务过账」开关，并且完成发布成本分摊报表。

请求 ​

项目值
HTTP URLhttps://open.feishu.cn/open-apis/payroll/v1/cost_allocation_reports
HTTP MethodGET
接口频率限制5 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用payroll:cost_allocation_report:read 获取成本分摊报表汇总数据

请求头 ​

名称类型必填描述
Authorizationstring是tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token

查询参数 ​

名称类型必填描述
page_sizeint是分页大小
示例值：50
数据校验规则：
- 取值范围：1 ～ 100
page_tokenstring否分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果
示例值：6823630319749592415
cost_allocation_plan_idstring是成本分摊方案ID，通过批量查询成本分摊方案获取
示例值：6823630319749580304
pay_periodstring是期间，成本分摊数据对应的年月，格式 为yyyy-MM
示例值：2023-11
report_typeint是报表类型
示例值：1
可选值有：
- 0: 默认，表示没有开通计提和实发功能时的报表类型，开通计提和实发之后，该类型报表将无法发布。 - 1: 计提 - 2: 实发

响应 ​

响应体 ​

名称类型描述
codeint错误码，非 0 表示失败
msgstring错误描述
data\--
  └ pay_periodstring期间，成本分摊报表对应的年月
  └ page_tokenstring分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
  └ has_moreboolean是否还有更多项
  └ cost_allocation_report_namesi18n_content\[\]报表名称
    └ localestring语种
    └ valuestring语种对应的值
  └ cost_allocation_report_datascost_allocation_report_data\[\]汇总数据
    └ data_summary_dimensionsdata_summary_dimension\[\]数据维度汇总
      └ dimension_levelint层级
      └ dimension_typeint类型：
公司主体 - 1
成本中心 - 2
部门 - 3
薪资组 - 4
人员类型 - 5
雇佣状态 - 6
转正状态 - 7
职务 - 8
序列 - 9
职级 - 10
工时制度 - 11
合同类型 - 12
算薪项 - 13
自定义维度 - 100
      └ dimension_value_idstring维度ID，需要根据dimension_type再次转换，如：当dimension_type为1时，该值表示公司主体的ID。
对应的接口映射如下：
dimension_type = 1 公司主体
dimension_type = 2 成本中心
dimension_type = 3 部门
dimension_type = 4 薪资组
dimension_type = 5 人员类型
dimension_type = 8 职务
dimension_type = 9 序列
dimension_type = 10 职级
dimension_type = 11 工时制度
      └ enum_dimensionenum_object算薪项汇总维度时，当算薪项是特定枚举值，会使用该字段返回枚举值ID以及枚举值Key，业务需要获取枚举对象的详情信息，可根据ID去对应的对象中查找，其中枚举对象的映射如下：
workCalendar 工作日历
location 地点
company 公司主体
costCenter 成本中心
department 部门
employeeType 人员类型
job 职务
jobFamily 序列
jobLevel 职级
workingHoursType 工时制度
        └ enum_value_idstring枚举对象ID
        └ enum_keystring枚举对象
      └ dimension_value_lookup_infodimension_value_lookup_info维度引用对象的基础信息，当维度为引用类型字段才会有值，目前支持的引用对象类型见type
        └ typestring引用对象类型，类型对应的对象映射包括不仅限：
type = company 公司主体
type = cost_center 成本中心
type = department 部门
type = pay_group 薪资组
type = employee_type 人员类型
type = job 职务
type = job_family 序列
type = job_level 职级
type = working_hours_type 工时制度
        └ idstring引用对象的id，可根据相关API查询到对象的完整信息
        └ codestring引用对象的code，目前下面的对象会有code：
type = company 公司主体
type = cost_center 成本中心
type = department 部门
type = job 职务
type = job_family 序列
type = job_level 职级
type = location 地点
      └ dimension_namesi18n_content\[\]维度名称，算薪项、自定义维度使用
        └ localestring语种
        └ valuestring语种对应的值
      └ dimension_titlesi18n_content\[\]数据维度表头，算薪项、自定义维度使用
        └ localestring语种
        └ valuestring语种对应的值
        └ idstring名称对应的实体id
需要根据dimension_type再次转换，如：当dimension_type为13时，该值表示算薪项的ID。
对应的接口映射如下：
dimension_type = 13 算薪项
    └ compensation_cost_itemcompensation_cost_item成本项数据
      └ number_of_individuals_for_paymentint发薪人数
      └ compensation_costscompensation_cost\[\]成本项数据
        └ compensation_cost_valuestring成本项值
        └ i18n_namesi18n_content\[\]成本项名称
          └ localestring语种
          └ valuestring语种对应的值

响应体示例 ​

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "pay_period": "2023-11",
        "page_token": "6823630319749580302",
        "has_more": true,
        "cost_allocation_report_names": [
            {
                "locale": "zh_cn",
                "value": "名称"
            }
        ],
        "cost_allocation_report_datas": [
            {
                "data_summary_dimensions": [
                    {
                        "dimension_level": 1,
                        "dimension_type": 1,
                        "dimension_value_id": "6823630319749580306",
                        "enum_dimension": {
                            "enum_value_id": "7188920315914207276",
                            "enum_key": "company"
                        },
                        "dimension_value_lookup_info": {
                            "type": "work_calendar",
                            "id": "6961286846093788621",
                            "code": "D1230011115"
                        },
                        "dimension_names": [
                            {
                                "locale": "zh_cn",
                                "value": "名称"
                            }
                        ],
                        "dimension_titles": [
                            {
                                "locale": "zh_cn",
                                "value": "名称",
                                "id": "723123123123123213"
                            }
                        ]
                    }
                ],
                "compensation_cost_item": {
                    "number_of_individuals_for_payment": 100,
                    "compensation_costs": [
                        {
                            "compensation_cost_value": "123456.78",
                            "i18n_names": [
                                {
                                    "locale": "zh_cn",
                                    "value": "名称"
                                }
                            ]
                        }
                    ]
                }
            }
        ]
    }
}

错误码 ​

HTTP状态码错误码描述排查建议
5002500001unknown error未知错误，请联系技术支持。
4002500002param is invalid参数错误，请检查参数
5002500003rpc fail请求调用出错，请联系技术支持
5002500004get plan version fail获取成本分摊方案版本出错，请联系技术支持
2002500005report has changed, please fetch again报表已变更，请重新获取。一般为报表拉取过程中新发布了报表。需要不传page_token参数，重新从头拉取
2002500006report not found or unpublished报表不存在或者未发布，请检查参数并且联系报表管理员确认发布报表后再尝试
5002500007report fetch fail获取报表数据失败，请联系技术支持

内容来源：飞书开放平台 · 自动爬取整理

本镜像仅供学习与查阅，文档版权归飞书所有