Remote API Integration

These are the list of integration use cases supported by Knit for Remote API as part of the HRIS category

Delete a Webhook Callback

ID: delete_a_webhook_callback
Operation: write
Entities: webhook callback
Summary: This API deletes a previously registered webhook callback. It requires the 'id' of the webhook callback as a path parameter and an 'Authorization' header with a Bearer token. On success, it returns a status 'ok'. If unauthorized, it returns a 401 error with a message 'Unauthorized'. If the resource is not found, it returns a 404 error with a message '{resource} not found'. If there are validation errors, it returns a 422 error with detailed error information.
Input Fields: Input Fields
Output Fields: Output Fields

Delete an Incentive

ID: delete_an_incentive
Operation: delete
Entities: authorization, incentive, response
Summary: The 'Delete an Incentive' API allows users to delete a specific incentive by providing the incentive ID in the path parameters. The request requires an Authorization header with a Bearer token for authentication. Upon successful deletion, a 200 status code is returned with a success message. If the request is malformed, unauthorized, or the resource is not found, appropriate error messages and status codes (400, 401, 404, 409, 422, 429) are returned.
Input Fields: Input Fields
Output Fields: Output Fields

Deletes a Company Manager User

ID: delete_company_manager_user
Operation: write
Entities: company manager, user, access token
Summary: This API deletes a Company Manager user. It requires a valid access token provided in the Authorization header. The user_id path parameter is required to specify which user to delete. The API responds with various status codes: 200 for success, 400 for bad request, 401 for unauthorized access, 404 if the user is not found, 422 for unprocessable entity, and 429 if too many requests are made. The response body varies based on the status code, providing relevant messages or data.
Input Fields: Input Fields
Output Fields: Output Fields

Delete a Recurring Incentive

ID: delete_recurring_incentive
Operation: write
Entities: authorization, incentive, payment
Summary: The 'Delete a Recurring Incentive' API allows users to delete a recurring incentive, specifically those with a pending status. The API requires an Authorization header with a Bearer token and a path parameter 'id' which is the Recurring Incentive ID. Upon successful deletion, it returns a list of incentives that were already scheduled and could not be deleted. The response includes various status codes such as 200 for success, 400 for bad request, 401 for unauthorized access, 404 for not found, 422 for unprocessable entity, and 429 for too many requests.
Input Fields: Input Fields
Output Fields: Output Fields

Get Compensation Details of an Employment

ID: get_compensation_details_of_an_employment
Operation: read
Entities: authorization, country, payslip
Summary: This API endpoint allows the user to retrieve compensation details of an employment in PDF format. The request requires an Authorization header with a Bearer token. Several query parameters can be used to filter the payslips, including 'employment_id', 'start_date', 'end_date', 'expected_payout_start_date', 'expected_payout_end_date', 'page', and 'page_size'. The response includes details such as the current page, a list of payslips with employment ID, expected payout date, payslip ID, issued date, net pay converted amount, and net pay source amount, along with the total count and total pages.
Input Fields: Input Fields
Output Fields: Output Fields

Show Contractor Invoice

ID: get_contractor_invoice
Operation: read
Entities: item, contractor invoice, contractor invoice schedule
Summary: The Show Contractor Invoice API retrieves a single Contractor Invoice record. It requires a valid Bearer token for authorization. The API takes a path parameter 'id' which is the unique identifier of the contractor invoice. The response can be a successful retrieval of the contractor invoice details with status 200, or it can return error messages for unauthorized access (401), forbidden access (403), not found (404), or unprocessable entity (422). The successful response includes details such as amount, currency, date, description, due date, status, and more.
Input Fields: Input Fields
Output Fields: Output Fields

Show Contractor Invoice Schedule

ID: get_contractor_invoice_schedule
Operation: read
Entities: schedule, invoice, contractor
Summary: The Show Contractor Invoice Schedule API retrieves a single Contractor Invoice Schedule record. It requires a Bearer token for authorization and a unique identifier for the resource as a path parameter. The API returns detailed information about the contractor invoice schedule, including currency, employment ID, items, next invoice date, note, number of occurrences, number, periodicity, start date, status, and total amount. The response can vary based on the status code, providing appropriate messages for success, bad request, unauthorized access, forbidden access, not found, unprocessable entity, and too many requests.
Input Fields: Input Fields
Output Fields: Output Fields

