# Lucca API - [Lucca Developers Hub](https://developers.luccasoftware.com/home.md) - [Introduction](https://developers.luccasoftware.com/api-reference/legacy/introduction.md): Earlier versions of the Lucca APIs, still available during the transition to the Lucca API. - [Authentication](https://developers.luccasoftware.com/api-reference/legacy/authentication.md): Learn how to authenticate on a Legacy API. - [Features](https://developers.luccasoftware.com/api-reference/legacy/api-generations.md): Features of the Legacy API, and the differences between v3 and v4 API generations. - [Limits](https://developers.luccasoftware.com/api-reference/legacy/limits.md) - [Download the OpenAPI specifications](https://developers.luccasoftware.com/api-reference/legacy/download.md): The OpenAPI specifications of the Lucca Legacy APIs are available for download. They can be used to generate client libraries, create API documentation, and more. - [Legacy API Changelog](https://developers.luccasoftware.com/api-reference/legacy/changelog.md) - [Using Files](https://developers.luccasoftware.com/api-reference/legacy/files/using-files.md) - [The file resource](https://developers.luccasoftware.com/api-reference/legacy/files/file.md) - [Upload a file](https://developers.luccasoftware.com/api-reference/legacy/files/post-upload.md): Upload a file. - [Get Started With Axis-Sections](https://developers.luccasoftware.com/api-reference/legacy/organization/axis-sections/get-started.md): Learn more about axes & axis-sections. - [The axis resource](https://developers.luccasoftware.com/api-reference/legacy/organization/axis-sections/axis.md) - [List Axes](https://developers.luccasoftware.com/api-reference/legacy/organization/axis-sections/list-axes.md): List all Axes satisfying query filters. - [The axis-section resource](https://developers.luccasoftware.com/api-reference/legacy/organization/axis-sections/axis-section.md) - [List AxisSections](https://developers.luccasoftware.com/api-reference/legacy/organization/axis-sections/list-axissections.md): List all AxisSections satisfying query filters. - [Create a new AxisSection](https://developers.luccasoftware.com/api-reference/legacy/organization/axis-sections/create-a-new-axissection.md): Create a new AxisSection. - [Get an AxisSection by id](https://developers.luccasoftware.com/api-reference/legacy/organization/axis-sections/get-an-axissection-by-id.md): Retrieve a single AxisSection by its unique identifier. - [Update an AxisSection by id](https://developers.luccasoftware.com/api-reference/legacy/organization/axis-sections/update-an-axissection-by-id.md): Partial or complete update to an existing AxisSection. - [Delete an AxisSection by id](https://developers.luccasoftware.com/api-reference/legacy/organization/axis-sections/delete-an-axissection-by-id.md): Delete an AxisSection by id - [The department resource](https://developers.luccasoftware.com/api-reference/legacy/organization/departments/department.md) - [List Departments (v3)](https://developers.luccasoftware.com/api-reference/legacy/organization/departments/list-departments-v3.md): List all Departments satisfying query filters. - [List Departements as a tree](https://developers.luccasoftware.com/api-reference/legacy/organization/departments/list-departements-as-a-tree.md): List all departments as a tree. Remark: first node is always empty and represents the starting point of the tree as multiple departments might be set to the highest level. - [Get Departement by id (v3)](https://developers.luccasoftware.com/api-reference/legacy/organization/departments/get-departement-by-id-v3.md): Retrieve a single Department by its unique identifier. - [The department resource](https://developers.luccasoftware.com/api-reference/legacy/organization/departments/department-v4.md) - [List departments](https://developers.luccasoftware.com/api-reference/legacy/organization/departments/list-departments.md): List departments. - [Retrieve a department](https://developers.luccasoftware.com/api-reference/legacy/organization/departments/retrieve-a-department.md): Retrieve a department by its ID. - [The legal-unit resource](https://developers.luccasoftware.com/api-reference/legacy/organization/legal-units/legal-unit.md) - [List legal-units](https://developers.luccasoftware.com/api-reference/legacy/organization/legal-units/list-legal-units.md): Retrieve a paginated list of legal-units. - [The establishment resource](https://developers.luccasoftware.com/api-reference/legacy/organization/establishments/establishment.md) - [List establishments](https://developers.luccasoftware.com/api-reference/legacy/organization/establishments/list-establishments.md): Retrieve a list of establishments. - [Migrating to Lucca API (v5) Business-Establishments & Legal-Entities](https://developers.luccasoftware.com/api-reference/legacy/organization/guides/establishments-migration.md): Migration steps from V3 legal-entities or V4 establishments to the Lucca API (v5) business-establishments and legal-entities. - [Migrating Departments to the Lucca API (v5)](https://developers.luccasoftware.com/api-reference/legacy/organization/guides/departments-migration.md): Migration steps from the V3 or V4 departments APIs to the Lucca API (v5) department resource. - [The user resource](https://developers.luccasoftware.com/api-reference/legacy/directory/user.md) - [List Users](https://developers.luccasoftware.com/api-reference/legacy/directory/list-users.md): Retrieve a list of Users. - [Create a new User](https://developers.luccasoftware.com/api-reference/legacy/directory/create-a-new-user.md): Create a new user - [Get a User by Id](https://developers.luccasoftware.com/api-reference/legacy/directory/get-a-user-by-id.md): Retrieve a single User identified by its unique identifier. - [Update a User by id](https://developers.luccasoftware.com/api-reference/legacy/directory/update-a-user-by-id.md): Update fields of a single User identified by its unique id. - [The work-contract resource](https://developers.luccasoftware.com/api-reference/legacy/directory/work-contract.md) - [List work-contracts](https://developers.luccasoftware.com/api-reference/legacy/directory/get-work-contracts.md): Retrieve a paginated collection of work-contracts. - [Create a work-contract](https://developers.luccasoftware.com/api-reference/legacy/directory/post-work-contract.md): Create a new work-contract. - [Retrieve a work-contract](https://developers.luccasoftware.com/api-reference/legacy/directory/get-work-contract.md): Retrieve a single work-contract by its ID. - [Update a work-contract](https://developers.luccasoftware.com/api-reference/legacy/directory/patch-work-contract.md): Update a work-contract by its ID. - [Delete a work-contract](https://developers.luccasoftware.com/api-reference/legacy/directory/delete-work-contract.md): Delete a work-contract by its ID. - [Users Examples](https://developers.luccasoftware.com/api-reference/legacy/directory/guides/users.md) - [Using the user-properties API](https://developers.luccasoftware.com/api-reference/legacy/directory/guides/user-properties.md): The UserProperties API can be used to retrieve information on the structure of all the properties that can be attached to a user. This API is read-only: only the HTTP `GET` request method is therefore available on this API. - [Extended Data](https://developers.luccasoftware.com/api-reference/legacy/directory/guides/extended-data.md) - [Delegation](https://developers.luccasoftware.com/api-reference/legacy/directory/guides/delegation.md) - [V3 Users to V5 Employees](https://developers.luccasoftware.com/api-reference/legacy/directory/guides/users-migration.md): Migration steps from the legacy /api/v3/users endpoint to the Lucca API employee resources. - [From a User Import File to an API Synchronization](https://developers.luccasoftware.com/api-reference/legacy/directory/guides/users-imports-migration.md): Replace your user import file with an API synchronization, and keep the full history of employments and job positions. - [V4 Work-Contracts to V5 Employments & Job-Positions](https://developers.luccasoftware.com/api-reference/legacy/directory/guides/work-contracts-migration.md): Migration steps from /directory/api/4.0/work-contracts to the Lucca API employment and job-position resources. - [Get Started With Job-Offers](https://developers.luccasoftware.com/api-reference/legacy/recruitment/job-offers/job-offer.md) - [List active job offers](https://developers.luccasoftware.com/api-reference/legacy/recruitment/job-offers/get-job-offers.md): Returns an XML file containing company metadata and a list of all currently open job positions. - [The application resource](https://developers.luccasoftware.com/api-reference/legacy/recruitment/applications/application.md) - [Create a new application for a job opportunity](https://developers.luccasoftware.com/api-reference/legacy/recruitment/applications/post-application.md): This route allows creating a new application for a job opportunity, given candidate information. - [The expense-temp-item resource](https://developers.luccasoftware.com/api-reference/legacy/cleemy-expenses/expenses/expense-temp-item.md) - [List ExpenseTempItems](https://developers.luccasoftware.com/api-reference/legacy/cleemy-expenses/expenses/list-expensetempitems-temporary-expense.md): Retrieve a list of `ExpenseTempItems`. - [Create a new temporary expense](https://developers.luccasoftware.com/api-reference/legacy/cleemy-expenses/expenses/create-a-new-temporary-expense.md): Create a new temporary-expense-item. - [Get an ExpenseTempItem by id](https://developers.luccasoftware.com/api-reference/legacy/cleemy-expenses/expenses/get-an-expensetempitem-by-id.md): Retrieve an temporary expense item by its identifier. - [Update an ExpenseTempItem by id](https://developers.luccasoftware.com/api-reference/legacy/cleemy-expenses/expenses/update-an-expensetempitem-by-id.md): Update a temporary expense item by its identifier. - [The expense-claim resource](https://developers.luccasoftware.com/api-reference/legacy/cleemy-expenses/expenseclaims/expense-claim.md) - [Create a new ExpenseClaim](https://developers.luccasoftware.com/api-reference/legacy/cleemy-expenses/expenseclaims/create-a-new-expenseclaim.md): When a user wants to declare his expenses, he creates an `ExpenseClaim`. - [List ExpenseClaims](https://developers.luccasoftware.com/api-reference/legacy/cleemy-expenses/expenseclaims/list-expenseclaims.md): Retrieve a list of `ExpenseClaims`. - [The expense-claim-item resource](https://developers.luccasoftware.com/api-reference/legacy/cleemy-expenses/expenseclaimitems/expense-claim-item.md) - [List ExpenseClaimItems](https://developers.luccasoftware.com/api-reference/legacy/cleemy-expenses/expenseclaimitems/list-expense-claim-items.md): Retrieve a list of `expenseClaimItems`. - [Get an ExpenseClaimItem by id](https://developers.luccasoftware.com/api-reference/legacy/cleemy-expenses/expenseclaimitems/get-an-expenseclaimitem-by-id.md): Retrieve an expense claim item by its identifier. - [Create an export and retrieve export content](https://developers.luccasoftware.com/api-reference/legacy/cleemy-expenses/exports/post-create-expense-accounting-export.md): Create a new export and retrieve the export content directly in the response body for a given business-establishment. - [Attaching receipts to expenses](https://developers.luccasoftware.com/api-reference/legacy/cleemy-expenses/guides/attaching-receipts.md): Learn how to upload a receipt file and attach it to an expense when using the Expenses API. - [Learn about expenses custom fields](https://developers.luccasoftware.com/api-reference/legacy/cleemy-expenses/guides/about-custom-fields.md): When configuring Lucca Expenses, you may add custom fields to `expense-temp-items` and `expense-claim-items`. - [The cost-center resource](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/cost-centers/cost-center.md) - [List Cost-Centers](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/cost-centers/get-cost-centers.md): List cost-centers. - [Create a Cost-Center](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/cost-centers/post-cost-center.md): Create a new cost-center. - [Get Cost-Center](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/cost-centers/get-cost-center.md): Retrieve a cost-center by its ID. - [Update Cost-Center](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/cost-centers/put-cost-center.md): Update a cost-center. - [Import Cost-Centers](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/cost-centers/import-cost-centers.md): Import a list of cost-centers. Endpoint to use for bulk import of cost-centers. - [The supplier resource](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/suppliers/supplier.md) - [List Suppliers](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/suppliers/get-suppliers.md): List suppliers. - [Create a Supplier](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/suppliers/post-supplier.md): Create a new supplier. - [Get Supplier](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/suppliers/get-supplier.md): Retrieve a supplier by its ID. - [Update Supplier](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/suppliers/put-supplier.md): Update a supplier. - [The nature resource](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/natures/nature.md) - [List Natures](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/natures/get-natures.md): List natures. - [Create a Nature](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/natures/post-nature.md): Create a new nature. - [Get Nature](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/natures/get-nature.md): Retrieve a nature by its ID. - [Update Nature](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/natures/put-nature.md): Update a nature. - [The purchase resource](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/purchases/purchase.md) - [List Purchases](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/purchases/get-purchases.md): List purchases. - [Create a Purchase](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/purchases/post-purchase.md): Create a Purchase. - [Get Purchase](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/purchases/get-purchase.md): Retrieve a purchase by its ID. - [Close a purchase](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/purchases/post-purchase-closing.md): Close a purchase - [The commitment resource](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/purchases/commitment.md) - [Create a commitment](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/purchases/post-purchase-commitment.md): Create a commitment. - [Create a commitment request](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/workflow/post-commitment-request.md): Trigger the approval workflow for a purchase commitment. Request body is expected to be empty. - [Cancel a commitment-request](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/workflow/post-commitment-request-cancellation.md): Cancel a commitment-request. - [The booked-document resource](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/booked-documents/booked-document.md) - [List booked-documents](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/booked-documents/get-booked-documents.md): List booked-documents (i.e. invoices and credit notes). - [The invoice resource](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/invoices/invoice.md) - [Get Invoice](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/invoices/get-invoice.md): Retrieve an invoice by its ID. - [Update Invoice](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/invoices/put-invoice.md): Update an invoice. - [List Invoice Confirmations](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/invoices/get-invoice-confirmations.md): List confirmations for an invoice. - [Confirm an Invoice](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/invoices/post-invoice-confirmation.md): Confirm (approve) an invoice. - [The inbox-document resource](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/inbox/inbox-document.md) - [List Inbox Documents](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/inbox/inbox-document/get-inbox-documents.md): List documents waiting to be processed in the inbox. - [Update Inbox Document](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/inbox/inbox-document/put-inbox-document.md): Update an inbox document and optionally attach or create a purchase. - [Book an Inbox Document](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/inbox/inbox-document/post-inbox-document-booking.md): Book (validate) a document from the inbox. No request body is needed. - [The document resource](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/documents/document.md) - [Get Document](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/documents/get-document.md): Retrieve a document by its ID. - [Update Document](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/documents/put-document.md): Update a document's information (e.g. accounting fields, amounts, supplier details) before booking it. - [Delete Document](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/documents/delete-document.md): Delete a document. - [List V.A.T. rates](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/purchases/get-vat-rates.md): List V.A.T. rates. - [Create an approved order](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/guides/create-approved-order.md): Learn how to create an approved Order in Lucca Invoices - [Retrieve processed invoices](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/guides/retrieve-processed-invoices.md): Learn how to retrieve already processed invoices from Lucca Invoices to sync them with your ERP - [Import cost-centers](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/guides/import-cost-centers.md): Use our API dedicated to import cost centers within Lucca Invoices - [Process an invoice automatically](https://developers.luccasoftware.com/api-reference/legacy/cleemy-invoices/guides/process-invoice-automatically.md): Retrieve inbox documents, update their information, and book them via the API - [The leave resource](https://developers.luccasoftware.com/api-reference/legacy/timmi-absences/leaves/leave.md) - [The leave-account resource](https://developers.luccasoftware.com/api-reference/legacy/timmi-absences/leaves/leave-account.md) - [List leaves](https://developers.luccasoftware.com/api-reference/legacy/timmi-absences/leaves/list-leaves.md): Retrieve a list of approved leaves for one or several users on a given period. - [Get a leave by id](https://developers.luccasoftware.com/api-reference/legacy/timmi-absences/leaves/get-a-leave-by-id.md): Retrieve a single Leave by its unique identifier. - [Cancellation of a leave](https://developers.luccasoftware.com/api-reference/legacy/timmi-absences/leaves/cancellation-of-a-leave.md): Cancel a single Leave by its unique identifier. - [The leave-request resource](https://developers.luccasoftware.com/api-reference/legacy/timmi-absences/leave-requests/leave-request.md) - [The leave-period resource](https://developers.luccasoftware.com/api-reference/legacy/timmi-absences/leave-requests/leave-period.md) - [List leave requests](https://developers.luccasoftware.com/api-reference/legacy/timmi-absences/leave-requests/list-leave-requests.md): Retrieve a list of Leave Requests. - [Get a leave request by id](https://developers.luccasoftware.com/api-reference/legacy/timmi-absences/leave-requests/get-a-leave-request-by-id.md): Retrieve a single Leave Request by its unique identifier. - [The leave-request-approval resource](https://developers.luccasoftware.com/api-reference/legacy/timmi-absences/leave-requests/leave-request-approval.md) - [Approve or deny a leave request](https://developers.luccasoftware.com/api-reference/legacy/timmi-absences/leave-requests/approve-or-deny-a-leave-request.md): Approve or deny a single Leave Request by its unique identifier - [The cancellation-request resource](https://developers.luccasoftware.com/api-reference/legacy/timmi-absences/leave-requests/cancellation-request.md) - [Request to cancel a leave request](https://developers.luccasoftware.com/api-reference/legacy/timmi-absences/leave-requests/request-to-cancel-a-leave-request.md): Request to cancel a single Leave Request by its unique identifier - [The SickLeaveCertificate resource](https://developers.luccasoftware.com/api-reference/legacy/timmi-absences/sick-leave-certificates/sick-leave-certificate.md) - [List SickLeaveCertificates](https://developers.luccasoftware.com/api-reference/legacy/timmi-absences/sick-leave-certificates/list-sick-leave-certificates.md): Retrieve a paginated list of SickLeaveCertificate objects, which contain further information about certain types of leaves. - [Get a SickLeaveCertificate](https://developers.luccasoftware.com/api-reference/legacy/timmi-absences/sick-leave-certificates/get-sick-leave-certificate.md): Retrieve a single SickLeaveCertificate. - [Import entitlements](https://developers.luccasoftware.com/api-reference/legacy/timmi-absences/imports/import-entitlements.md): **Import entitlements** credits leave accounts by **adding** the values provided in the import file to the employees' existing balances. Each value in the file is treated as a new credit entry, increasing the current entitlement total. This operation generates new accounting entries of type "entitle… - [Replace entitlements](https://developers.luccasoftware.com/api-reference/legacy/timmi-absences/imports/replace-entitlements.md): **Replace entitlements** adjusts leave accounts so that the entitlement total for selected entry types **matches exactly** the values provided in the import file. The system computes the difference between the target value and the current entitlement total (based on the `EntryTypes` parameter), then… - [Import leaves](https://developers.luccasoftware.com/api-reference/legacy/timmi-absences/imports/import-leaves.md): Create absences in batch from a CSV file. - [Get import leaves progress](https://developers.luccasoftware.com/api-reference/legacy/timmi-absences/imports/get-import-leaves-progress.md): Retrieve the progress of Import leaves API request. - [Import vs. Replace entitlements](https://developers.luccasoftware.com/api-reference/legacy/timmi-absences/guides/entitlements-imports.md): Understand the differences between Import entitlements and Replace entitlements, their business and technical impact, and how to call each endpoint. - [Syncing leaves](https://developers.luccasoftware.com/api-reference/legacy/timmi-absences/guides/syncing-leaves.md) - [Migrate from leaves v2](https://developers.luccasoftware.com/api-reference/legacy/timmi-absences/guides/migrate-from-leaves-v2.md) - [The user-location resource](https://developers.luccasoftware.com/api-reference/legacy/timmi-office/user-locations/user-location.md) - [List userLocations](https://developers.luccasoftware.com/api-reference/legacy/timmi-office/user-locations/list-user-locations.md): Query employees work locations - [Get specific userLocation](https://developers.luccasoftware.com/api-reference/legacy/timmi-office/user-locations/get-user-location.md): Get specific userLocation by id - [The work-location resource](https://developers.luccasoftware.com/api-reference/legacy/timmi-office/work-locations/work-location.md) - [List workLocations](https://developers.luccasoftware.com/api-reference/legacy/timmi-office/work-locations/list-work-locations.md): Query all available work locations - [Retrieve specific workLocation](https://developers.luccasoftware.com/api-reference/legacy/timmi-office/work-locations/get-work-location.md): Get a specific work location by id - [Import user locations](https://developers.luccasoftware.com/api-reference/legacy/timmi-office/imports/import-user-locations.md): Create user locations in batch from a CSV file. - [Get import user locations progress](https://developers.luccasoftware.com/api-reference/legacy/timmi-office/imports/get-import-user-locations-progress.md): Retrieve the progress of the Import User Locations API request. - [Get import user locations analysis](https://developers.luccasoftware.com/api-reference/legacy/timmi-office/imports/get-import-user-locations-analysis.md): Retrieve the analysis of the Import User Locations API request with the create parameter set to false. - [Get import user locations results](https://developers.luccasoftware.com/api-reference/legacy/timmi-office/imports/get-import-user-locations-results.md): Retrieve the results of the Import User Locations API request with the create parameter set to true. - [Import user locations](https://developers.luccasoftware.com/api-reference/legacy/timmi-office/guides/import-and-create-user-locations.md) - [The client resource](https://developers.luccasoftware.com/api-reference/legacy/timmi-project/clients/client.md) - [List Clients](https://developers.luccasoftware.com/api-reference/legacy/timmi-project/clients/list-clients.md): List clients from an organization. - [Create a new Client](https://developers.luccasoftware.com/api-reference/legacy/timmi-project/clients/create-a-new-client.md): Create a new client. - [Get a Client by id](https://developers.luccasoftware.com/api-reference/legacy/timmi-project/clients/get-a-client-by-id.md): Retrieve a single client identified by its unique identifier. - [Update a Client by id](https://developers.luccasoftware.com/api-reference/legacy/timmi-project/clients/update-a-client-by-id.md): Update fields of a single client identified by its unique id. - [Delete a Client by id](https://developers.luccasoftware.com/api-reference/legacy/timmi-project/clients/delete-a-client-by-id.md): Delete a single client. Deletion is irrevocable. - [The project resource](https://developers.luccasoftware.com/api-reference/legacy/timmi-project/projects/project.md) - [List Projects](https://developers.luccasoftware.com/api-reference/legacy/timmi-project/projects/list-projects.md): List projects from an organization. Only returns a subset of a [Project](reference/Timmi-Project.yaml/components/schemas/Project) fields. - [Create a new Project](https://developers.luccasoftware.com/api-reference/legacy/timmi-project/projects/create-a-new-project.md): Create a new Project - [Get Project by id](https://developers.luccasoftware.com/api-reference/legacy/timmi-project/projects/get-project-by-id.md): Retrieve a project by its unique identifier. - [Update a Project by id](https://developers.luccasoftware.com/api-reference/legacy/timmi-project/projects/update-a-project-by-id.md): Update an existing Project. - [Delete a Project by id](https://developers.luccasoftware.com/api-reference/legacy/timmi-project/projects/delete-a-project-by-id.md): Only projects at "draft" status can be deleted. - [The project-service resource](https://developers.luccasoftware.com/api-reference/legacy/timmi-project/project-services/project-service.md) - [List a Project's Services](https://developers.luccasoftware.com/api-reference/legacy/timmi-project/project-services/list-a-projects-services.md): List all services from a project identified by its unique id. - [Create a new Project Service](https://developers.luccasoftware.com/api-reference/legacy/timmi-project/project-services/create-a-new-project-service.md): Create a new Project Service on a project. - [The organization resource](https://developers.luccasoftware.com/api-reference/legacy/timmi-project/organizations/organization.md) - [List Organizations](https://developers.luccasoftware.com/api-reference/legacy/timmi-project/organizations/list-organizations.md): List organizations. - [The project-financials resource](https://developers.luccasoftware.com/api-reference/legacy/timmi-project/financials/project-financials.md) - [List financials by project](https://developers.luccasoftware.com/api-reference/legacy/timmi-project/financials/list-financials-by-project.md): Retrieve all financial metrics on projects. - [Get Started with the Schedule API](https://developers.luccasoftware.com/api-reference/legacy/schedule/get-started.md) - [The working-time-arrangement resource](https://developers.luccasoftware.com/api-reference/legacy/schedule/working-time-arrangements/working-time-arrangement.md) - [List Working Time Arrangements.](https://developers.luccasoftware.com/api-reference/legacy/schedule/working-time-arrangements/list-working-time-arrangements.md): You may not benefit from this feature. Working-time-arrangements are the replacement for the workcycles. If this feature has not been deployed on your environment, please contact our support. - [Get a Working Time Arrangement by id.](https://developers.luccasoftware.com/api-reference/legacy/schedule/working-time-arrangements/get-working-time-arrangement.md): **This is a beta feature.** You may not benefit from this feature. Working-time-arrangements are the replacement for the workcycles. If this feature has not been deployed on your environment, please contact our support. - [The collective-schedule resource](https://developers.luccasoftware.com/api-reference/legacy/schedule/working-time-arrangements/collective-schedule.md) - [List Collective Schedules from a Working Time Arrangement](https://developers.luccasoftware.com/api-reference/legacy/schedule/working-time-arrangements/list-collective-schedules.md): **This is a beta feature.** You may not benefit from this feature. Working-time-arrangements are the replacement for the workcycles. If this feature has not been deployed on your environment, please contact our support. - [Get a Collective Schedule from a Working Time Arrangement by id.](https://developers.luccasoftware.com/api-reference/legacy/schedule/working-time-arrangements/get-collective-schedule.md): **This is a beta feature.** You may not benefit from this feature. Working-time-arrangements are the replacement for the workcycles. If this feature has not been deployed on your environment, please contact our support. - [The employee-assignment resource](https://developers.luccasoftware.com/api-reference/legacy/schedule/employee-assignments/employee-assignment.md) - [List Employee Assignments](https://developers.luccasoftware.com/api-reference/legacy/schedule/employee-assignments/list-employee-assignments.md): You may not benefit from this feature. Working-time-arrangements are the replacement for the workcycles. If this feature has not been deployed on your environment, please contact our support. - [Assign a Working Time Arrangement to an Employee](https://developers.luccasoftware.com/api-reference/legacy/schedule/employee-assignments/assign-working-time-arrangement-to-employee.md): You may not benefit from this feature. Working-time-arrangements are the replacement for the workcycles. If this feature has not been deployed on your environment, please contact our support. - [The workcycle-exception resource](https://developers.luccasoftware.com/api-reference/legacy/schedule/workcycle-exceptions/workcycle-exception.md) - [List WorkCycleExceptions.](https://developers.luccasoftware.com/api-reference/legacy/schedule/workcycle-exceptions/list-workcycle-exceptions.md): Retrieve a paginated list of WorkCycleExceptions that satisfy the given query filters. - [Create (or update) a WorkCycleException.](https://developers.luccasoftware.com/api-reference/legacy/schedule/workcycle-exceptions/create-workcycle-exception.md): An employee can only have a single `WorkCycleException` on any given half-day (indicated by the `startsAt` date and the `isAm` boolean). As a result, creating a new `WorkCycleException` via a POST request may result in the update of the existing one. - [Retrieve a WorkCycleException.](https://developers.luccasoftware.com/api-reference/legacy/schedule/workcycle-exceptions/get-workcycle-exception.md): Retrieve a single WorkCycleException by its ID. - [Delete a WorkCycleException.](https://developers.luccasoftware.com/api-reference/legacy/schedule/workcycle-exceptions/delete-workcycle-exception.md): The `WorkCycleException`, once deleted, stays available in the API. - [The shift-override resource](https://developers.luccasoftware.com/api-reference/legacy/schedule/shift-overrides/shift-override.md) - [List ShiftOverrides.](https://developers.luccasoftware.com/api-reference/legacy/schedule/shift-overrides/list-shift-overrides.md): Retrieve a paginated list of ShiftOverrides that satisfy the given query filters. - [Replace ShiftOverrides for an employee.](https://developers.luccasoftware.com/api-reference/legacy/schedule/shift-overrides/replace-shift-overrides.md): Replace all ShiftOverrides for a given employee within the specified date range. - [The user-date resource](https://developers.luccasoftware.com/api-reference/legacy/schedule/userdates/userdate.md) - [List UserDates.](https://developers.luccasoftware.com/api-reference/legacy/schedule/userdates/list-userdates.md): Retrieve a list of UserDates. - [The time-entry resource](https://developers.luccasoftware.com/api-reference/legacy/timmi-timesheet/time-entries/time-entry.md) - [List multiple time-entries](https://developers.luccasoftware.com/api-reference/legacy/timmi-timesheet/time-entries/list-timeentries.md): List all time-entries satisfying query filters. - [Create new time-entries](https://developers.luccasoftware.com/api-reference/legacy/timmi-timesheet/time-entries/create-new-timeentries.md): Create one or multiple time-entries. - [Update multiple time-entries](https://developers.luccasoftware.com/api-reference/legacy/timmi-timesheet/time-entries/update-multiple-timeentries.md): Update one or several time-entries. - [Delete multiple time-entries](https://developers.luccasoftware.com/api-reference/legacy/timmi-timesheet/time-entries/delete-multiple-timeentries.md): Delete one or several time-entries. Deletion is irrevocable. - [Get a time-entry by id](https://developers.luccasoftware.com/api-reference/legacy/timmi-timesheet/time-entries/get-a-timeentry-by-id.md): Retrieve a single time-entry identified by its unique identifier. - [Update a time-entry by id](https://developers.luccasoftware.com/api-reference/legacy/timmi-timesheet/time-entries/update-a-time-entry-by-id.md): Update fields of a single time-entry identified by its unique id. - [Delete a time-entry by id](https://developers.luccasoftware.com/api-reference/legacy/timmi-timesheet/time-entries/delete-a-time-entry-by-id.md): Delete a time-entry. Deletion is irrevocable. - [TimeEntries update service](https://developers.luccasoftware.com/api-reference/legacy/timmi-timesheet/time-entries/import-time-entries.md): ## Before using this service - [The timesheet resource](https://developers.luccasoftware.com/api-reference/legacy/timmi-timesheet/timesheets/timesheet.md) - [List timesheets](https://developers.luccasoftware.com/api-reference/legacy/timmi-timesheet/timesheets/list-timesheets.md): List all timesheets satisfying query filters. - [List due timesheets](https://developers.luccasoftware.com/api-reference/legacy/timmi-timesheet/timesheets/list-due-timesheets.md): List timesheets that are not yet submitted (status: 0). - [Remind Timesheets](https://developers.luccasoftware.com/api-reference/legacy/timmi-timesheet/workflow/remind-timesheets.md): Remind users of a due timesheet. Sends him/her an email. - [The transfer object](https://developers.luccasoftware.com/api-reference/legacy/timmi-timesheet/workflow/transfer.md) - [Submit timesheets](https://developers.luccasoftware.com/api-reference/legacy/timmi-timesheet/workflow/submit-timesheets.md): Submit all timesheets for an owner up to the given period, or to the last submittable timesheet. - [Approve a timesheet](https://developers.luccasoftware.com/api-reference/legacy/timmi-timesheet/workflow/approve-timesheet.md): Approve once the timesheet referenced by its ID, and any timesheets before it pending approval belonging to the same timesheet owner. - [Cancel a timesheet](https://developers.luccasoftware.com/api-reference/legacy/timmi-timesheet/workflow/cancel-timesheet.md): Cancel a timesheet referenced by its ID, and any timesheets after it pending approval belonging to the same timesheet owner. - [Deny a timesheet](https://developers.luccasoftware.com/api-reference/legacy/timmi-timesheet/workflow/deny-timesheet.md): Deny a timesheet with a mandatory comment. - [Invalidate a timesheet](https://developers.luccasoftware.com/api-reference/legacy/timmi-timesheet/workflow/invalidate-timesheet.md): Invalidate a timesheet with a mandatory comment. - [The report resource](https://developers.luccasoftware.com/api-reference/legacy/timmi-timesheet/reports/report.md) - [Create a new Report](https://developers.luccasoftware.com/api-reference/legacy/timmi-timesheet/reports/create-a-report.md): This endpoint does not adhere to the "v3 API endpoints" principles. The "fields" query parameter is not supported, but all fields are systematically returned. - [Download Report as CSV](https://developers.luccasoftware.com/api-reference/legacy/timmi-timesheet/reports/download-report-as-csv.md): This endpoint does not adhere to the "v3 API endpoints" principles. The "fields" query parameter is not supported, but all fields are systematically returned. - [Download Report as Excel](https://developers.luccasoftware.com/api-reference/legacy/timmi-timesheet/reports/download-report-as-excel.md): This endpoint does not adhere to the "v3 API endpoints" principles. The "fields" query parameter is not supported, but all fields are systematically returned. - [How To Retrieve TimeEntries](https://developers.luccasoftware.com/api-reference/legacy/timmi-timesheet/guides/retrieve-time-entries.md) - [How to Update TimeEntries](https://developers.luccasoftware.com/api-reference/legacy/timmi-timesheet/guides/update-time-entries.md) - [How to Submit Timesheets](https://developers.luccasoftware.com/api-reference/legacy/timmi-timesheet/guides/mass-submit-timesheets.md) - [How to Reject Timesheets](https://developers.luccasoftware.com/api-reference/legacy/timmi-timesheet/guides/mass-rejection-timesheets.md) - [How to Download Reports](https://developers.luccasoftware.com/api-reference/legacy/timmi-timesheet/guides/download-report.md) - [How to Mass Delete TimeEntries](https://developers.luccasoftware.com/api-reference/legacy/timmi-timesheet/guides/mass-deletion-timeentries.md) - [Export from Lucca Timesheet](https://developers.luccasoftware.com/api-reference/legacy/timmi-timesheet/guides/exports.md): Learn how to use the export feature of Lucca Timesheet through the API. In particular, **how to generate a new export and retrieve its content**. - [List statutories](https://developers.luccasoftware.com/api-reference/legacy/pagga-mealvouchers/statutory/list-statutories.md): Retrieve all existing statutories. A statutory is the object that contains the application settings. - [Retrieve a statutory](https://developers.luccasoftware.com/api-reference/legacy/pagga-mealvouchers/statutory/retrieve-a-statutory.md): Retrieve a single statutory by its ID. - [Retrieve a statutory's parameters](https://developers.luccasoftware.com/api-reference/legacy/pagga-mealvouchers/statutory/retrieve-a-statutorys-parameters.md): Retrieve all general parameters of a specific statutory - [List a statutory's distributions](https://developers.luccasoftware.com/api-reference/legacy/pagga-mealvouchers/statutory/list-a-statutorys-distributions.md): Retrieve all distributions of a specific statutory - [Retrieve a computation's details](https://developers.luccasoftware.com/api-reference/legacy/pagga-mealvouchers/computation/retrieve-a-computations-details.md): A computation's details indicate the number of meal voucher to be given to each employee subject to the applicable statutory. - [The fixed-nature resource](https://developers.luccasoftware.com/api-reference/legacy/pagga-remuneration/fixed-natures/fixed-nature.md) - [List fixed natures](https://developers.luccasoftware.com/api-reference/legacy/pagga-remuneration/fixed-natures/list-fixed-natures.md): Retrieve all existing fixed natures - [Get a fixed nature](https://developers.luccasoftware.com/api-reference/legacy/pagga-remuneration/fixed-natures/get-fixed-nature.md): Retrieve a single fixed nature from its identifier - [The fixed-nature-category resource](https://developers.luccasoftware.com/api-reference/legacy/pagga-remuneration/fixed-natures/fixed-nature-category.md) - [List fixed nature categories](https://developers.luccasoftware.com/api-reference/legacy/pagga-remuneration/fixed-natures/list-fixed-nature-categories.md): List fixed-nature categories. - [The fixed-item resource](https://developers.luccasoftware.com/api-reference/legacy/pagga-remuneration/fixed-items/fixed-item.md) - [List fixed items](https://developers.luccasoftware.com/api-reference/legacy/pagga-remuneration/fixed-items/list-fixed-items.md): Retrieve fixed remuneration items matching a set of filters - [The variable-nature resource](https://developers.luccasoftware.com/api-reference/legacy/pagga-remuneration/variable-natures/variable-nature.md) - [List variable natures](https://developers.luccasoftware.com/api-reference/legacy/pagga-remuneration/variable-natures/list-variable-natures.md): Retrieve all existing variable natures - [Get a variable nature](https://developers.luccasoftware.com/api-reference/legacy/pagga-remuneration/variable-natures/get-variable-nature.md): Retrieve a single variable nature from its identifier - [The variable-nature-category resource](https://developers.luccasoftware.com/api-reference/legacy/pagga-remuneration/variable-natures/variable-nature-category.md) - [List variable nature categories](https://developers.luccasoftware.com/api-reference/legacy/pagga-remuneration/variable-natures/list-variable-nature-categories.md): List variable-nature-categories - [The variable-item resource](https://developers.luccasoftware.com/api-reference/legacy/pagga-remuneration/variable-items/variable-item.md) - [List variable items](https://developers.luccasoftware.com/api-reference/legacy/pagga-remuneration/variable-items/list-variable-items.md): Retrieve variable remuneration items matching a set of filters - [Create a variable item](https://developers.luccasoftware.com/api-reference/legacy/pagga-remuneration/variable-items/create-variable-item.md): Create a new variable item attached to an employee work contract. - [Retrieve a variable item](https://developers.luccasoftware.com/api-reference/legacy/pagga-remuneration/variable-items/get-variable-item.md): Retrieve a single variable item by id. - [Update a variable-item](https://developers.luccasoftware.com/api-reference/legacy/pagga-remuneration/variable-items/update-variable-item.md): Update a variable-item. - [Delete a variable-item](https://developers.luccasoftware.com/api-reference/legacy/pagga-remuneration/variable-items/delete-variable-item.md): Delete a variable-item. - [Create a completed course in Lucca](https://developers.luccasoftware.com/api-reference/legacy/poplee-training/guides/create-a-completed-course-in-lucca.md): Learn how to create a completed course in Lucca for all your employees. This is useful for consolidating all completed courses, regardless of where they took place—for example, courses from an e-learning LMS platform. This integration simplifies how managers and employees track completed courses and… - [Create a training](https://developers.luccasoftware.com/api-reference/legacy/poplee-training/guides/create-a-training.md): Learn how to create a new training with the state ‘ready’ in Lucca training. - [The training-provider resource](https://developers.luccasoftware.com/api-reference/legacy/poplee-training/trainings/training-provider.md) - [List training-providers](https://developers.luccasoftware.com/api-reference/legacy/poplee-training/trainings/list-training-providers.md): Retrieve a paginated list of training-providers. - [The training-category resource](https://developers.luccasoftware.com/api-reference/legacy/poplee-training/trainings/training-category.md) - [List training-categories](https://developers.luccasoftware.com/api-reference/legacy/poplee-training/trainings/list-training-categories.md): Retrieve a paginated list of training-categories. - [The training resource](https://developers.luccasoftware.com/api-reference/legacy/poplee-training/trainings/training-v1.md) - [List trainings](https://developers.luccasoftware.com/api-reference/legacy/poplee-training/trainings/get-trainings-v1.md): Retrieve a paginated list of trainings. - [Create a training](https://developers.luccasoftware.com/api-reference/legacy/poplee-training/trainings/post-training-v1.md): Creates a training with the state 'ready', which by default is not displayed in the public catalog. - [The training-demand resource](https://developers.luccasoftware.com/api-reference/legacy/poplee-training/training-demands/training-demand.md) - [List training-demands](https://developers.luccasoftware.com/api-reference/legacy/poplee-training/training-demands/list-training-demands.md): Retrieve a paginated list of training-demands that satisfy the query filters. - [The realized-training resource](https://developers.luccasoftware.com/api-reference/legacy/poplee-training/realized-trainings/realized-training.md) - [List realized-trainings](https://developers.luccasoftware.com/api-reference/legacy/poplee-training/realized-trainings/list-realized-trainings.md): Retrieve a paginated list of realized-trainings for all employees who were present at a closed session. It also includes all realized training that have been manually imported via CSV file into Lucca Training. - [The realized-training (v2) resource](https://developers.luccasoftware.com/api-reference/legacy/poplee-training/realized-trainings/realized-training-v2.md) - [List realized-trainings (v2)](https://developers.luccasoftware.com/api-reference/legacy/poplee-training/realized-trainings/get-realized-trainings-v2.md): Retrieve a paginated list of realized trainings. It includes all realized trainings that have been manually imported via CSV file, imported through the process in Lucca Training, or created via the API. - [Create a realized-training (v2)](https://developers.luccasoftware.com/api-reference/legacy/poplee-training/realized-trainings/post-realized-trainings-v2.md): Create a new realized training. It must refer to a training that is in the 'ready' state, and the sessionEndsOn date must be in the past. It is also not possible to create two realized trainings for the same employee with the same trainingId and sessionEndsOn. - [Get a realized-training (v2)](https://developers.luccasoftware.com/api-reference/legacy/poplee-training/realized-trainings/get-realized-training-v2.md): Retrieve a single realized-training by its id. - [Delete a realized-training (v2)](https://developers.luccasoftware.com/api-reference/legacy/poplee-training/realized-trainings/delete-realized-training-v2.md): Delete a realized training by its id. - [Lucca Developers Hub](https://developers.luccasoftware.com/home.md) - [The Lucca API](https://developers.luccasoftware.com/documentation/get-started/introduction.md): The Lucca API is the unified, documented, long-term supported and irresistible API for all of Lucca's enterprise applications. - [Quick Start](https://developers.luccasoftware.com/documentation/get-started/quickstart.md): Start building integrations with the Lucca API - [URL & Environments](https://developers.luccasoftware.com/documentation/get-started/environments.md): The base URL of the Lucca API depends on your account, region and environment. - [Get Started With Authentication](https://developers.luccasoftware.com/documentation/using-api/authentication.md): Learn how to authenticate to the Lucca API - [Create Access-Token](https://developers.luccasoftware.com/documentation/using-api/authentication-spec.md): Generate a new access-token for a client application (OAuth 2.0 client credentials flow). - [Versioning](https://developers.luccasoftware.com/documentation/using-api/versioning.md): Learn how to target a specific version - [Filtering](https://developers.luccasoftware.com/documentation/using-api/filtering.md): Learn how to return a subset of a collection's items. - [Pagination](https://developers.luccasoftware.com/documentation/using-api/paging.md): Learn how to iterate through a collection's pages. - [Sorting](https://developers.luccasoftware.com/documentation/using-api/sorting.md): You can sort items of most collections thanks to the `sort` query parameter. - [Includes](https://developers.luccasoftware.com/documentation/using-api/includes.md): Expand responses to retrieve more data. - [Error Handling](https://developers.luccasoftware.com/documentation/using-api/errors.md): Learn how to handle errors. - [HTTP Cache](https://developers.luccasoftware.com/documentation/using-api/cache.md): Learn how to take advantage of the HTTP cache to reduce bandwidth. - [Data Types & Formatting](https://developers.luccasoftware.com/documentation/using-api/data-types.md): The Lucca API normalizes the formatting of some data types. - [Translations (t9n) & Localization (l10n)](https://developers.luccasoftware.com/documentation/using-api/t9n.md): Learn how the Lucca API handles translations. - [Get Started With Webhooks & Events](https://developers.luccasoftware.com/documentation/webhooks/get-started.md): Use incoming webhook events to get real-time updates - [Get Started](https://developers.luccasoftware.com/documentation/webhooks/catching/get-started.md): Learn how to receive events. - [Receive events](https://developers.luccasoftware.com/documentation/webhooks/catching/spec-receive.md): How to respond to a POST request against your endpoint. - [Respond to Activation](https://developers.luccasoftware.com/documentation/webhooks/catching/spec-activate.md): How to respond to the challenge required for your webhook-endpoint activation. - [Validating events](https://developers.luccasoftware.com/documentation/webhooks/catching/validate.md): Protect your webhook-endpoint by validating incoming events. - [Declare Your Webhook-Endpoint](https://developers.luccasoftware.com/documentation/webhooks/catching/declare.md): Once implemented, declare your webhook-endpoint in your Lucca account. - [Troubleshooting](https://developers.luccasoftware.com/documentation/webhooks/troubleshooting.md) - [Sandbox](https://developers.luccasoftware.com/documentation/sandbox.md): Deploy and manage your sandbox environment. - [Limits](https://developers.luccasoftware.com/documentation/limits.md): To maintain consistent response times for all users, limits are placed on how the Lucca API can be consumed. - [Breaking Changes](https://developers.luccasoftware.com/documentation/breaking-changes.md): When backwards-incompatible changes are made to the API, we release a new, dated version. Here is the list of changes we consider breaking. - [Playground](https://developers.luccasoftware.com/documentation/playground.md): Learn how to use the API playground. - [Security Best Practices](https://developers.luccasoftware.com/documentation/security.md): Your Lucca account contains sensitive data which you wouldn't want leaked. - [Support](https://developers.luccasoftware.com/documentation/support.md): Find answers to the most frequently asked questions or encountered problems. - [API Guidelines](https://developers.luccasoftware.com/documentation/guidelines.md): Design principles behind the Lucca API. - [The Lucca API](https://developers.luccasoftware.com/api-reference/latest/introduction.md): The reference of the `2024-11-01` version of the Lucca API. - [Create Access-Token](https://developers.luccasoftware.com/api-reference/latest/create-access-token.md): Generate a new access-token for a client application (OAuth 2.0 client credentials flow). - [OAuth scopes](https://developers.luccasoftware.com/api-reference/latest/oauth-scopes.md) - [API lifecycle](https://developers.luccasoftware.com/api-reference/latest/lifecycle.md) - [Download the OpenAPI specification](https://developers.luccasoftware.com/api-reference/latest/download.md): The OpenAPI specification of the Lucca API is available for download. It can be used to generate client libraries, create API documentation, and more. - [Get Started](https://developers.luccasoftware.com/api-reference/latest/files/get-started.md): Introduction to the Files Management Sub-system. - [The file resource](https://developers.luccasoftware.com/api-reference/latest/files/file.md) - [Upload a file](https://developers.luccasoftware.com/api-reference/latest/files/post-files.md): Upload a file in order to reference it as the attachment of another resource (e.g. a portrait). - [Retrieve a file](https://developers.luccasoftware.com/api-reference/latest/files/get-file.md): Retrieve a file, either its JSON representation or its content. - [Get Started](https://developers.luccasoftware.com/api-reference/latest/organization/get-started.md) - [The legal-entity resource](https://developers.luccasoftware.com/api-reference/latest/organization/legal-entity.md) - [List legal-entities](https://developers.luccasoftware.com/api-reference/latest/organization/get-legal-entities.md): Returns a paginated list of legal-entities. - [Retrieve a legal-entity](https://developers.luccasoftware.com/api-reference/latest/organization/get-legal-entity.md): Retrieve a legal-entity. - [The business-establishment resource](https://developers.luccasoftware.com/api-reference/latest/organization/business-establishment.md) - [List business-establishments](https://developers.luccasoftware.com/api-reference/latest/organization/list-business-establishments.md): List business-establishments. - [Retrieve a business-establishment](https://developers.luccasoftware.com/api-reference/latest/organization/get-business-establishment.md): Retrieve a business-establishment. - [The department resource](https://developers.luccasoftware.com/api-reference/latest/organization/department.md) - [List departments](https://developers.luccasoftware.com/api-reference/latest/organization/get-departments.md): Returns a paginated list of departments. - [Create a department](https://developers.luccasoftware.com/api-reference/latest/organization/post-departments.md): Create a new department. - [Retrieve a department](https://developers.luccasoftware.com/api-reference/latest/organization/get-department.md): Retrieve a single department by ID. - [Update a department](https://developers.luccasoftware.com/api-reference/latest/organization/patch-department.md): Update a department. - [Get Started With Taxonomies](https://developers.luccasoftware.com/api-reference/latest/taxonomies/get-started.md): Learn what taxonomies are and how to list available values for extension properties. - [The taxonomy resource](https://developers.luccasoftware.com/api-reference/latest/taxonomies/taxonomy.md) - [List taxonomies](https://developers.luccasoftware.com/api-reference/latest/taxonomies/get-taxonomies.md): Returns a paginated list of taxonomies. - [Create a taxonomy](https://developers.luccasoftware.com/api-reference/latest/taxonomies/post-taxonomy.md): Create a new taxonomy. - [Retrieve a taxonomy](https://developers.luccasoftware.com/api-reference/latest/taxonomies/get-taxonomy.md): Retrieve a taxonomy by its ID. - [Replace a taxonomy](https://developers.luccasoftware.com/api-reference/latest/taxonomies/put-taxonomy.md): Replace a taxonomy. This is a retroactive action. - [Update a taxonomy](https://developers.luccasoftware.com/api-reference/latest/taxonomies/patch-taxonomy.md): Update a taxonomy. This is a retroactive action. - [Delete a taxonomy](https://developers.luccasoftware.com/api-reference/latest/taxonomies/delete-taxonomy.md): Deleting a taxonomy results in the deletion of all its [taxonomy-labels](/api-reference/2024-11-01/taxonomies/taxonomy-label). - [The taxonomy-label resource](https://developers.luccasoftware.com/api-reference/latest/taxonomies/taxonomy-label.md) - [List taxonomy-labels](https://developers.luccasoftware.com/api-reference/latest/taxonomies/get-taxonomy-labels.md): Returns a paginated list of taxonomy-labels. - [Create a taxonomy-label](https://developers.luccasoftware.com/api-reference/latest/taxonomies/post-taxonomy-label.md): Create a new taxonomy-label. - [Retrieve a taxonomy-label](https://developers.luccasoftware.com/api-reference/latest/taxonomies/get-taxonomy-label.md): Retrieve a taxonomy-label by its ID. - [Replace a taxonomy-label](https://developers.luccasoftware.com/api-reference/latest/taxonomies/put-taxonomy-label.md): Replace a taxonomy-label. - [Update a taxonomy-label](https://developers.luccasoftware.com/api-reference/latest/taxonomies/patch-taxonomy-label.md): Update a taxonomy-label. - [Delete a taxonomy-label](https://developers.luccasoftware.com/api-reference/latest/taxonomies/delete-taxonomy-label.md): Permanently delete a taxonomy-label by its ID. To hide a label while keeping it, archive it with `PATCH` and `isArchived: true` instead. - [Get Started With Employees](https://developers.luccasoftware.com/api-reference/latest/employees/get-started.md): Learn more about the employee resource and its relations with other resources. - [Get Started With Employee Attributes](https://developers.luccasoftware.com/api-reference/latest/employee-attributes/get-started.md): Learn what employee-attributes are and how to use them to read and write any employee property in a uniform way. - [The employee-attribute-definition resource](https://developers.luccasoftware.com/api-reference/latest/employee-attributes/employee-attribute-definition.md) - [List employee-attribute-definitions](https://developers.luccasoftware.com/api-reference/latest/employee-attributes/get-employee-attribute-definitions.md): Returns a paginated list of employee-attribute-definitions. - [Create an employee-attribute-definition](https://developers.luccasoftware.com/api-reference/latest/employee-attributes/post-employee-attribute-definition.md): Create a new employee-attribute-definition. - [Retrieve an employee-attribute-definition](https://developers.luccasoftware.com/api-reference/latest/employee-attributes/get-employee-attribute-definition.md): Retrieve a single employee-attribute-definition by ID. - [Replace an employee-attribute-definition](https://developers.luccasoftware.com/api-reference/latest/employee-attributes/put-employee-attribute-definition.md): Replace an employee-attribute-definition. - [Update an employee-attribute-definition](https://developers.luccasoftware.com/api-reference/latest/employee-attributes/patch-employee-attribute-definition.md): Update an employee-attribute-definition. - [Delete an employee-attribute-definition](https://developers.luccasoftware.com/api-reference/latest/employee-attributes/delete-employee-attribute-definition.md): Archive an employee-attribute-definition by ID. - [Employee Attribute Definition Schemas](https://developers.luccasoftware.com/api-reference/latest/employee-attributes/attribute-definition-schemas.md): Learn how to define and read the (JSON) schema of an employee-attribute-definition. - [The employee-attribute resource](https://developers.luccasoftware.com/api-reference/latest/employee-attributes/employee-attribute.md) - [List employee-attributes](https://developers.luccasoftware.com/api-reference/latest/employee-attributes/get-employee-attributes.md): Returns a paginated list of employee-attributes. - [Create an employee-attribute](https://developers.luccasoftware.com/api-reference/latest/employee-attributes/post-employee-attribute.md): Create a new employee-attribute. - [Retrieve an employee-attribute](https://developers.luccasoftware.com/api-reference/latest/employee-attributes/get-employee-attribute.md): Retrieve a single employee-attribute by ID. - [Replace an employee-attribute](https://developers.luccasoftware.com/api-reference/latest/employee-attributes/put-employee-attribute.md): Replace the value of an employee-attribute. - [Update an employee-attribute](https://developers.luccasoftware.com/api-reference/latest/employee-attributes/patch-employee-attribute.md): Update an employee-attribute. - [The employee resource](https://developers.luccasoftware.com/api-reference/latest/employees/employee.md) - [List employees](https://developers.luccasoftware.com/api-reference/latest/employees/get-employees.md): Returns a paginated list of employees. - [Create an employee](https://developers.luccasoftware.com/api-reference/latest/employees/post-employees.md): When creating an employee, you MUST also indicate their first employment, as an employee must belong to a [legal-entity](/api-reference/2024-11-01/organization/legal-entity) at all time. - [Retrieve an employee](https://developers.luccasoftware.com/api-reference/latest/employees/get-employee.md): Retrieve a single employee. - [Update an employee](https://developers.luccasoftware.com/api-reference/latest/employees/patch-employee.md): Update an employee. - [The portrait resource](https://developers.luccasoftware.com/api-reference/latest/employees/portrait.md) - [Retrieve/Download a portrait](https://developers.luccasoftware.com/api-reference/latest/employees/get-portrait.md): Retrieve a single employee portrait, either as a JSON representation, or the actual image file. - [The employee-personal-record resource](https://developers.luccasoftware.com/api-reference/latest/employees/employee-personal-record.md) - [List employee-personal-records](https://developers.luccasoftware.com/api-reference/latest/employees/get-employee-personal-records.md): Retrieve a paginated list of employee-personal-records. - [Retrieve an employee-personal-record](https://developers.luccasoftware.com/api-reference/latest/employees/get-employee-personal-record.md): Retrieve an employee-personal-record. - [The employment resource](https://developers.luccasoftware.com/api-reference/latest/employments/employment.md) - [List employments](https://developers.luccasoftware.com/api-reference/latest/employments/get-employments.md): Returns a paginated list of employments. - [Create an employment](https://developers.luccasoftware.com/api-reference/latest/employments/post-employments.md): Create an employment for a employee in a legal-entity. No two employments of a given employee may overlap. - [Retrieve an employment](https://developers.luccasoftware.com/api-reference/latest/employments/get-employment.md): Retrieve an employment by its ID. - [Update an employment](https://developers.luccasoftware.com/api-reference/latest/employments/patch-employment.md): Update an employment. This is a retroactive action. - [Delete an employment](https://developers.luccasoftware.com/api-reference/latest/employments/delete-employment.md): You cannot delete the employment of an employee if it is the only one they have. In this case, please update it. - [The employment-template resource](https://developers.luccasoftware.com/api-reference/latest/employments/employment-template.md) - [List employment-templates](https://developers.luccasoftware.com/api-reference/latest/employments/get-employment-templates.md): Retrieve a paginated list of employment-templates. - [Retrieve an employment-template](https://developers.luccasoftware.com/api-reference/latest/employments/get-employment-template.md): Retrieve an employment-template by its ID. - [The job-position resource](https://developers.luccasoftware.com/api-reference/latest/employments/job-position.md) - [List job-positions](https://developers.luccasoftware.com/api-reference/latest/employments/get-job-positions.md): Retrieve a paginated list of job-positions. - [Create a job-position](https://developers.luccasoftware.com/api-reference/latest/employments/post-job-positions.md): Create an job-position for an employee's employment. - [Retrieve a job-position](https://developers.luccasoftware.com/api-reference/latest/employments/get-job-position.md): Retrieve an job-position by its ID. - [Update a job-position](https://developers.luccasoftware.com/api-reference/latest/employments/patch-job-position.md): Update a job-position. - [Delete a job-position](https://developers.luccasoftware.com/api-reference/latest/employments/delete-job-position.md): Delete a job-position. - [The probationary-period resource](https://developers.luccasoftware.com/api-reference/latest/employments/probationary-period.md) - [List probationary-periods](https://developers.luccasoftware.com/api-reference/latest/employments/get-probationary-periods.md): List probationary-periods. - [Create a probationary-period](https://developers.luccasoftware.com/api-reference/latest/employments/post-probationary-period.md): Create a new probationary-period. - [Retrieve a probationary-period](https://developers.luccasoftware.com/api-reference/latest/employments/get-probationary-period.md): Retrieve a probationary-period by its ID. - [Update a probationary-period](https://developers.luccasoftware.com/api-reference/latest/employments/put-probationary-period.md): Update a probationary-period by its ID. - [Delete a probationary-period](https://developers.luccasoftware.com/api-reference/latest/employments/delete-probationary-period.md): Delete a probationary-period by its ID. - [Get Started](https://developers.luccasoftware.com/api-reference/latest/employee-occupation-categories/get-started.md) - [The occupation-category resource](https://developers.luccasoftware.com/api-reference/latest/employee-occupation-categories/occupation-category.md) - [List occupation-categories](https://developers.luccasoftware.com/api-reference/latest/employee-occupation-categories/get-occupation-categories.md): Returns a paginated list of occupation-categories. - [Retrieve an occupation-category](https://developers.luccasoftware.com/api-reference/latest/employee-occupation-categories/get-occupation-category.md): Retrieve an occupation-category. - [Get Started](https://developers.luccasoftware.com/api-reference/latest/employee-job-qualifications/get-started.md) - [The profession resource](https://developers.luccasoftware.com/api-reference/latest/employee-job-qualifications/profession.md) - [List professions](https://developers.luccasoftware.com/api-reference/latest/employee-job-qualifications/get-professions.md): List professions. - [Retrieve a profession](https://developers.luccasoftware.com/api-reference/latest/employee-job-qualifications/get-profession.md): Retrieve a profession by its ID. - [The job-qualification resource](https://developers.luccasoftware.com/api-reference/latest/employee-job-qualifications/job-qualification.md) - [List job-qualifications](https://developers.luccasoftware.com/api-reference/latest/employee-job-qualifications/get-job-qualifications.md): Returns a paginated list of job-qualifications. - [Retrieve a job-qualification](https://developers.luccasoftware.com/api-reference/latest/employee-job-qualifications/get-job-qualification.md): Retrieve a job-qualification by its ID. - [The working-time-arrangement resource](https://developers.luccasoftware.com/api-reference/latest/working-time-arrangements/working-time-arrangement.md) - [List working-time-arrangements](https://developers.luccasoftware.com/api-reference/latest/working-time-arrangements/get-working-time-arrangements.md): Returns a paginated list of working-time-arrangements. - [Retrieve a working-time-arrangement](https://developers.luccasoftware.com/api-reference/latest/working-time-arrangements/get-working-time-arrangement.md): Retrieves a single working-time-arrangement resource. - [Get Started](https://developers.luccasoftware.com/api-reference/latest/events/get-started.md) - [Types of events](https://developers.luccasoftware.com/api-reference/latest/events/event-topics.md) - [Access Control](https://developers.luccasoftware.com/api-reference/latest/events/access-control.md) - [The event resource](https://developers.luccasoftware.com/api-reference/latest/events/event.md) - [List events](https://developers.luccasoftware.com/api-reference/latest/events/get-events.md): Returns a paginated list of events. - [Retrieve an event](https://developers.luccasoftware.com/api-reference/latest/events/get-event.md): Retrieve an event by its ID. - [Test event (test.created)](https://developers.luccasoftware.com/api-reference/latest/events/test-event.md) - [The webhook-endpoint resource](https://developers.luccasoftware.com/api-reference/latest/webhooks/webhook-endpoint.md) - [List webhook-endpoints](https://developers.luccasoftware.com/api-reference/latest/webhooks/get-webhook-endpoints.md): Returns a paginated list of webhook-endpoints. - [Create a webhook-endpoint](https://developers.luccasoftware.com/api-reference/latest/webhooks/post-webhook-endpoints.md): Create a new webhook-endpoint. - [Retrieve a webhook-endpoint](https://developers.luccasoftware.com/api-reference/latest/webhooks/get-webhook-endpoint.md): Retrieves a single webhook-endpoint resource. - [Update a webhook-endpoint](https://developers.luccasoftware.com/api-reference/latest/webhooks/patch-webhook-endpoint.md): Update an existing webhook-endpoint. - [Delete a webhook-endpoint](https://developers.luccasoftware.com/api-reference/latest/webhooks/delete-webhook-endpoint.md): Delete an existing webhook-endpoint. - [The webhook-delivery resource](https://developers.luccasoftware.com/api-reference/latest/webhooks/webhook-delivery.md) - [List webhook-deliveries](https://developers.luccasoftware.com/api-reference/latest/webhooks/get-webhook-deliveries.md): Returns a paginated list of webhook-deliveries. - [Trigger a test delivery](https://developers.luccasoftware.com/api-reference/latest/webhooks/post-webhook-deliveries.md): Triggers a test delivery to in order to test it out a webhook-endpoint. - [Retrieve a webhook-delivery](https://developers.luccasoftware.com/api-reference/latest/webhooks/get-webhook-delivery.md): Retrieve a webhook-delivery. - [The webhook-delivery-attempt resource](https://developers.luccasoftware.com/api-reference/latest/webhooks/webhook-delivery-attempt.md) - [List webhook-delivery-attempts](https://developers.luccasoftware.com/api-reference/latest/webhooks/get-webhook-delivery-attempts.md): Retrieve a paginated list of webhook-delivery-attempts. - [Retrieve a webhook-delivery-attempt](https://developers.luccasoftware.com/api-reference/latest/webhooks/get-webhook-delivery-attempt.md): Retrieve a webhook-delivery-attempt. - [Lucca API Changes](https://developers.luccasoftware.com/changelog/overview.md): New updates and improvements made to the Lucca API. ## OpenAPI Specs - [lucca-api-nav](/lucca-api-nav.json) - [authentication](/openapi-specs/authentication.yaml) - [cleemy-expenses-v3](/openapi-specs/cleemy-expenses-v3.yaml) - [directory-v3](/openapi-specs/directory-v3.yaml) - [lucca-api@2024-11-01](/openapi-specs/lucca-api@2024-11-01.json) - [lucca-files](/openapi-specs/lucca-files.yaml) - [lucca-invoices](/openapi-specs/lucca-invoices.yaml) - [organization-v3](/openapi-specs/organization-v3.yaml) - [Pagga-MealVoucher](/openapi-specs/Pagga-MealVoucher.yaml) - [pagga-remuneration](/openapi-specs/pagga-remuneration.yaml) - [poplee-training](/openapi-specs/poplee-training.yaml) - [recruitment-world](/openapi-specs/recruitment-world.yaml) - [recruitment](/openapi-specs/recruitment.yaml) - [schedule](/openapi-specs/schedule.yaml) - [timmi-absences-v3](/openapi-specs/timmi-absences-v3.yaml) - [timmi-office](/openapi-specs/timmi-office.yaml) - [timmi-project](/openapi-specs/timmi-project.yaml) - [timmi-timesheet-v3](/openapi-specs/timmi-timesheet-v3.yaml) - [timmi-timesheet](/openapi-specs/timmi-timesheet.yaml) - [webhook-client-api](/openapi-specs/webhook-client-api.json) ## Optional - [Community](https://join.slack.com/t/luccaapicommunity/shared_invite/zt-32njiaefl-QjdcZ8JGfPEO_y6BdJh3lg) - [Status](https://status.lucca.fr)