Performance

Usage

Work with performance agreements and reviews:

import asyncio
import factorialhr

async def main():
    auth = factorialhr.AccessTokenAuth("your_access_token")
    async with factorialhr.ApiClient(auth=auth) as api:
        agreements = factorialhr.AgreementsEndpoint(api)
        response = await agreements.get(params={"limit": 20})
        for a in response.data():
            print(a.employee_id, a.status)
        reviews = factorialhr.ReviewProcessesEndpoint(api)
        for r in (await reviews.all()).data():
            print(r.name, r.status)

asyncio.run(main())

class factorialhr.Agreement(*, id: str, process_id: int, target_id: str, signer_id: int | None = None, reviewer_id: int | None = None, manager_signed_at: datetime | None = None, target_signed_at: datetime | None = None, agreement_signed_at: datetime | None = None, last_modified_at: datetime | None = None, status: AgreementStatus, locked: bool, conclusions: Mapping[str, Any] | None = None, self_evaluation_id: int | None = None, manager_evaluation_id: int | None = None, self_comments: Sequence[Mapping[str, Any]], manager_comments: Sequence[Mapping[str, Any]])[source]

Model for performance_agreement.

agreement_signed_at: datetime | None: Date when the action plan was last signed

conclusions: Mapping[str, Any] | None: Conclusions of the action plan

id: str: Action plan ID

last_modified_at: datetime | None: Date when the action plan was last modified

locked: bool: When the action plan cannot be edited anymore. Locked when both manager and employee signed it

manager_comments: Sequence[Mapping[str, Any]]: Manager comments by question

manager_evaluation_id: int | None: Manager review evaluation ID

manager_signed_at: datetime | None: Date when the manager signed the action plan

process_id: int: Review process ID

reviewer_id: int | None: Manager employee ID

self_comments: Sequence[Mapping[str, Any]]: Self comments by question

self_evaluation_id: int | None: Self review evaluation ID

signer_id: int | None: Manager access ID who signed the action plan

status: AgreementStatus: Action plan status

target_id: str: Review process target ID

target_signed_at: datetime | None: Date when the employee signed the action plan

class factorialhr.AgreementsEndpoint(api: ApiClient)[source]

Endpoint for performance/agreements operations.

async all(**kwargs) → ListApiResponse[Agreement][source]

Get all agreements.

Official documentation: performance/agreements

Parameters:: kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.
Raises:: httpx.HTTPStatusError – When the API returns an error status code.
Returns:: Response containing the list of records.
Return type:: ListApiResponse[Agreement]

async bulk_initiate(data: Mapping[str, Any], **kwargs) → Sequence[Agreement][source]

Initiate action plans for all direct reports in a review process.

Official documentation: performance/agreements

Parameters:

data (Mapping[str, Any]) – Payload for the new record (key-value mapping).
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

Result.

Return type:

Sequence[Agreement]

async get(**kwargs) → MetaApiResponse[Agreement][source]

Get agreements with pagination metadata.

Official documentation: performance/agreements

Parameters:: kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.
Raises:: httpx.HTTPStatusError – When the API returns an error status code.
Returns:: Response containing records and pagination metadata.
Return type:: MetaApiResponse[Agreement]

async get_by_id(agreement_id: int | str, **kwargs) → Agreement[source]

Get a specific agreement by ID.

Official documentation: performance/agreements

Parameters:

agreement_id (int | str) – The unique identifier.
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

The record.

Return type:

Agreement

async initiate(data: Mapping[str, Any], **kwargs) → Agreement[source]

Initiate an action plan for a specific review process target.

Official documentation: performance/agreements

Parameters:

data (Mapping[str, Any]) – Payload for the new record (key-value mapping).
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

Result.

Return type:

Agreement

class factorialhr.CompanyEmployeeScoreScale(*, id: int, scale_id: int, is_default: bool)[source]

Model for performance_company_employee_score_scale.

id: int: Company ID

is_default: bool: Default employee score scale

scale_id: int: Employee score scale ID

class factorialhr.CompanyEmployeeScoreScalesEndpoint(api: ApiClient)[source]

Endpoint for performance/company_employee_score_scales operations.

async all(**kwargs) → ListApiResponse[CompanyEmployeeScoreScale][source]

Get all company employee score scales.

Official documentation: performance/company_employee_score_scales

Parameters:: kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.
Raises:: httpx.HTTPStatusError – When the API returns an error status code.
Returns:: Response containing the list of records.
Return type:: ListApiResponse[CompanyEmployeeScoreScale]

async get(**kwargs) → MetaApiResponse[CompanyEmployeeScoreScale][source]