List Contractor Invoice Schedules

ID: get_contractor_invoice_schedules
Operation: read
Entities: employment, item, contractor invoice schedule
Summary: The List Contractor Invoice Schedules API retrieves a list of contractor invoice schedule records. It requires an authorization token in the header. The API supports various query parameters to filter the results, such as start_date_from, start_date_to, next_invoice_date_from, next_invoice_date_to, status, employment_id, periodicity, currency, sort_by, order, page, and page_size. The response includes a list of contractor invoice schedules with details like currency, employment_id, id, items, next_invoice_at, note, nr_occurrences, number, periodicity, start_date, status, and total_amount. The API returns different status codes, including 200 for success, 401 for unauthorized access, 403 for forbidden access, and 404 for not found.
Input Fields: Input Fields
Output Fields: Output Fields

Download a Receipt by ID

ID: get_download_receipt_by_id
Operation: read
Entities: receipt, expense
Summary: This API endpoint allows users to download a receipt by specifying the expense ID and receipt ID in the path parameters. The request requires an Authorization header with a Bearer token. The response can be a PDF document if successful (HTTP 200), or various error messages in JSON format for different error conditions such as Bad Request (400), Unauthorized (401), Forbidden (403), Not Found (404), Unprocessable Entity (422), and Too Many Requests (429).
Input Fields: Input Fields
Output Fields: Output Fields

Get Employee Identification Details

ID: get_employee_identification_details
Operation: read
Entities: employment, custom field
Summary: This API endpoint retrieves employee identification details for a given employment. It requires a Bearer token for authorization. The request must include the 'employment_id' as a path parameter. The response will include the identity verification data if successful. Possible error responses include 400 Bad Request, 401 Unauthorized, 404 Not Found, 422 Unprocessable Entity, and 429 Too Many Requests.
Input Fields: Input Fields
Output Fields: Output Fields

Show Incentive Details

ID: get_incentive_details
Operation: read
Entities: employment, incentive
Summary: The Show Incentive Details API retrieves the details of a specific incentive using its ID. It requires an Authorization header with a Bearer token for authentication. The path parameter 'id' is required to specify the incentive ID. The API returns a detailed object of the incentive on a successful request (HTTP 200). Possible error responses include 400 Bad Request, 401 Unauthorized, 404 Not Found, 422 Unprocessable Entity, and 429 Too Many Requests, each with a specific error message.
Input Fields: Input Fields
Output Fields: Output Fields

List all holidays of a country

ID: get_list_all_holidays_of_a_country
Operation: read
Entities: country, year, holiday
Summary: This API lists all holidays of a specified country for a specific year. It requires the country code and year as path parameters. Optionally, it can be filtered by country subdivision using a query parameter. The request must include an Authorization header with a Bearer token. The response includes a list of holidays with details such as the day, name, note, and observed day. Possible error responses include 401 Unauthorized, 404 Not Found, and 422 Unprocessable Entity.
Input Fields: Input Fields
Output Fields: Output Fields

List Company Managers

ID: get_list_company_managers
Operation: read
Entities: company, manager, role
Summary: The List Company Managers API retrieves a list of company managers associated with an integration. It can be filtered by the company_id query parameter to list managers of a specific company. The API requires an Authorization header with a Bearer token. Query parameters include company_id for filtering, page for pagination, and page_size to specify the number of records per page. The response includes a list of company managers with details such as company_id, role, user_email, user_id, and user_name. Possible response codes include 200 for success, 400 for bad request, 401 for unauthorized access, 404 for not found, 422 for unprocessable entity, and 429 for too many requests.
Input Fields: Input Fields
Output Fields: Output Fields

List Contractor Invoices

ID: get_list_contractor_invoices
Operation: read
Entities: item, contractor invoice, contractor invoice schedule
Summary: The List Contractor Invoices API retrieves a list of contractor invoice records. It requires a Bearer token for authorization. The API supports various query parameters to filter the invoices, such as status, contractor invoice schedule ID, date ranges, and sorting options. The response includes detailed information about each invoice, including amounts, dates, descriptions, and status. The API also handles various error responses, including unauthorized access, forbidden access, not found resources, and unprocessable entities.
Input Fields: Input Fields
Output Fields: Output Fields

