get_report: Get Company Report

In bambooHR: A Wrapper to the 'BambooHR' API

Get Company Report

Description

Request one of your pre-existing company reports from the reporting section. At present, only reports from the Company Reports section are supported.

Usage

get_report(
  id,
  format = c("CSV", "PDF", "XLS", "XML", "JSON"),
  field_filtering = TRUE,
  only_current = TRUE,
  api_version = "v1"
)

Arguments

id	The report ID. You can get the report number by hovering over the report name on the reports page and grabbing the ID.
format	The output format for the report. Supported formats: CSV, PDF, XLS, XML, JSON.
field_filtering	Logical, default [TRUE]. Whether to apply duplicate field filtering.
only_current	Logical default [TRUE]. Should the report be limited to only current employees.
api_version	(optional) - Version of API to use to make request. Default is "v1".

Value

Currently the function simply returns a parsed response object.

bambooHR documentation built on Oct. 25, 2023, 5:07 p.m.