Get company employee score scales with pagination metadata.

Official documentation: performance/company_employee_score_scales

Parameters:: kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.
Raises:: httpx.HTTPStatusError – When the API returns an error status code.
Returns:: Response containing records and pagination metadata.
Return type:: MetaApiResponse[CompanyEmployeeScoreScale]

async get_by_id(scale_id: int | str, **kwargs) → CompanyEmployeeScoreScale[source]

Get a specific company employee score scale by ID.

Official documentation: performance/company_employee_score_scales

Parameters:

scale_id (int | str) – The unique identifier.
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

The record.

Return type:

CompanyEmployeeScoreScale

async set_scale(data: Mapping[str, Any], **kwargs) → CompanyEmployeeScoreScale[source]

Set the predefined employee score scale for the company.

Official documentation: performance/company_employee_score_scales

Parameters:

data (Mapping[str, Any]) – Payload for the new record (key-value mapping).
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

Result.

Return type:

CompanyEmployeeScoreScale

class factorialhr.EmployeeScoreScale(*, id: int, scale: Sequence[Any], is_default: bool)[source]

Model for performance_employee_score_scale.

id: int: Employee score scale ID

is_default: bool: Whether this is the default score scale

scale: Sequence[Any]: Scale to be used when scoring the employee performance

class factorialhr.EmployeeScoreScalesEndpoint(api: ApiClient)[source]

Endpoint for performance/employee_score_scales operations.

async all(**kwargs) → ListApiResponse[EmployeeScoreScale][source]

Get all employee score scales.

Official documentation: performance/employee_score_scales

Parameters:: kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.
Raises:: httpx.HTTPStatusError – When the API returns an error status code.
Returns:: Response containing the list of records.
Return type:: ListApiResponse[EmployeeScoreScale]

async get(**kwargs) → MetaApiResponse[EmployeeScoreScale][source]

Get employee score scales with pagination metadata.

Official documentation: performance/employee_score_scales

Parameters:: kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.
Raises:: httpx.HTTPStatusError – When the API returns an error status code.
Returns:: Response containing records and pagination metadata.
Return type:: MetaApiResponse[EmployeeScoreScale]

async get_by_id(scale_id: int | str, **kwargs) → EmployeeScoreScale[source]

Get a specific employee score scale by ID.

Official documentation: performance/employee_score_scales

Parameters:

scale_id (int | str) – The unique identifier.
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

The record.

Return type:

EmployeeScoreScale

class factorialhr.ReviewEvaluation(*, id: int, performance_review_process_id: int | None = None, target_access_id: int | None = None, reviewer_access_id: int | None = None, evaluation_type: EvaluationType, published: bool, status: EvaluationStatus, review_process_target_id: str, published_at: datetime | None = None)[source]

Model for performance_review_evaluation.

evaluation_type: EvaluationType: Evaluation type

id: int: Evaluation ID

performance_review_process_id: int | None: Review process ID

published: bool: Whether the evaluation is published

published_at: datetime | None: Date when the evaluation was published

review_process_target_id: str: Review process target identifier

reviewer_access_id: int | None: Reviewer access ID

status: EvaluationStatus: Evaluation status

target_access_id: int | None: Participant access ID

class factorialhr.ReviewEvaluationAnswer(*, id: int, performance_review_evaluation_id: int, answered_questionnaire_with_sections: Mapping[str, Any], answered_employee_score_questionnaire: Mapping[str, Any] | None = None, answered_employee_potential_score_questionnaire: Mapping[str, Any] | None = None)[source]

Model for performance_review_evaluation_answer.

answered_employee_potential_score_questionnaire: Mapping[str, Any] | None: Questionnaire for getting the employee potential score

answered_employee_score_questionnaire: Mapping[str, Any] | None: Questionnaire for getting employee score

answered_questionnaire_with_sections: Mapping[str, Any]: List of questions and their respective answers grouped by section

id: int: Review evaluation ID

performance_review_evaluation_id: int: Review evaluation ID

class factorialhr.ReviewEvaluationAnswersEndpoint(api: ApiClient)[source]

Endpoint for performance/review_evaluation_answers operations.

async all(**kwargs) → ListApiResponse[ReviewEvaluationAnswer][source]

Get all review evaluation answers.

Official documentation: performance/review_evaluation_answers

Parameters:: kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.
Raises:: httpx.HTTPStatusError – When the API returns an error status code.
Returns:: Response containing the list of records.
Return type:: ListApiResponse[ReviewEvaluationAnswer]

async get(**kwargs) → MetaApiResponse[ReviewEvaluationAnswer][source]