List Employments

ID: get_list_employments
Operation: read
Entities: company, country, employment
Summary: The List Employments API endpoint retrieves a list of all employments, excluding those that have been deleted. It requires a Bearer token for authorization and specifies the media type of the response as application/json. The endpoint accepts query parameters such as company_id, email, status, page, page_size, and employment_type to filter and paginate the results. The employment_type parameter allows filtering by employment product type with possible values: contractor, direct_employee, employee, global_payroll_employee. The response includes details about the employments such as country, department, full name, job title, and status. The API returns different response codes and messages for various scenarios, including success (200), bad request (400), unauthorized (401), not found (404), unprocessable entity (422), and too many requests (429). The API is country-specific, and the exact fields required and returned depend on the country of the employment.
Input Fields: Input Fields
Output Fields: Output Fields

List Expenses

ID: get_list_expenses
Operation: read
Entities: currency, receipt, expense
Summary: The List Expenses API endpoint retrieves all expense records. It requires an Authorization header with a Bearer token for access. The API supports pagination through the 'page' and 'page_size' query parameters. The response includes details of expenses such as amount, currency, tax amount, and receipts. The API returns various status codes including 201 for success, 400 for bad requests, 401 for unauthorized access, 404 for not found resources, 422 for unprocessable entities, and 429 for too many requests.
Input Fields: Input Fields
Output Fields: Output Fields

List Incentives

ID: get_list_incentives
Operation: read
Entities: recurring_incentive, employment, incentive
Summary: The List Incentives API retrieves all incentives associated with a company. It requires an Authorization header with a Bearer token for access. The API supports filtering incentives by employment ID, status, and recurring incentive ID through query parameters. Pagination is supported with 'page' and 'page_size' parameters. The response includes details of incentives such as amount, tax type, effective date, and status. Possible response codes include 200 for success, 400 for bad request, 401 for unauthorized access, 404 for not found, 422 for unprocessable entity, and 429 for too many requests.
Input Fields: Input Fields
Output Fields: Output Fields

List Offboarding Requests

ID: get_list_offboarding_requests
Operation: read
Entities: employee awareness, offboarding request, risk assessment reason
Summary: The List Offboarding Requests API allows users to retrieve a list of offboarding requests. It requires an Authorization header with a Bearer token. The API supports filtering by employment ID, offboarding type, and the inclusion of confidential requests. Pagination is supported through the 'page' and 'page_size' query parameters. The response includes details such as the current page, total count, and offboarding details like employment ID, termination date, and reasons. Error responses include messages for bad requests, unauthorized access, resource not found, unprocessable entities, and rate limiting.
Input Fields: Input Fields
Output Fields: Output Fields

List Recurring Incentive

ID: get_list_recurring_incentive
Operation: read
Entities: employment, employee, incentive
Summary: The List Recurring Incentive API allows users to retrieve all recurring incentives of a company. It requires an Authorization header with a Bearer token for access. The API supports filtering by status, type, and note through query parameters. Pagination is supported with 'page' and 'page_size' parameters. The response includes the current page, a list of recurring incentives, total count, and total pages. Possible response codes include 201 for success, 400 for bad request, 401 for unauthorized access, 404 for not found, 422 for unprocessable entity, and 429 for too many requests.
Input Fields: Input Fields
Output Fields: Output Fields

List Supported Countries

ID: get_list_supported_countries
Operation: read
Entities: country, employment, json schema
Summary: This API endpoint returns a list of all countries supported by the Remote API, ordered alphabetically. It requires an Authorization header with a Bearer token. The response includes the country's two-letter and three-letter codes, name, and supported JSON schemas for employment-related information. The API can return various error messages for bad requests, unauthorized access, resource not found, unprocessable entities, and too many requests.
Input Fields: Input Fields
Output Fields: Output Fields

List Time Off Records

ID: get_list_time_off_records
Operation: read
Entities: time off, employment, document
Summary: The List Time Off Records API retrieves all time off records. It requires a Bearer token for authorization. The API supports various query parameters to filter the results, such as employment_id, timeoff_type, status, order, sort_by, page, and page_size. The response includes details of time off records, such as document information, employment ID, start and end dates, status, time off days, type, and timezone. The API returns different response codes for success, bad request, unauthorized access, not found, unprocessable entity, and too many requests, each with a specific response schema.
Input Fields: Input Fields
Output Fields: Output Fields

