> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Officient

> How to set up the Officient connector, plus the actions that are available.

![Officient](https://stackone-logos.com/api/officient/filled/svg)

Betav0.2.0[See changelog](https://docs.stackone.com/connectors/officient/changelog.md)

[71 actions](#actions) · 2 auth methods

HRIS

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [Access Token · Connector Profile](https://docs.stackone.com/connectors/officient/guides/connector-profile/access-token.md)
>
> Authenticate with a personal access token generated from the Officient developer portal. Recommended for integrating wit...

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/officient/guides/connector-profile/oauth-2-0.md)
>
> OAuth 2.0 for third-party integrations. Register a client app in the Officient developer portal and configure the OAuth...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [Access Token · Link Account](https://docs.stackone.com/connectors/officient/guides/link-account/access-token.md)

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/officient/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

basics:read

basics:write

budgets:read

budgets:write

calendar:read

calendar:write

contracts:read

contracts:write

custom.fields:read

custom.fields:write

documents:read

documents:write

expenses.categories:read

expenses.categories:write

expenses:read

expenses:write

managers:read

performance.reviews:read

personal.info.custom.fields:read

personal.info:read

personal.info:write

wages:read

No scopes found

71 actions

ActionDescriptionRequired scopes

Get Account`officient_get_account`

Retrieve information about your own Officient account

`basics:read`

List Assets`officient_list_assets`

Retrieve a list of assets in the Officient account

`basics:read`

Get Asset`officient_get_asset`

Retrieve the full detail of a single asset by its ID

`basics:read`

Create Asset`officient_create_asset`

Add a new asset to Officient

`basics:write`

Update Asset`officient_update_asset`

Update the details of an existing asset

`basics:write`

Delete Asset`officient_delete_asset`

Delete an asset from Officient

`basics:write`

List Asset Types`officient_list_asset_types`

Retrieve a list of the custom asset types configured in the Officient account

`basics:read`

List Budgets`officient_list_budgets`

Retrieve the budgets defined for a person in a given year

`budgets:read`

List Budget Items`officient_list_budget_items`

Retrieve the items that make up a specific budget

`budgets:read`

Create Budget`officient_create_budget`

Create a new budget for an employee for a given year

`budgets:write`

Update Budget`officient_update_budget`

Update the maximum amount of an existing budget

`budgets:write`

Delete Budget`officient_delete_budget`

Delete a budget by its ID

`budgets:write`

Create Budget Item`officient_create_budget_item`

Add a new item to an existing budget

`budgets:write`

Delete Budget Item`officient_delete_budget_item`

Delete an item from a budget

`budgets:write`

Get Daily Calendar`officient_get_daily_calendar`

List the time off, overtime and scheduled time for a single person on a single day

`calendar:read`

Get Monthly Calendar`officient_get_monthly_calendar`

List the time off, overtime and scheduled time for a single person for an entire month

`calendar:read`

Get Yearly Calendar`officient_get_yearly_calendar`

List the time off, overtime and scheduled time for a single person for an entire year

`calendar:read`

Get Calendar Request`officient_get_calendar_request`

Retrieve the full detail of a single calendar (time off) request

`calendar:read`

List Calendar Requests`officient_list_days_off_requests`

List calendar (time off) requests in the Officient account

`calendar:read`

List Custom Event Types`officient_list_event_types`

List the custom calendar event types (time off types, overtime types) for a year

`calendar:read`

Add Calendar Event`officient_create_event`

Add one or more calendar events (day off, overtime, etc.) for a person

`calendar:write`

Overwrite Calendar Event`officient_overwrite_event`

Create or overwrite a calendar event of a given type on a specific day

`calendar:write`

Delete Calendar Event`officient_delete_event`

Remove an event (such as a day off) from a person's calendar

`calendar:write`

Update Time Worked`officient_update_time_worked`

Overwrite the amount of time worked by a person on a specific day

`calendar:write`

List Contracts`officient_list_contracts`

Retrieve a list of all contracts in the Officient account

`contracts:read`

Get Contract`officient_get_contract`

Retrieve the full detail of a single contract by its ID

`contracts:read`

Get Contract PDF`officient_get_contract_pdf`

Get a temporary PDF download link for a contract

`contracts:read`

Create Contract`officient_create_contract`

Add a new contract for a person in Officient

`contracts:write`

Request Contract Signature`officient_request_contract_signature`

Send an email invite requesting a person to sign a contract

`contracts:write`

List Cost Centers`officient_list_cost_centers`

Retrieve a list of all cost centers in the Officient account

`wages:read`

Get Cost Center`officient_get_cost_center`

Retrieve the details of a single cost center by its internal code

`wages:read`

List Custom Fields`officient_list_custom_fields`

List all custom fields defined in the Officient account

`custom.fields:read`

Update Custom Field Value`officient_update_custom_field_value`

Set the value of a custom field for a specific object (person, asset, car, contract, ...)

`custom.fields:write`

List Departments`officient_list_departments`

Retrieve a list of all departments in the Officient account

`wages:read`

Get Department`officient_get_department`

Retrieve the details of a single department by its internal code

`wages:read`

List Documents`officient_list_documents`

List all documents attached to a specific parent object (employee, asset or car)

`documents:read`

Upload Document`officient_upload_document`

Upload a base64-encoded document and attach it to a parent object (employee, asset or car)

`documents:write`

Download Document`officient_download_document`

Get a temporary download URL for a document by its file id

`documents:read`

Delete Document`officient_delete_document`

Delete a document by its file id

`documents:write`

List Expense Categories`officient_list_expense_categories`

List all expense categories in the Officient account

`expenses.categories:read`

Get Expense Category`officient_get_expense_category`

Retrieve the full detail of a single expense category by its ID

`expenses.categories:read`

Create Expense Category`officient_create_expense_category`

Add a new expense category

`expenses.categories:read``expenses.categories:write`

Update Expense Category`officient_update_expense_category`

Rename an existing expense category

`expenses.categories:write`

Delete Expense Category`officient_delete_expense_category`

Delete an expense category by its ID

`expenses.categories:write`

List Expenses By Month`officient_list_expenses_by_month`

List all expenses for a specific year and month

`expenses:read`

List Expenses By Year`officient_list_expenses_by_year`

List all expenses for a specific year

`expenses:read`

Get Expense`officient_get_expense`

Retrieve the full detail of a single expense by its ID

`expenses:read`

Create Expense`officient_create_expense`

Add a new expense for an employee with an optional category

`expenses:write``expenses:read`

Update Expense`officient_update_expense`

Update an existing expense (e.g., its category)

`expenses:write`

Delete Expense`officient_delete_expense`

Delete an expense by its ID

`expenses:write`

List Vehicles`officient_list_vehicles`

Retrieve a list of vehicles in the Officient fleet

`basics:read`

Get Vehicle`officient_get_vehicle`

Retrieve the full detail of a single fleet vehicle by its ID

`basics:read`

Create Vehicle`officient_create_vehicle`

Add a new vehicle to the Officient fleet

`basics:write`

Update Vehicle`officient_update_vehicle`

Update the details of an existing fleet vehicle

`basics:write`

List Functions`officient_list_functions`

Retrieve a list of all functions (job functions) in the Officient account

`wages:read`

Get Function`officient_get_function`

Retrieve the details of a single function by its internal code

`wages:read`

List People`officient_list_people`

Retrieve a list of people (employees) in the Officient account

`basics:read`

Search People`officient_search_people`

Search for people by name, email or national number

`personal.info:read`

Get Person`officient_get_person`

Retrieve the full detail of a single person by their ID

`personal.info:read`

Get Person Custom Fields`officient_get_person_custom_fields`

Retrieve the custom field values set on a specific person

`personal.info.custom.fields:read`

Get Person Manager`officient_get_person_manager`

Retrieve the current manager of a specific person

`managers:read`

Create Person`officient_create_person`

Add a new person (employee) to Officient

`basics:write`

Update Person`officient_update_person`

Update the personal details of an existing person

`personal.info:write`

Update Person Manager`officient_update_person_manager`

Set or change the manager of a person (who reports to whom)

`basics:write`

Update Person Role`officient_update_person_role`

Set the function / role description for a person

`basics:write`

List Performance Reviews`officient_list_performance_reviews`

Retrieve the performance review metadata for a specific person

`performance.reviews:read`

List Teams`officient_list_teams`

Retrieve a list of all teams in the Officient account

`basics:read`

Create Team`officient_create_team`

Create a new team in Officient

`basics:write`

Update Team`officient_update_team`

Update the information about an existing team in Officient

`basics:write`

Get Current Wage`officient_get_current_wage`

Retrieve the current wage details for a specific person

`wages:read`

Get Wage History`officient_get_wage_history`

Retrieve the entire wage history for a specific person

`wages:read`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.