Jump to Content
Guides
API Reference
Changelog
v2024-10-01
v2025-01-01
v2025-04-01
v2025-07-01
v2025-10-01
API Reference
Moon (Dark Mode)
Sun (Light Mode)
v2025-07-01 - laurent
Guides
API Reference
Changelog
Compensations > Concept
Search
All
Pages
Start typing to search…
JUMP TO
Factorial API
ApiPublic > Credential
Reads all Credentials
get
ApiPublic > WebhookSubscription
Reads all Webhook subscriptions
get
Creates a Webhook subscription
post
Reads a single Webhook subscription
get
Updates a Webhook subscription
put
Deletes a Webhook subscription
del
Ats > Answer
Reads all Answers
get
Creates an Answer
post
Reads a single Answer
get
Ats > Application
Reads all Applications
get
Creates an Application
post
Reads a single Application
get
Updates an Application
put
Deletes an Application
del
Applies an Application
post
Ats > ApplicationPhase
Reads all Application phases
get
Reads a single Application phase
get
Ats > Candidate
Reads all Candidates
get
Creates a Candidate
post
Reads a single Candidate
get
Updates a Candidate
put
Deletes a Candidate
del
Ats > CandidateSource
Reads all Candidate sources
get
Reads a single Candidate source
get
Ats > EvaluationForm
Reads all Evaluation forms
get
Reads a single Evaluation form
get
Save as templates an Evaluation form
post
Ats > Feedback
Reads all Feedbacks
get
Creates a Feedback
post
Reads a single Feedback
get
Updates a Feedback
put
Deletes a Feedback
del
Ats > HiringStage
Reads all Hiring stages
get
Reads a single Hiring stage
get
Ats > JobPosting
Reads all Job postings
get
Creates a Job posting
post
Reads a single Job posting
get
Updates a Job posting
put
Deletes a Job posting
del
Duplicates a Job posting
post
Ats > Message
Reads all Messages
get
Creates a Message
post
Reads a single Message
get
Ats > Question
Reads all Questions
get
Creates a Question
post
Reads a single Question
get
Updates a Question
put
Deletes a Question
del
Ats > RejectionReason
Reads all Rejection reasons
get
Reads a single Rejection reason
get
Attendance > BreakConfiguration
Reads all Break configurations
get
Creates a Break configuration
post
Reads a single Break configuration
get
Updates a Break configuration
put
Attendance > EditTimesheetRequest
Reads all Edit timesheet requests
get
Creates an Edit timesheet request
post
Reads all Edit timesheet requests
get
Updates an Edit timesheet request
put
Deletes an Edit timesheet request
del
Attendance > EstimatedTime
Reads all Estimated times
get
Attendance > OpenShift
Reads all Open shifts
get
Attendance > OvertimeRequest
Reads all Overtime requests
get
Creates an Overtime request
post
Reads a single Overtime request
get
Updates an Overtime request
put
Deletes an Overtime request
del
Approves an Overtime request
post
Rejects an Overtime request
post
Attendance > Shift
Reads all Shifts
get
Creates a shift
post
Reads a single Shift
get
Updates a Shift
put
Deletes a Shift
del
Autofills a Shift
post
Break ends a Shift
post
Break starts a Shift
post
Clocks in a shift
post
Clocks out a shift
post
Clock in/out a shift
post
Attendance > WorkedTime
Reads all Worked times
get
Banking > BankAccount
Reads all Bank accounts
get
Reads a single Bank account
get
Create manuals a Bank account
post
Banking > CardPayment
Reads all Card payments
get
Reads a single Card payment
get
Banking > Transaction
Reads all Transactions
get
Reads a single Transaction
get
BookkeepersManagement > Incidence
Reads all Incidences
get
Reads a single Incidence
get
Updates an Incidence
put
Companies > LegalEntity
Reads all Legal entities
get
Creates a Legal entity
post
Reads a single Legal entity
get
Contracts > Compensation
Reads all Compensations
get
Creates a Compensation
post
Reads a single Compensation
get
Updates a Compensation
put
Deletes a Compensation
del
Contracts > ContractTemplate
Reads all Contract templates
get
Reads a single Contract template
get
Contracts > ContractVersion
Reads all Contract versions
get
Creates a Contract version
post
Reads a single Contract version
get
Updates a Contract version
put
Deletes a Contract version
del
Contracts > FrenchContractType
Reads all French contract types
get
Reads a single French contract type
get
Contracts > GermanContractType
Reads all German contract types
get
Reads a single German contract type
get
Contracts > PortugueseContractType
Reads all Portuguese contract types
get
Reads a single Portuguese contract type
get
Contracts > ReferenceContract
Reads all Reference contracts
get
Contracts > SpanishContractType
Reads all Spanish contract types
get
Creates a Spanish contract type
post
Reads a single Spanish contract type
get
Contracts > SpanishEducationLevel
Reads all Spanish education levels
get
Creates a Spanish education level
post
Reads a single Spanish education level
get
Contracts > SpanishProfessionalCategory
Reads all Spanish professional categories
get
Creates a Spanish professional category
post
Reads a single Spanish professional category
get
Contracts > SpanishWorkingDayType
Reads all Spanish working day types
get
Creates a Spanish working day type
post
Reads a single Spanish working day type
get
Contracts > Taxonomy
Reads all Taxonomies
get
Reads a single Taxonomy
get
CustomFields > Field
Reads all Fields
get
Creates a Field
post
Reads a single Field
get
Deletes a Field
del
CustomFields > Option
Reads all Options
get
Creates an Option
post
Reads a single Option
get
CustomFields > ResourceField
Reads all Resource fields
get
Creates a Resource field
post
Reads a single Resource field
get
CustomFields > Value
Reads all Values
get
Creates a Value
post
Reads a single Value
get
Updates a Value
put
CustomResources > Schema
Reads all Schemas
get
Creates a Schema
post
Reads a single Schema
get
CustomResources > Value
Reads all Values
get
Creates a Value
post
Reads a single Value
get
Documents > Document
Reads all Documents
get
Creates a Document
post
Reads a single Document
get
Updates a Document
put
Deletes a Document
del
Move to trash bins a Document
post
Restore from trash bins a Document
post
Documents > DownloadUrl
Bulk creates a Download url
post
Documents > Folder
Reads all Folders
get
Creates a Folder
post
Reads a single Folder
get
Updates a Folder
put
Employees > Employee
Reads all Employees
get
Reads a single Employee
get
Updates an Employee
put
Create with contracts an Employee
post
Invites an Employee
post
Terminates an Employee
post
Unterminates an Employee
post
EmployeeUpdates > Absence
Reads all Absences
get
Reads a single Absence
get
EmployeeUpdates > ContractChange
Reads all Contract changes
get
Reads a single Contract change
get
EmployeeUpdates > NewHire
Reads all New hires
get
Reads a single New hire
get
EmployeeUpdates > PersonalChange
Reads all Personal changes
get
Reads a single Personal change
get
EmployeeUpdates > Summary
Reads all Summaries
get
Reads a single Summary
get
EmployeeUpdates > Termination
Reads all Terminations
get
Reads a single Termination
get
Expenses > Expensable
Reads all Expensables
get
Reads a single Expensable
get
Expenses > Expense
Reads all Expenses
get
Reads a single Expense
get
Expenses > Mileage
Reads all Mileages
get
Reads a single Mileage
get
Expenses > PerDiem
Reads all Per diems
get
Reads a single Per diem
get
Finance > Account
Reads all Accounts
get
Creates an Account
post
Reads a single Account
get
Updates an Account
put
Finance > AccountingSetting
Reads all Accounting settings
get
Reads a single Accounting setting
get
Upserts an Accounting setting
post
Finance > Contact
Reads all Contacts
get
Creates a Contact
post
Reads a single Contact
get
Updates a Contact
put
Finance > CostCenter
Reads all Cost centers
get
Creates a Cost center
post
Reads a single Cost center
get
Deletes a Cost center
del
Edits a Cost center
post
Finance > CostCenterMembership
Reads all Cost center memberships
get
Bulk create updates a Cost center membership
post
Finance > FinancialDocument
Reads all Financial documents
get
Reads a single Financial document
get
Finance > JournalEntry
Reads all Journal entries
get
Creates a Journal entry
post
Reads a single Journal entry
get
Finance > JournalLine
Reads all Journal lines
get
Reads a single Journal line
get
Finance > LedgerAccountResource
Reads all Ledger account resources
get
Reads a single Ledger account resource
get
Upserts a Ledger account resource
post
Finance > TaxRate
Reads all Tax rates
get
Creates a Tax rate
post
Reads a single Tax rate
get
Updates a Tax rate
put
Finance > TaxType
Reads all Tax types
get
Creates a Tax type
post
Reads a single Tax type
get
Updates a Tax type
put
Holidays > CompanyHoliday
Reads all Company holidays
get
Reads a single Company holiday
get
JobCatalog > Level
Reads all Levels
get
Reads a single Level
get
JobCatalog > Role
Reads all Roles
get
Reads a single Role
get
Locations > Location
Reads all Locations
get
Creates a Location
post
Reads a single Location
get
Updates a Location
put
Deletes a Location
del
Locations > WorkArea
Reads all Work areas
get
Creates a Work area
post
Reads a single Work area
get
Updates a Work area
put
Archives a Work area
post
Unarchives a Work area
post
Marketplace > InstallationSetting
Reads all Installation settings
get
Payroll > FamilySituation
Reads all Family situations
get
Creates a Family situation
post
Updates a Family situation
put
Payroll > PolicyPeriod
Change statuses a Policy period
post
Payroll > Supplement
Reads all Supplements
get
Creates a Supplement
post
Reads a single Supplement
get
Updates a Supplement
put
Deletes a Supplement
del
PayrollEmployees > Identifier
Reads all Identifiers
get
Creates an Identifier
post
Reads a single Identifier
get
Updates an Identifier
put
Deletes an Identifier
del
PayrollIntegrationsBase > Code
Reads all Codes
get
Creates a Code
post
Updates a Code
put
Deletes a Code
del
Performance > Agreement
Reads all Agreements
get
Reads a single Agreement
get
Bulk initiates an Agreement
post
Initiates an Agreement
post
Performance > CompanyEmployeeScoreScale
Reads all Company employee score scales
get
Reads a single Company employee score scale
get
Sets a Company employee score scale
post
Performance > EmployeeScoreScale
Reads all Employee score scales
get
Reads a single Employee score scale
get
Performance > ReviewEmployeeScore
Reads all Review employee scores
get
Reads a single Review employee score
get
Performance > ReviewEvaluation
Reads all Review evaluations
get
Reads a single Review evaluation
get
Replace reviewers a Review evaluation
post
Performance > ReviewEvaluationAnswer
Reads all Review evaluation answers
get
Performance > ReviewOwner
Reads all Review owners
get
Deletes a Review owner
del
Bulk creates a Review owner
post
Performance > ReviewProcess
Reads all Review processes
get
Creates a Review process
post
Reads a single Review process
get
Deletes a Review process
del
Create from templates a Review process
post
Duplicates a Review process
post
Remind in bulks a Review process
post
Remove schedules a Review process
post
Reopens a Review process
post
Schedules a Review process
post
Starts a Review process
post
Stops a Review process
post
Toggle archives a Review process
post
Update agreements configurations a Review process
post
Update basic infos a Review process
post
Update competencies assessments configurations a Review process
post
Update deadlines a Review process
post
Update employee score configurations a Review process
post
Update reviewer strategies a Review process
post
Update schedules a Review process
post
Update target strategies a Review process
post
Performance > ReviewProcessCustomTemplate
Reads all Review process custom templates
get
Reads a single Review process custom template
get
Performance > ReviewProcessEstimatedTarget
Reads all Review process estimated targets
get
Performance > ReviewProcessTarget
Reads all Review process targets
get
Reads a single Review process target
get
Deletes a Review process target
del
Add peers a Review process target
post
Bulk creates a Review process target
post
Remove peer evaluations a Review process target
post
Performance > ReviewQuestionnaireByStrategy
Reads all Review questionnaire by strategies
get
Reads a single Review questionnaire by strategy
get
Update default rating scales a Review questionnaire by strategy
post
Update questionnaire for strategies a Review questionnaire by strategy
post
Performance > ReviewVisibilitySetting
Reads all Review visibility settings
get
Updates a Review visibility setting
put
Performance > TargetManager
Reads all Target managers
get
Reads a single Target manager
get
Posts > Comment
Reads all Comments
get
Creates a Comment
post
Reads a single Comment
get
Updates a Comment
put
Deletes a Comment
del
Posts > Group
Reads all Groups
get
Creates a Group
post
Reads a single Group
get
Updates a Group
put
Deletes a Group
del
Archives a Group
post
Posts > Post
Reads all Posts
get
Creates a Post
post
Reads a single Post
get
Updates a Post
put
Deletes a Post
del
ProjectManagement > ExpenseRecord
Reads all Expense records
get
Reads a single Expense record
get
ProjectManagement > ExportableExpense
Reads all Exportable expenses
get
ProjectManagement > FlexibleTimeRecord
Reads all Flexible time records
get
Creates a Flexible time record
post
Reads a single Flexible time record
get
Updates a Flexible time record
put
Deletes a Flexible time record
del
ProjectManagement > FlexibleTimeRecordComment
Reads all Flexible time record comments
get
Creates a Flexible time record comment
post
Reads a single Flexible time record comment
get
Delete by flexible time records a Flexible time record comment
post
Update by flexible time records a Flexible time record comment
post
ProjectManagement > Project
Reads all Projects
get
Creates a Project
post
Reads a single Project
get
Updates a Project
put
Activates a Project
post
Change assignments a Project
post
Change statuses a Project
post
Closes a Project
post
Soft deletes a Project
post
ProjectManagement > ProjectTask
Reads all Project tasks
get
Creates a Project task
post
Reads a single Project task
get
Updates a Project task
put
Bulk destroys a Project task
post
Bulk duplicates a Project task
post
ProjectManagement > ProjectWorker
Reads all Project workers
get
Creates a Project worker
post
Reads a single Project worker
get
Bulk assigns a Project worker
post
Bulk creates a Project worker
post
Unassigns a Project worker
post
ProjectManagement > Subproject
Reads all Subprojects
get
Creates a Subproject
post
Reads a single Subproject
get
Deletes a Subproject
del
Renames a Subproject
post
ProjectManagement > TimeRecord
Reads all Time records
get
Creates a Time record
post
Reads a single Time record
get
Deletes a Time record
del
Bulk deletes a Time record
post
Bulk processes a Time record
post
Update project workers a Time record
post
ShiftManagement > Shift
Reads all Shifts
get
Creates a Shift
post
Reads a single Shift
get
Deletes a Shift
del
Bulk creates a Shift
post
Bulk deletes a Shift
post
Tasks > Task
Reads all Tasks
get
Creates a Task
post
Reads a single Task
get
Updates a Task
put
Deletes a Task
del
Bulk creates a Task
post
Bulk deletes a Task
post
Bulk updates a Task
post
Copies a Task
post
Create comments a Task
post
Tasks > TaskFile
Reads all Task files
get
Creates a Task file
post
Reads a single Task file
get
Deletes a Task file
del
Teams > Membership
Reads all Memberships
get
Creates a Membership
post
Reads a single Membership
get
Updates a Membership
put
Deletes a Membership
del
Teams > Team
Reads all Teams
get
Creates a Team
post
Reads a single Team
get
Updates a Team
put
Deletes a Team
del
Timeoff > Allowance
Reads all Allowances
get
Creates an Allowance
post
Reads a single Allowance
get
Updates an Allowance
put
Deletes an Allowance
del
Delete with alt allowances an Allowance
post
Timeoff > AllowanceIncidence
Reads all Allowance incidences
get
Creates an Allowance incidence
post
Reads a single Allowance incidence
get
Updates an Allowance incidence
put
Deletes an Allowance incidence
del
Timeoff > AllowanceStat
Reads all Allowance stats
get
Reads a single Allowance stat
get
Timeoff > BlockedPeriod
Reads all Blocked periods
get
Creates a Blocked period
post
Reads a single Blocked period
get
Updates a Blocked period
put
Deletes a Blocked period
del
Timeoff > Leave
Reads all Leaves
get
Creates a Leave
post
Reads a single Leave
get
Updates a Leave
put
Deletes a Leave
del
Approves a Leave
post
Approve alls a Leave
post
Rejects a Leave
post
Timeoff > LeaveType
Reads all Leave types
get
Creates a Leave type
post
Reads a single Leave type
get
Updates a Leave type
put
Timeoff > Policy
Reads all Policies
get
Creates a Policy
post
Reads a single Policy
get
Updates a Policy
put
Deletes a Policy
del
Timeoff > PolicyAssignment
Reads all Policy assignments
get
Creates a Policy assignment
post
Reads a single Policy assignment
get
Updates a Policy assignment
put
Deletes a Policy assignment
del
Timeoff > PolicyTimeline
Reads all Policy timelines
get
TimePlanning > PlannedBreak
Reads all Planned breaks
get
Reads a single Planned break
get
Bulk creates a Planned break
post
TimePlanning > PlanningVersion
Reads all Planning versions
get
Creates a Planning version
post
Updates a Planning version
put
Deletes a Planning version
del
Bulk creates a Planning version
post
TimeSettings > BreakConfiguration
Reads all Break configurations
get
Creates a Break configuration
post
Reads a single Break configuration
get
Updates a Break configuration
put
Trainings > Category
Reads all Categories
get
Creates a Category
post
Reads a single Category
get
Deletes a Category
del
Trainings > Session
Reads all Sessions
get
Create a new training session
post
Reads a single Session
get
Update training session
put
Deletes a Session
del
Trainings > SessionAccessMembership
Reads all Session access memberships
get
Reads a single Session access membership
get
Bulk creates a Session access membership
post
Bulk destroys a Session access membership
post
Trainings > SessionAttendance
Reads all Session attendances
get
Reads a single Session attendance
get
Bulk updates a Session attendance
post
Trainings > Training
Reads all Trainings
get
Creates a Training
post
Reads a single Training
get
Updates a Training
put
Deletes a Training
del
Bulk deletes a Training
post
Bulk update catalogs a Training
post
Update statuses a Training
post
Trainings > TrainingClass
Reads all Training classes
get
Creates a Training class
post
Reads a single Training class
get
Updates a Training class
put
Deletes a Training class
del
Trainings > TrainingMembership
Reads all Training memberships
get
Reads a single Training membership
get
Updates a Training membership
put
Bulk creates a Training membership
post
Bulk destroys a Training membership
post
WorkSchedule > DayConfiguration
Reads all Day configurations
get
Reads a single Day configuration
get
Bulk cuds a Day configuration
post
WorkSchedule > OverlapPeriod
Reads all Overlap periods
get
Creates an Overlap period
post
Reads a single Overlap period
get
Updates an Overlap period
put
Deletes an Overlap period
del
WorkSchedule > Schedule
Reads all Schedules
get
Creates a Schedule
post
Reads a single Schedule
get
Updates a Schedule
put
Toggle archives a Schedule
post
Webhooks
ApiPublic > WebhookSubscription > Creates
post
ApiPublic > WebhookSubscription > Deletes
post
ApiPublic > WebhookSubscription > Updates
post
Ats > Application > Applies
post
Ats > Application > Creates
post
Ats > Application > Deletes
post
Ats > Application > Updates
post
Ats > Candidate > Creates
post
Ats > Candidate > Deletes
post
Ats > Candidate > Updates
post
Ats > EvaluationForm > Save as templates
post
Ats > JobPosting > Creates
post
Ats > JobPosting > Deletes
post
Ats > JobPosting > Duplicates
post
Ats > JobPosting > Updates
post
Attendance > Shift > Autofills
post
Attendance > Shift > Break ends
post
Attendance > Shift > Break starts
post
Attendance > Shift > Clock ins
post
Attendance > Shift > Clock outs
post
Attendance > Shift > Creates
post
Attendance > Shift > Deletes
post
Attendance > Shift > Toggle clocks
post
Attendance > Shift > Updates
post
Banking > BankAccountNumber > Upserts
post
BookkeepersManagement > Incidence > Updates
post
Companies > LegalEntity > Creates
post
Contracts > ContractVersion > Creates
post
Contracts > ContractVersion > Deletes
post
Contracts > ContractVersion > Updates
post
CustomResources > Schema > Creates
post
Documents > Document > Creates
post
Documents > Document > Deletes
post
Documents > Document > Move to trash bins
post
Documents > Document > Restore from trash bins
post
Documents > Document > Updates
post
Documents > Folder > Creates
post
Documents > Folder > Updates
post
Employees > Employee > Create with contracts
post
Employees > Employee > Invites
post
Employees > Employee > Terminates
post
Employees > Employee > Unterminates
post
Employees > Employee > Updates
post
Finance > CostCenter > Creates
post
Finance > CostCenter > Deletes
post
Finance > CostCenter > Edits
post
Locations > Location > Creates
post
Locations > Location > Deletes
post
Locations > Location > Updates
post
Payroll > PolicyPeriod > Change statuses
post
Payroll > Supplement > Creates
post
Payroll > Supplement > Deletes
post
Payroll > Supplement > Updates
post
PayrollIntegrationsBase > Code > Creates
post
PayrollIntegrationsBase > Code > Deletes
post
PayrollIntegrationsBase > Code > Updates
post
Performance > ReviewProcess > Creates
post
Performance > ReviewProcess > Create from templates
post
Performance > ReviewProcess > Deletes
post
Performance > ReviewProcess > Duplicates
post
Performance > ReviewProcess > Remind in bulks
post
Performance > ReviewProcess > Remove schedules
post
Performance > ReviewProcess > Reopens
post
Performance > ReviewProcess > Schedules
post
Performance > ReviewProcess > Starts
post
Performance > ReviewProcess > Stops
post
Performance > ReviewProcess > Toggle archives
post
Performance > ReviewProcess > Update agreements configurations
post
Performance > ReviewProcess > Update basic infos
post
Performance > ReviewProcess > Update competencies assessments configurations
post
Performance > ReviewProcess > Update deadlines
post
Performance > ReviewProcess > Update employee score configurations
post
Performance > ReviewProcess > Update reviewer strategies
post
Performance > ReviewProcess > Update schedules
post
Performance > ReviewProcess > Update target strategies
post
ShiftManagement > Shift > Bulk creates
post
ShiftManagement > Shift > Bulk deletes
post
ShiftManagement > Shift > Creates
post
ShiftManagement > Shift > Deletes
post
Tasks > Task > Bulk creates
post
Tasks > Task > Bulk deletes
post
Tasks > Task > Bulk updates
post
Tasks > Task > Copies
post
Tasks > Task > Creates
post
Tasks > Task > Create comments
post
Tasks > Task > Deletes
post
Tasks > Task > Updates
post
Teams > Membership > Bulk upserts
post
Teams > Membership > Creates
post
Teams > Membership > Deletes
post
Teams > Membership > Updates
post
Teams > Team > Creates
post
Teams > Team > Deletes
post
Teams > Team > Projects
post
Teams > Team > Updates
post
Timeoff > BlockedPeriod > Creates
post
Timeoff > BlockedPeriod > Deletes
post
Timeoff > BlockedPeriod > Updates
post
Timeoff > LeaveType > Creates
post
Timeoff > LeaveType > Updates
post
Timeoff > Leave > Approves
post
Timeoff > Leave > Creates
post
Timeoff > Leave > Deletes
post
Timeoff > Leave > Rejects
post
Timeoff > Leave > Updates
post
Timeoff > Policy > Creates
post
Timeoff > Policy > Deletes
post
Timeoff > Policy > Updates
post
Trainings > Category > Creates
post
Trainings > Category > Deletes
post
Trainings > Training > Bulk deletes
post
Trainings > Training > Bulk update catalogs
post
Trainings > Training > Creates
post
Trainings > Training > Deletes
post
Trainings > Training > Updates
post
Trainings > Training > Update statuses
post
WorkSchedule > Schedule > Creates
post
WorkSchedule > Schedule > Toggle archives
post
WorkSchedule > Schedule > Updates
post
Attendance > Review
Compensations > Concept
Contracts > ContractVersionHistory
Contracts > ContractVersionMetaDatum
CustomResources > Resource
Integrations > SyncableItem
Integrations > SyncableSyncRun
Marketplace > Installation
Performance > ReviewEvaluationScore
ProjectManagement > ExportableProject
Compensations > Concept