List Time Off Types

ID: get_list_time_off_types
Operation: read
Entities: authorization, time off type, response schema
Summary: The List Time Off Types API endpoint retrieves all available time off types that can be used for the timeoff_type parameter. It requires an Authorization header with a Bearer token for authentication. The response includes a list of time off types with their descriptions and names. Possible error responses include 400 Bad Request, 401 Unauthorized, 404 Not Found, 422 Unprocessable Entity, and 429 Too Many Requests, each with a corresponding error message.
Input Fields: Input Fields
Output Fields: Output Fields

Lists Custom Fields Definitions

ID: get_lists_custom_fields_definitions
Operation: read
Entities: authorization, custom field, response schema
Summary: The 'Lists Custom Fields Definitions' API returns the definitions of custom fields. It requires an Authorization header with a Bearer token. The API supports query parameters 'page' and 'page_size' to paginate the results. The response includes the current page, a list of custom fields with their IDs, names, and types, the total count of custom fields, and the total number of pages. Possible response codes include 200 for success, 400 for bad requests, 401 for unauthorized access, 404 for not found resources, 422 for unprocessable entities, and 429 for too many requests.
Input Fields: Input Fields
Output Fields: Output Fields

Show Employment Information

ID: get_show_employment_information
Operation: read
Entities: authorization, country, employment
Summary: The Show Employment Information API endpoint retrieves all the information of an employment based on the provided employment ID. It requires an Authorization header with a Bearer token and a path parameter 'employment_id'. The response includes detailed employment data such as address details, administrative details, bank account details, and more, specific to the country of employment. The endpoint returns various status codes including 200 for success, 400 for bad request, 401 for unauthorized access, 404 for not found, 422 for unprocessable entity, and 429 for too many requests. The response data is country-specific and may vary based on local compliance requirements.
Input Fields: Input Fields
Output Fields: Output Fields

Show Expense

ID: get_show_expense
Operation: read
Entities: currency, receipt, expense
Summary: The Show Expense API retrieves a single expense record identified by the provided expense ID. It requires an Authorization header with a Bearer token for authentication. The path parameter 'id' is required to specify the expense ID. On success, it returns a detailed object containing the expense information, including amounts, currency details, employment ID, expense date, receipts, tax amount, and title. Possible error responses include 400 Bad Request, 401 Unauthorized, 404 Not Found, 422 Unprocessable Entity, and 429 Too Many Requests, each with a corresponding message.
Input Fields: Input Fields
Output Fields: Output Fields

Show Form Schema

ID: get_show_form_schema
Operation: read
Entities: country, employment, form
Summary: The Show Form Schema API returns the JSON schema of a supported form based on the specified country code and form name. The API requires a company access token for authorization. The path parameters include 'country_code' and 'form', both of which are required. The query parameters include 'employment_id', which is required for the 'contract_amendment' form, and 'only_for_testing_include_scheduled_benefit_groups', which is optional and used for testing purposes. The response can vary based on the status code, with a successful response (200) returning the form schema, while other status codes (400, 401, 404, 422, 429) return error messages.
Input Fields: Input Fields
Output Fields: Output Fields

Show Offboarding Request

ID: get_show_offboarding_request
Operation: read
Entities: offboarding, employment, termination
Summary: The Show Offboarding Request API retrieves details of a specific offboarding request using the provided offboarding request ID. It requires an Authorization header with a Bearer token for authentication. The API returns a detailed object containing information about the offboarding, such as the termination date, reason, and risk assessment reasons. If the request is successful, a 200 status code is returned with the offboarding details. Possible error responses include 400 Bad Request, 401 Unauthorized, 404 Not Found, 422 Unprocessable Entity, and 429 Too Many Requests, each with a corresponding message.
Input Fields: Input Fields
Output Fields: Output Fields

Show Time Off Balance