Get review evaluation answers with pagination metadata.

Official documentation: performance/review_evaluation_answers

Parameters:: kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.
Raises:: httpx.HTTPStatusError – When the API returns an error status code.
Returns:: Response containing records and pagination metadata.
Return type:: MetaApiResponse[ReviewEvaluationAnswer]

class factorialhr.ReviewEvaluationScore(*, id: int, review_evaluation_id: int, score: float, created_at: datetime, updated_at: datetime)[source]

Model for performance_review_evaluation_score.

created_at: datetime: Creation date

id: int: Review evaluation score identifier

review_evaluation_id: int: Review evaluation identifier

score: float: Evaluation score

updated_at: datetime: Last update date

class factorialhr.ReviewEvaluationScoresEndpoint(api: ApiClient)[source]

Endpoint for performance/review_evaluation_scores operations.

async all(**kwargs) → ListApiResponse[ReviewEvaluationScore][source]

Get all review evaluation scores.

Official documentation: performance/review_evaluation_scores

Parameters:: kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.
Raises:: httpx.HTTPStatusError – When the API returns an error status code.
Returns:: Response containing the list of records.
Return type:: ListApiResponse[ReviewEvaluationScore]

async get(**kwargs) → MetaApiResponse[ReviewEvaluationScore][source]

Get review evaluation scores with pagination metadata.

Official documentation: performance/review_evaluation_scores

Parameters:: kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.
Raises:: httpx.HTTPStatusError – When the API returns an error status code.
Returns:: Response containing records and pagination metadata.
Return type:: MetaApiResponse[ReviewEvaluationScore]

async get_by_id(score_id: int | str, **kwargs) → ReviewEvaluationScore[source]

Get a specific review evaluation score by ID.

Official documentation: performance/review_evaluation_scores

Parameters:

score_id (int | str) – The unique identifier.
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

The record.

Return type:

ReviewEvaluationScore

class factorialhr.ReviewEvaluationsEndpoint(api: ApiClient)[source]

Endpoint for performance/review_evaluations operations.

async all(**kwargs) → ListApiResponse[ReviewEvaluation][source]

Get all review evaluations.

Official documentation: performance/review_evaluations

Parameters:: kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.
Raises:: httpx.HTTPStatusError – When the API returns an error status code.
Returns:: Response containing the list of records.
Return type:: ListApiResponse[ReviewEvaluation]

async get(**kwargs) → MetaApiResponse[ReviewEvaluation][source]

Get review evaluations with pagination metadata.

Official documentation: performance/review_evaluations

Parameters:: kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.
Raises:: httpx.HTTPStatusError – When the API returns an error status code.
Returns:: Response containing records and pagination metadata.
Return type:: MetaApiResponse[ReviewEvaluation]

async get_by_id(evaluation_id: int | str, **kwargs) → ReviewEvaluation[source]

Get a specific review evaluation by ID.

Official documentation: performance/review_evaluations

Parameters:

evaluation_id (int | str) – The unique identifier.
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

The record.

Return type:

ReviewEvaluation

async replace_reviewer(data: Mapping[str, Any], **kwargs) → ReviewEvaluation[source]

Replace a reviewer for an evaluation.

Official documentation: performance/review_evaluations

Parameters:

data (Mapping[str, Any]) – Payload for the new record (key-value mapping).
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

Result.

Return type:

ReviewEvaluation

class factorialhr.ReviewOwner(*, id: int, access_id: int, performance_review_process_id: int)[source]

Model for performance_review_owner.

access_id: int: Review owner access ID

id: int: Review owner ID

performance_review_process_id: int: Review process ID

class factorialhr.ReviewOwnersEndpoint(api: ApiClient)[source]

Endpoint for performance/review_owners operations.

async all(**kwargs) → ListApiResponse[ReviewOwner][source]

Get all review owners.

Official documentation: performance/review_owners

Parameters:: kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.
Raises:: httpx.HTTPStatusError – When the API returns an error status code.
Returns:: Response containing the list of records.
Return type:: ListApiResponse[ReviewOwner]

async bulk_create(data: Mapping[str, Any], **kwargs) → Sequence[ReviewOwner][source]

Add multiple owners to a review process.

Official documentation: performance/review_owners

Parameters:

data (Mapping[str, Any]) – Payload for the new record (key-value mapping).
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

The created record.

Return type:

Sequence[ReviewOwner]

async delete(owner_id: int | str, **kwargs) → ReviewOwner[source]

Delete a review owner.

Official documentation: performance/review_owners

Parameters:

