> ## 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.

# Lucca

> How to set up the Lucca connector, plus the actions and events that are available.

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

Betav4.0.0[See changelog](https://docs.stackone.com/connectors/lucca/changelog.md)

[256 actions](#actions) · [12 events](#events) · 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] [OAuth 2.0 (Client Credentials) · Connector Profile](https://docs.stackone.com/connectors/lucca/guides/connector-profile/oauth-2-0-client-credentials.md)
>
> Requires an integration key created in the Lucca account being linked, limited to the business establishments you select...

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/lucca/guides/connector-profile/api-key.md)
>
> Covers only the legacy v3/v4 actions (absences, timesheets, schedules, expenses, invoices, compensation, training, proje...

Optionally, configure receiving Events for Lucca into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/lucca/guides/webhook-setup.md)

**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] [OAuth 2.0 (Client Credentials) · Link Account](https://docs.stackone.com/connectors/lucca/guides/link-account/oauth-2-0-client-credentials.md)

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/lucca/guides/link-account/api-key.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

Authentication type

Select all
|
Clear

API Key

OAuth 2.0 (Client Credentials)

No auth methods found

Scopes

Select all
|
Clear

business-establishments.readonly

departments.readonly

departments.readwrite

employee-attribute-definitions.readonly

employee-attribute-definitions.readwrite

employee-attributes.readonly

employee-attributes.readwrite

employee-personal-records.readonly

employee-personal-records.readwrite

employees.readonly

employees.readwrite

employment-templates.readonly

employments.readonly

employments.readwrite

events.readonly

files.readonly

files.readwrite

job-positions.readonly

job-positions.readwrite

job-qualifications.readonly

legal-entities.readonly

occupation-categories.readonly

probationary-periods.readonly

probationary-periods.readwrite

taxonomies.readonly

taxonomies.readwrite

webhook-deliveries.readonly

webhook-deliveries.readwrite

webhook-endpoints.readonly

webhook-endpoints.readwrite

working-time-arrangements.readonly

No scopes found

256 actions

ActionDescriptionRequired scopes

List Leaves`lucca_list_leaves`

List approved leaves for a set of employees over a date range.

Retrieve A Leave`lucca_retrieve_leave`

Retrieve a single approved leave by its ID.

Cancel A Leave`lucca_cancel_leave`

Cancel a single approved leave by its ID.

List Leave Requests`lucca_list_leave_requests`

List leave requests with their status and approval history.

Retrieve A Leave Request`lucca_retrieve_leave_request`

Retrieve a single leave request by its ID.

Cancel A Leave Request`lucca_cancel_leave_request`

Request cancellation of a leave request by its ID.

Approve Or Deny A Leave Request`lucca_approve_or_deny_leave_request`

Approve or deny a pending leave request.

Import Leave Entitlements`lucca_import_leave_entitlements`

Credit leave accounts by adding the values in an uploaded file to existing balances.

Replace Leave Entitlements`lucca_replace_leave_entitlements`

Adjust leave accounts so their entitlement totals match the values in an uploaded file.

Import Leaves`lucca_import_leaves`

Create leaves in batch from an uploaded CSV file.

Retrieve Leaves Import Progress`lucca_retrieve_leaves_import_progress`

Retrieve the progress of an asynchronous leaves import.

List Sick Leave Certificates`lucca_list_sick_leave_certificates`

List sick leave certificates holding extra legal details for certain leaves.

Retrieve A Sick Leave Certificate`lucca_retrieve_sick_leave_certificate`

Retrieve a single sick leave certificate by its ID.

List Fixed Natures`lucca_list_fixed_natures`

List the fixed remuneration natures configured in Lucca Compensation.

Get A Fixed Nature`lucca_retrieve_fixed_nature`

Retrieve a single fixed remuneration nature by ID.

List Fixed Nature Categories`lucca_list_fixed_nature_categories`

List the categories of fixed remuneration natures.

List Variable Items`lucca_list_variable_items`

List variable remuneration items (bonuses, commissions) matching a set of filters.

Create A Variable Item`lucca_create_variable_item`

Create a variable remuneration item on an employee work contract.

Get A Variable Item`lucca_retrieve_variable_item`

Retrieve a single variable remuneration item by ID.

Update A Variable Item`lucca_update_variable_item`

Update an existing variable remuneration item.

Delete A Variable Item`lucca_delete_variable_item`

Delete a variable remuneration item.

List Variable Natures`lucca_list_variable_natures`

List the variable remuneration natures configured in Lucca Compensation.

Get A Variable Nature`lucca_retrieve_variable_nature`

Retrieve a single variable remuneration nature by ID.

List Variable Nature Categories`lucca_list_variable_nature_categories`

List the categories of variable remuneration natures.

List Fixed Items`lucca_list_fixed_items`

List fixed remuneration items (e.g. base salary) matching a set of filters.

Create A Fixed Item`lucca_create_fixed_item`

Create a fixed remuneration item on an employee work contract.

Update A Fixed Item`lucca_update_fixed_item`

Replace the data of an existing fixed remuneration item.

Delete A Fixed Item`lucca_delete_fixed_item`

Delete a fixed remuneration item.

List Employee-attribute-definitions`lucca_list_employee_attribute_definitions`

Returns a paginated list of employee-attribute-definitions.

`employee-attribute-definitions.readonly`

Retrieve An Employee-attribute-definition`lucca_retrieve_employee_attribute_definition`

Retrieve a single employee-attribute-definition by ID.

`employee-attribute-definitions.readonly`

List Employee-attributes`lucca_list_employee_attributes`

Returns a paginated list of employee-attributes.

`employee-attributes.readonly`

Retrieve An Employee-attribute`lucca_retrieve_employee_attribute`

Retrieve a single employee-attribute by ID.

`employee-attributes.readonly`

List Professions`lucca_list_professions`

List professions.

`job-qualifications.readonly`

Retrieve A Profession`lucca_retrieve_profession`

Retrieve a profession by its ID.

`job-qualifications.readonly`

List Job-qualifications`lucca_list_job_qualifications`

Returns a paginated list of job-qualifications.

`job-qualifications.readonly`

Retrieve A Job-qualification`lucca_retrieve_job_qualification`

Retrieve a job-qualification by its ID.

`job-qualifications.readonly`

List Occupation-categories`lucca_list_occupation_categories`

Returns a paginated list of occupation-categories.

`occupation-categories.readonly`

Retrieve An Occupation-category`lucca_retrieve_occupation_category`

Retrieve an occupation-category.

`occupation-categories.readonly`

Create An Employee-attribute-definition`lucca_create_employee_attribute_definition`

Create a new custom employee attribute definition.

`employee-attribute-definitions.readwrite`

Replace An Employee-attribute-definition`lucca_replace_employee_attribute_definition`

Replace a custom employee attribute definition as a whole.

`employee-attribute-definitions.readwrite`

Update An Employee-attribute-definition`lucca_update_employee_attribute_definition`

Partially update a custom employee attribute definition.

`employee-attribute-definitions.readwrite`

Delete An Employee-attribute-definition`lucca_delete_employee_attribute_definition`

Archive a custom employee attribute definition.

`employee-attribute-definitions.readwrite`

Create An Employee-attribute`lucca_create_employee_attribute`

Set a custom attribute value for an employee.

`employee-attributes.readwrite`

Replace An Employee-attribute`lucca_replace_employee_attribute`

Replace the value of an employee-attribute as a whole.

`employee-attributes.readwrite`

Update An Employee-attribute`lucca_update_employee_attribute`

Partially update an employee-attribute.

`employee-attributes.readwrite`

List Users (legacy V3)`lucca_list_users`

List users (employees) from the legacy Lucca Directory v3 API.

Retrieve A User (legacy V3)`lucca_retrieve_user`

Retrieve a single user by ID from the legacy Lucca Directory v3 API.

Update A User (legacy V3)`lucca_update_user`

Update a user by ID in the legacy Lucca Directory v3 API.

List Work Contracts`lucca_list_work_contracts`

List employee work contracts from the legacy Lucca Directory v4 API.

Create A Work Contract`lucca_create_work_contract`

Create a work contract for an existing employee in the legacy Lucca Directory v4 API.

Retrieve A Work Contract`lucca_retrieve_work_contract`

Retrieve a single work contract by ID from the legacy Lucca Directory v4 API.

Update A Work Contract`lucca_update_work_contract`

Partially update a work contract by ID in the legacy Lucca Directory v4 API.

Delete A Work Contract`lucca_delete_work_contract`

Delete a work contract by ID in the legacy Lucca Directory v4 API.

List Employees`lucca_list_employees`

Returns a paginated list of employees.

`employees.readonly`

Retrieve An Employee`lucca_retrieve_employee`

Retrieve a single employee.

`employees.readonly`

List Employee-personal-records`lucca_list_employee_personal_records`

Retrieve a paginated list of employee-personal-records.

`employee-personal-records.readonly`

Retrieve An Employee-personal-record`lucca_retrieve_employee_personal_record`

Retrieve an employee-personal-record.

`employee-personal-records.readonly`

Create A User (legacy V3, API Key)`lucca_create_user`

Create a new employee (user) in Lucca through the legacy v3 API, with role IDs, using API Key authentication.

Create An Employee`lucca_create_employee`

Create a new employee with their first employment and first job position.

`employees.readwrite``employments.readwrite``job-positions.readwrite`

Update An Employee`lucca_update_employee`

Partially update an existing employee.

`employees.readwrite`

Update An Employee-personal-record`lucca_update_employee_personal_record`

Partially update an employee-personal-record.

`employee-personal-records.readwrite`

List Employments`lucca_list_employments`

Returns a paginated list of employments.

`employments.readonly`

Retrieve An Employment`lucca_retrieve_employment`

Retrieve an employment by its ID.

`employments.readonly`

List Employment-templates`lucca_list_employment_templates`

Retrieve a paginated list of employment-templates.

`employment-templates.readonly`

Retrieve An Employment-template`lucca_retrieve_employment_template`

Retrieve an employment-template by its ID.

`employment-templates.readonly`

List Job-positions`lucca_list_job_positions`

Retrieve a paginated list of job-positions.

`job-positions.readonly`

Retrieve A Job-position`lucca_retrieve_job_position`

Retrieve a job-position by its ID.

`job-positions.readonly`

List Probationary-periods`lucca_list_probationary_periods`

List probationary-periods.

`probationary-periods.readonly`

Retrieve A Probationary-period`lucca_retrieve_probationary_period`

Retrieve a probationary-period by its ID.

`probationary-periods.readonly`

Create An Employment`lucca_create_employment`

Create a new employment, with its first job position, for an existing employee.

`employments.readwrite``job-positions.readwrite`

Update An Employment`lucca_update_employment`

Partially update an existing employment.

`employments.readwrite`

Delete An Employment`lucca_delete_employment`

Delete an employment and all its job positions.

`employments.readwrite`

Create A Job-position`lucca_create_job_position`

Create a new job position within an employee employment.

`job-positions.readwrite`

Update A Job-position`lucca_update_job_position`

Partially update an existing job position.

`job-positions.readwrite`

Delete A Job-position`lucca_delete_job_position`

Delete a job position.

`job-positions.readwrite`

Create A Probationary-period`lucca_create_probationary_period`

Create a probationary period for an employment.

`probationary-periods.readwrite`

Update A Probationary-period`lucca_update_probationary_period`

Partially update a probationary period.

`probationary-periods.readwrite`

Delete A Probationary-period`lucca_delete_probationary_period`

Delete a probationary period.

`probationary-periods.readwrite`

List Temporary Expenses`lucca_list_expense_temp_items`

List temporary (not yet declared) expenses.

Create A Temporary Expense`lucca_create_expense_temp_item`

Create a temporary expense for an employee.

Get A Temporary Expense`lucca_retrieve_expense_temp_item`

Retrieve a temporary expense by ID.

Update A Temporary Expense`lucca_update_expense_temp_item`

Update a temporary expense by ID.

Create Expense Claims`lucca_create_expense_claim`

Declare one or more expense claims from temporary expenses.

List Expense Claims`lucca_list_expense_claims`

List declared expense claims.

List Expense Claim Items`lucca_list_expense_claim_items`

List expenses already declared in an expense claim.

Get An Expense Claim Item`lucca_retrieve_expense_claim_item`

Retrieve a declared expense claim item by ID.

Create An Expense Accounting Export`lucca_create_expense_accounting_export`

Create an accounting export and return its entry lines.

Upload A File`lucca_upload_file`

Upload a file in order to reference it as the attachment of another resource (e.g. a portrait).

`files.readwrite`

Retrieve A File`lucca_retrieve_file`

Retrieve a file, either its JSON representation or its content.

`files.readonly`

Upload A File (legacy)`lucca_upload_a_file`

Upload a file to Lucca Files through the legacy API to reference it from another resource.

List Meal Voucher Statutories`lucca_list_statutories`

List meal voucher statutories (application settings).

Get A Meal Voucher Statutory`lucca_retrieve_statutory`

Retrieve a meal voucher statutory by ID.

Get Statutory General Parameters`lucca_retrieve_statutory_general_parameters`

Retrieve the general parameters of a meal voucher statutory.

List Statutory Distributions`lucca_list_statutory_distributions`

List the meal voucher distributions of a statutory.

Get Meal Voucher Computation Details`lucca_retrieve_computation_details`

Retrieve the per-employee meal voucher counts of a computation.

List User Locations`lucca_list_user_locations`

List where employees work on given days.

Retrieve A User Location`lucca_retrieve_user_location`

Retrieve a single user location by its ID.

List Work Locations`lucca_list_work_locations`

List the work locations employees can work from.

Retrieve A Work Location`lucca_retrieve_work_location`

Retrieve a single work location by its ID.

Import User Locations`lucca_import_user_locations`

Create, replace or delete user locations in batch from an uploaded CSV file.

Retrieve User Locations Import Progress`lucca_retrieve_user_locations_import_progress`

Retrieve the progress of a user locations import.

Retrieve User Locations Import Analysis`lucca_retrieve_user_locations_import_analysis`

Retrieve the dry-run analysis of a simulated user locations import.

Retrieve User Locations Import Results`lucca_retrieve_user_locations_import_results`

Retrieve the results of a user locations import.

List Departments`lucca_list_departments`

Returns a paginated list of departments.

`departments.readonly`

Retrieve A Department`lucca_retrieve_department`

Retrieve a single department by ID.

`departments.readonly`

Create A Department`lucca_create_department`

Create a new department.

`departments.readwrite`

Update A Department`lucca_update_department`

Update a department.

`departments.readwrite`

List Legal-entities`lucca_list_legal_entities`

Returns a paginated list of legal-entities.

`legal-entities.readonly`

Retrieve A Legal-entity`lucca_retrieve_legal_entity`

Retrieve a legal-entity.

`legal-entities.readonly`

List Business-establishments`lucca_list_business_establishments`

List business-establishments.

`business-establishments.readonly`

Retrieve A Business-establishment`lucca_retrieve_business_establishment`

Retrieve a business-establishment.

`business-establishments.readonly`

List Legal Units (legacy V4)`lucca_list_legal_units`

List legal units from the legacy Lucca Organization Structure v4 API.

List Establishments (legacy V4)`lucca_list_establishments`

List establishments from the legacy Lucca Organization Structure v4 API.

List Departments (legacy V4)`lucca_list_structure_departments`

List departments from the legacy Lucca Organization Structure v4 API.

Retrieve A Department (legacy V4)`lucca_retrieve_structure_department`

Retrieve a single department by ID from the legacy Lucca Organization Structure v4 API.

List Axes`lucca_list_axes`

List analytical axes that group axis sections in the legacy Lucca v3 API.

List Axis Sections`lucca_list_axis_sections`

List axis sections (analytical codes) in the legacy Lucca v3 API.

Create An Axis Section`lucca_create_axis_section`

Create an axis section (analytical code) under an axis in the legacy Lucca v3 API.

Retrieve An Axis Section`lucca_retrieve_axis_section`

Retrieve a single axis section by ID from the legacy Lucca v3 API.

Update An Axis Section`lucca_update_axis_section`

Update an axis section by ID in the legacy Lucca v3 API.

Delete An Axis Section`lucca_delete_axis_section`

Delete an axis section by ID in the legacy Lucca v3 API.

List VAT Rates`lucca_list_vat_rates`

List the VAT rates applicable on a given date in a territory.

List Purchases`lucca_list_purchases`

List purchases in Lucca Cleemy Procurement.

Create Purchase`lucca_create_purchase`

Create a new purchase in Lucca Cleemy Procurement.

Get Purchase`lucca_retrieve_purchase`

Retrieve a purchase by its ID.

Create Purchase Commitment`lucca_create_purchase_commitment`

Create a commitment on an existing purchase.

Create Commitment Request`lucca_create_commitment_request`

Submit a purchase commitment for approval.

List Cost-centers`lucca_list_cost_centers`

List cost-centers in Lucca Cleemy Procurement.

Create Cost-center`lucca_create_cost_center`

Create a new cost-center.

Get Cost-center`lucca_retrieve_cost_center`

Retrieve a cost-center by its ID.

Update Cost-center`lucca_update_cost_center`

Update a cost-center.

Import Cost-centers`lucca_import_cost_centers`

Bulk import a list of cost-centers.

Cancel Commitment Request`lucca_cancel_commitment_request`

Cancel a pending commitment request.

Close Purchase`lucca_close_purchase`

Close a purchase.

List Suppliers`lucca_list_suppliers`

List suppliers in Lucca Cleemy Procurement.

Create Supplier`lucca_create_supplier`

Create a new supplier.

Get Supplier`lucca_retrieve_supplier`

Retrieve a supplier by its ID.

Update Supplier`lucca_update_supplier`

Update a supplier.

List Natures`lucca_list_natures`

List purchase natures (categories).

Create Nature`lucca_create_nature`

Create a new purchase nature.

Get Nature`lucca_retrieve_nature`

Retrieve a nature by its ID.

Update Nature`lucca_update_nature`

Update a purchase nature.

Get Invoice`lucca_retrieve_invoice`

Retrieve an invoice by its ID.

Update Invoice`lucca_update_invoice`

Update the editable fields of an invoice.

List Invoice Confirmations`lucca_list_invoice_confirmations`

List the confirmations (approvals) of an invoice.

Confirm Invoice`lucca_confirm_invoice`

Confirm (approve) an invoice.

List Inbox Documents`lucca_list_inbox_documents`

List documents waiting to be processed in the inbox.

Update Inbox Document`lucca_update_inbox_document`

Update an inbox document and optionally attach or create a purchase.

Book Inbox Document`lucca_book_inbox_document`

Book (validate) a document from the inbox.

Get Document`lucca_retrieve_document`

Retrieve a document by its ID.

Update Document`lucca_update_document`

Update a document's information before booking it.

Delete Document`lucca_delete_document`

Delete a document.

List Booked Documents`lucca_list_booked_documents`

List booked documents (invoices and credit notes).

List Clients`lucca_list_clients`

List the Lucca Project clients of an organization.

Create A Client`lucca_create_client`

Create a new Lucca Project client in an organization.

Get A Client`lucca_retrieve_client`

Retrieve a single Lucca Project client by its ID.

Update A Client`lucca_update_client`

Update a Lucca Project client by its ID.

Delete A Client`lucca_delete_client`

Permanently delete a Lucca Project client by its ID.

List Projects`lucca_list_projects`

List the Lucca Project projects of an organization.

Create A Project`lucca_create_project`

Create a new Lucca Project project for a client.

Get A Project`lucca_retrieve_project`

Retrieve a single Lucca Project project by its ID.

Update A Project`lucca_update_project`

Update a Lucca Project project by its ID.

Delete A Project`lucca_delete_project`

Delete a draft Lucca Project project by its ID.

List Project Services`lucca_list_project_services`

List the services (work items) of a Lucca Project project.

Create A Project Service`lucca_create_project_service`

Add a new service (work item) to a Lucca Project project.

List Project Organizations`lucca_list_project_organizations`

List the Lucca Project organizations.

List Project Financials`lucca_list_project_financials`

List financial metrics for the Lucca Project projects of an organization.

Create A Job Application`lucca_create_job_application`

Create a candidate application for a job opportunity in Lucca Recruitment.

List Active Job Offers`lucca_list_active_job_offers`

List a company's currently open job offers from the public Lucca Recruitment XML feed.

List Work Cycle Exceptions`lucca_list_work_cycle_exceptions`

List work cycle exceptions that override an employee's planned hours on a half-day.

Create Or Update A Work Cycle Exception`lucca_upsert_work_cycle_exception`

Create a work cycle exception, or update the existing one on the same employee half-day.

Get A Work Cycle Exception`lucca_retrieve_work_cycle_exception`

Get a single work cycle exception by ID.

Delete A Work Cycle Exception`lucca_delete_work_cycle_exception`

Soft-delete a work cycle exception by ID.

List Shift Overrides`lucca_list_shift_overrides`

List one-time overrides of employees' regular work schedules.

Replace Shift Overrides For An Employee`lucca_replace_employee_shift_overrides`

Replace all shift overrides of one employee within a date range.

List User Dates`lucca_list_user_dates`

List the computed daily theoretical working hours of employees over a period.

List Working Time Arrangements (legacy Schedule API)`lucca_list_schedule_working_time_arrangements`

List working time arrangements through the legacy schedule API.

Create A Working Time Arrangement`lucca_create_schedule_working_time_arrangement`

Create a working time arrangement through the legacy schedule API.

Get A Working Time Arrangement (legacy Schedule API)`lucca_retrieve_schedule_working_time_arrangement`

Get a working time arrangement by ID through the legacy schedule API.

Update A Working Time Arrangement`lucca_update_schedule_working_time_arrangement`

Replace the properties of a working time arrangement through the legacy schedule API.

Delete A Working Time Arrangement`lucca_delete_schedule_working_time_arrangement`

Permanently delete a working time arrangement by ID.

Archive A Working Time Arrangement`lucca_archive_schedule_working_time_arrangement`

Archive a working time arrangement so it is no longer given to employees.

Unarchive A Working Time Arrangement`lucca_unarchive_schedule_working_time_arrangement`

Restore an archived working time arrangement.

Duplicate A Working Time Arrangement`lucca_duplicate_schedule_working_time_arrangement`

Create a copy of an existing working time arrangement.

List Collective Schedules`lucca_list_collective_schedules`

List the collective schedules (weekly working patterns) of a working time arrangement.

Create A Collective Schedule`lucca_create_collective_schedule`

Add a weekly working pattern to a working time arrangement.

Get A Collective Schedule`lucca_retrieve_collective_schedule`

Get one collective schedule of a working time arrangement by ID.

Update A Collective Schedule`lucca_update_collective_schedule`

Replace the weekly working pattern of a collective schedule.

Delete A Collective Schedule`lucca_delete_collective_schedule`

Delete a collective schedule from a working time arrangement.

List Employee Assignments`lucca_list_employee_assignments`

List assignments of working time arrangements to employees over time.

Assign A Working Time Arrangement To An Employee`lucca_create_employee_assignment`

Assign a new working time arrangement to an employee from a start date.

List Taxonomies`lucca_list_taxonomies`

Returns a paginated list of taxonomies.

`taxonomies.readonly`

Retrieve A Taxonomy`lucca_retrieve_taxonomy`

Retrieve a taxonomy by its ID.

`taxonomies.readonly`

List Taxonomy-labels`lucca_list_taxonomy_labels`

Returns a paginated list of taxonomy-labels.

`taxonomies.readonly`

Retrieve A Taxonomy-label`lucca_retrieve_taxonomy_label`

Retrieve a taxonomy-label by its ID.

`taxonomies.readonly`

Create A Taxonomy`lucca_create_taxonomy`

Create a new taxonomy.

`taxonomies.readwrite`

Replace A Taxonomy`lucca_replace_taxonomy`

Replace a taxonomy as a whole.

`taxonomies.readwrite`

Update A Taxonomy`lucca_update_taxonomy`

Partially update a taxonomy.

`taxonomies.readwrite`

Delete A Taxonomy`lucca_delete_taxonomy`

Delete a taxonomy and all its labels.

`taxonomies.readwrite`

Create A Taxonomy-label`lucca_create_taxonomy_label`

Create a new value in a taxonomy.

`taxonomies.readwrite`

Replace A Taxonomy-label`lucca_replace_taxonomy_label`

Replace a taxonomy-label as a whole.

`taxonomies.readwrite`

Update A Taxonomy-label`lucca_update_taxonomy_label`

Partially update a taxonomy-label.

`taxonomies.readwrite`

Delete A Taxonomy-label`lucca_delete_taxonomy_label`

Permanently delete a taxonomy-label.

`taxonomies.readwrite`

List Time Entries`lucca_list_time_entries`

List time entries (worked hours) matching the given filters.

Create Time Entries`lucca_create_time_entries`

Create one or more time entries, possibly for several owners.

Update Multiple Time Entries`lucca_bulk_update_time_entries`

Update one or more existing time entries, possibly for several owners.

Delete Multiple Time Entries`lucca_bulk_delete_time_entries`

Delete one or more time entries by ID.

Get A Time Entry`lucca_retrieve_time_entry`

Retrieve a single time entry by its ID.

Update A Time Entry`lucca_update_time_entry`

Update the fields of a single time entry by its ID.

Delete A Time Entry`lucca_delete_time_entry`

Delete a single time entry by its ID.

List Timesheets`lucca_list_timesheets`

List timesheets matching owner, date and status filters.

List Due Timesheets`lucca_list_due_timesheets`

List timesheets that are not yet submitted.

Remind Timesheets`lucca_remind_timesheets`

Email users a reminder to submit their due timesheets.

Submit Timesheets (v3)`lucca_submit_timesheets`

Submit timesheets for approval through the v3 workflow service.

Cancel Timesheets (v3)`lucca_cancel_timesheets`

Cancel submitted timesheets by ID through the v3 workflow service.

Approve Timesheets (v3)`lucca_approve_timesheets`

Approve pending timesheets by ID through the v3 workflow service.

Deny Timesheets (v3)`lucca_deny_timesheets`

Deny pending timesheets by ID with a mandatory comment.

Invalidate Timesheets (v3)`lucca_invalidate_timesheets`

Reject approved timesheets by ID with a mandatory comment.

Create A Timesheet Report`lucca_create_timesheet_report`

Start generating a timesheet report from a report template.

Download A Timesheet Report As CSV`lucca_download_timesheet_report_csv`

Download the content of a generated timesheet report as a CSV file.

Download A Timesheet Report As Excel`lucca_download_timesheet_report_excel`

Download the content of a generated timesheet report as an Excel file.

Submit Timesheets`lucca_submit_timesheets_for_period`

Submit all of an owner's timesheets up to a given period.

Approve A Timesheet`lucca_approve_timesheet`

Approve a pending timesheet and any earlier pending ones of the same owner.

Cancel A Timesheet`lucca_cancel_timesheet`

Cancel a pending timesheet and any later pending ones of the same owner.

Deny A Timesheet`lucca_deny_timesheet`

Deny a pending timesheet with a mandatory comment.

Invalidate A Timesheet`lucca_invalidate_timesheet`

Reject an approved timesheet with a mandatory comment.

Approve Timesheets`lucca_bulk_approve_timesheets`

Approve several pending timesheets by ID in one call.

Replace Time Entries For A Period`lucca_update_time_entries`

Replace an owner's time entries over a period with the ones provided.

Create A Time Punch`lucca_create_time_punch`

Record a clock-in or clock-out for an employee.

List Time Punches`lucca_list_time_punches`

List clock-ins and clock-outs, archived ones included.

Get A Time Punch`lucca_retrieve_time_punch`

Retrieve a single time punch by its ID, archived or not.

Archive Or Restore A Time Punch`lucca_archive_or_restore_time_punch`

Archive a time punch sent by mistake, or restore an archived one.

List Trainings`lucca_list_trainings`

List trainings in the training catalogue.

Create A Training`lucca_create_training`

Create a training in the training catalogue.

Get A Training`lucca_retrieve_training`

Retrieve a training by ID.

List Realized Trainings`lucca_list_realized_trainings`

List realized (completed) trainings.

Create A Realized Training`lucca_create_realized_training`

Record a completed training for an employee.

Get A Realized Training`lucca_retrieve_realized_training`

Retrieve a realized training by ID.

Delete A Realized Training`lucca_delete_realized_training`

Delete a realized training by ID.

List Training Demands`lucca_list_training_demands`

List training demands (training requests per employee).

List Training Providers`lucca_list_training_providers`

List training providers.

List Training Categories`lucca_list_training_categories`

List training categories.

List Webhook-endpoints`lucca_list_webhook_endpoints`

Returns a paginated list of webhook-endpoints.

`webhook-endpoints.readonly`

Create A Webhook-endpoint`lucca_create_webhook_endpoint`

Create a new webhook-endpoint.

`webhook-endpoints.readwrite`

Retrieve A Webhook-endpoint`lucca_retrieve_webhook_endpoint`

Retrieves a single webhook-endpoint resource.

`webhook-endpoints.readonly`

Update A Webhook-endpoint`lucca_update_webhook_endpoint`

Update an existing webhook-endpoint.

`webhook-endpoints.readwrite`

Delete A Webhook-endpoint`lucca_delete_webhook_endpoint`

Delete an existing webhook-endpoint.

`webhook-endpoints.readwrite`

List Webhook-deliveries`lucca_list_webhook_deliveries`

Returns a paginated list of webhook-deliveries.

`webhook-deliveries.readonly`

Trigger A Test Delivery`lucca_trigger_test_delivery`

Triggers a test delivery to a webhook endpoint to verify it is configured correctly.

`webhook-deliveries.readwrite`

Retrieve A Webhook-delivery`lucca_retrieve_webhook_delivery`

Retrieve a webhook-delivery.

`webhook-deliveries.readonly`

List Webhook-delivery-attempts`lucca_list_webhook_delivery_attempts`

Retrieve a paginated list of webhook-delivery-attempts.

`webhook-deliveries.readonly`

Retrieve A Webhook-delivery-attempt`lucca_retrieve_webhook_delivery_attempt`

Retrieve a webhook-delivery-attempt.

`webhook-deliveries.readonly`

List Events`lucca_list_events`

Returns a paginated list of webhook events.

`events.readonly`

Retrieve An Event`lucca_retrieve_event`

Retrieve a single webhook event.

`events.readonly`

List Working-time-arrangements`lucca_list_working_time_arrangements`

Returns a paginated list of working-time-arrangements.

`working-time-arrangements.readonly`

Retrieve A Working-time-arrangement`lucca_retrieve_working_time_arrangement`

Retrieve a single working-time-arrangement.

`working-time-arrangements.readonly`

## Events

Tags

Select all
|
Clear

Employee Attributes

Employees

Employments

Job Positions

Webhooks

No tags found

12 events

EventDescriptionTags

Employee Created`lucca_webhook_employee_created`

Processes Lucca employee.created events when a new employee is added.

EmployeesWebhooks

Employee Updated`lucca_webhook_employee_updated`

Processes Lucca employee.updated events when an employee is modified.

EmployeesWebhooks

Employee Deleted`lucca_webhook_employee_deleted`

Processes Lucca employee.deleted events when an employee is removed.

EmployeesWebhooks

Employment Created`lucca_webhook_employment_created`

Processes Lucca employment.created events when a new employment is added.

EmploymentsWebhooks

Employment Updated`lucca_webhook_employment_updated`

Processes Lucca employment.updated events when an employment is modified.

EmploymentsWebhooks

Employment Deleted`lucca_webhook_employment_deleted`

Processes Lucca employment.deleted events when an employment is removed.

EmploymentsWebhooks

Job Position Created`lucca_webhook_job_position_created`

Processes Lucca job-position.created events when a new job position is added.

Job PositionsWebhooks

Job Position Updated`lucca_webhook_job_position_updated`

Processes Lucca job-position.updated events when a job position is modified.

Job PositionsWebhooks

Job Position Deleted`lucca_webhook_job_position_deleted`

Processes Lucca job-position.deleted events when a job position is removed.

Job PositionsWebhooks

Employee Extension Created`lucca_webhook_employee_extension_created`

Processes Lucca employee-extension.created events when a custom attribute value is added.

Employee AttributesWebhooks

Employee Extension Updated`lucca_webhook_employee_extension_updated`

Processes Lucca employee-extension.updated events when a custom attribute value is modified.

Employee AttributesWebhooks

Employee Extension Deleted`lucca_webhook_employee_extension_deleted`

Processes Lucca employee-extension.deleted events when a custom attribute value is removed.

Employee AttributesWebhooks


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