ID: get_show_time_off_balance
Operation: read
Entities: employment id, leave entitlement, timeoff balance
Summary: The Show Time Off Balance API retrieves the time off balance for a specified employment ID. It requires an Authorization header with a Bearer token. The path parameter 'employment_id' is required to specify the employment ID for which the time off balance is to be shown. The API returns a detailed object containing the time off balance, including contractual entitlements, leave entitlements, total entitled days, and working hours per day. Possible responses include a 200 success with the time off balance data, 400 for bad requests, 401 for unauthorized access, 404 if the time off balance is not found, 422 for unprocessable entities, and 429 for too many requests.
Input Fields: Input Fields
Output Fields: Output Fields

Show Time Off Record

ID: get_show_time_off_record
Operation: read
Entities: time off, employment, document
Summary: The Show Time Off Record API retrieves a single time off record based on the provided timeoff ID. It requires an authorization token in the header. The path parameter 'id' is mandatory and represents the timeoff ID. The API returns a detailed time off record if successful, including document details, employment ID, start and end dates, status, and timeoff days. In case of errors, it returns appropriate error messages for bad requests, unauthorized access, not found resources, unprocessable entities, and too many requests.
Input Fields: Input Fields
Output Fields: Output Fields

Update Employment

ID: patch_update_employment
Operation: write
Entities: company, employment, address
Summary: The Update Employment API allows users to modify employment details in the production environment. It requires a Bearer token for authorization and an employment ID as a path parameter. The request body can include various employment details such as address, administrative details, bank account details, and more. The API responds with detailed employment data upon success or various error messages for different failure scenarios, such as unauthorized access, not found, or too many requests.
Input Fields: Input Fields
Output Fields: Output Fields

Update Incentive

ID: patch_update_incentive
Operation: write
Entities: company, employment, incentive
Summary: The Update Incentive API allows you to update an existing incentive for an employee. It requires a valid incentive ID as a path parameter and an access token in the Authorization header. The request body must include the amount, amount tax type, effective date, note, and type of the incentive. The response will include the updated incentive details if successful, or an error message if there is an issue with the request.
Input Fields: Input Fields
Output Fields: Output Fields

Update Time Off Record

ID: patch_update_time_off_record
Operation: write
Entities: time off, document, time off day
Summary: The Update Time Off Record API allows users to update an existing time off record or cancel it. It requires a Bearer token for authorization. The API takes a path parameter 'id' which is the Timeoff ID. The request body can include fields such as 'approved_at', 'approver_id', 'cancel_reason', 'document', 'edit_reason', 'end_date', 'notes', 'start_date', 'status', 'timeoff_days', 'timeoff_type', and 'timezone'. The response can be a success with the updated time off details or various error messages indicating issues like bad request, unauthorized access, not found, unprocessable entity, or too many requests.
Input Fields: Input Fields
Output Fields: Output Fields

Updates Contractor Invoice Schedule

ID: patch_updates_contractor_invoice_schedule
Operation: write
Entities: employment, invoice item, contractor invoice schedule
Summary: The 'Updates Contractor Invoice Schedule' API allows users to update a contractor invoice schedule record. It requires a Bearer token for authorization. The API endpoint is '/v1/contractor-invoice-schedules/{id}', where 'id' is a required path parameter representing the unique identifier of the resource. The request must include an Authorization header with a valid access token. The request body should be in JSON format and can include fields such as 'currency', 'items', 'note', 'nr_occurrences', 'number', 'periodicity', and 'start_date'. The response will return the updated contractor invoice schedule data if successful, or an error message if there are issues such as unauthorized access, forbidden access, resource not found, or unprocessable entity.
Input Fields: Input Fields
Output Fields: Output Fields

Create and Invite a Company Manager

ID: post_create_and_invite_company_manager
Operation: write
Entities: company, manager
Summary: This API endpoint allows the creation and invitation of a Company Manager on the Remote Platform. It requires an access token for authorization. The request body must include the email, name, and role of the company manager. The company_id is optional unless the access token can access multiple companies. The API returns a 201 status code with the details of the created company manager upon success. Possible error responses include 400 for bad requests, 401 for unauthorized access, 404 for resource not found, 422 for unprocessable entity, and 429 for too many requests.
Input Fields: Input Fields
Output Fields: Output Fields

Create Contractor Invoice Schedules