owner_id (int | str) – The unique identifier of the record to delete.
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

The deleted record.

Return type:

ReviewOwner

async get(**kwargs) → MetaApiResponse[ReviewOwner][source]

Get review owners with pagination metadata.

Official documentation: performance/review_owners

Parameters:: kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.
Raises:: httpx.HTTPStatusError – When the API returns an error status code.
Returns:: Response containing records and pagination metadata.
Return type:: MetaApiResponse[ReviewOwner]

class factorialhr.ReviewProcess(*, id: int, company_id: int, name: str | None = None, description: str | None = None, status: ProcessStatus, target_strategy: Mapping[str, Any] | None = None, reviewer_strategies: Sequence[str] | None = None, starts_at: datetime | None = None, ends_at: datetime | None = None, start_validation_errors: Sequence[StartValidationError], archived: bool, agreements_configuration: Mapping[str, Any], competencies_assessments_configuration: Mapping[str, Any], last_bulk_reminder: datetime | None = None, cycle_id: str | None = None)[source]

Model for performance_review_process.

agreements_configuration: Mapping[str, Any]: Action plans help track goal progress, and facilitate performance review discussions

archived: bool: Whether the review process is archived or not

company_id: int: Company ID

competencies_assessments_configuration: Mapping[str, Any]: Assess employees based on their assigned competencies through both manager and self-reviews. Ensure roles with designated competencies are properly set up

cycle_id: str | None: Performance cycle ID

description: str | None: A brief description of the review process

ends_at: datetime | None: Date when the review process should end

id: int: Review process ID

last_bulk_reminder: datetime | None: Date when the last bulk reminder was sent

name: str | None: Review process name

reviewer_strategies: Sequence[str] | None: Review types that will be assigned to the review process. It’ll be used to create the evaluations when the process starts

start_validation_errors: Sequence[StartValidationError]: Missing or invalid information to be able to start the review process

starts_at: datetime | None: Date when the review process should start

status: ProcessStatus: Review process status

target_strategy: Mapping[str, Any] | None: Condition that defines the employees that will be evaluated (participants). Calculated when the review process starts

class factorialhr.ReviewProcessCustomTemplate(*, id: int, author_id: int | None = None, company_id: int, name: str, description: str | None = None, template_description: str | None = None, target_strategy: Mapping[str, Any] | None = None, reviewer_strategies: Sequence[str] | None = None, agreements_enabled: bool | None = None, employee_potential_score_enabled: bool | None = None, competencies_assessments_enabled: bool | None = None, visibility_settings: Mapping[str, Any] | None = None, created_at: datetime)[source]

Model for performance_review_process_custom_template.

agreements_enabled: bool | None: Action plans help track goal progress, and facilitate performance review discussions

author_id: int | None: Author of the custom template

company_id: int: Company ID

competencies_assessments_enabled: bool | None: Assess employees based on their assigned competencies through both manager and self-reviews. Ensure roles with designated competencies are properly set up

created_at: datetime: Creation date of the template

description: str | None: A brief description of the review process

employee_potential_score_enabled: bool | None: Include one question at the end of the review to rate participants’ potential. This rating will be reflected in the 9 box grid

id: int: Review process template ID

name: str: Review process name

reviewer_strategies: Sequence[str] | None: Review types that will be assigned to the review process. It’ll be used to create the evaluations when the process starts

target_strategy: Mapping[str, Any] | None: Condition that defines the employees that will be evaluated (participants). Calculated when the review process starts

template_description: str | None: A brief description of the review process template

visibility_settings: Mapping[str, Any] | None: Visibility settings for the custom template

class factorialhr.ReviewProcessCustomTemplatesEndpoint(api: ApiClient)[source]

Endpoint for performance/review_process_custom_templates operations.

async all(**kwargs) → ListApiResponse[ReviewProcessCustomTemplate][source]

Get all review process custom templates.

Official documentation: performance/review_process_custom_templates

Parameters:: kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.
Raises:: httpx.HTTPStatusError – When the API returns an error status code.
Returns:: Response containing the list of records.
Return type:: ListApiResponse[ReviewProcessCustomTemplate]

async get(**kwargs) → MetaApiResponse[ReviewProcessCustomTemplate][source]

Get review process custom templates with pagination metadata.

Official documentation: performance/review_process_custom_templates

Parameters:: kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.
Raises:: httpx.HTTPStatusError – When the API returns an error status code.
Returns:: Response containing records and pagination metadata.
Return type:: MetaApiResponse[ReviewProcessCustomTemplate]

async get_by_id(template_id: int | str, **kwargs) → ReviewProcessCustomTemplate[source]

