Action

Description

Required scopes

Get Account

Retrieve information about your own Officient account

List Assets

Retrieve a list of assets in the Officient account

Get Asset

Retrieve the full detail of a single asset by its ID

Create Asset

Add a new asset to Officient

Update Asset

Update the details of an existing asset

Delete Asset

Delete an asset from Officient

List Asset Types

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

List Budgets

Retrieve the budgets defined for a person in a given year

List Budget Items

Retrieve the items that make up a specific budget

Create Budget

Create a new budget for an employee for a given year

Update Budget

Update the maximum amount of an existing budget

Delete Budget

Delete a budget by its ID

Create Budget Item

Add a new item to an existing budget

Delete Budget Item

Delete an item from a budget

Get Daily Calendar

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

Get Monthly Calendar

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

Get Yearly Calendar

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

Get Calendar Request

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

List Calendar Requests

List calendar (time off) requests in the Officient account

List Custom Event Types

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

Add Calendar Event

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

Overwrite Calendar Event

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

Delete Calendar Event

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

Update Time Worked

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

List Contracts

Retrieve a list of all contracts in the Officient account

Get Contract

Retrieve the full detail of a single contract by its ID

Get Contract PDF

Get a temporary PDF download link for a contract

Create Contract

Add a new contract for a person in Officient

Request Contract Signature

Send an email invite requesting a person to sign a contract

List Cost Centers

Retrieve a list of all cost centers in the Officient account

Get Cost Center

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

List Custom Fields

List all custom fields defined in the Officient account

Update Custom Field Value

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

List Departments

Retrieve a list of all departments in the Officient account

Get Department

Retrieve the details of a single department by its internal code

List Documents

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

Upload Document

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

Download Document

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

Delete Document

Delete a document by its file id

List Expense Categories

List all expense categories in the Officient account

Get Expense Category

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

Create Expense Category

Add a new expense category

Update Expense Category

Rename an existing expense category

Delete Expense Category

Delete an expense category by its ID

List Expenses By Month

List all expenses for a specific year and month

List Expenses By Year

List all expenses for a specific year

Get Expense

Retrieve the full detail of a single expense by its ID

Create Expense

Add a new expense for an employee with an optional category

Update Expense

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

Delete Expense

Delete an expense by its ID

List Vehicles

Retrieve a list of vehicles in the Officient fleet

Get Vehicle

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

Create Vehicle

Add a new vehicle to the Officient fleet

Update Vehicle

Update the details of an existing fleet vehicle

List Functions

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

Get Function

Retrieve the details of a single function by its internal code

List People

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

Search People

Search for people by name, email or national number

Get Person

Retrieve the full detail of a single person by their ID

Get Person Custom Fields

Retrieve the custom field values set on a specific person

Get Person Manager

Retrieve the current manager of a specific person

Create Person

Add a new person (employee) to Officient

Update Person

Update the personal details of an existing person

Update Person Manager

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

Update Person Role

Set the function / role description for a person

List Performance Reviews

Retrieve the performance review metadata for a specific person

List Teams

Retrieve a list of all teams in the Officient account

Create Team

Create a new team in Officient

Update Team

Update the information about an existing team in Officient

Get Current Wage

Retrieve the current wage details for a specific person

Get Wage History

Retrieve the entire wage history for a specific person