ID: post_create_contractor_invoice_schedules
Operation: write
Entities: employment, item, contractor invoice schedule
Summary: The Create Contractor Invoice Schedules API allows the creation of multiple invoice schedule records in a single request. It requires an Authorization header with a Bearer token for access. The request body must include an array of contractor invoice schedules, each containing details such as currency, employment ID, items, note, number of occurrences, number, periodicity, and start date. The API returns a 201 status code if all entries are successfully created, a 207 status code if there are mixed successes and failures, a 403 status code if access is forbidden, a 404 status code if a resource is not found, and a 422 status code if all entries fail. The response includes lists of successes and failures, detailing the created schedules and any errors encountered.
Input Fields: Input Fields
Output Fields: Output Fields

Create Employment

ID: post_create_employment
Operation: write
Entities: employment, employee, contractor
Summary: The Create Employment API endpoint allows for the creation of employment records for employees and contractors. It requires country-specific data, which can be obtained by querying the 'Show form schema' endpoint. The request must include an Authorization header with a Bearer token, and headers for 'accept' and 'content-type' set to 'application/json'. The request body can include basic employment information, a deprecated company ID, a required country code, and an optional employment type (defaulting to 'employee'). The response will vary based on the status code, providing employment data on success or error messages for various failure scenarios.
Input Fields: Input Fields
Output Fields: Output Fields

Create Expense

ID: post_create_expense
Operation: write
Entities: employment, receipt, expense
Summary: The Create Expense API allows users to create an approved expense by providing necessary details such as amount, category, currency, employment ID, expense date, and title. The request requires an Authorization header with a Bearer token. Optional fields include receipt, receipts, reviewed_at, reviewer_id, tax_amount, and timezone. The API returns a 201 status with the created expense data upon success. Error responses include 400 for bad requests, 401 for unauthorized access, 404 for not found resources, 422 for unprocessable entities, and 429 for too many requests.
Input Fields: Input Fields
Output Fields: Output Fields

Create Incentive

ID: post_create_incentive
Operation: write
Entities: employment, amount, incentive
Summary: The Create Incentive API allows you to create an incentive for an employee. It requires an authorization token in the header. The request body must include the amount, amount tax type, effective date, employment ID, and type of incentive. The amount should be specified as an integer, including fractional amounts. The effective date determines the payroll cycle for the incentive. The response includes the incentive details if successful, or an error message if there is an issue with the request.
Input Fields: Input Fields
Output Fields: Output Fields

Create Offboarding

ID: post_create_offboarding
Operation: write
Entities: termination detail, offboarding request
Summary: The Create Offboarding API allows you to create an offboarding request for an employee. It requires an access token for authorization. The request body must include the employment ID, termination details, and the type of offboarding, which is currently limited to 'termination'. The termination details include additional comments, confidentiality status, employee awareness details, proposed termination date, reason description, risk assessment reasons, termination reason, termination reason files, and whether the termination will be challenged. The API returns a 201 status code with offboarding details upon success. Possible error responses include 400 Bad Request, 401 Unauthorized, 404 Not Found, 422 Unprocessable Entity, 429 Too Many Requests, and 500 Internal Server Error.
Input Fields: Input Fields
Output Fields: Output Fields

Create Recurring Incentive

ID: post_create_recurring_incentive
Operation: write
Entities: employment, incentive
Summary: The Create Recurring Incentive API allows you to create a monthly paid incentive for an employee. The incentive uses the currency of the specified employment. The request requires an Authorization header with a Bearer token. The request body must include the amount, amount_tax_type, effective_date, employment_id, and type of incentive. Optional fields include a note and duration_in_months. The response will return the details of the created incentive or an error message if the request fails.
Input Fields: Input Fields
Output Fields: Output Fields

Create Time Off

ID: post_create_time_off
Operation: write
Entities: time off, manager, employment
Summary: The Create Time Off API allows users to create a new time off record in the system. It requires an authorization token in the header. The request body must include details such as employment ID, start and end dates, time off type, timezone, approval details, and status. The API returns a 201 status with the created time off details upon success. Possible error responses include 400 for bad requests, 401 for unauthorized access, 404 for not found resources, 422 for unprocessable entities, and 429 for too many requests.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Webhook Callback