Get a specific review process custom template by ID.

Official documentation: performance/review_process_custom_templates

Parameters:

template_id (int | str) – The unique identifier.
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

The record.

Return type:

ReviewProcessCustomTemplate

class factorialhr.ReviewProcessesEndpoint(api: ApiClient)[source]

Endpoint for performance/review_processes operations.

async all(**kwargs) → ListApiResponse[ReviewProcess][source]

Get all review processes.

Official documentation: performance/review_processes

Parameters:: kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.
Raises:: httpx.HTTPStatusError – When the API returns an error status code.
Returns:: Response containing the list of records.
Return type:: ListApiResponse[ReviewProcess]

async create(data: Mapping[str, Any], **kwargs) → ReviewProcess[source]

Create a new review process.

Official documentation: performance/review_processes

Parameters:

data (Mapping[str, Any]) – Payload for the new record (key-value mapping).
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

The created record.

Return type:

ReviewProcess

async create_from_template(data: Mapping[str, Any], **kwargs) → ReviewProcess[source]

Create a new review process from a template.

Official documentation: performance/review_processes

Parameters:

data (Mapping[str, Any]) – Payload for the new record (key-value mapping).
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

The created record.

Return type:

ReviewProcess

async delete(process_id: int | str, **kwargs) → ReviewProcess[source]

Delete a review process.

Official documentation: performance/review_processes

Parameters:

process_id (int | str) – The unique identifier of the record to delete.
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

The deleted record.

Return type:

ReviewProcess

async duplicate(data: Mapping[str, Any], **kwargs) → ReviewProcess[source]

Duplicate an existing review process.

Official documentation: performance/review_processes

Parameters:

data (Mapping[str, Any]) – Payload for the new record (key-value mapping).
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

Result.

Return type:

ReviewProcess

async get(**kwargs) → MetaApiResponse[ReviewProcess][source]

Get review processes with pagination metadata.

Official documentation: performance/review_processes

Parameters:: kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.
Raises:: httpx.HTTPStatusError – When the API returns an error status code.
Returns:: Response containing records and pagination metadata.
Return type:: MetaApiResponse[ReviewProcess]

async get_by_id(process_id: int | str, **kwargs) → ReviewProcess[source]

Get a specific review process by ID.

Official documentation: performance/review_processes

Parameters:

process_id (int | str) – The unique identifier.
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

The record.

Return type:

ReviewProcess

async remind_in_bulk(data: Mapping[str, Any], **kwargs) → ReviewProcess[source]

Send bulk reminders to reviewers.

Official documentation: performance/review_processes

Parameters:

data (Mapping[str, Any]) – Payload for the new record (key-value mapping).
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

Result.

Return type:

ReviewProcess

async remove_schedule(data: Mapping[str, Any], **kwargs) → ReviewProcess[source]

Remove the schedule job for a review process.

Official documentation: performance/review_processes

Parameters:

data (Mapping[str, Any]) – Payload for the new record (key-value mapping).
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

Result.

Return type:

ReviewProcess

async reopen(data: Mapping[str, Any], **kwargs) → ReviewProcess[source]

Reopen a finished review process.

Official documentation: performance/review_processes

Parameters:

data (Mapping[str, Any]) – Payload for the new record (key-value mapping).
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

Result.

Return type:

ReviewProcess

async schedule(data: Mapping[str, Any], **kwargs) → ReviewProcess[source]

Schedule a review process to start at a given date.

Official documentation: performance/review_processes

Parameters:

data (Mapping[str, Any]) – Payload for the new record (key-value mapping).
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

Result.

Return type:

ReviewProcess

async start(data: Mapping[str, Any], **kwargs) → ReviewProcess[source]

Start a review process.

Official documentation: performance/review_processes

Parameters:

data (Mapping[str, Any]) – Payload for the new record (key-value mapping).
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

Result.

Return type:

ReviewProcess

async stop(data: Mapping[str, Any], **kwargs) → ReviewProcess[source]

Stop a review process.

Official documentation: performance/review_processes

Parameters:

data (Mapping[str, Any]) – Payload for the new record (key-value mapping).
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

Result.

Return type:

ReviewProcess

async toggle_archive(data: Mapping[str, Any], **kwargs) → ReviewProcess[source]

Archive or unarchive a review process.

Official documentation: performance/review_processes

Parameters:

data (Mapping[str, Any]) – Payload for the new record (key-value mapping).
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

Result.

Return type:

ReviewProcess

async update_agreements_configuration(data: Mapping[str, Any], **kwargs) → ReviewProcess[source]