ID: post_create_webhook_callback
Operation: write
Entities: webhook callback, subscribed event, url
Summary: This API endpoint allows you to create a webhook callback by registering a URL that will receive notifications for specified events. The request requires an Authorization header with a Bearer token. The body of the request must include a list of subscribed events and a URL. The response will include the details of the created webhook callback, or an error message if the request was unauthorized, the resource was not found, or the entity was unprocessable.
Input Fields: Input Fields
Output Fields: Output Fields

Invite Employment for Self-Enrollment

ID: post_invite_employment_for_self_enrollment
Operation: write
Entities: contract detail, pricing plan detail, employment
Summary: This API endpoint invites an employment to start the self-enrollment process. The invitation requires the employment to have filled the JSON Schema forms for contract_details and pricing_plan_details. The provisional_start_date must consider the minimum onboarding time of the employment's country. The API requires a Bearer token for authorization and the employment_id as a path parameter. On success, it returns a 201 status with a success message. If there are validation errors, it returns a 409 Conflict status with a descriptive message. Other possible responses include 400 Bad Request, 422 Unprocessable Entity, and 429 Too Many Requests.
Input Fields: Input Fields
Output Fields: Output Fields

Trigger a Webhook

ID: post_trigger_a_webhook
Operation: write
Entities: webhook, employment, event
Summary: The 'Trigger a Webhook' API endpoint is used to emit a webhook for testing purposes in the Sandbox environment. It requires an access token for authorization, which should be included in the 'Authorization' header as a Bearer token. The request body must include 'employment_id' and 'event_type', where 'event_type' is a specific event from a predefined list. The API responds with a 200 status code and a data object if successful, or with error messages for 401 Unauthorized, 404 Not Found, and 422 Unprocessable Entity status codes.
Input Fields: Input Fields
Output Fields: Output Fields

Update Employment in Sandbox Environment

ID: put_update_employment_in_sandbox_environment
Operation: write
Entities: company, country, employment
Summary: The Update Employment in Sandbox Environment API allows users to modify employment states for testing purposes within the Sandbox environment. It requires a valid Bearer token for authorization and an employment ID as a path parameter. The request body must include the employment status, which can be one of several predefined states. The API responds with detailed employment data upon success or various error messages for different failure scenarios, such as unauthorized access, resource not found, or too many requests.
Input Fields: Input Fields
Output Fields: Output Fields

Update Incentive

ID: put_update_incentive
Operation: write
Entities: company, employment, incentive
Summary: The Update Incentive API allows you to update an existing incentive for an employee. It requires an authorization token and the incentive ID as a path parameter. The request body must include the amount, amount tax type, effective date, and type of incentive. Optional fields include a note. The API returns the updated incentive details upon success or an error message if the request fails. Possible error responses include 400 Bad Request, 401 Unauthorized, 404 Not Found, 409 Conflict, 422 Unprocessable Entity, and 429 Too Many Requests.
Input Fields: Input Fields
Output Fields: Output Fields

Update Time Off Record

ID: put_update_time_off_record
Operation: write
Entities: time off, document, approver
Summary: The Update Time Off Record API allows users to update a time off record, including cancelling it. It requires a Bearer token for authorization. The API takes a path parameter 'id' which is the Timeoff ID. The request body can include fields such as 'approved_at', 'approver_id', 'cancel_reason', 'document', 'edit_reason', 'end_date', 'notes', 'start_date', 'status', 'timeoff_days', 'timeoff_type', and 'timezone'. The response can be a success with the updated time off details or various error messages indicating issues like bad request, unauthorized access, not found, unprocessable entity, or too many requests.
Input Fields: Input Fields
Output Fields: Output Fields

Updates Contractor Invoice Schedule

ID: put_updates_contractor_invoice_schedule
Operation: write
Entities: authorization, invoice item, contractor invoice schedule
Summary: The 'Updates Contractor Invoice Schedule' API allows users to update a contractor invoice schedule record. It requires an authorization token in the header and a unique identifier for the invoice schedule in the path parameters. The request body can include details such as currency, invoice items, notes, number of occurrences, invoice number, periodicity, and start date. The API responds with a detailed object of the updated invoice schedule on success, or error messages for unauthorized, forbidden, not found, or unprocessable entity responses.
Input Fields: Input Fields
Output Fields: Output Fields