Enable or disable action plans in a review process.

Official documentation: performance/review_processes

Parameters:

data (Mapping[str, Any]) – Payload with fields to update (key-value mapping).
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

Result.

Return type:

ReviewProcess

async update_basic_info(data: Mapping[str, Any], **kwargs) → ReviewProcess[source]

Update the basic information of a review process.

Official documentation: performance/review_processes

Parameters:

data (Mapping[str, Any]) – Payload with fields to update (key-value mapping).
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

Result.

Return type:

ReviewProcess

async update_competencies_assessments_configuration(data: Mapping[str, Any], **kwargs) → ReviewProcess[source]

Update competencies assessments configuration.

Official documentation: performance/review_processes

Parameters:

data (Mapping[str, Any]) – Payload with fields to update (key-value mapping).
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

Result.

Return type:

ReviewProcess

async update_deadline(data: Mapping[str, Any], **kwargs) → ReviewProcess[source]

Update the deadline of a review process.

Official documentation: performance/review_processes

Parameters:

data (Mapping[str, Any]) – Payload with fields to update (key-value mapping).
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

Result.

Return type:

ReviewProcess

async update_employee_score_configuration(data: Mapping[str, Any], **kwargs) → ReviewProcess[source]

Update employee score configuration.

Official documentation: performance/review_processes

Parameters:

data (Mapping[str, Any]) – Payload with fields to update (key-value mapping).
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

Result.

Return type:

ReviewProcess

async update_reviewer_strategies(data: Mapping[str, Any], **kwargs) → ReviewProcess[source]

Update the review types of a review process.

Official documentation: performance/review_processes

Parameters:

data (Mapping[str, Any]) – Payload with fields to update (key-value mapping).
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

Result.

Return type:

ReviewProcess

async update_schedule(data: Mapping[str, Any], **kwargs) → ReviewProcess[source]

Update the starting date of a scheduled review process.

Official documentation: performance/review_processes

Parameters:

data (Mapping[str, Any]) – Payload with fields to update (key-value mapping).
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

Result.

Return type:

ReviewProcess

async update_target_strategy(data: Mapping[str, Any], **kwargs) → ReviewProcess[source]

Update the criteria for calculating the participants of a review process.

Official documentation: performance/review_processes

Parameters:

data (Mapping[str, Any]) – Payload with fields to update (key-value mapping).
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

Result.

Return type:

ReviewProcess

class factorialhr.ReviewProcessEstimatedTarget(*, id: str, performance_review_process_id: int, access_id: int, employee_id: int)[source]

Model for performance_review_process_estimated_target.

access_id: int: Access ID

employee_id: int: Employee ID

id: str: Process target ID

performance_review_process_id: int: Review process ID

class factorialhr.ReviewProcessEstimatedTargetsEndpoint(api: ApiClient)[source]

Endpoint for performance/review_process_estimated_targets operations.

async all(**kwargs) → ListApiResponse[ReviewProcessEstimatedTarget][source]

Get all review process estimated targets.

Official documentation: performance/review_process_estimated_targets

Parameters:: kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.
Raises:: httpx.HTTPStatusError – When the API returns an error status code.
Returns:: Response containing the list of records.
Return type:: ListApiResponse[ReviewProcessEstimatedTarget]

async get(**kwargs) → MetaApiResponse[ReviewProcessEstimatedTarget][source]

Get review process estimated targets with pagination metadata.

Official documentation: performance/review_process_estimated_targets

Parameters:: kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.
Raises:: httpx.HTTPStatusError – When the API returns an error status code.
Returns:: Response containing records and pagination metadata.
Return type:: MetaApiResponse[ReviewProcessEstimatedTarget]

class factorialhr.ReviewProcessTarget(*, id: str, access_id: int, performance_review_process_id: int, materialized_process_target_id: int)[source]

Model for performance_review_process_target.

access_id: int: Participant access ID

id: str: Review process target ID

materialized_process_target_id: int: Materialized process target ID

performance_review_process_id: int: Review process ID

class factorialhr.ReviewProcessTargetsEndpoint(api: ApiClient)[source]

Endpoint for performance/review_process_targets operations.

async add_peers(data: Mapping[str, Any], **kwargs) → ReviewProcessTarget[source]

Assign peers to evaluate a specific participant.

Official documentation: performance/review_process_targets

Parameters:

data (Mapping[str, Any]) – Payload for the new record (key-value mapping).
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

Result.

Return type:

ReviewProcessTarget

async all(**kwargs) → ListApiResponse[ReviewProcessTarget][source]

Get all review process targets.

Official documentation: performance/review_process_targets

Parameters:: kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.
Raises:: httpx.HTTPStatusError – When the API returns an error status code.
Returns:: Response containing the list of records.
Return type:: ListApiResponse[ReviewProcessTarget]

async bulk_create(data: Mapping[str, Any], **kwargs) → Sequence[ReviewProcessTarget][source]

Add multiple participants to the active review process.

Official documentation: performance/review_process_targets

Parameters:

data (Mapping[str, Any]) – Payload for the new record (key-value mapping).
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

The created record.

Return type:

Sequence[ReviewProcessTarget]

async delete(target_id: str, **kwargs) → ReviewProcessTarget[source]

Delete a participant from the active review process.

Official documentation: performance/review_process_targets

Parameters:

target_id (int | str) – The unique identifier of the record to delete.
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

The deleted record.

Return type:

ReviewProcessTarget

async get(**kwargs) → MetaApiResponse[ReviewProcessTarget][source]

Get review process targets with pagination metadata.

Official documentation: performance/review_process_targets

Parameters:: kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.
Raises:: httpx.HTTPStatusError – When the API returns an error status code.
Returns:: Response containing records and pagination metadata.
Return type:: MetaApiResponse[ReviewProcessTarget]

async get_by_id(target_id: str, **kwargs) → ReviewProcessTarget[source]

Get a specific review process target by ID.

Official documentation: performance/review_process_targets

Parameters:

target_id (int | str) – The unique identifier.
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

The record.

Return type:

ReviewProcessTarget

async remove_peer_evaluations(data: Mapping[str, Any], **kwargs) → ReviewProcessTarget[source]

Remove peers and their evaluations from a specific participant.

Official documentation: performance/review_process_targets

Parameters:

data (Mapping[str, Any]) – Payload for the new record (key-value mapping).
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

Result.

Return type:

ReviewProcessTarget

class factorialhr.ReviewQuestionnaireByStrategiesEndpoint(api: ApiClient)[source]

Endpoint for performance/review_questionnaire_by_strategies operations.

async all(**kwargs) → ListApiResponse[ReviewQuestionnairesByStrategy][source]

Get all review questionnaires by strategies.

Official documentation: performance/review_questionnaire_by_strategies

Parameters:: kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.
Raises:: httpx.HTTPStatusError – When the API returns an error status code.
Returns:: Response containing the list of records.
Return type:: ListApiResponse[ReviewQuestionnairesByStrategy]

async get(**kwargs) → MetaApiResponse[ReviewQuestionnairesByStrategy][source]

Get review questionnaires by strategies with pagination metadata.

Official documentation: performance/review_questionnaire_by_strategies

Parameters:: kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.
Raises:: httpx.HTTPStatusError – When the API returns an error status code.
Returns:: Response containing records and pagination metadata.
Return type:: MetaApiResponse[ReviewQuestionnairesByStrategy]

async get_by_id(questionnaire_id: int | str, **kwargs) → ReviewQuestionnairesByStrategy[source]

Get a specific review questionnaire by strategy by ID.

Official documentation: performance/review_questionnaire_by_strategies

Parameters:

questionnaire_id (int | str) – The unique identifier.
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

The record.

Return type:

ReviewQuestionnairesByStrategy

async update_default_rating_scale(data: Mapping[str, Any], **kwargs) → ReviewQuestionnairesByStrategy[source]

Update the scoring range used in rating questions for all reviewer strategies.

Official documentation: performance/review_questionnaire_by_strategies

Parameters:

data (Mapping[str, Any]) – Payload with fields to update (key-value mapping).
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

Result.

Return type:

ReviewQuestionnairesByStrategy

async update_questionnaire_for_strategy(data: Mapping[str, Any], **kwargs) → ReviewQuestionnairesByStrategy[source]

Update the review process questionnaire for a specific reviewer strategy.

Official documentation: performance/review_questionnaire_by_strategies

Parameters:

data (Mapping[str, Any]) – Payload with fields to update (key-value mapping).
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

Result.

Return type:

ReviewQuestionnairesByStrategy

class factorialhr.ReviewQuestionnairesByStrategy(*, id: int, performance_review_process_id: int, default_rating_scale: Sequence[Any], self_questionnaire: Mapping[str, Any] | None = None, manager_questionnaire: Mapping[str, Any] | None = None, direct_report_questionnaire: Mapping[str, Any] | None = None, peers_questionnaire: Mapping[str, Any] | None = None, employee_score_self_questionnaire: Mapping[str, Any] | None = None, employee_score_manager_questionnaire: Mapping[str, Any] | None = None, employee_potential_score_manager_questionnaire: Mapping[str, Any] | None = None)[source]

Model for performance_review_questionnaires_by_strategy.

default_rating_scale: Sequence[Any]: Scoring range used in rating questions

direct_report_questionnaire: Mapping[str, Any] | None: Questionnaire for direct report evaluation

employee_potential_score_manager_questionnaire: Mapping[str, Any] | None: Questionnaire included in the end of manager evaluation to evaluate the employee potential

employee_score_manager_questionnaire: Mapping[str, Any] | None: Questionnaire included in the end of manager evaluation to evaluate the employee performance

employee_score_self_questionnaire: Mapping[str, Any] | None: Questionnaire included in the end of self evaluation to evaluate the employee performance

id: int: Review process ID

manager_questionnaire: Mapping[str, Any] | None: Questionnaire for manager evaluation

peers_questionnaire: Mapping[str, Any] | None: Questionnaire for peers evaluation

performance_review_process_id: int: Review process ID

self_questionnaire: Mapping[str, Any] | None: Questionnaire for self evaluation

class factorialhr.ReviewVisibilitySetting(*, id: int, performance_review_process_id: int, restrict_answers_visibility_to_reportees: bool, early_access_to_answers_for_managers: bool, anonymous_peer_evaluation_for_target: bool)[source]

Model for performance_review_visibility_setting.

anonymous_peer_evaluation_for_target: bool: Peer evaluations are anonymous when enabled, so employees don’t know who reviewed them

early_access_to_answers_for_managers: bool: Managers can access the results of their reports before deadline when enabled

id: int: Review process ID

performance_review_process_id: int: Review process ID

restrict_answers_visibility_to_reportees: bool: Employees don’t have access to their results when enabled

class factorialhr.ReviewVisibilitySettingsEndpoint(api: ApiClient)[source]

Endpoint for performance/review_visibility_settings operations.

async all(**kwargs) → ListApiResponse[ReviewVisibilitySetting][source]

Get all review visibility settings.

Official documentation: performance/review_visibility_settings

Parameters:: kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.
Raises:: httpx.HTTPStatusError – When the API returns an error status code.
Returns:: Response containing the list of records.
Return type:: ListApiResponse[ReviewVisibilitySetting]

async get(**kwargs) → MetaApiResponse[ReviewVisibilitySetting][source]

Get review visibility settings with pagination metadata.

Official documentation: performance/review_visibility_settings

Parameters:: kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.
Raises:: httpx.HTTPStatusError – When the API returns an error status code.
Returns:: Response containing records and pagination metadata.
Return type:: MetaApiResponse[ReviewVisibilitySetting]

async update(setting_id: int | str, data: Mapping[str, Any], **kwargs) → ReviewVisibilitySetting[source]

Update the visibility settings of a review process.

Official documentation: performance/review_visibility_settings

Parameters:

setting_id (int | str) – The unique identifier of the record to update.
data (Mapping[str, Any]) – Payload with fields to update (key-value mapping).
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

The updated record.

Return type:

ReviewVisibilitySetting

class factorialhr.TargetManager(*, id: str, performance_review_process_id: int, manager_access_id: int, manager_full_name: str)[source]

Model for performance_target_manager.

id: str: Manager employee ID

manager_access_id: int: Manager access ID

manager_full_name: str: Manager full name

performance_review_process_id: int: Review process ID

class factorialhr.TargetManagersEndpoint(api: ApiClient)[source]

Endpoint for performance/target_managers operations.

async all(**kwargs) → ListApiResponse[TargetManager][source]

Get all target managers.

Official documentation: performance/target_managers

Parameters:: kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.
Raises:: httpx.HTTPStatusError – When the API returns an error status code.
Returns:: Response containing the list of records.
Return type:: ListApiResponse[TargetManager]

async get(**kwargs) → MetaApiResponse[TargetManager][source]

Get target managers with pagination metadata.

Official documentation: performance/target_managers

Parameters:: kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.
Raises:: httpx.HTTPStatusError – When the API returns an error status code.
Returns:: Response containing records and pagination metadata.
Return type:: MetaApiResponse[TargetManager]

async get_by_id(manager_id: int | str, **kwargs) → TargetManager[source]

Get a specific target manager by ID.

Official documentation: performance/target_managers

Parameters:

manager_id (int | str) – The unique identifier.
kwargs (optional) – Optional keyword arguments (e.g. params for query string) forwarded to the HTTP request.

Raises:

httpx.HTTPStatusError – When the API returns an error status code.

Returns:

The record.

Return type:

TargetManager