{"openapi":"3.1.0","info":{"title":"EOR Endpoints","version":"1.0.0"},"paths":{"/adjustments":{"post":{"operationId":"create-contract-adjustment","summary":"Create a new adjustment","description":"Generates a new adjustment entry attributed to a specific worker\n **Token scopes**: `adjustments:write`","tags":["subpackage_adjustments"],"parameters":[{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/adjustments_createContractAdjustment_Response_201"}}}},"400":{"description":"Bad Request – failed to create adjustments","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateANewAdjustment-v2026-01-01RequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"description":"Creation data for a new adjustment","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"File of adjustment."},"title":{"type":"string","description":"Title of adjustment."},"amount":{"$ref":"#/components/schemas/AdjustmentsPostRequestBodyContentMultipartFormDataSchemaAmount","description":"Amount of adjustment."},"vendor":{"type":"string","description":"Vendor of adjustment."},"country":{"type":"string","description":"Country code."},"contract_id":{"type":"string","description":"The identifier of the contract associated with the adjustment"},"description":{"type":"string","description":"Description of adjustment."},"cycle_reference":{"type":"string","description":"Cycle reference of adjustment."},"move_next_cycle":{"type":["boolean","null"],"description":"If an adjustments can belong to another payroll cycle."},"date_of_adjustment":{"type":["string","null"],"format":"date","description":"Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31."},"adjustment_category_id":{"type":"string","description":"Adjustment category id."}},"required":["file","title","amount","vendor","country","contract_id","description","adjustment_category_id"]}}}}}},"/adjustments/{id}":{"delete":{"operationId":"delete-contract-adjustment","summary":"Delete an adjustment","description":"Delete an adjustment.\n **Token scopes**: `adjustments:write`","tags":["subpackage_adjustments"],"parameters":[{"name":"id","in":"path","description":"Deel adjustment id.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/adjustments_deleteContractAdjustment_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}},"get":{"operationId":"get-contract-adjustment","summary":"Retrieve an adjustment","description":"Use this endpoint to retrieve details of a specific adjustment by its id. You can view its amount, status, dates, and related contract_id\n **Token scopes**: `adjustments:read`","tags":["subpackage_adjustments"],"parameters":[{"name":"id","in":"path","description":"Deel adjustment id.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/adjustments_getContractAdjustment_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveAnAdjustmentRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}},"patch":{"operationId":"update-contract-adjustment","summary":"Update an adjustment","description":"Update an adjustment.\n **Token scopes**: `adjustments:write`","tags":["subpackage_adjustments"],"parameters":[{"name":"id","in":"path","description":"Deel adjustment id.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/adjustments_updateContractAdjustment_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"description":"Adjustment object that needs to be updated","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AdjustmentsIdPatchRequestBodyContentMultipartFormDataSchemaData","description":"Details of adjustment to update"}},"required":["data"]}}}}}},"/contracts/{contract_id}/adjustments":{"get":{"operationId":"get-contract-adjustments","summary":"Retrieve adjustments","description":"Get all adjustments for the specific contract.\n **Token scopes**: `adjustments:read`","tags":["subpackage_adjustments"],"parameters":[{"name":"contract_id","in":"path","description":"Deel adjustment id.","required":true,"schema":{"type":"string"}},{"name":"from","in":"query","description":"Filter adjustments by start date.","required":false,"schema":{"type":"string","format":"date"}},{"name":"to","in":"query","description":"Filter adjustments by end date.","required":false,"schema":{"type":"string","format":"date"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/adjustments_getContractAdjustments_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveAdjustmentsRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/adjustments/categories":{"get":{"operationId":"get-adjustment-categories","summary":"Retrieve categories","description":"Get all categories for your organization.\n **Token scopes**: `adjustments:read`","tags":["subpackage_adjustments"],"parameters":[{"name":"contract_types","in":"query","description":"array of contract types to filter categories","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/AdjustmentsCategoriesGetParametersContractTypesSchemaItems"}}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/adjustments_getAdjustmentCategories_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/eor/contracts/{contract_id}/amendments/{amendment_id}/accept":{"post":{"operationId":"accept-contract-amendment","summary":"Accept amendment","description":"Allows the client to accept a contract amendment, formally acknowledging and approving the modifications to the contract.\n **Token scopes**: `contracts:write`","tags":["subpackage_eorAmendments"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of EOR worker contract.","required":true,"schema":{"type":"string","format":"alphanumeric"}},{"name":"amendment_id","in":"path","description":"A unique identifier for the employee contract amendment.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Amendment info","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-amendments_acceptContractAmendment_Response_200"}}}},"400":{"description":"Bad Request. The request could not be understood or was missing required parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptAContractAmendmentOnBehalfOfTheClientRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Resource not found (e.g., contract, profile, amendment, change request).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptAContractAmendmentOnBehalfOfTheClientRequestNotFoundError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptAContractAmendmentOnBehalfOfTheClientRequestInternalServerError"}}}}},"requestBody":{"description":"This operation does not require a request body. Provide an empty JSON object if required by the client.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}}},"/eor/contracts/{contract_id}/amendments/{amendment_id}":{"delete":{"operationId":"delete-contract-amendment","summary":"Cancel amendment","description":"Cancel a pending employee contract amendment. This action voids the amendment request and prevents it from being reviewed or applied.\n **Token scopes**: `contracts:write`","tags":["subpackage_eorAmendments"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of EOR worker contract.","required":true,"schema":{"type":"string","format":"alphanumeric"}},{"name":"amendment_id","in":"path","description":"A unique identifier for the employee contract amendment.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-amendments_deleteContractAmendment_Response_200"}}}},"400":{"description":"Bad Request. The request could not be understood or was missing required parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelAmendmentRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Resource not found (e.g., contract, profile, amendment, change request).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelAmendmentRequestNotFoundError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelAmendmentRequestInternalServerError"}}}}}},"get":{"operationId":"get-contract-amendment-by-id","summary":"Get amendment by ID","description":"Retrieves the full details for a specific EOR contract amendment, including requested changes to salary, scope, and key dates.\n **Token scopes**: `contracts:read`","tags":["subpackage_eorAmendments"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of EOR worker contract.","required":true,"schema":{"type":"string","format":"alphanumeric"}},{"name":"amendment_id","in":"path","description":"A unique identifier for the employee contract amendment.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Amendment info","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-amendments_getContractAmendmentById_Response_200"}}}},"400":{"description":"Bad Request. The request could not be understood or was missing required parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewInformationAboutAmendmentRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Resource not found (e.g., contract, profile, amendment, change request).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewInformationAboutAmendmentRequestNotFoundError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewInformationAboutAmendmentRequestInternalServerError"}}}}}},"patch":{"operationId":"update-contract-amendment","summary":"Update amendment","description":"Updates a specific contract amendment. This can only be performed on amendments in a DRAFT status. This action is irreversible and will overwrite any previous draft data.\n **Token scopes**: `contracts:write`","tags":["subpackage_eorAmendments"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of EOR worker contract.","required":true,"schema":{"type":"string","format":"alphanumeric"}},{"name":"amendment_id","in":"path","description":"A unique identifier for the employee contract amendment. This string is either supplied by the client or generated by the system and is used to uniquely identify the amendment during upsert operations.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Amendment info","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-amendments_updateContractAmendment_Response_200"}}}},"400":{"description":"Bad Request. The request could not be understood or was missing required parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateASpecificEorContractAmendmentRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Resource not found (e.g., contract, profile, amendment, change request).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateASpecificEorContractAmendmentRequestNotFoundError"}}}},"409":{"description":"Conflict error. Indicates that the requested operation conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateASpecificEorContractAmendmentRequestConflictError"}}}},"422":{"description":"Validation errors or disabled amendments.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateASpecificEorContractAmendmentRequestUnprocessableEntityError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateASpecificEorContractAmendmentRequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/eor/contracts/{contract_id}/amendments/{amendment_id}/confirm":{"post":{"operationId":"confirm-contract-amendment","summary":"Confirm amendment","description":"Confirms an existing contract amendment and initiates the review process, sending it to both Deel and the employee for acknowledgment and approval.\n **Token scopes**: `contracts:write`","tags":["subpackage_eorAmendments"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of EOR worker contract.","required":true,"schema":{"type":"string","format":"alphanumeric"}},{"name":"amendment_id","in":"path","description":"A unique identifier for the employee contract amendment.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Amendment info","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-amendments_confirmContractAmendment_Response_200"}}}},"400":{"description":"Bad Request. The request could not be understood or was missing required parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmAnExistingContractAmendment-v2026-01-01RequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Resource not found (e.g., contract, profile, amendment, change request).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmAnExistingContractAmendment-v2026-01-01RequestNotFoundError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmAnExistingContractAmendment-v2026-01-01RequestInternalServerError"}}}}},"requestBody":{"description":"This operation does not require a request body. Provide an empty JSON object if required by the client.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}}},"/eor/contracts/{contract_id}/amendments/{amendment_id}/pdf":{"get":{"operationId":"get-contract-amendment-pdf","summary":"Contract amendment PDF","description":"Generates a secure PDF download link for the EOR contract amendment, valid for 15 minutes.\n **Token scopes**: `contracts:read`","tags":["subpackage_eorAmendments"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of EOR worker contract.","required":true,"schema":{"type":"string","format":"alphanumeric"}},{"name":"amendment_id","in":"path","description":"A unique identifier for the employee contract amendment.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"URL of exported PDF(valid for 15m)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-amendments_getContractAmendmentPdf_Response_200"}}}},"400":{"description":"Bad Request. The request could not be understood or was missing required parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEorContractAmendmentPdfDownloadLinkForClientAndEmployeeRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Resource not found (e.g., contract, profile, amendment, change request).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEorContractAmendmentPdfDownloadLinkForClientAndEmployeeRequestNotFoundError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEorContractAmendmentPdfDownloadLinkForClientAndEmployeeRequestInternalServerError"}}}}}}},"/eor/contracts/{contract_id}/amendments":{"post":{"operationId":"create-contract-amendment","summary":"Create amendment","description":"This endpoint allows you to create a new amendment for a EOR contract. Amendments may include changes to salary, currency, effective date, or other contract terms, and all requests are validated against business and regulatory rules.\n **Token scopes**: `contracts:write`","tags":["subpackage_eorAmendments"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the EOR worker contract","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Amendment info","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-amendments_createContractAmendment_Response_201"}}}},"400":{"description":"Bad Request. The request could not be understood or was missing required parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnEorContractAmendment-v2026-01-01RequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Resource not found (e.g., contract, profile, amendment, change request).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnEorContractAmendment-v2026-01-01RequestNotFoundError"}}}},"409":{"description":"Conflict error. Indicates that the requested operation conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnEorContractAmendment-v2026-01-01RequestConflictError"}}}},"422":{"description":"Validation errors or disabled amendments.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnEorContractAmendment-v2026-01-01RequestUnprocessableEntityError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnEorContractAmendment-v2026-01-01RequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaData"}}}}}}},"get":{"operationId":"get-contract-amendments","summary":"Get amendments by contract","description":"This endpoint retrieves all EOR contact amendments. It provides details such as the amendment type, effective date, and current status, allowing clients to understand the history and state of changes applied to the contract.\n **Token scopes**: `contracts:read`","tags":["subpackage_eorAmendments"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of EOR worker contract.","required":true,"schema":{"type":"string","format":"alphanumeric"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Amendment info. Returns the amendment flow details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-amendments_getContractAmendments_Response_200"}}}},"400":{"description":"Bad Request. The request could not be understood or was missing required parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAllAmendmentsForAnEorContract-v2026-01-01RequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Resource not found (e.g., contract, profile, amendment, change request).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAllAmendmentsForAnEorContract-v2026-01-01RequestNotFoundError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAllAmendmentsForAnEorContract-v2026-01-01RequestInternalServerError"}}}}}}},"/eor/contracts/{contract_id}/amendments/validation/settings":{"get":{"operationId":"get-contract-amendments-validation-settings","summary":"Get amendment validation settings","description":"Get all amendment validations settings of available data points for an EOR contract amendment\n **Token scopes**: `contracts:read`","tags":["subpackage_eorAmendments"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of EOR worker contract.","required":true,"schema":{"type":"string","format":"alphanumeric"}},{"name":"employment_state","in":"query","description":"The employment state of the EOR worker contract","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Amendment settings response with additional_details included as optional.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-amendments_getContractAmendmentsValidationSettings_Response_200"}}}},"400":{"description":"Bad Request. The request could not be understood or was missing required parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAmendmentValidationSettingsForAnEorContractRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Resource not found (e.g., contract, profile, amendment, change request).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAmendmentValidationSettingsForAnEorContractRequestNotFoundError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAmendmentValidationSettingsForAnEorContractRequestInternalServerError"}}}}}}},"/eor/contracts/{contract_id}/amendments/{amendment_id}/effective-date-limitations":{"get":{"operationId":"get-contract-amendment-effective-date-limitations","summary":"Retrieve Effective Date Limitations","description":"Retrieves validation rules for the effective date in an amendment flow of an EOR contract, including date limits, defaults, and visibility settings.\n **Token scopes**: `contracts:read`","tags":["subpackage_eorAmendments"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the EOR worker contract","required":true,"schema":{"type":"string"}},{"name":"amendment_id","in":"path","description":"A unique identifier for the employee contract amendment","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the effective date limits for the amendment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-amendments_getContractAmendmentEffectiveDateLimitations_Response_200"}}}},"400":{"description":"Bad Request. The request could not be understood or was missing required parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveEffectiveDateLimitationsRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Resource not found (e.g., contract, profile, amendment, change request).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveEffectiveDateLimitationsRequestNotFoundError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveEffectiveDateLimitationsRequestInternalServerError"}}}}}}},"/eor/contracts/{contract_id}/amendments/{amendment_id}/sign":{"post":{"operationId":"sign-eor-amendment","summary":"Sign a contract amendment (employee)","description":"Allows the employee to provide their signature for a specific contract amendment, confirming acknowledgment and acceptance of the changes.\n **Token scopes**: `contracts:write`","tags":["subpackage_eorAmendments"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of EOR worker contract.","required":true,"schema":{"type":"string","format":"alphanumeric"}},{"name":"amendment_id","in":"path","description":"A unique identifier for the employee contract amendment.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Amendment info","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-amendments_signEORAmendment_Response_200"}}}},"400":{"description":"Bad Request. The request could not be understood or was missing required parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignAContractAmendmentEmployeeRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Resource not found (e.g., contract, profile, amendment, change request).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignAContractAmendmentEmployeeRequestNotFoundError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignAContractAmendmentEmployeeRequestInternalServerError"}}}}},"requestBody":{"description":"This operation does not require a request body. Provide an empty JSON object if required by the client.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}}},"/eor/contracts/{contract_id}/amendments/validate":{"post":{"operationId":"validate-eor-amendments","summary":"Validate amendment data points","description":"Validate amendment data points that require external validation\n **Token scopes**: `contracts:write`","tags":["subpackage_eorAmendments"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","required":true,"schema":{"type":"string","format":"alphanumeric"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Validation result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-amendments_validateEORAmendments_Response_200"}}}},"400":{"description":"Bad Request. The request could not be understood or was missing required parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidateAmendmentDataPointsRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Resource not found (e.g., contract, profile, amendment, change request).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidateAmendmentDataPointsRequestNotFoundError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidateAmendmentDataPointsRequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Dynamic object containing amendment fields. Supports flexible keys such as scope, job_title, or others."}}}}}}}},"/eor/{contract_id}/benefits":{"get":{"operationId":"get-eor-benefits-by-contract-id","summary":"Retrieve Benefits for EOR Contract","description":"Fetch detailed information about benefits associated with a specific Employee of Record (EOR) contract. The benefits include plan details, provider information, and enrollment statuses.\n **Token scopes**: `contracts:read`","tags":["subpackage_eorBenefits"],"parameters":[{"name":"contract_id","in":"path","description":"Deel contract ID.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved the list of EOR contract benefits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-benefits_getEORBenefitsByContractId_Response_200"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/eor":{"post":{"operationId":"create-eor-contract","summary":"Create an EOR contract","description":"Creates an Employee of Record (EOR) contract quote. This endpoint allows to submit details for an EOR contract. Deel will process the information and return a quote for the requested contract.\n **Token scopes**: `contracts:write`","tags":["subpackage_eorContract"],"parameters":[{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successfully created the EOR contract quote.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-contract_createEORContract_Response_201"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"description":"The details of the Employee (EOR) contract to be created.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/eor/contracts/{contract_id}/details":{"get":{"operationId":"get-eor-contract-details","summary":"Retrieve EOR Contract Details","description":"Returns the basic information for an EOR contract, along with employment costs associated to it\n **Token scopes**: `contracts:read`","tags":["subpackage_eorContract"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier for the Deel contract","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-contract_getEORContractDetails_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveEorContractDetails-v2026-01-01RequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/eor/contract/{contract_id}":{"patch":{"operationId":"update-eor-contract","summary":"Update EOR Contract","description":"This endpoint is used to modify mutable fields of an EOR contract, such as salary, job title, or benefits. It supports partial updates—only include fields that should be updated. Required fields must still be present for validation.\n **Token scopes**: `contracts:write`","tags":["subpackage_eorContract"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Contract updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-contract_updateEORContract_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEorContractRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEorContractRequestForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEorContractRequestNotFoundError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEorContractRequestInternalServerError"}}}}},"requestBody":{"description":"Contract update request object","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/eor/contracts/{contract_id}/documents":{"get":{"operationId":"get-eor-contract-documents","summary":"Fetch EOR contract documents","description":"Lists all documents for a given EOR contract\n **Token scopes**: `contracts:read`","tags":["subpackage_eorContractDocuments"],"parameters":[{"name":"contract_id","in":"path","description":"EOR contract ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The documents for the given EOR contract","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-contract-documents_getEORContractDocuments_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchEorContractDocumentsRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/eor/employment_cost":{"post":{"operationId":"get-employment-cost","summary":"Calculate Employee Costs Globally","description":"Determine the total employment costs for an Employee of Record (EOR) arrangement across different countries, including salary, employer costs, benefits, and additional fees.","tags":["subpackage_costCalculator"],"parameters":[{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully calculated employee costs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cost-calculator_getEmploymentCost_Response_200"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorEmploymentCostPostRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/eor/contract/{oid}/cancel":{"post":{"operationId":"cancel-contract","summary":"Cancel EOR Contract","description":"Cancel EOR Contract\n **Token scopes**: `contracts:write`","tags":["subpackage_eorHiring"],"parameters":[{"name":"oid","in":"path","description":"Contract oid","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Contract cancelled successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-hiring_cancelContract_Response_204"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelEorContractRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Contract not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelEorContractRequestNotFoundError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"description":"Cancel EOR Contract","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractOidCancelPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/eor/contract/{oid}/delay-onboarding":{"patch":{"operationId":"delay-onboarding","summary":"Delay EOR employee onboarding","description":"Delay EOR employee onboarding\n **Token scopes**: `contracts:write`","tags":["subpackage_eorHiring"],"parameters":[{"name":"oid","in":"path","description":"Contract oid","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Employee onboarding delay status updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-hiring_delayOnboarding_Response_200"}}}},"400":{"description":"Bad Request - Contract not found or invalid status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DelayEorEmployeeOnboardingRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"description":"Indicates if the employee onboarding is delayed","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractOidDelayOnboardingPatchRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/forms/eor/create-contract/{country_code}":{"get":{"operationId":"get-create-contract-form","summary":"Fetch EOR Contract form","description":"Returns a formulary for creating EOR Contracts\n **Token scopes**: `forms:read`","tags":["subpackage_eorHiring"],"parameters":[{"name":"country_code","in":"path","description":"Two-letter country code in ISO 3166-1 alpha-2 format","required":true,"schema":{"type":"string"}},{"name":"state","in":"query","description":"The selected state code of the contract. This is only required for countries that specify it.","required":false,"schema":{"type":"string"}},{"name":"start_date","in":"query","description":"The selected start date of the contract in ISO 8601 formatted date string.","required":false,"schema":{"type":"string"}},{"name":"work_hours_per_week","in":"query","description":"The selected number of work hours per week.","required":false,"schema":{"type":"integer"}},{"name":"contract_duration_in_days","in":"query","description":"The contract duration in days for definite contracts.","required":false,"schema":{"type":"integer"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response containing form configuration data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-hiring_getCreateContractForm_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchEorContractFormRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/eor/start-date":{"get":{"operationId":"get-start-date","summary":"Fetch Start Date for EOR Contracts","description":"Returns the earliest allowed start date for a new EOR contract quote based on employment parameters.\n **Token scopes**: `contracts:read`","tags":["subpackage_eorHiring"],"parameters":[{"name":"employment_country","in":"query","description":"Employment country in ISO 3166-1 alpha-2 format","required":true,"schema":{"type":"string"}},{"name":"employee_nationality","in":"query","description":"Employee nationality in ISO 3166-1 alpha-2 format","required":false,"schema":{"type":"string"}},{"name":"work_visa","in":"query","description":"Whether a work visa is required","required":false,"schema":{"type":"boolean"}},{"name":"team_id","in":"query","description":"Team ID","required":true,"schema":{"type":"string"}},{"name":"legal_entity_id","in":"query","description":"Legal entity ID","required":false,"schema":{"type":"string"}},{"name":"employment_state","in":"query","description":"State or province of employment","required":false,"schema":{"type":"string"}},{"name":"special_job_id","in":"query","description":"Special job ID (if applicable)","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Start date details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-hiring_getStartDate_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchStartDateForEorContractsRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/eor/additional-costs/{country}":{"get":{"operationId":"get-additional-costs","summary":"Get EOR Additional Costs","description":"Retrieve all additional costs to eor quote flow by country\n **Token scopes**: `contracts:read`","tags":["subpackage_eorHiring"],"parameters":[{"name":"country","in":"path","description":"The two-letter ISO code of the country for which to retrieve the EOR additional costs.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-hiring_getAdditionalCosts_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEorAdditionalCostsRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/eor/benefits":{"get":{"operationId":"get-benefits","summary":"Retrieve Benefits by Country","description":"Retrieves list of benefits available in a specific country based work visa requirement, work hours, employment type, team, and legal entity.\n **Token scopes**: `benefits:read`","tags":["subpackage_eorHiring"],"parameters":[{"name":"country_code","in":"query","description":"Country code.","required":true,"schema":{"type":"string"}},{"name":"work_visa","in":"query","description":"Indicates if work visa is required.","required":true,"schema":{"type":"boolean"}},{"name":"work_hours_per_week","in":"query","description":"Working hours per week","required":true,"schema":{"type":"number","format":"double"}},{"name":"employment_type","in":"query","description":"Type of employment","required":true,"schema":{"$ref":"#/components/schemas/EorBenefitsGetParametersEmploymentType"}},{"name":"team_id","in":"query","description":"The ID of the team the worker belongs to.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"legal_entity_id","in":"query","description":"The ID of the legal entity.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-hiring_getBenefits_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveBenefitsByCountryRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/eor/validations/{country_code}":{"get":{"operationId":"get-eor-hiring-guide-by-country","summary":"Retrieve detailed hiring guide for a country","description":"Retrieve comprehensive hiring guide data for a specific country. This data can be used in creation and validation of Employee of Record (EOR) contract quotes, providing details on salaries, holidays, insurance, and other employment specifics.\n **Token scopes**: `contracts:read`","tags":["subpackage_eorHiring"],"parameters":[{"name":"country_code","in":"path","description":"The two-letter ISO code of the country for which to retrieve the hiring guide.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The hiring guide data was successfully retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-hiring_getEORHiringGuideByCountry_Response_200"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/eor/contracts/{contract_id}/documents/{type}/sign":{"post":{"operationId":"sign-contract-document","summary":"Sign EOR contract document","description":"Signs a document with the provided signature and title\n **Token scopes**: `contracts:write`","tags":["subpackage_eorHiring"],"parameters":[{"name":"contract_id","in":"path","description":"EOR contract ID","required":true,"schema":{"type":"string"}},{"name":"type","in":"path","description":"The type of document. Currently only FRAMEWORK_AGREEMENT is supported.","required":true,"schema":{"$ref":"#/components/schemas/EorContractsContractIdDocumentsTypeSignPostParametersType"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The document has been signed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-hiring_signContractDocument_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignEorContractDocumentRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdDocumentsTypeSignPostRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/eor/contracts/{contract_id}/employee-information":{"patch":{"operationId":"update-contract-employee-information","summary":"Update Employee Information for EOR Contract","description":"Updates employee information related to an EOR Contract. This endpoint supports partial updates. Attempting to update any undocumented fields will result in a validation error. This endpoint will only work for contracts with status `new`, `under_review`, `waiting_for_client_sign`, `waiting_for_eor_sign`, `waiting_for_employee_contract`, `waiting_for_employee_sign`, `awaiting_deposit_payment`, or `rejected`.\n **Token scopes**: `contracts:write`","tags":["subpackage_eorHiring"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Employee information updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-hiring_updateContractEmployeeInformation_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEmployeeInformationForEorContractRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Contract not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEmployeeInformationForEorContractRequestNotFoundError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEmployeeInformationForEorContractRequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdEmployeeInformationPatchRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/eor/job-scopes":{"get":{"operationId":"get-job-scopes","summary":"List of job scope templates for EOR contracts","description":"Returns a list of predefined job scope templates for an EOR contract, which can be filtered by team. The list includes both predefined and custom job scope templates belonging to the user's teams.\n **Token scopes**: `organizations:read`","tags":["subpackage_eorJobScopes"],"parameters":[{"name":"team","in":"query","description":"Team public id","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfull response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EorJobScopesGetResponsesContentApplicationJsonSchemaItems"}}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Not Found - Organization not linked to profile or no teams found for the organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOfJobScopeTemplatesForEorContractsRequestNotFoundError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/eor/job-scopes/validate":{"post":{"operationId":"validate-job-scope","summary":"Request job scope validation","description":"This endpoint allows client to validate job scope description.\n **Token scopes**: `contracts:write`","tags":["subpackage_eorJobScopes"],"parameters":[{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-job-scopes_validateJobScope_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestJobScopeValidation-v2026-01-01RequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"description":"Run job scope validation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorJobScopesValidatePostRequestBodyContentApplicationJsonSchemaData","description":"details of job scope"}},"required":["data"]}}}}}},"/eor/contracts/{contract_id}/offboarding/review-client-sign-offs":{"post":{"operationId":"create-eor-offboarding-client-sign-off","summary":"Create client sign off","description":"Use this endpoint to review, approve, or request changes to EOR employee offboarding documents for a specific contract during the client sign‑off step.\n **Token scopes**: `contracts:write`","tags":["subpackage_eorOffboarding"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Approval submitted successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-offboarding_createEOROffboardingClientSignOff_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewApproveOrRequestChangesToEorOffboardingDocumentsRequestBadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewApproveOrRequestChangesToEorOffboardingDocumentsRequestUnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewApproveOrRequestChangesToEorOffboardingDocumentsRequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewApproveOrRequestChangesToEorOffboardingDocumentsRequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/eor/contracts/{contract_id}/offboarding/required-information":{"get":{"operationId":"get-eor-contract-offboarding-required-information","summary":"Get additional information required to request employee termination","description":"This endpoint provides additional country-specific requirements for employee offboarding. It specifies any mandatory or optional questions that the client must answer and identifies required supporting documents that must be uploaded during the offboarding process. This ensures compliance with local regulations and streamlines the offboarding workflow.\n **Token scopes**: `contracts:read`","tags":["subpackage_eorOffboarding"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-offboarding_getEORContractOffboardingRequiredInformation_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAdditionalInformationRequiredToRequestEmployeeTerminationRequestBadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAdditionalInformationRequiredToRequestEmployeeTerminationRequestUnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAdditionalInformationRequiredToRequestEmployeeTerminationRequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAdditionalInformationRequiredToRequestEmployeeTerminationRequestInternalServerError"}}}}}}},"/eor/contracts/{contract_id}/offboarding/time-offs":{"get":{"operationId":"get-contract-offboarding-time-offs","summary":"Retrieve Employee Time Off Data for Offboarding","description":"This endpoint provides detailed time off information for an employee, including accrued, used, and scheduled days across all tracking periods. It also includes policy details, tracking configurations, and additional metadata to support the offboarding request process. The data is used to display comprehensive time off information on the offboarding request page.\n **Token scopes**: `contracts:read`","tags":["subpackage_eorOffboarding"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","required":true,"schema":{"type":"string"}},{"name":"end_date","in":"query","description":"Desired end date for offboarding","required":false,"schema":{"type":"string","format":"date"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved used time off information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-offboarding_getContractOffboardingTimeOffs_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveEmployeeTimeOffDataForOffboardingRequestBadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveEmployeeTimeOffDataForOffboardingRequestUnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveEmployeeTimeOffDataForOffboardingRequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveEmployeeTimeOffDataForOffboardingRequestInternalServerError"}}}}}}},"/eor/contracts/{contract_id}/offboarding/attachments/{attachment_id}":{"get":{"operationId":"get-contract-offboarding-attachment-by-id","summary":"Retrieve offboarding attachment","description":"This endpoint allows client and employee download the content of a specific attachment associated with a termination for the given contract.\n **Token scopes**: `contracts:read`","tags":["subpackage_eorOffboarding"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","required":true,"schema":{"type":"string"}},{"name":"attachment_id","in":"path","description":"The unique identifier of the attachment to download.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"File download successful","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveOffboardingAttachmentRequestBadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveOffboardingAttachmentRequestUnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveOffboardingAttachmentRequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveOffboardingAttachmentRequestInternalServerError"}}}}}}},"/eor/contracts/{contract_id}/offboarding":{"get":{"operationId":"get-contract-offboarding","summary":"Retrieve Offboarding Request","description":"Retrieve the offboarding request associated with a specific EOR contract (contract_id). Use it to review termination details, document review status, offboarding request data, and notifications required for the employee.\n **Token scopes**: `contracts:read`, `worker:read`","tags":["subpackage_eorOffboarding"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful retrieval of the offboarding request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-offboarding_getContractOffboarding_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveOffboardingRequestRequestBadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveOffboardingRequestRequestUnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveOffboardingRequestRequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveOffboardingRequestRequestInternalServerError"}}}}}}},"/eor/contracts/{contract_id}/offboarding/restricted-dates":{"get":{"operationId":"get-contract-offboarding-restricted-dates","summary":"Retrieve restricted offboarding dates","description":"Retrieves a list of dates, including weekends and public holidays, that are restricted for employee offboarding based on country-specific rules. Use this endpoint to plan employee offboarding by validating end-date selection. Call it when initiating an EOR offboarding flow to determine which dates are unavailable and what is the first day available.\n **Token scopes**: `contracts:read`","tags":["subpackage_eorOffboarding"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","required":true,"schema":{"type":"string"}},{"name":"termination_type","in":"query","description":"Type of offboarding.","required":false,"schema":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingRestrictedDatesGetParametersTerminationType"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful retrieval of restricted dates.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-offboarding_getContractOffboardingRestrictedDates_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveRestrictedOffboardingDatesRequestBadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveRestrictedOffboardingDatesRequestUnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveRestrictedOffboardingDatesRequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveRestrictedOffboardingDatesRequestInternalServerError"}}}}}}},"/eor/contracts/{contract_id}/offboarding/resignations/review-pto":{"post":{"operationId":"review-eor-offboarding-pto","summary":"Submit employee resignation PTO review","description":"Allows a client to review and submit the Paid Time Off (PTO) details for an employee resignation request. This endpoint updates the resignation with the provided PTO information, triggers related notifications, and finalizes the PTO review process. Only available when the resignation status is AWAITING_PTO.\n **Token scopes**: `contracts:write`","tags":["subpackage_eorOffboarding"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"PTO review submitted successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-offboarding_reviewEOROffboardingPTO_Response_201"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitEmployeeResignationPtoReviewRequestBadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitEmployeeResignationPtoReviewRequestUnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitEmployeeResignationPtoReviewRequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitEmployeeResignationPtoReviewRequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/eor/contracts/{contract_id}/offboarding/review-employee-sign-offs":{"post":{"operationId":"review-eor-offboarding-employee-sign-offs","summary":"Submit employee sign-off review for offboarding documents","description":"Use this endpoint to submit an employee's review decision for the EOR offboarding document set for contract. Employees can approve the documents or request changes by providing feedback.\n **Token scopes**: `worker:write`","tags":["subpackage_eorOffboarding"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Approval submitted successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-offboarding_reviewEOROffboardingEmployeeSignOffs_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitEmployeeSignOffReviewForOffboardingDocumentsRequestBadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitEmployeeSignOffReviewForOffboardingDocumentsRequestUnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitEmployeeSignOffReviewForOffboardingDocumentsRequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitEmployeeSignOffReviewForOffboardingDocumentsRequestInternalServerError"}}}}},"requestBody":{"description":"Ok response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/eor/workers/{worker_id}/payslips":{"get":{"operationId":"get-worker-payslips","summary":"Retrieve employee payslip records","description":"Retrieve a list of payslip records for a specific employee, detailing payment periods, status, and associated identifiers.\n **Token scopes**: `payslips:read`","tags":["subpackage_eorPayslips"],"parameters":[{"name":"worker_id","in":"path","description":"The ID of the worker whose payslips are being retrieved.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Payslip records successfully retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-payslips_getWorkerPayslips_Response_200"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/eor/contracts/{contract_id}/project-assignment/accept":{"post":{"operationId":"accept-project-assignment","summary":"Accept EOR project assignment as client","description":"Utilize this endpoint to accept a project assignment for an EOR contract once the client has reviewed and approved the terms.\n **Token scopes**: `contracts:write`","tags":["subpackage_eorProjectAssignment"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The project assignment was accepted successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-project-assignment_acceptProjectAssignment_Response_204"}}}},"400":{"description":"Bad Request. The request could not be understood or was missing required parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptEorProjectAssignmentAsClientRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"409":{"description":"The requested version of the document mismatch the current version.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptEorProjectAssignmentAsClientRequestConflictError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptEorProjectAssignmentAsClientRequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentAcceptPostRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/eor/contracts/{contract_id}/project-assignment":{"get":{"operationId":"get-project-assignment","summary":"Fetch EOR project assignment PDF","description":"Utilize this endpoint to retrieve the PDF of the project assignment for an EOR contract that a client is required to approve.\n **Token scopes**: `contracts:read`","tags":["subpackage_eorProjectAssignment"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","required":true,"schema":{"type":"string"}},{"name":"version","in":"query","description":"This field is to ensure that the latest version of the project assignment PDF matches the version received from the webhook. If it is not sent, the version validation is not performed and the endpoint returns the PDF. If it is sent, it is checked whether the current version is equal to the version sent; if not, a 409 error occurs, otherwise, the PDF is returned.","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad Request. The request could not be understood or was missing required parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchEorProjectAssignmentPdfRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"409":{"description":"The requested version of the document mismatch the current version.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchEorProjectAssignmentPdfRequestConflictError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchEorProjectAssignmentPdfRequestInternalServerError"}}}}}}},"/eor/contracts/{contract_id}/project-assignment/checkin":{"get":{"operationId":"get-project-assignment-checkin","summary":"Fetch Project Assignment Checkin Questionnaire Data","description":"Use this endpoint to fetch the project assignment checkin data with all necessary information to render in your side the questionnaire\n **Token scopes**: `contracts:read`","tags":["subpackage_eorProjectAssignment"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the contract.","required":true,"schema":{"type":"string"}},{"name":"version","in":"query","description":"This field is to ensure that the latest version of the project assignment checkin matches the version received from the webhook. If it is not sent, the version validation is not performed. If it is sent, it is checked whether the current version is equal to the version sent; if not, a 409 error occurs, otherwise, the data is returned.","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response containing form configuration data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-project-assignment_getProjectAssignmentCheckin_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchProjectAssignmentCheckinQuestionnaireDataRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"409":{"description":"The requested version of the document mismatch the current version.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchProjectAssignmentCheckinQuestionnaireDataRequestConflictError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchProjectAssignmentCheckinQuestionnaireDataRequestInternalServerError"}}}}}},"post":{"operationId":"checkin-project-assignment","summary":"Submit Project Assignment Checkin Questionnaire Data","description":"Use this endpoint to submit the checkin questionnaire. It is necessary to send all required questionnaire answers.\n **Token scopes**: `contracts:read`, `contracts:write`","tags":["subpackage_eorProjectAssignment"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the contract.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No content. The request was successful, but there is no response body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-project-assignment_checkinProjectAssignment_Response_204"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitProjectAssignmentCheckinQuestionnaireDataRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"409":{"description":"The requested version of the document mismatch the current version.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitProjectAssignmentCheckinQuestionnaireDataRequestConflictError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitProjectAssignmentCheckinQuestionnaireDataRequestInternalServerError"}}}}},"requestBody":{"description":"Payload for submitting employee or client form answers.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentCheckinPostRequestBodyContentApplicationJsonSchemaData","description":"Form submission payload containing respondent type, question answers, and optional version."}}}}}}}},"/eor/{oid}/terminations/{terminationId}":{"get":{"operationId":"get-termination","summary":"Get termination","description":"This API allows clients and employees with viewer permissions to retrieve termination data. It ensures that only authorized users can access sensitive information related to terminations.\n **Token scopes**: `contracts:read`","tags":["subpackage_eorTerminations"],"parameters":[{"name":"oid","in":"path","description":"Public contract oid","required":true,"schema":{"type":"string"}},{"name":"terminationId","in":"path","description":"Termination id","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-terminations_getTermination_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Unauthorized response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaItems"}}}}},"403":{"description":"Forbidden response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaItems"}}}}},"404":{"description":"Not Found response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaItems"}}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/eor/contracts/{contract_id}/offboarding/termination":{"post":{"operationId":"create-offboarding-termination","summary":"Initiate EOR contract termination request","description":"Enables clients to initiate a request for the termination of an Employee of Record (EOR) contract for members of their team.\n **Token scopes**: `contracts:write`","tags":["subpackage_eorTerminations"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Ok response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-terminations_createOffboardingTermination_Response_201"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitiateEorContractTerminationRequestRequestBadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitiateEorContractTerminationRequestRequestUnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitiateEorContractTerminationRequestRequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitiateEorContractTerminationRequestRequestInternalServerError"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaData"}},"required":["data"]}}}}}},"/eor/{oid}/terminations/resignation":{"post":{"operationId":"create-resignation","summary":"Request EOR Contract Resignation","description":"Enable clients with group admin and people manager permissions to initiate a resignation request for an Employee of Record (EOR) contract within their team.\n **Token scopes**: `contracts:read`, `contracts:write`","tags":["subpackage_eorTerminations"],"parameters":[{"name":"oid","in":"path","description":"Public contract oid","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-terminations_createResignation_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Unauthorized response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaItems"}}}}},"403":{"description":"Forbidden response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaItems"}}}}},"404":{"description":"Not Found response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaItems"}}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/eor/{oid}/terminations/regular":{"post":{"operationId":"create-regular-termination","summary":"Termination Request","description":"This API enables clients with group admin and people manager permissions to initiate a request for the termination of an Employee of Record (EOR) contract for members of their team.\n **Token scopes**: `contracts:read`, `contracts:write`","tags":["subpackage_eorTerminations"],"parameters":[{"name":"oid","in":"path","description":"Public contract id","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-terminations_createRegularTermination_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Unauthorized response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaItems"}}}}},"403":{"description":"Forbidden response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaItems"}}}}},"404":{"description":"Not Found response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaItems"}}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}}},"servers":[{"url":"https://api.letsdeel.com/rest/v2"},{"url":"https://api-staging.letsdeel.com/rest/v2"}],"components":{"schemas":{"AdjustmentsPostRequestBodyContentMultipartFormDataSchemaAmount":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Amount of adjustment.","title":"AdjustmentsPostRequestBodyContentMultipartFormDataSchemaAmount"},"AdjustmentsPostResponsesContentApplicationJsonSchemaDataFile":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"fileType":{"type":"string","description":"The type of the file"}},"description":"'Adjustment attachement","title":"AdjustmentsPostResponsesContentApplicationJsonSchemaDataFile"},"AdjustmentsPostResponsesContentApplicationJsonSchemaDataStatus0":{"type":"string","enum":["OPEN","PENDING_APPROVAL","OVERWRITTEN","FAILED","SUCCESS","AI_CHECK_IN_PROGRESS"],"description":"Adjustment status (when contract type is GP)","title":"AdjustmentsPostResponsesContentApplicationJsonSchemaDataStatus0"},"AdjustmentsPostResponsesContentApplicationJsonSchemaDataStatus1":{"type":"string","enum":["DRAFT","PENDING","ERRORS_FOUND","APPROVED","DENIED","DISBURSE_SCHEDULED","REIMBURSED","UNDER_REVIEW","PENDING_DEEL_REVIEW"],"description":"Adjustment status (when contract type is EOR)","title":"AdjustmentsPostResponsesContentApplicationJsonSchemaDataStatus1"},"AdjustmentsPostResponsesContentApplicationJsonSchemaDataStatus":{"oneOf":[{"$ref":"#/components/schemas/AdjustmentsPostResponsesContentApplicationJsonSchemaDataStatus0"},{"$ref":"#/components/schemas/AdjustmentsPostResponsesContentApplicationJsonSchemaDataStatus1"}],"description":"The status of the adjustments","title":"AdjustmentsPostResponsesContentApplicationJsonSchemaDataStatus"},"AdjustmentsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the adjustment"},"file":{"oneOf":[{"$ref":"#/components/schemas/AdjustmentsPostResponsesContentApplicationJsonSchemaDataFile"},{"type":"null"}],"description":"'Adjustment attachement"},"title":{"type":"string","description":"The title of the adjustment"},"amount":{"type":"string","description":"The amount of the adjustment"},"status":{"$ref":"#/components/schemas/AdjustmentsPostResponsesContentApplicationJsonSchemaDataStatus","description":"The status of the adjustments"},"created_at":{"type":"string","format":"date-time","description":"The date and time when the adjustment was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time when the adjustment was last updated"},"contract_id":{"type":"string","description":"The identifier of the contract associated with the adjustment"},"description":{"type":"string","description":"The description of the adjustment"},"cycle_reference":{"type":["string","null"],"description":"The reference to the cycle associated with the adjustment"},"move_next_cycle":{"type":"boolean","description":"If an adjustments can belong to another payroll cycle"},"date_of_adjustment":{"type":"string","format":"date-time","description":"The date of the adjustment"},"actual_end_cycle_date":{"type":"string","description":"The date of the actual end cycle date"},"adjustment_category_id":{"type":"string","description":"The identifier of the adjustment category associated with the adjustment"},"actual_start_cycle_date":{"type":"string","description":"The date of the actual start cycle date"}},"title":"AdjustmentsPostResponsesContentApplicationJsonSchemaData"},"adjustments_createContractAdjustment_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AdjustmentsPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"adjustments_createContractAdjustment_Response_201"},"AdjustmentsPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"title":"AdjustmentsPostResponsesContentApplicationJsonSchemaErrorsItems"},"CreateANewAdjustment-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/AdjustmentsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"CreateANewAdjustment-v2026-01-01RequestBadRequestError"},"ApiErrorRequest":{"type":"object","properties":{"method":{"type":"string","description":"The HTTP method of the failed request"},"url":{"type":"string","description":"The relative URL of the failed request"},"status":{"type":"number","format":"double","description":"The status code of the response"},"api_req_id":{"type":"string","description":"The request ID of the failed request"},"docs":{"type":"string","description":"A link to the official documentation for the requested endpoint resource"},"source":{"type":"string","description":"The source handler which produced the returned error"},"code":{"type":"number","format":"double","description":"The code of the source handler which produced the returned error"}},"title":"ApiErrorRequest"},"ApiError":{"type":"object","properties":{"message":{"type":"string","description":"A description of the returned error"},"path":{"type":"string","description":"The JSON path where input validation failed"}},"title":"ApiError"},"ApiErrorContainer":{"type":"object","properties":{"request":{"$ref":"#/components/schemas/ApiErrorRequest"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}},"title":"ApiErrorContainer"},"AdjustmentsIdDeleteResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"deleted":{"type":"boolean","description":"Confirms the deletion."}},"required":["deleted"],"title":"AdjustmentsIdDeleteResponsesContentApplicationJsonSchemaData"},"adjustments_deleteContractAdjustment_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AdjustmentsIdDeleteResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"adjustments_deleteContractAdjustment_Response_200"},"ContractsContractIdAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsFile":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"fileType":{"type":"string","description":"The type of the file"}},"description":"Info for the attachment of adjustment","title":"ContractsContractIdAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsFile"},"ContractsContractIdAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsStatus":{"type":"string","enum":["open","pending_approval","overwritten","failed","success","DRAFT","PENDING","APPROVED","DENIED","DISBURSE_SCHEDULED","REIMBURSED","UNDER_REVIEW","ERRORS_FOUND","PENDING_DEEL_REVIEW","AI_CHECK_IN_PROGRESS"],"description":"Adjustment status","title":"ContractsContractIdAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsStatus"},"ContractsContractIdAdjustmentsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the adjustment"},"file":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsFile"},{"type":"null"}],"description":"Info for the attachment of adjustment"},"title":{"type":"string","description":"The title of the adjustment"},"amount":{"type":"string","description":"The amount of the adjustment"},"status":{"$ref":"#/components/schemas/ContractsContractIdAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsStatus","description":"Adjustment status"},"created_at":{"type":"string","format":"date-time","description":"The date and time when the adjustment was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time when the adjustment was last updated"},"contract_id":{"type":"string","description":"The identifier of the contract associated with the adjustment"},"description":{"type":"string","description":"The description of the adjustment"},"cycle_reference":{"type":["string","null"],"description":"The reference to the cycle associated with the adjustment"},"move_next_cycle":{"type":"boolean","description":"If an adjustments can belong to another payroll cycle"},"date_of_adjustment":{"type":["string","null"],"format":"date-time","description":"The date of the adjustment"},"actual_end_cycle_date":{"type":"string","description":"The date of the actual end cycle date"},"adjustment_category_id":{"type":"string","description":"The identifier of the adjustment category associated with the adjustment"},"actual_start_cycle_date":{"type":"string","description":"The date of the actual start cycle date"}},"title":"ContractsContractIdAdjustmentsGetResponsesContentApplicationJsonSchemaDataItems"},"adjustments_getContractAdjustments_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdAdjustmentsGetResponsesContentApplicationJsonSchemaDataItems"}}},"required":["data"],"title":"adjustments_getContractAdjustments_Response_200"},"ContractsContractIdAdjustmentsGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"message":{"type":"string","description":"You must have access to the contract sent"}},"title":"ContractsContractIdAdjustmentsGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveAdjustmentsRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdAdjustmentsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveAdjustmentsRequestBadRequestError"},"AdjustmentsIdGetResponsesContentApplicationJsonSchemaDataFile":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"fileType":{"type":"string","description":"The type of the file"}},"description":"Info about the attachment of adjustment","title":"AdjustmentsIdGetResponsesContentApplicationJsonSchemaDataFile"},"AdjustmentsIdGetResponsesContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["open","pending_approval","overwritten","failed","success","DRAFT","PENDING","APPROVED","DENIED","DISBURSE_SCHEDULED","REIMBURSED","UNDER_REVIEW","ERRORS_FOUND","PENDING_DEEL_REVIEW","AI_CHECK_IN_PROGRESS"],"description":"Adjustment status","title":"AdjustmentsIdGetResponsesContentApplicationJsonSchemaDataStatus"},"AdjustmentsIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the adjustment"},"file":{"oneOf":[{"$ref":"#/components/schemas/AdjustmentsIdGetResponsesContentApplicationJsonSchemaDataFile"},{"type":"null"}],"description":"Info about the attachment of adjustment"},"title":{"type":"string","description":"The title of the adjustment"},"amount":{"type":"string","description":"The amount of the adjustment"},"status":{"$ref":"#/components/schemas/AdjustmentsIdGetResponsesContentApplicationJsonSchemaDataStatus","description":"Adjustment status"},"created_at":{"type":"string","format":"date-time","description":"The date and time when the adjustment was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time when the adjustment was last updated"},"contract_id":{"type":"string","description":"The identifier of the contract associated with the adjustment"},"description":{"type":"string","description":"The description of the adjustment"},"cycle_reference":{"type":["string","null"],"description":"The reference to the cycle associated with the adjustment"},"move_next_cycle":{"type":"boolean","description":"If an adjustments can belong to another payroll cycle"},"date_of_adjustment":{"type":"string","format":"date-time","description":"The date of the adjustment"},"actual_end_cycle_date":{"type":"string","description":"The date of the actual end cycle date"},"adjustment_category_id":{"type":"string","description":"The identifier of the adjustment category associated with the adjustment"},"actual_start_cycle_date":{"type":"string","description":"The date of the actual start cycle date"}},"title":"AdjustmentsIdGetResponsesContentApplicationJsonSchemaData"},"adjustments_getContractAdjustment_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AdjustmentsIdGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"adjustments_getContractAdjustment_Response_200"},"AdjustmentsIdGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"message":{"type":"string","description":"You must have access to the contract sent"}},"title":"AdjustmentsIdGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveAnAdjustmentRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/AdjustmentsIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveAnAdjustmentRequestBadRequestError"},"AdjustmentsCategoriesGetParametersContractTypesSchemaItems":{"type":"string","enum":["peo","global_payroll","hris_direct_employee","eor","employee","independent_contractor"],"title":"AdjustmentsCategoriesGetParametersContractTypesSchemaItems"},"AdjustmentsCategoriesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of an adjustment category."},"name":{"type":"string","description":"The name of the adjustment category."},"label":{"type":"string","description":"The label of the adjustment category."},"unit_type":{"type":"string","description":"The unit type of the adjustment category."}},"title":"AdjustmentsCategoriesGetResponsesContentApplicationJsonSchemaDataItems"},"adjustments_getAdjustmentCategories_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AdjustmentsCategoriesGetResponsesContentApplicationJsonSchemaDataItems"}}},"required":["data"],"title":"adjustments_getAdjustmentCategories_Response_200"},"AdjustmentsIdPatchRequestBodyContentMultipartFormDataSchemaDataAmount":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Amount of adjustment.","title":"AdjustmentsIdPatchRequestBodyContentMultipartFormDataSchemaDataAmount"},"AdjustmentsIdPatchRequestBodyContentMultipartFormDataSchemaData":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"File of adjustment."},"title":{"type":"string","description":"Title of adjustment."},"amount":{"$ref":"#/components/schemas/AdjustmentsIdPatchRequestBodyContentMultipartFormDataSchemaDataAmount","description":"Amount of adjustment."},"description":{"type":"string","description":"Description of adjustment."}},"description":"Details of adjustment to update","title":"AdjustmentsIdPatchRequestBodyContentMultipartFormDataSchemaData"},"AdjustmentsIdPatchResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"updated":{"type":"boolean"}},"required":["updated"],"title":"AdjustmentsIdPatchResponsesContentApplicationJsonSchemaData"},"adjustments_updateContractAdjustment_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AdjustmentsIdPatchResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"adjustments_updateContractAdjustment_Response_200"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataType":{"type":"string","enum":["INSTANT","OPS","LEGAL","DISABLED","CUSTOM","AUTOMATED"],"description":"Type of amendment","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataType"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataItemsItemsType":{"type":"string","enum":["INSTANT","OPS","LEGAL","DISABLED","CUSTOM","AUTOMATED"],"description":"Type of amendment","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataItemsItemsType"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataItemsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Id of amendment item"},"item":{"type":"string","description":"Amendment item"},"type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataItemsItemsType","description":"Type of amendment"},"new_value":{"type":"string","description":"The new valid value after the attempted change."},"data_point":{"type":"string","description":"The field that is selected for amendment."},"previous_value":{"type":"string","description":"The previous valid value before the attempted change."}},"title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataItemsItems"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataSource":{"type":"string","enum":["APP","PUBLIC_API","APP_BULK_AMENDMENT"],"description":"Source of amendment flow creation.","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataSource"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus":{"type":"string","enum":["REJECTED","APPROVED","PENDING_REVIEW","PENDING_LEGAL"],"description":"Current status of the custom amendment item","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataCustomItemsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the custom amendment item"},"type":{"type":"string","description":"Type/context of the custom amendment item"},"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus","description":"Current status of the custom amendment item"},"description":{"type":["string","null"],"description":"Detailed description of the custom amendment item"},"rejection_reason":{"type":["string","null"],"description":"Reason for rejection if the item was rejected"}},"required":["id","type","status"],"title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataCustomItemsItems"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataDocumentType":{"type":"string","enum":["EA","SOW","SOW_EA"],"description":"Amendment document type","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataDocumentType"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataLegalContextStatus":{"type":"string","enum":["REQUEST_LEGAL_REVIEW","WAITING_FOR_ANOTHER_TEAM","WAITING_FOR_HRX_ACTION","DECLINED","SOLVED"],"description":"Current status of the legal review process","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataLegalContextStatus"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataLegalContext":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataLegalContextStatus","description":"Current status of the legal review process"},"details":{"type":"string","description":"Details regarding the legal request"},"jira_ticket":{"type":"string","description":"Jira ticket identifier linked to the legal context"},"jira_web_url":{"type":"string","format":"uri","description":"Link to the Jira ticket for tracking"},"requested_at":{"type":"string","format":"date-time","description":"Timestamp when legal review was requested"}},"description":"Additional details needed for legal input","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataLegalContext"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataTimeOffType":{"type":"string","enum":["STANDARD","SPECIFIC","PRORATED"],"description":"Type of time off.","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataTimeOffType"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataEmploymentType":{"type":"string","enum":["FULL_TIME","PART_TIME"],"description":"Type of employment.","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataEmploymentType"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus":{"type":"string","enum":["WAITING_FOR_SIGNING","ACTIVE","OUTDATED","CANCELLED"],"description":"Current status of the fixed adjustment.","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems":{"type":"object","properties":{"id":{"type":"string","description":"System-generated unique identifier for the fixed adjustment record in an amendment request."},"value":{"type":"string","description":"Value of the fixed adjustment."},"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus","description":"Current status of the fixed adjustment."},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the fixed adjustment was created."},"is_amended":{"type":"boolean","description":"Whether this fixed adjustment was amended from a previous one."},"is_deleted":{"type":"boolean","description":"True if the fixed adjustment was deleted as part of the amendment; otherwise false."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the fixed adjustment was last updated."},"description":{"type":"string","description":"Description of the fixed adjustment."},"is_recurring":{"type":"boolean","description":"Whether the fixed adjustment is recurring. If set to false, it will be treated as a one-time fixed allowance."},"is_country_specific":{"type":"boolean","description":"Whether this fixed adjustment applies only to a specific country."},"parent_fixed_adjustment_id":{"type":["string","null"],"description":"Reference to the parent fixed adjustment, if applicable."}},"required":["id","value","status","created_at","is_amended","updated_at","description","is_recurring","is_country_specific"],"title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataRejectionContext":{"type":"object","properties":{"rejected_at":{"type":"string","format":"date-time","description":"Timestamp of when the rejection occurred"}},"description":"Additional details containing rejection reason","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataRejectionContext"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"The timestamp when this amendment status was created."}},"description":"Metadata about the amendment status, including when it was created.","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems":{"type":"object","properties":{"name":{"type":"string","description":"Logical, system-oriented identifier of the amendment status. Can be used to group statuses under a parent category and subgroup them for more granular state tracking. The structure typically follows a dot-separated hierarchy (e.g., 'PARENT','PARENT.CHILD', 'PARENT.CHILD.CHILD.CHILD', ...), which allows logical grouping and filtering of related statuses."},"friendly_name":{"type":"string","description":"Human-readable label of the amendment status (e.g., DRAFT, PENDING, APPROVED)."},"amendment_flow_status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus","description":"Metadata about the amendment status, including when it was created."}},"description":"Details of a specific amendment status in the lifecycle of the amendment.","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataNoticePeriodType":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of notice period.","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataNoticePeriodType"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVoidDeadlineType":{"type":"string","enum":["CUTOFF","START_DATE","END_DATE","EXPIRY"],"description":"Type of void deadline","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVoidDeadlineType"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVariableCompensationType":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary.","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVariableCompensationType"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline":{"type":"string","enum":["MONTHLY","QUARTERLY","ANNUALLY","BIANNUALLY"],"description":"How often the compensation is paid — for example monthly, quarterly, annually, or twice a year.","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan":{"type":"object","properties":{"details":{"type":"string","description":"Extra details about the incentive plan, if any."},"employee_signature":{"type":"string","description":"The employee’s signature for the incentive plan, if collected."},"employee_signed_at":{"type":"string","format":"date-time","description":"The date and time when the employee signed the incentive plan. Empty if not signed."}},"description":"Details of the incentive plan linked to this compensation, if any.","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVariableCompensation":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID assigned by the system to this variable compensation record."},"type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVariableCompensationType","description":"The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary."},"title":{"type":"string","description":"Title or name of the variable compensation."},"amount":{"type":"string","format":"decimal","description":"The value of the compensation. Shown as a string to keep the exact number of decimals."},"timeline":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline","description":"How often the compensation is paid — for example monthly, quarterly, annually, or twice a year."},"parent_id":{"type":["string","null"],"description":"Reference to the parent variable compensation, if applicable. Null if this compensation is not linked to any compensation."},"created_at":{"type":"string","format":"date-time","description":"The date and time when this record was first created in the system."},"is_amended":{"type":"boolean","description":"Shows whether this compensation has been changed as part of an amendment."},"is_deleted":{"type":"boolean","description":"Shows whether this compensation has been deleted."},"updated_at":{"type":"string","format":"date-time","description":"The date and time when this record was last updated."},"effective_date":{"type":"string","format":"date-time","description":"The date when this compensation starts being valid."},"incentive_plan":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan","description":"Details of the incentive plan linked to this compensation, if any."}},"required":["id","type","title","amount","timeline","parent_id","created_at","updated_at","effective_date"],"description":"Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended.","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVariableCompensation"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit":{"type":"string","enum":["DAY","WEEK","MONTH"],"description":"Notice period time unit.","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of probation period for definite contracts.","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Id of amendment"},"type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataType"},{"type":"null"}],"description":"Type of amendment"},"items":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataItemsItems"},"description":"Items of amendment"},"scope":{"type":"string","description":"Scope of the amendment."},"salary":{"type":"string","description":"Salary for the amendment."},"source":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataSource"},{"type":"null"}],"description":"Source of amendment flow creation."},"currency":{"type":"string","description":"Contract currency."},"end_date":{"type":["string","null"],"format":"date-time","description":"End date of the employment."},"holidays":{"type":["integer","null"],"description":"Number of holidays."},"job_code":{"type":["string","null"],"description":"Job code associated with the job title."},"job_title":{"type":"string","description":"Job title associated with the amendment."},"created_at":{"type":"string","format":"date-time","description":"Creation date of the amendment."},"start_date":{"type":"string","format":"date-time","description":"Start date of the employment."},"updated_at":{"type":"string","format":"date-time","description":"Date when amendment is updated"},"hourly_rate":{"type":["string","null"],"description":"Hourly rate of the amendment"},"custom_items":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataCustomItemsItems"},"description":"Custom amendment items associated with the amendment flow"},"job_category":{"type":["string","null"],"description":"Job category associated with the job title."},"requested_by":{"type":["string","null"],"description":"Profile name of the user who requested the change"},"seniority_id":{"type":["string","null"],"format":"uuid","description":"Seniority level identifier."},"document_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataDocumentType"},{"type":"null"}],"description":"Amendment document type"},"legal_context":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataLegalContext"},{"type":"null"}],"description":"Additional details needed for legal input"},"time_off_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataTimeOffType","description":"Type of time off."},"void_deadline":{"type":["string","null"],"format":"date-time","description":"Deadline this SOW to be voided"},"effective_date":{"type":["string","null"],"format":"date-time","description":"Effective date of the amendment."},"seniority_date":{"type":["string","null"],"format":"date","description":"The seniority date represents the employee’s original start date with a previous employer. It is used to preserve employment tenure when the employee transfers to this company. Can be null if not applicable."},"employment_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataEmploymentType","description":"Type of employment."},"sick_leave_days":{"type":["integer","null"],"description":"Number of sick leave days"},"employment_state":{"type":["string","null"],"description":"State of employment."},"probation_period":{"type":["integer","null"],"description":"Duration of the probation period."},"work_schedule_id":{"type":["string","null"],"format":"uuid","description":"Work schedule id"},"fixed_adjustments":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems"},"description":"List of fixed adjustments associated with the amendment request."},"rejection_context":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataRejectionContext"},{"type":"null"}],"description":"Additional details containing rejection reason"},"amendment_statuses":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems"},"description":"List of amendment statuses representing the history and progression of an amendment."},"notice_period_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataNoticePeriodType"},{"type":"null"}],"description":"Type of notice period."},"void_deadline_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVoidDeadlineType"},{"type":"null"}],"description":"Type of void deadline"},"work_hours_per_week":{"type":"string","description":"Number of work hours per week."},"employee_nationality":{"type":"string","description":"Nationality of the employee."},"is_hrx_action_needed":{"type":"boolean","description":"Is HRX action needed."},"variable_compensation":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVariableCompensation","description":"Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended."},"notice_period_time_unit":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit"},{"type":"null"}],"description":"Notice period time unit."},"is_effective_date_updated":{"type":"boolean","description":"Is Effective Date updated."},"work_schedule_rules_version":{"type":["string","null"],"description":"Work schedule rule version."},"notice_period_after_probation":{"type":["string","null"],"description":"Notice period after probation."},"notice_period_during_probation":{"type":["string","null"],"description":"Notice period during probation."},"probation_period_type_for_definite":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite"},{"type":"null"}],"description":"Type of probation period for definite contracts."}},"title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaData"},"eor-amendments_acceptContractAmendment_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaData"}},"title":"eor-amendments_acceptContractAmendment_Response_200"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaErrorsItems"},"AcceptAContractAmendmentOnBehalfOfTheClientRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"AcceptAContractAmendmentOnBehalfOfTheClientRequestBadRequestError"},"AcceptAContractAmendmentOnBehalfOfTheClientRequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"AcceptAContractAmendmentOnBehalfOfTheClientRequestNotFoundError"},"AcceptAContractAmendmentOnBehalfOfTheClientRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"AcceptAContractAmendmentOnBehalfOfTheClientRequestInternalServerError"},"EorContractsContractIdAmendmentsAmendmentIdDeleteResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["success"],"title":"EorContractsContractIdAmendmentsAmendmentIdDeleteResponsesContentApplicationJsonSchemaData"},"eor-amendments_deleteContractAmendment_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdDeleteResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-amendments_deleteContractAmendment_Response_200"},"EorContractsContractIdAmendmentsAmendmentIdDeleteResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"title":"EorContractsContractIdAmendmentsAmendmentIdDeleteResponsesContentApplicationJsonSchemaErrorsItems"},"CancelAmendmentRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdDeleteResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"CancelAmendmentRequestBadRequestError"},"CancelAmendmentRequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdDeleteResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"CancelAmendmentRequestNotFoundError"},"CancelAmendmentRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdDeleteResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"CancelAmendmentRequestInternalServerError"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataType":{"type":"string","enum":["INSTANT","OPS","LEGAL","DISABLED","CUSTOM","AUTOMATED"],"description":"Type of amendment","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataType"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataItemsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Id of amendment item"},"item":{"type":"string","description":"Amendment item"},"type":{"type":"string","description":"Type of amendment"},"new_value":{"type":"string","description":"The new valid value after the attempted change."},"data_point":{"type":"string","description":"The field that is selected for amendment."},"previous_value":{"type":"string","description":"The previous valid value before the attempted change."}},"title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataItemsItems"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataSource":{"type":"string","enum":["APP","PUBLIC_API","APP_BULK_AMENDMENT"],"description":"Source of amendment flow creation.","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataSource"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus":{"type":"string","enum":["REJECTED","APPROVED","PENDING_REVIEW","PENDING_LEGAL"],"description":"Current status of the custom amendment item","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataCustomItemsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the custom amendment item"},"type":{"type":"string","description":"Type/context of the custom amendment item"},"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus","description":"Current status of the custom amendment item"},"description":{"type":["string","null"],"description":"Detailed description of the custom amendment item"},"rejection_reason":{"type":["string","null"],"description":"Reason for rejection if the item was rejected"}},"required":["id","type","status"],"title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataCustomItemsItems"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataDocumentType":{"type":"string","enum":["EA","SOW","SOW_EA"],"description":"Amendment document type","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataDocumentType"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataLegalContextStatus":{"type":"string","enum":["REQUEST_LEGAL_REVIEW","WAITING_FOR_ANOTHER_TEAM","WAITING_FOR_HRX_ACTION","DECLINED","SOLVED"],"description":"Current status of the legal review process","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataLegalContextStatus"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataLegalContext":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataLegalContextStatus","description":"Current status of the legal review process"},"details":{"type":"string","description":"Details regarding the legal request"},"jira_ticket":{"type":"string","description":"Jira ticket identifier linked to the legal context"},"jira_web_url":{"type":"string","format":"uri","description":"Link to the Jira ticket for tracking"},"requested_at":{"type":"string","format":"date-time","description":"Timestamp when legal review was requested"}},"description":"Additional details needed for legal input","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataLegalContext"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataTimeOffType":{"type":"string","enum":["STANDARD","SPECIFIC","PRORATED"],"description":"Type of time off.","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataTimeOffType"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataEmploymentType":{"type":"string","enum":["FULL_TIME","PART_TIME"],"description":"Type of employment.","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataEmploymentType"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus":{"type":"string","enum":["WAITING_FOR_SIGNING","ACTIVE","OUTDATED","CANCELLED"],"description":"Current status of the fixed adjustment.","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems":{"type":"object","properties":{"id":{"type":"string","description":"System-generated unique identifier for the fixed adjustment record in an amendment request."},"value":{"type":"string","description":"Value of the fixed adjustment."},"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus","description":"Current status of the fixed adjustment."},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the fixed adjustment was created."},"is_amended":{"type":"boolean","description":"Whether this fixed adjustment was amended from a previous one."},"is_deleted":{"type":"boolean","description":"True if the fixed adjustment was deleted as part of the amendment; otherwise false."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the fixed adjustment was last updated."},"description":{"type":"string","description":"Description of the fixed adjustment."},"is_recurring":{"type":"boolean","description":"Whether the fixed adjustment is recurring. If set to false, it will be treated as a one-time fixed allowance."},"is_country_specific":{"type":"boolean","description":"Whether this fixed adjustment applies only to a specific country."},"parent_fixed_adjustment_id":{"type":["string","null"],"description":"Reference to the parent fixed adjustment, if applicable."}},"required":["id","value","status","created_at","is_amended","updated_at","description","is_recurring","is_country_specific"],"title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataRejectionContext":{"type":"object","properties":{"rejected_at":{"type":"string","format":"date-time","description":"Timestamp of when the rejection occurred"}},"description":"Additional details containing rejection reason","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataRejectionContext"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"Creation date"}},"description":"Metadata about the amendment status, including when it was created.","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems":{"type":"object","properties":{"name":{"type":"string","description":"Logical, system-oriented identifier of the amendment status. Can be used to group statuses under a parent category and subgroup them for more granular state tracking. The structure typically follows a dot-separated hierarchy (e.g., 'PARENT','PARENT.CHILD', 'PARENT.CHILD.CHILD.CHILD', ...), which allows logical grouping and filtering of related statuses."},"friendly_name":{"type":"string","description":"Friendly name of amendment status"},"amendment_flow_status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus","description":"Metadata about the amendment status, including when it was created."}},"title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataNoticePeriodType":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of notice period.","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataNoticePeriodType"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVoidDeadlineType":{"type":"string","enum":["CUTOFF","START_DATE","END_DATE","EXPIRY"],"description":"Type of void deadline","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVoidDeadlineType"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVariableCompensationType":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary.","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVariableCompensationType"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline":{"type":"string","enum":["MONTHLY","QUARTERLY","ANNUALLY","BIANNUALLY"],"description":"How often the compensation is paid — for example monthly, quarterly, annually, or twice a year.","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan":{"type":"object","properties":{"details":{"type":"string","description":"Extra details about the incentive plan, if any."},"employee_signature":{"type":"string","description":"The employee’s signature for the incentive plan, if collected."},"employee_signed_at":{"type":"string","format":"date-time","description":"The date and time when the employee signed the incentive plan. Empty if not signed."}},"description":"Details of the incentive plan linked to this compensation, if any.","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVariableCompensation":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID assigned by the system to this variable compensation record."},"type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVariableCompensationType","description":"The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary."},"title":{"type":"string","description":"Title or name of the variable compensation."},"amount":{"type":"string","format":"decimal","description":"The value of the compensation. Shown as a string to keep the exact number of decimals."},"timeline":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline","description":"How often the compensation is paid — for example monthly, quarterly, annually, or twice a year."},"parent_id":{"type":["string","null"],"description":"Reference to the parent variable compensation, if applicable. Null if this compensation is not linked to any compensation."},"created_at":{"type":"string","format":"date-time","description":"The date and time when this record was first created in the system."},"is_amended":{"type":"boolean","description":"Shows whether this compensation has been changed as part of an amendment."},"is_deleted":{"type":"boolean","description":"Shows whether this compensation has been deleted."},"updated_at":{"type":"string","format":"date-time","description":"The date and time when this record was last updated."},"effective_date":{"type":"string","format":"date-time","description":"The date when this compensation starts being valid."},"incentive_plan":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan","description":"Details of the incentive plan linked to this compensation, if any."}},"required":["id","type","title","amount","timeline","parent_id","created_at","updated_at","effective_date"],"description":"Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended.","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVariableCompensation"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit":{"type":"string","enum":["DAY","WEEK","MONTH"],"description":"Notice period time unit.","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of probation period for definite contracts.","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Id of amendment"},"type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataType"},{"type":"null"}],"description":"Type of amendment"},"items":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataItemsItems"},"description":"Items of amendment"},"scope":{"type":"string","description":"Scope of the amendment."},"salary":{"type":"string","description":"Salary for the amendment."},"source":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataSource"},{"type":"null"}],"description":"Source of amendment flow creation."},"currency":{"type":"string","description":"Contract currency."},"end_date":{"type":["string","null"],"format":"date-time","description":"End date of the employment."},"holidays":{"type":["integer","null"],"description":"Number of holidays."},"job_code":{"type":["string","null"],"description":"Job code associated with the job title."},"job_title":{"type":"string","description":"Job title associated with the amendment."},"created_at":{"type":"string","format":"date-time","description":"Creation date of the amendment."},"start_date":{"type":"string","format":"date-time","description":"Start date of the employment."},"updated_at":{"type":"string","format":"date-time","description":"Date when amendment is updated"},"hourly_rate":{"type":["string","null"],"description":"Hourly rate of the amendment"},"custom_items":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataCustomItemsItems"},"description":"Custom amendment items associated with the amendment flow"},"job_category":{"type":["string","null"],"description":"Job category associated with the job title."},"requested_by":{"type":["string","null"],"description":"Profile name of the user who requested the change"},"seniority_id":{"type":["string","null"],"format":"uuid","description":"Seniority level identifier."},"document_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataDocumentType"},{"type":"null"}],"description":"Amendment document type"},"legal_context":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataLegalContext"},{"type":"null"}],"description":"Additional details needed for legal input"},"time_off_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataTimeOffType","description":"Type of time off."},"void_deadline":{"type":["string","null"],"format":"date","description":"Deadline this SOW to be voided"},"effective_date":{"type":["string","null"],"format":"date-time","description":"Effective date of the amendment."},"seniority_date":{"type":["string","null"],"format":"date-time","description":"The seniority date represents the employee’s original start date with a previous employer. It is used to preserve employment tenure when the employee transfers to this company. Can be null if not applicable."},"employment_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataEmploymentType","description":"Type of employment."},"sick_leave_days":{"type":["integer","null"],"description":"Number of sick leave days"},"employment_state":{"type":["string","null"],"description":"State of employment."},"probation_period":{"type":["integer","null"],"description":"Duration of the probation period."},"work_schedule_id":{"type":["string","null"],"format":"uuid","description":"Work schedule id"},"fixed_adjustments":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems"},"description":"List of fixed adjustments associated with the amendment request."},"rejection_context":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataRejectionContext"},{"type":"null"}],"description":"Additional details containing rejection reason"},"amendment_statuses":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems"},"description":"List of amendment statuses representing the history and progression of an amendment."},"notice_period_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataNoticePeriodType"},{"type":"null"}],"description":"Type of notice period."},"void_deadline_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVoidDeadlineType"},{"type":"null"}],"description":"Type of void deadline"},"work_hours_per_week":{"type":"string","description":"Number of work hours per week."},"employee_nationality":{"type":"string","description":"Nationality of the employee."},"is_hrx_action_needed":{"type":"boolean","description":"Is HRX action needed."},"variable_compensation":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVariableCompensation","description":"Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended."},"notice_period_time_unit":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit"},{"type":"null"}],"description":"Notice period time unit."},"is_effective_date_updated":{"type":"boolean","description":"Is Effective Date updated."},"work_schedule_rules_version":{"type":["string","null"],"description":"Work schedule rule version."},"notice_period_after_probation":{"type":["string","null"],"description":"Notice period after probation."},"notice_period_during_probation":{"type":["string","null"],"description":"Notice period during probation."},"probation_period_type_for_definite":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite"},{"type":"null"}],"description":"Type of probation period for definite contracts."}},"title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaData"},"eor-amendments_confirmContractAmendment_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaData"}},"title":"eor-amendments_confirmContractAmendment_Response_200"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaErrorsItems"},"ConfirmAnExistingContractAmendment-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"ConfirmAnExistingContractAmendment-v2026-01-01RequestBadRequestError"},"ConfirmAnExistingContractAmendment-v2026-01-01RequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"ConfirmAnExistingContractAmendment-v2026-01-01RequestNotFoundError"},"ConfirmAnExistingContractAmendment-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"ConfirmAnExistingContractAmendment-v2026-01-01RequestInternalServerError"},"EorContractsContractIdAmendmentsAmendmentIdPdfGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"Pre-signed URL to download the exported PDF (valid for 15 minutes)."}},"title":"EorContractsContractIdAmendmentsAmendmentIdPdfGetResponsesContentApplicationJsonSchemaData"},"eor-amendments_getContractAmendmentPdf_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPdfGetResponsesContentApplicationJsonSchemaData"}},"title":"eor-amendments_getContractAmendmentPdf_Response_200"},"EorContractsContractIdAmendmentsAmendmentIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"title":"EorContractsContractIdAmendmentsAmendmentIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems"},"GetEorContractAmendmentPdfDownloadLinkForClientAndEmployeeRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"GetEorContractAmendmentPdfDownloadLinkForClientAndEmployeeRequestBadRequestError"},"GetEorContractAmendmentPdfDownloadLinkForClientAndEmployeeRequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"GetEorContractAmendmentPdfDownloadLinkForClientAndEmployeeRequestNotFoundError"},"GetEorContractAmendmentPdfDownloadLinkForClientAndEmployeeRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"GetEorContractAmendmentPdfDownloadLinkForClientAndEmployeeRequestInternalServerError"},"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataCustomItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"An optional identifier for the custom object."},"type":{"type":"string","description":"The type of the custom object. Must be one of the valid custom types."},"description":{"type":"string","description":"A required description for the custom object."}},"required":["type","description"],"title":"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataCustomItems"},"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataTimeOffType":{"type":"string","enum":["STANDARD","SPECIFIC","PRORATED"],"description":"Type of time off.","title":"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataTimeOffType"},"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataAdditionalInfo":{"type":"object","properties":{"ai_scope_check_public_id":{"type":"string","format":"uuid","description":"Identifier or flag for AI scope validation check"},"job_categorization_log_id":{"type":"string","format":"uuid","description":"Identifier for job categorisation log"}},"description":"Additional metadata related to job validation and categorisation","title":"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataAdditionalInfo"},"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataEmploymentType":{"type":"string","enum":["FULL_TIME","PART_TIME"],"description":"Type of employment.","title":"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataEmploymentType"},"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataFixedAdjustmentsItems":{"type":"object","properties":{"id":{"type":"string","description":"The ID of an existing active fixed adjustment to update or delete. Include this in the request only if you are updating or deleting an existing adjustment. Do not include it when creating a new one."},"value":{"type":"string","description":"Value of the fixed adjustment. Must be a positive number, not zero."},"is_deleted":{"type":"boolean","description":"Flag to mark the fixed adjustment as deleted. Required only when the fixed adjustment needs to be removed; omit it otherwise."},"description":{"type":"string","description":"Description of the fixed adjustment."},"is_recurring":{"type":"boolean","description":"Whether the fixed adjustment is recurring. If set to false, it will be treated as a one-time fixed allowance."}},"required":["value","description","is_recurring"],"title":"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataFixedAdjustmentsItems"},"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataNoticePeriodType":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of notice period.","title":"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataNoticePeriodType"},"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataVariableCompensationType":{"type":"string","enum":["PERCENTAGE","FIXED"],"description":"Type of variable compensation.","title":"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataVariableCompensationType"},"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataVariableCompensationTimeline":{"type":"string","enum":["MONTHLY","QUARTERLY","ANNUALLY","BIANNUALLY"],"description":"How often this compensation occurs. Required when creating a new compensation. Forbidden when updating an existing compensation.","title":"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataVariableCompensationTimeline"},"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataVariableCompensation":{"type":"object","properties":{"id":{"type":"string","description":"The ID of an existing active variable compensation to update or delete. Include this in the request only if you are updating or deleting an existing compensation. Do not include it when creating a new one."},"type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataVariableCompensationType","description":"Type of variable compensation."},"title":{"type":"string","description":"The title of the compensation. Required when creating a new compensation. Optional when updating an existing compensation."},"amount":{"type":"number","format":"double","description":"Positive amount for the variable compensation."},"timeline":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataVariableCompensationTimeline","description":"How often this compensation occurs. Required when creating a new compensation. Forbidden when updating an existing compensation."},"is_deleted":{"type":"boolean","description":"Flag to mark the variable compensation as deleted. Required only when the variable compensation needs to be removed; omit it otherwise"},"effective_date":{"type":"string","format":"date","description":"The date when this compensation starts or becomes effective. Required when creating a new compensation. Optional when updating an existing compensation."}},"required":["type","amount"],"description":"Represents a change to an employee’s variable compensation (e.g., bonus or commission). This schema is used for creating new variable compensation items or updating existing ones. Some fields are required when creating, optional when updating, and forbidden when updating, as specified in each field description.","title":"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataVariableCompensation"},"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of probation period for definite contracts.","title":"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite"},"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"scope":{"type":"string","description":"Scope of the amendment."},"custom":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataCustomItems"},"description":"An optional array of custom objects."},"salary":{"type":"number","format":"double","description":"Salary for the amendment."},"end_date":{"type":"string","format":"date","description":"End date of the employment."},"holidays":{"type":"number","format":"double","description":"Number of holidays."},"job_title":{"type":"string","description":"Job title associated with the amendment."},"start_date":{"type":"string","format":"date","description":"Start date of the employment."},"hourly_rate":{"type":"number","format":"double","description":"Hourly rate of the amendment. The max value supported is 1e19"},"seniority_id":{"type":"string","format":"uuid","description":"Public Id of the seniority level."},"time_off_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataTimeOffType","description":"Type of time off."},"effective_date":{"type":"string","format":"date","description":"Effective date for the amendment."},"seniority_date":{"type":["string","null"],"format":"date","description":"The seniority date represents the employee’s original start date with a previous employer. It is used to preserve employment tenure when the employee transfers to this company. Can be null if not applicable."},"additional_info":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataAdditionalInfo"},{"type":"null"}],"description":"Additional metadata related to job validation and categorisation"},"employment_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataEmploymentType","description":"Type of employment."},"employment_state":{"type":"string","description":"State of employment."},"probation_period":{"type":"number","format":"double","description":"Duration of the probation period."},"fixed_adjustments":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataFixedAdjustmentsItems"},"description":"Array of fixed adjustments to be submitted for the amendment request."},"notice_period_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataNoticePeriodType","description":"Type of notice period."},"work_hours_per_week":{"type":"number","format":"double","description":"Number of work hours per week."},"variable_compensation":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataVariableCompensation","description":"Represents a change to an employee’s variable compensation (e.g., bonus or commission). This schema is used for creating new variable compensation items or updating existing ones. Some fields are required when creating, optional when updating, and forbidden when updating, as specified in each field description."},"notice_period_after_probation":{"type":"number","format":"double","description":"Notice period after probation."},"notice_period_during_probation":{"type":"number","format":"double","description":"Notice period during probation."},"probation_period_type_for_definite":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite","description":"Type of probation period for definite contracts."}},"title":"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaData"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataType":{"type":"string","enum":["INSTANT","OPS","LEGAL","DISABLED","CUSTOM","AUTOMATED"],"description":"Type of amendment","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataType"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataItemsItemsType":{"type":"string","enum":["INSTANT","OPS","LEGAL","DISABLED","CUSTOM","AUTOMATED"],"description":"Type of amendment","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataItemsItemsType"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataItemsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Id of amendment item"},"item":{"type":"string","description":"Amendment item"},"type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataItemsItemsType","description":"Type of amendment"},"new_value":{"type":"string","description":"The new valid value after the attempted change."},"data_point":{"type":"string","description":"The field that is selected for amendment."},"previous_value":{"type":"string","description":"The previous valid value before the attempted change."}},"title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataItemsItems"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataSource":{"type":"string","enum":["APP","PUBLIC_API","APP_BULK_AMENDMENT"],"description":"Source of amendment flow creation.","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataSource"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus":{"type":"string","enum":["REJECTED","APPROVED","PENDING_REVIEW","PENDING_LEGAL"],"description":"Current status of the custom amendment item","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataCustomItemsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the custom amendment item"},"type":{"type":"string","description":"Type/context of the custom amendment item"},"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus","description":"Current status of the custom amendment item"},"description":{"type":["string","null"],"description":"Detailed description of the custom amendment item"},"rejection_reason":{"type":["string","null"],"description":"Reason for rejection if the item was rejected"}},"required":["id","type","status"],"title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataCustomItemsItems"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataDocumentType":{"type":"string","enum":["EA","SOW","SOW_EA"],"description":"Amendment document type","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataDocumentType"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataLegalContextStatus":{"type":"string","enum":["REQUEST_LEGAL_REVIEW","WAITING_FOR_ANOTHER_TEAM","WAITING_FOR_HRX_ACTION","DECLINED","SOLVED"],"description":"Current status of the legal review process","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataLegalContextStatus"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataLegalContext":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataLegalContextStatus","description":"Current status of the legal review process"},"details":{"type":"string","description":"Details regarding the legal request"},"jira_ticket":{"type":"string","description":"Jira ticket identifier linked to the legal context"},"jira_web_url":{"type":"string","format":"uri","description":"Link to the Jira ticket for tracking"},"requested_at":{"type":"string","format":"date-time","description":"Timestamp when legal review was requested"}},"description":"Additional details needed for legal input","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataLegalContext"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataTimeOffType":{"type":"string","enum":["STANDARD","SPECIFIC","PRORATED"],"description":"Type of time off.","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataTimeOffType"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataEmploymentType":{"type":"string","enum":["FULL_TIME","PART_TIME"],"description":"Type of employment.","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataEmploymentType"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus":{"type":"string","enum":["WAITING_FOR_SIGNING","ACTIVE","OUTDATED","CANCELLED"],"description":"Current status of the fixed adjustment.","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems":{"type":"object","properties":{"id":{"type":"string","description":"System-generated unique identifier for the fixed adjustment record in an amendment request."},"value":{"type":"string","description":"Value of the fixed adjustment."},"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus","description":"Current status of the fixed adjustment."},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the fixed adjustment was created."},"is_amended":{"type":"boolean","description":"Whether this fixed adjustment was amended from a previous one."},"is_deleted":{"type":"boolean","description":"True if the fixed adjustment was deleted as part of the amendment; otherwise false."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the fixed adjustment was last updated."},"description":{"type":"string","description":"Description of the fixed adjustment."},"is_recurring":{"type":"boolean","description":"Whether the fixed adjustment is recurring. If set to false, it will be treated as a one-time fixed allowance."},"is_country_specific":{"type":"boolean","description":"Whether this fixed adjustment applies only to a specific country."},"parent_fixed_adjustment_id":{"type":["string","null"],"description":"Reference to the parent fixed adjustment, if applicable."}},"required":["id","value","status","created_at","is_amended","updated_at","description","is_recurring","is_country_specific"],"title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataRejectionContext":{"type":"object","properties":{"rejected_at":{"type":"string","format":"date-time","description":"Timestamp of when the rejection occurred"}},"description":"Additional details containing rejection reason","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataRejectionContext"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"Creation date"}},"description":"Metadata about the amendment status, including when it was created.","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems":{"type":"object","properties":{"name":{"type":"string","description":"Logical, system-oriented identifier of the amendment status. Can be used to group statuses under a parent category and subgroup them for more granular state tracking. The structure typically follows a dot-separated hierarchy (e.g., 'PARENT','PARENT.CHILD', 'PARENT.CHILD.CHILD.CHILD', ...), which allows logical grouping and filtering of related statuses."},"friendly_name":{"type":"string","description":"Friendly name of amendment status"},"amendment_flow_status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus","description":"Metadata about the amendment status, including when it was created."}},"title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataNoticePeriodType":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of notice period.","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataNoticePeriodType"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVoidDeadlineType":{"type":"string","enum":["CUTOFF","START_DATE","END_DATE","EXPIRY"],"description":"Type of void deadline","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVoidDeadlineType"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVariableCompensationType":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary.","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVariableCompensationType"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline":{"type":"string","enum":["MONTHLY","QUARTERLY","ANNUALLY","BIANNUALLY"],"description":"How often the compensation is paid — for example monthly, quarterly, annually, or twice a year.","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan":{"type":"object","properties":{"details":{"type":"string","description":"Extra details about the incentive plan, if any."},"employee_signature":{"type":"string","description":"The employee’s signature for the incentive plan, if collected."},"employee_signed_at":{"type":"string","format":"date-time","description":"The date and time when the employee signed the incentive plan. Empty if not signed."}},"description":"Details of the incentive plan linked to this compensation, if any.","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVariableCompensation":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID assigned by the system to this variable compensation record."},"type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVariableCompensationType","description":"The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary."},"title":{"type":"string","description":"Title or name of the variable compensation."},"amount":{"type":"string","format":"decimal","description":"The value of the compensation. Shown as a string to keep the exact number of decimals."},"timeline":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline","description":"How often the compensation is paid — for example monthly, quarterly, annually, or twice a year."},"parent_id":{"type":["string","null"],"description":"Reference to the parent variable compensation, if applicable. Null if this compensation is not linked to any compensation."},"created_at":{"type":"string","format":"date-time","description":"The date and time when this record was first created in the system."},"is_amended":{"type":"boolean","description":"Shows whether this compensation has been changed as part of an amendment."},"is_deleted":{"type":"boolean","description":"Shows whether this compensation has been deleted."},"updated_at":{"type":"string","format":"date-time","description":"The date and time when this record was last updated."},"effective_date":{"type":"string","format":"date-time","description":"The date when this compensation starts being valid."},"incentive_plan":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan","description":"Details of the incentive plan linked to this compensation, if any."}},"required":["id","type","title","amount","timeline","parent_id","created_at","updated_at","effective_date"],"description":"Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended.","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVariableCompensation"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit":{"type":"string","enum":["DAY","WEEK","MONTH"],"description":"Notice period time unit.","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of probation period for definite contracts.","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Id of amendment"},"type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataType"},{"type":"null"}],"description":"Type of amendment"},"items":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataItemsItems"},"description":"Items of amendment"},"scope":{"type":"string","description":"Scope of the amendment."},"salary":{"type":"string","description":"Salary for the amendment."},"source":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataSource"},{"type":"null"}],"description":"Source of amendment flow creation."},"currency":{"type":"string","description":"Contract currency."},"end_date":{"type":["string","null"],"format":"date-time","description":"End date of the employment."},"holidays":{"type":["integer","null"],"description":"Number of holidays."},"job_code":{"type":["string","null"],"description":"Job code associated with the job title."},"job_title":{"type":"string","description":"Job title associated with the amendment."},"created_at":{"type":"string","format":"date-time","description":"Creation date of the amendment."},"start_date":{"type":"string","format":"date-time","description":"Start date of the employment."},"updated_at":{"type":"string","format":"date-time","description":"Date when amendment is updated"},"hourly_rate":{"type":["string","null"],"description":"Hourly rate of the amendment"},"custom_items":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataCustomItemsItems"},"description":"Custom amendment items associated with the amendment flow"},"job_category":{"type":["string","null"],"description":"Job category associated with the job title."},"requested_by":{"type":["string","null"],"description":"Profile name of the user who requested the change"},"seniority_id":{"type":["string","null"],"format":"uuid","description":"Seniority level identifier."},"document_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataDocumentType"},{"type":"null"}],"description":"Amendment document type"},"legal_context":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataLegalContext"},{"type":"null"}],"description":"Additional details needed for legal input"},"time_off_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataTimeOffType","description":"Type of time off."},"void_deadline":{"type":["string","null"],"format":"date-time","description":"Deadline this SOW to be voided"},"effective_date":{"type":["string","null"],"format":"date-time","description":"Effective date of the amendment."},"seniority_date":{"oneOf":[{"description":"Any type"},{"type":"null"}],"description":"The seniority date represents the employee’s original start date with a previous employer. It is used to preserve employment tenure when the employee transfers to this company. Can be null if not applicable."},"employment_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataEmploymentType","description":"Type of employment."},"sick_leave_days":{"type":["integer","null"],"description":"Number of sick leave days"},"employment_state":{"type":["string","null"],"description":"State of employment."},"probation_period":{"type":["integer","null"],"description":"Duration of the probation period."},"work_schedule_id":{"type":["string","null"],"format":"uuid","description":"Work schedule id"},"fixed_adjustments":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems"},"description":"List of fixed adjustments associated with the amendment request."},"rejection_context":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataRejectionContext"},{"type":"null"}],"description":"Additional details containing rejection reason"},"amendment_statuses":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems"},"description":"List of amendment statuses representing the history and progression of an amendment."},"notice_period_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataNoticePeriodType"},{"type":"null"}],"description":"Type of notice period."},"void_deadline_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVoidDeadlineType"},{"type":"null"}],"description":"Type of void deadline"},"work_hours_per_week":{"type":"string","description":"Number of work hours per week."},"employee_nationality":{"type":"string","description":"Nationality of the employee."},"is_hrx_action_needed":{"type":"boolean","description":"Is HRX action needed."},"variable_compensation":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVariableCompensation","description":"Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended."},"notice_period_time_unit":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit"},{"type":"null"}],"description":"Notice period time unit."},"is_effective_date_updated":{"type":"boolean","description":"Is Effective Date updated."},"work_schedule_rules_version":{"type":["string","null"],"description":"Work schedule rule version."},"notice_period_after_probation":{"type":["string","null"],"description":"Notice period after probation."},"notice_period_during_probation":{"type":["string","null"],"description":"Notice period during probation."},"probation_period_type_for_definite":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite"},{"type":"null"}],"description":"Type of probation period for definite contracts."}},"title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaData"},"eor-amendments_createContractAmendment_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaData"}},"title":"eor-amendments_createContractAmendment_Response_201"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaErrorsItems"},"CreateAnEorContractAmendment-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"CreateAnEorContractAmendment-v2026-01-01RequestBadRequestError"},"CreateAnEorContractAmendment-v2026-01-01RequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"CreateAnEorContractAmendment-v2026-01-01RequestNotFoundError"},"CreateAnEorContractAmendment-v2026-01-01RequestConflictError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"CreateAnEorContractAmendment-v2026-01-01RequestConflictError"},"CreateAnEorContractAmendment-v2026-01-01RequestUnprocessableEntityError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaErrorsItems"},"description":"List of validation or business rule errors."}},"required":["errors"],"title":"CreateAnEorContractAmendment-v2026-01-01RequestUnprocessableEntityError"},"CreateAnEorContractAmendment-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"CreateAnEorContractAmendment-v2026-01-01RequestInternalServerError"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataType":{"type":"string","enum":["INSTANT","OPS","LEGAL","DISABLED","CUSTOM","AUTOMATED"],"description":"Type of amendment","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataType"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataItemsItemsType":{"type":"string","enum":["INSTANT","OPS","LEGAL","DISABLED","CUSTOM","AUTOMATED"],"description":"Type of amendment","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataItemsItemsType"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataItemsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Id of amendment item"},"item":{"type":"string","description":"Amendment item"},"type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataItemsItemsType","description":"Type of amendment"},"new_value":{"type":"string","description":"The new valid value after the attempted change."},"data_point":{"type":"string","description":"The field that is selected for amendment."},"previous_value":{"type":"string","description":"The previous valid value before the attempted change."}},"title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataItemsItems"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataSource":{"type":"string","enum":["APP","PUBLIC_API","APP_BULK_AMENDMENT"],"description":"Source of amendment flow creation.","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataSource"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus":{"type":"string","enum":["REJECTED","APPROVED","PENDING_REVIEW","PENDING_LEGAL"],"description":"Current status of the custom amendment item","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataCustomItemsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the custom amendment item"},"type":{"type":"string","description":"Type/context of the custom amendment item"},"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus","description":"Current status of the custom amendment item"},"description":{"type":["string","null"],"description":"Detailed description of the custom amendment item"},"rejection_reason":{"type":["string","null"],"description":"Reason for rejection if the item was rejected"}},"required":["id","type","status"],"title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataCustomItemsItems"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataDocumentType":{"type":"string","enum":["EA","SOW","SOW_EA"],"description":"Amendment document type","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataDocumentType"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataLegalContextStatus":{"type":"string","enum":["REQUEST_LEGAL_REVIEW","WAITING_FOR_ANOTHER_TEAM","WAITING_FOR_HRX_ACTION","DECLINED","SOLVED"],"description":"Current status of the legal review process","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataLegalContextStatus"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataLegalContext":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataLegalContextStatus","description":"Current status of the legal review process"},"details":{"type":"string","description":"Details regarding the legal request"},"jira_ticket":{"type":"string","description":"Jira ticket identifier linked to the legal context"},"jira_web_url":{"type":"string","format":"uri","description":"Link to the Jira ticket for tracking"},"requested_at":{"type":"string","format":"date-time","description":"Timestamp when legal review was requested"}},"description":"Additional details needed for legal input","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataLegalContext"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataTimeOffType":{"type":"string","enum":["STANDARD","SPECIFIC","PRORATED"],"description":"Type of time off.","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataTimeOffType"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataEmploymentType":{"type":"string","enum":["FULL_TIME","PART_TIME"],"description":"Type of employment.","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataEmploymentType"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus":{"type":"string","enum":["WAITING_FOR_SIGNING","ACTIVE","OUTDATED","CANCELLED"],"description":"Current status of the fixed adjustment.","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems":{"type":"object","properties":{"id":{"type":"string","description":"System-generated unique identifier for the fixed adjustment record in an amendment request."},"value":{"type":"string","description":"Value of the fixed adjustment."},"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus","description":"Current status of the fixed adjustment."},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the fixed adjustment was created."},"is_amended":{"type":"boolean","description":"Whether this fixed adjustment was amended from a previous one."},"is_deleted":{"type":"boolean","description":"True if the fixed adjustment was deleted as part of the amendment; otherwise false."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the fixed adjustment was last updated."},"description":{"type":"string","description":"Description of the fixed adjustment."},"is_recurring":{"type":"boolean","description":"Whether the fixed adjustment is recurring. If set to false, it will be treated as a one-time fixed allowance."},"is_country_specific":{"type":"boolean","description":"Whether this fixed adjustment applies only to a specific country."},"parent_fixed_adjustment_id":{"type":["string","null"],"description":"Reference to the parent fixed adjustment, if applicable."}},"required":["id","value","status","created_at","is_amended","updated_at","description","is_recurring","is_country_specific"],"title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataRejectionContext":{"type":"object","properties":{"rejected_at":{"type":"string","format":"date-time","description":"Timestamp of when the rejection occurred"}},"description":"Additional details containing rejection reason","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataRejectionContext"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"The timestamp when this amendment status was created."}},"description":"Metadata about the amendment status, including when it was created.","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems":{"type":"object","properties":{"name":{"type":"string","description":"Logical, system-oriented identifier of the amendment status. Can be used to group statuses under a parent category and subgroup them for more granular state tracking. The structure typically follows a dot-separated hierarchy (e.g., 'PARENT','PARENT.CHILD', 'PARENT.CHILD.CHILD.CHILD', ...), which allows logical grouping and filtering of related statuses."},"friendly_name":{"type":"string","description":"Human-readable label of the amendment status (e.g., DRAFT, PENDING, APPROVED)."},"amendment_flow_status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus","description":"Metadata about the amendment status, including when it was created."}},"description":"Details of a specific amendment status in the lifecycle of the amendment.","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataNoticePeriodType":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of notice period.","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataNoticePeriodType"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVoidDeadlineType":{"type":"string","enum":["CUTOFF","START_DATE","END_DATE","EXPIRY"],"description":"Type of void deadline","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVoidDeadlineType"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVariableCompensationType":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary.","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVariableCompensationType"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline":{"type":"string","enum":["MONTHLY","QUARTERLY","ANNUALLY","BIANNUALLY"],"description":"How often the compensation is paid — for example monthly, quarterly, annually, or twice a year.","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan":{"type":"object","properties":{"details":{"type":"string","description":"Extra details about the incentive plan, if any."},"employee_signature":{"type":"string","description":"The employee’s signature for the incentive plan, if collected."},"employee_signed_at":{"type":"string","format":"date-time","description":"The date and time when the employee signed the incentive plan. Empty if not signed."}},"description":"Details of the incentive plan linked to this compensation, if any.","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVariableCompensation":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID assigned by the system to this variable compensation record."},"type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVariableCompensationType","description":"The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary."},"title":{"type":"string","description":"Title or name of the variable compensation."},"amount":{"type":"string","format":"decimal","description":"The value of the compensation. Shown as a string to keep the exact number of decimals."},"timeline":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline","description":"How often the compensation is paid — for example monthly, quarterly, annually, or twice a year."},"parent_id":{"type":["string","null"],"description":"Reference to the parent variable compensation, if applicable. Null if this compensation is not linked to any compensation."},"created_at":{"type":"string","format":"date-time","description":"The date and time when this record was first created in the system."},"is_amended":{"type":"boolean","description":"Shows whether this compensation has been changed as part of an amendment."},"is_deleted":{"type":"boolean","description":"Shows whether this compensation has been deleted."},"updated_at":{"type":"string","format":"date-time","description":"The date and time when this record was last updated."},"effective_date":{"type":"string","format":"date-time","description":"The date when this compensation starts being valid."},"incentive_plan":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan","description":"Details of the incentive plan linked to this compensation, if any."}},"required":["id","type","title","amount","timeline","parent_id","created_at","updated_at","effective_date"],"description":"Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended.","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVariableCompensation"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit":{"type":"string","enum":["DAY","WEEK","MONTH"],"description":"Notice period time unit.","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of probation period for definite contracts.","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Id of amendment"},"type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataType"},{"type":"null"}],"description":"Type of amendment"},"items":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataItemsItems"},"description":"Items of amendment"},"scope":{"type":"string","description":"Scope of the amendment."},"salary":{"type":"string","description":"Salary for the amendment."},"source":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataSource"},{"type":"null"}],"description":"Source of amendment flow creation."},"currency":{"type":"string","description":"Contract currency."},"end_date":{"type":["string","null"],"format":"date-time","description":"End date of the employment."},"holidays":{"type":["integer","null"],"description":"Number of holidays."},"job_code":{"type":["string","null"],"description":"Job code associated with the job title."},"job_title":{"type":"string","description":"Job title associated with the amendment."},"created_at":{"type":"string","format":"date-time","description":"Creation date of the amendment."},"start_date":{"type":"string","format":"date-time","description":"Start date of the employment."},"updated_at":{"type":"string","format":"date-time","description":"Date when amendment is updated"},"hourly_rate":{"type":["string","null"],"description":"Hourly rate of the amendment"},"custom_items":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataCustomItemsItems"},"description":"Custom amendment items associated with the amendment flow"},"job_category":{"type":["string","null"],"description":"Job category associated with the job title."},"requested_by":{"type":["string","null"],"description":"Profile name of the user who requested the change"},"seniority_id":{"type":["string","null"],"format":"uuid","description":"Seniority level identifier."},"document_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataDocumentType"},{"type":"null"}],"description":"Amendment document type"},"legal_context":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataLegalContext"},{"type":"null"}],"description":"Additional details needed for legal input"},"time_off_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataTimeOffType","description":"Type of time off."},"void_deadline":{"type":["string","null"],"format":"date-time","description":"Deadline this SOW to be voided"},"effective_date":{"type":["string","null"],"format":"date-time","description":"Effective date of the amendment."},"seniority_date":{"type":["string","null"],"format":"date","description":"The seniority date represents the employee’s original start date with a previous employer. It is used to preserve employment tenure when the employee transfers to this company. Can be null if not applicable."},"employment_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataEmploymentType","description":"Type of employment."},"sick_leave_days":{"type":["integer","null"],"description":"Number of sick leave days"},"employment_state":{"type":["string","null"],"description":"State of employment."},"probation_period":{"type":["integer","null"],"description":"Duration of the probation period."},"work_schedule_id":{"type":["string","null"],"format":"uuid","description":"Work schedule id"},"fixed_adjustments":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems"},"description":"List of fixed adjustments associated with the amendment request."},"rejection_context":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataRejectionContext"},{"type":"null"}],"description":"Additional details containing rejection reason"},"amendment_statuses":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems"},"description":"List of amendment statuses representing the history and progression of an amendment."},"notice_period_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataNoticePeriodType"},{"type":"null"}],"description":"Type of notice period."},"void_deadline_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVoidDeadlineType"},{"type":"null"}],"description":"Type of void deadline"},"work_hours_per_week":{"type":"string","description":"Number of work hours per week."},"employee_nationality":{"type":"string","description":"Nationality of the employee."},"is_hrx_action_needed":{"type":"boolean","description":"Is HRX action needed."},"variable_compensation":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVariableCompensation","description":"Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended."},"notice_period_time_unit":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit"},{"type":"null"}],"description":"Notice period time unit."},"is_effective_date_updated":{"type":"boolean","description":"Is Effective Date updated."},"work_schedule_rules_version":{"type":["string","null"],"description":"Work schedule rule version."},"notice_period_after_probation":{"type":["string","null"],"description":"Notice period after probation."},"notice_period_during_probation":{"type":["string","null"],"description":"Notice period during probation."},"probation_period_type_for_definite":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite"},{"type":"null"}],"description":"Type of probation period for definite contracts."}},"title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaData"},"eor-amendments_getContractAmendmentById_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaData"}},"title":"eor-amendments_getContractAmendmentById_Response_200"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaErrorsItems"},"ViewInformationAboutAmendmentRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"ViewInformationAboutAmendmentRequestBadRequestError"},"ViewInformationAboutAmendmentRequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"ViewInformationAboutAmendmentRequestNotFoundError"},"ViewInformationAboutAmendmentRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"ViewInformationAboutAmendmentRequestInternalServerError"},"EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsRequires":{"type":"object","properties":{},"description":"Contract conditions that must be met for this rule to be applied.","title":"EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsRequires"},"EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsAdditionalDetailsRule":{"type":"string","enum":["ONE_QUARTER_OF_CONTRACT_DURATION","ONE_THIRD_OF_CONTRACT_DURATION","HALF_OF_CONTRACT_DURATION"],"description":"Specific rule that applies for probation period.","title":"EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsAdditionalDetailsRule"},"EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsAdditionalDetailsTimeUnit":{"type":"string","enum":["WEEK","MONTH","DAY"],"description":"The unit of time applicable to notice period.","title":"EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsAdditionalDetailsTimeUnit"},"EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsAdditionalDetails":{"type":"object","properties":{"cap":{"type":["number","null"],"format":"double","description":"The maximum limit imposed for probation period for definite contract when specific calculation is used, it will be in additional_details.rule."},"note":{"type":["string","null"],"description":"Additional explanation or notes related to this rule."},"rule":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsAdditionalDetailsRule"},{"type":"null"}],"description":"Specific rule that applies for probation period."},"time_unit":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsAdditionalDetailsTimeUnit"},{"type":"null"}],"description":"The unit of time applicable to notice period."}},"description":"Optional additional information for rules, if applicable.","title":"EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsAdditionalDetails"},"EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsTenureBasedRulesItemsEmploymentDurationType":{"type":"string","enum":["DAY","WEEK","MONTH","YEAR"],"description":"The unit of measurement for the employment duration.","title":"EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsTenureBasedRulesItemsEmploymentDurationType"},"EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsTenureBasedRulesItems":{"type":"object","properties":{"notice_value":{"type":["integer","null"],"description":"The required notice period for this range of employment duration."},"max_employment_duration":{"type":["integer","null"],"description":"The maximum duration of employment for this rule to apply."},"min_employment_duration":{"type":["integer","null"],"description":"The minimum duration of employment for this rule to apply."},"employment_duration_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsTenureBasedRulesItemsEmploymentDurationType"},{"type":"null"}],"description":"The unit of measurement for the employment duration."}},"title":"EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsTenureBasedRulesItems"},"EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItems":{"type":"object","properties":{"max":{"type":"number","format":"double","description":"The maximum allowable value for numerical data points."},"min":{"type":["number","null"],"format":"double","description":"The minimum allowable value for numerical data points."},"max_date":{"type":["string","null"],"format":"date","description":"The latest allowable date for date-type data points."},"min_date":{"type":["string","null"],"format":"date","description":"The earliest allowable date for date-type data points."},"nullable":{"type":"boolean","description":"Indicates whether the data point can be null."},"requires":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsRequires","description":"Contract conditions that must be met for this rule to be applied."},"is_editable":{"type":"boolean","description":"Indicates whether the data point can be updated."},"possible_options":{"type":"array","items":{"type":"string"},"description":"A list of possible values the data point can have. Unique for each data point."},"additional_details":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsAdditionalDetails","description":"Optional additional information for rules, if applicable."},"tenure_based_rules":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsTenureBasedRulesItems"},"description":"Defines notice period rules based on the duration of employment."},"external_validation":{"type":"boolean","description":"Indicates whether external validation/fetching is required for this data point. If yes, the information for this data point must be retrieved using another endpoint."}},"title":"EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItems"},"EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"rules":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItems"},"description":"The rules for the data point."},"data_point":{"type":"string","description":"The name of the data point being configured."}},"title":"EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItems"},"eor-amendments_getContractAmendmentsValidationSettings_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItems"}}},"title":"eor-amendments_getContractAmendmentsValidationSettings_Response_200"},"EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"title":"EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaErrorsItems"},"GetAmendmentValidationSettingsForAnEorContractRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"GetAmendmentValidationSettingsForAnEorContractRequestBadRequestError"},"GetAmendmentValidationSettingsForAnEorContractRequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"GetAmendmentValidationSettingsForAnEorContractRequestNotFoundError"},"GetAmendmentValidationSettingsForAnEorContractRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"GetAmendmentValidationSettingsForAnEorContractRequestInternalServerError"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsType":{"type":"string","enum":["INSTANT","OPS","LEGAL","DISABLED","CUSTOM","AUTOMATED"],"description":"Type of amendment","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsType"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsItemsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Id of amendment item"},"item":{"type":"string","description":"Amendment item"},"type":{"type":"string","description":"Type of amendment"},"new_value":{"type":"string","description":"The new valid value after the attempted change."},"data_point":{"type":"string","description":"The field that is selected for amendment."},"previous_value":{"type":"string","description":"The previous valid value before the attempted change."}},"title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsItemsItems"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsSource":{"type":"string","enum":["APP","PUBLIC_API","APP_BULK_AMENDMENT"],"description":"Source of amendment flow creation.","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsSource"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsCustomItemsItemsStatus":{"type":"string","enum":["REJECTED","APPROVED","PENDING_REVIEW","PENDING_LEGAL"],"description":"Current status of the custom amendment item","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsCustomItemsItemsStatus"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsCustomItemsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the custom amendment item"},"type":{"type":"string","description":"Type/context of the custom amendment item"},"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsCustomItemsItemsStatus","description":"Current status of the custom amendment item"},"description":{"type":["string","null"],"description":"Detailed description of the custom amendment item"},"rejection_reason":{"type":["string","null"],"description":"Reason for rejection if the item was rejected"}},"required":["id","type","status"],"title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsCustomItemsItems"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsDocumentType":{"type":"string","enum":["EA","SOW","SOW_EA"],"description":"Amendment document type","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsDocumentType"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsLegalContextStatus":{"type":"string","enum":["REQUEST_LEGAL_REVIEW","WAITING_FOR_ANOTHER_TEAM","WAITING_FOR_HRX_ACTION","DECLINED","SOLVED","SOLVE_LEGAL","LEGAL_JIRA_REOPENED"],"description":"Current status of the legal review process","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsLegalContextStatus"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsLegalContext":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsLegalContextStatus","description":"Current status of the legal review process"},"details":{"type":"string","description":"Details regarding the legal request"},"jira_ticket":{"type":"string","description":"Jira ticket identifier linked to the legal context"},"jira_web_url":{"type":"string","format":"uri","description":"Link to the Jira ticket for tracking"},"requested_at":{"type":"string","format":"date-time","description":"Timestamp when legal review was requested"}},"description":"Additional details needed for legal input","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsLegalContext"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffType":{"type":"string","enum":["STANDARD","SPECIFIC","PRORATED"],"description":"Type of time off.","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffType"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsEmploymentType":{"type":"string","enum":["FULL_TIME","PART_TIME"],"description":"Type of employment.","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsEmploymentType"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsFixedAdjustmentsItemsStatus":{"type":"string","enum":["WAITING_FOR_SIGNING","ACTIVE","OUTDATED","CANCELLED"],"description":"Current status of the fixed adjustment.","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsFixedAdjustmentsItemsStatus"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsFixedAdjustmentsItems":{"type":"object","properties":{"id":{"type":"string","description":"System-generated unique identifier for the fixed adjustment record in an amendment request."},"value":{"type":"string","description":"Value of the fixed adjustment."},"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsFixedAdjustmentsItemsStatus","description":"Current status of the fixed adjustment."},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the fixed adjustment was created."},"is_amended":{"type":"boolean","description":"Whether this fixed adjustment was amended from a previous one."},"is_deleted":{"type":"boolean","description":"True if the fixed adjustment was deleted as part of the amendment; otherwise false."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the fixed adjustment was last updated."},"description":{"type":"string","description":"Description of the fixed adjustment."},"is_recurring":{"type":"boolean","description":"Whether the fixed adjustment is recurring. If set to false, it will be treated as a one-time fixed allowance."},"is_country_specific":{"type":"boolean","description":"Whether this fixed adjustment applies only to a specific country."},"parent_fixed_adjustment_id":{"type":["string","null"],"description":"Reference to the parent fixed adjustment, if applicable."}},"required":["id","value","status","created_at","is_amended","updated_at","description","is_recurring","is_country_specific"],"title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsFixedAdjustmentsItems"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsRejectionContext":{"type":"object","properties":{"rejected_at":{"type":"string","format":"date-time","description":"Timestamp of when the rejection occurred"}},"description":"Additional details containing rejection reason","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsRejectionContext"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsAmendmentStatusesItemsAmendmentFlowStatus":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"Creation date"}},"description":"Metadata about the amendment status, including when it was created.","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsAmendmentStatusesItemsAmendmentFlowStatus"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsAmendmentStatusesItems":{"type":"object","properties":{"name":{"type":"string","description":"Logical, system-oriented identifier of the amendment status. Can be used to group statuses under a parent category and subgroup them for more granular state tracking. The structure typically follows a dot-separated hierarchy (e.g., 'PARENT','PARENT.CHILD', 'PARENT.CHILD.CHILD.CHILD', ...), which allows logical grouping and filtering of related statuses."},"friendly_name":{"type":"string","description":"Friendly name of amendment status"},"amendment_flow_status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsAmendmentStatusesItemsAmendmentFlowStatus","description":"Metadata about the amendment status, including when it was created."}},"title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsAmendmentStatusesItems"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsNoticePeriodType":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of notice period.","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsNoticePeriodType"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVoidDeadlineType":{"type":"string","enum":["CUTOFF","START_DATE","END_DATE","EXPIRY"],"description":"Type of void deadline","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVoidDeadlineType"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVariableCompensationType":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary.","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVariableCompensationType"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVariableCompensationTimeline":{"type":"string","enum":["MONTHLY","QUARTERLY","ANNUALLY","BIANNUALLY"],"description":"How often the compensation is paid — for example monthly, quarterly, annually, or twice a year.","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVariableCompensationTimeline"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVariableCompensationIncentivePlan":{"type":"object","properties":{"details":{"type":"string","description":"Extra details about the incentive plan, if any."},"employee_signature":{"type":"string","description":"The employee’s signature for the incentive plan, if collected."},"employee_signed_at":{"type":"string","format":"date-time","description":"The date and time when the employee signed the incentive plan. Empty if not signed."}},"description":"Details of the incentive plan linked to this compensation, if any.","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVariableCompensationIncentivePlan"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVariableCompensation":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID assigned by the system to this variable compensation record."},"type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVariableCompensationType","description":"The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary."},"title":{"type":"string","description":"Title or name of the variable compensation."},"amount":{"type":"string","format":"decimal","description":"The value of the compensation. Shown as a string to keep the exact number of decimals."},"timeline":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVariableCompensationTimeline","description":"How often the compensation is paid — for example monthly, quarterly, annually, or twice a year."},"parent_id":{"type":["string","null"],"description":"Reference to the parent variable compensation, if applicable. Null if this compensation is not linked to any compensation."},"created_at":{"type":"string","format":"date-time","description":"The date and time when this record was first created in the system."},"is_amended":{"type":"boolean","description":"Shows whether this compensation has been changed as part of an amendment."},"is_deleted":{"type":"boolean","description":"Shows whether this compensation has been deleted."},"updated_at":{"type":"string","format":"date-time","description":"The date and time when this record was last updated."},"effective_date":{"type":"string","format":"date-time","description":"The date when this compensation starts being valid."},"incentive_plan":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVariableCompensationIncentivePlan","description":"Details of the incentive plan linked to this compensation, if any."}},"required":["id","type","title","amount","timeline","parent_id","created_at","updated_at","effective_date"],"description":"Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended.","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVariableCompensation"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsNoticePeriodTimeUnit":{"type":"string","enum":["DAY","WEEK","MONTH"],"description":"Notice period time unit.","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsNoticePeriodTimeUnit"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsProbationPeriodTypeForDefinite":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of probation period for definite contracts.","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsProbationPeriodTypeForDefinite"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Id of amendment"},"type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsType"},{"type":"null"}],"description":"Type of amendment"},"items":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsItemsItems"},"description":"Items of amendment"},"scope":{"type":"string","description":"Scope of the amendment."},"salary":{"type":"string","description":"Salary for the amendment."},"source":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsSource"},{"type":"null"}],"description":"Source of amendment flow creation."},"currency":{"type":"string","description":"Contract currency."},"end_date":{"type":["string","null"],"format":"date-time","description":"End date of the employment."},"holidays":{"type":["integer","null"],"description":"Number of holidays."},"job_code":{"type":["string","null"],"description":"Job code associated with the job title."},"job_title":{"type":"string","description":"Job title associated with the amendment."},"created_at":{"type":"string","format":"date-time","description":"Creation date of the amendment."},"start_date":{"type":"string","format":"date-time","description":"Start date of the employment."},"updated_at":{"type":"string","format":"date-time","description":"Date when amendment is updated"},"hourly_rate":{"type":["string","null"],"description":"Hourly rate of the amendment"},"custom_items":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsCustomItemsItems"},"description":"Custom amendment items associated with the amendment flow"},"job_category":{"type":["string","null"],"description":"Job category associated with the job title."},"requested_by":{"type":["string","null"],"description":"Profile name of the user who requested the change"},"seniority_id":{"type":["string","null"],"format":"uuid","description":"New seniority level identifier."},"document_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsDocumentType"},{"type":"null"}],"description":"Amendment document type"},"legal_context":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsLegalContext"},{"type":"null"}],"description":"Additional details needed for legal input"},"time_off_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffType","description":"Type of time off."},"void_deadline":{"type":["string","null"],"format":"date-time","description":"Deadline this SOW to be voided"},"effective_date":{"type":["string","null"],"format":"date-time","description":"Effective date of the amendment."},"seniority_date":{"type":["string","null"],"format":"date-time","description":"The seniority date represents the employee’s original start date with a previous employer. It is used to preserve employment tenure when the employee transfers to this company. Can be null if not applicable."},"employment_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsEmploymentType","description":"Type of employment."},"sick_leave_days":{"type":["integer","null"],"description":"Number of sick leave days"},"employment_state":{"type":["string","null"],"description":"State of employment."},"probation_period":{"type":["integer","null"],"description":"Duration of the probation period."},"work_schedule_id":{"type":["string","null"],"format":"uuid","description":"Work schedule id"},"fixed_adjustments":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsFixedAdjustmentsItems"},"description":"List of fixed adjustments associated with the amendment request."},"rejection_context":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsRejectionContext"},{"type":"null"}],"description":"Additional details containing rejection reason"},"amendment_statuses":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsAmendmentStatusesItems"},"description":"List of amendment statuses representing the history and progression of an amendment."},"notice_period_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsNoticePeriodType"},{"type":"null"}],"description":"Type of notice period."},"void_deadline_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVoidDeadlineType"},{"type":"null"}],"description":"Type of void deadline"},"work_hours_per_week":{"type":"string","description":"Number of work hours per week."},"employee_nationality":{"type":"string","description":"Nationality of the employee."},"is_hrx_action_needed":{"type":"boolean","description":"Is HRX action needed."},"variable_compensation":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVariableCompensation","description":"Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended."},"notice_period_time_unit":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsNoticePeriodTimeUnit"},{"type":"null"}],"description":"Notice period time unit."},"is_effective_date_updated":{"type":"boolean","description":"Is Effective Date updated."},"work_schedule_rules_version":{"type":["string","null"],"description":"Work schedule rule version."},"notice_period_after_probation":{"type":["string","null"],"description":"Notice period after probation."},"notice_period_during_probation":{"type":["string","null"],"description":"Notice period during probation."},"probation_period_type_for_definite":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsProbationPeriodTypeForDefinite"},{"type":"null"}],"description":"Type of probation period for definite contracts."}},"title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItems"},"eor-amendments_getContractAmendments_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItems"}}},"title":"eor-amendments_getContractAmendments_Response_200"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaErrorsItems"},"ListAllAmendmentsForAnEorContract-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"ListAllAmendmentsForAnEorContract-v2026-01-01RequestBadRequestError"},"ListAllAmendmentsForAnEorContract-v2026-01-01RequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"ListAllAmendmentsForAnEorContract-v2026-01-01RequestNotFoundError"},"ListAllAmendmentsForAnEorContract-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"ListAllAmendmentsForAnEorContract-v2026-01-01RequestInternalServerError"},"EorContractsContractIdAmendmentsAmendmentIdEffectiveDateLimitationsGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"message":{"type":"string","description":"Optional human-readable additional explanation on effective date limitation"},"is_hidden":{"type":"boolean","description":"Indicates if the effective date field should be hidden."},"is_disabled":{"type":"boolean","description":"Indicates if the effective date field is disabled"},"max_effective_date":{"type":["string","null"],"format":"date","description":"The latest valid effective date"},"min_effective_date":{"type":["string","null"],"format":"date-time","description":"The earliest valid effective date"},"default_effective_date":{"type":["string","null"],"format":"date-time","description":"A default effective date suggested by the system"}},"title":"EorContractsContractIdAmendmentsAmendmentIdEffectiveDateLimitationsGetResponsesContentApplicationJsonSchemaData"},"eor-amendments_getContractAmendmentEffectiveDateLimitations_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdEffectiveDateLimitationsGetResponsesContentApplicationJsonSchemaData"}},"title":"eor-amendments_getContractAmendmentEffectiveDateLimitations_Response_200"},"EorContractsContractIdAmendmentsAmendmentIdEffectiveDateLimitationsGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"title":"EorContractsContractIdAmendmentsAmendmentIdEffectiveDateLimitationsGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveEffectiveDateLimitationsRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdEffectiveDateLimitationsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"RetrieveEffectiveDateLimitationsRequestBadRequestError"},"RetrieveEffectiveDateLimitationsRequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdEffectiveDateLimitationsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"RetrieveEffectiveDateLimitationsRequestNotFoundError"},"RetrieveEffectiveDateLimitationsRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdEffectiveDateLimitationsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"RetrieveEffectiveDateLimitationsRequestInternalServerError"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataType":{"type":"string","enum":["INSTANT","OPS","LEGAL","DISABLED","CUSTOM","AUTOMATED"],"description":"Type of amendment","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataType"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataItemsItemsType":{"type":"string","enum":["INSTANT","OPS","LEGAL","DISABLED","CUSTOM","AUTOMATED"],"description":"Type of amendment","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataItemsItemsType"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataItemsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Id of amendment item"},"item":{"type":"string","description":"Amendment item"},"type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataItemsItemsType","description":"Type of amendment"},"new_value":{"type":"string","description":"The new valid value after the attempted change."},"data_point":{"type":"string","description":"The field that is selected for amendment."},"previous_value":{"type":"string","description":"The previous valid value before the attempted change."}},"title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataItemsItems"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataSource":{"type":"string","enum":["APP","PUBLIC_API","APP_BULK_AMENDMENT"],"description":"Source of amendment flow creation.","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataSource"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus":{"type":"string","enum":["REJECTED","APPROVED","PENDING_REVIEW","PENDING_LEGAL"],"description":"Current status of the custom amendment item","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataCustomItemsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the custom amendment item"},"type":{"type":"string","description":"Type/context of the custom amendment item"},"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus","description":"Current status of the custom amendment item"},"description":{"type":["string","null"],"description":"Detailed description of the custom amendment item"},"rejection_reason":{"type":["string","null"],"description":"Reason for rejection if the item was rejected"}},"required":["id","type","status"],"title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataCustomItemsItems"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataDocumentType":{"type":"string","enum":["EA","SOW","SOW_EA"],"description":"Amendment document type","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataDocumentType"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataLegalContextStatus":{"type":"string","enum":["REQUEST_LEGAL_REVIEW","WAITING_FOR_ANOTHER_TEAM","WAITING_FOR_HRX_ACTION","DECLINED","SOLVED"],"description":"Current status of the legal review process","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataLegalContextStatus"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataLegalContext":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataLegalContextStatus","description":"Current status of the legal review process"},"details":{"type":"string","description":"Details regarding the legal request"},"jira_ticket":{"type":"string","description":"Jira ticket identifier linked to the legal context"},"jira_web_url":{"type":"string","format":"uri","description":"Link to the Jira ticket for tracking"},"requested_at":{"type":"string","format":"date-time","description":"Timestamp when legal review was requested"}},"description":"Additional details needed for legal input","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataLegalContext"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataTimeOffType":{"type":"string","enum":["STANDARD","SPECIFIC","PRORATED"],"description":"Type of time off.","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataTimeOffType"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataEmploymentType":{"type":"string","enum":["FULL_TIME","PART_TIME"],"description":"Type of employment.","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataEmploymentType"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus":{"type":"string","enum":["WAITING_FOR_SIGNING","ACTIVE","OUTDATED","CANCELLED"],"description":"Current status of the fixed adjustment.","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems":{"type":"object","properties":{"id":{"type":"string","description":"System-generated unique identifier for the fixed adjustment record in an amendment request."},"value":{"type":"string","description":"Value of the fixed adjustment."},"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus","description":"Current status of the fixed adjustment."},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the fixed adjustment was created."},"is_amended":{"type":"boolean","description":"Whether this fixed adjustment was amended from a previous one."},"is_deleted":{"type":"boolean","description":"True if the fixed adjustment was deleted as part of the amendment; otherwise false."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the fixed adjustment was last updated."},"description":{"type":"string","description":"Description of the fixed adjustment."},"is_recurring":{"type":"boolean","description":"Whether the fixed adjustment is recurring. If set to false, it will be treated as a one-time fixed allowance."},"is_country_specific":{"type":"boolean","description":"Whether this fixed adjustment applies only to a specific country."},"parent_fixed_adjustment_id":{"type":["string","null"],"description":"Reference to the parent fixed adjustment, if applicable."}},"required":["id","value","status","created_at","is_amended","updated_at","description","is_recurring","is_country_specific"],"title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataRejectionContext":{"type":"object","properties":{"rejected_at":{"type":"string","format":"date-time","description":"Timestamp of when the rejection occurred"}},"description":"Additional details containing rejection reason","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataRejectionContext"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"Creation date"}},"description":"Metadata about the amendment status, including when it was created.","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems":{"type":"object","properties":{"name":{"type":"string","description":"Logical, system-oriented identifier of the amendment status. Can be used to group statuses under a parent category and subgroup them for more granular state tracking. The structure typically follows a dot-separated hierarchy (e.g., 'PARENT','PARENT.CHILD', 'PARENT.CHILD.CHILD.CHILD', ...), which allows logical grouping and filtering of related statuses."},"friendly_name":{"type":"string","description":"Friendly name of amendment status"},"amendment_flow_status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus","description":"Metadata about the amendment status, including when it was created."}},"title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataNoticePeriodType":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of notice period.","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataNoticePeriodType"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVoidDeadlineType":{"type":"string","enum":["CUTOFF","START_DATE","END_DATE","EXPIRY"],"description":"Type of void deadline","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVoidDeadlineType"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVariableCompensationType":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary.","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVariableCompensationType"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline":{"type":"string","enum":["MONTHLY","QUARTERLY","ANNUALLY","BIANNUALLY"],"description":"How often the compensation is paid — for example monthly, quarterly, annually, or twice a year.","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan":{"type":"object","properties":{"details":{"type":"string","description":"Extra details about the incentive plan, if any."},"employee_signature":{"type":"string","description":"The employee’s signature for the incentive plan, if collected."},"employee_signed_at":{"type":"string","format":"date-time","description":"The date and time when the employee signed the incentive plan. Empty if not signed."}},"description":"Details of the incentive plan linked to this compensation, if any.","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVariableCompensation":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID assigned by the system to this variable compensation record."},"type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVariableCompensationType","description":"The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary."},"title":{"type":"string","description":"Title or name of the variable compensation."},"amount":{"type":"string","format":"decimal","description":"The value of the compensation. Shown as a string to keep the exact number of decimals."},"timeline":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline","description":"How often the compensation is paid — for example monthly, quarterly, annually, or twice a year."},"parent_id":{"type":["string","null"],"description":"Reference to the parent variable compensation, if applicable. Null if this compensation is not linked to any compensation."},"created_at":{"type":"string","format":"date-time","description":"The date and time when this record was first created in the system."},"is_amended":{"type":"boolean","description":"Shows whether this compensation has been changed as part of an amendment."},"is_deleted":{"type":"boolean","description":"Shows whether this compensation has been deleted."},"updated_at":{"type":"string","format":"date-time","description":"The date and time when this record was last updated."},"effective_date":{"type":"string","format":"date-time","description":"The date when this compensation starts being valid."},"incentive_plan":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan","description":"Details of the incentive plan linked to this compensation, if any."}},"required":["id","type","title","amount","timeline","parent_id","created_at","updated_at","effective_date"],"description":"Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended.","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVariableCompensation"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit":{"type":"string","enum":["DAY","WEEK","MONTH"],"description":"Notice period time unit.","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of probation period for definite contracts.","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Id of amendment"},"type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataType"},{"type":"null"}],"description":"Type of amendment"},"items":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataItemsItems"},"description":"Items of amendment"},"scope":{"type":"string","description":"Scope of the amendment."},"salary":{"type":"string","description":"Salary for the amendment."},"source":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataSource"},{"type":"null"}],"description":"Source of amendment flow creation."},"currency":{"type":"string","description":"Contract currency."},"end_date":{"type":["string","null"],"format":"date-time","description":"End date of the employment."},"holidays":{"type":["integer","null"],"description":"Number of holidays."},"job_code":{"type":["string","null"],"description":"Job code associated with the job title."},"job_title":{"type":"string","description":"Job title associated with the amendment."},"created_at":{"type":"string","format":"date-time","description":"Creation date of the amendment."},"start_date":{"type":"string","format":"date-time","description":"Start date of the employment."},"updated_at":{"type":"string","format":"date-time","description":"Date when amendment is updated"},"hourly_rate":{"type":["string","null"],"description":"Hourly rate of the amendment"},"custom_items":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataCustomItemsItems"},"description":"Custom amendment items associated with the amendment flow"},"job_category":{"type":["string","null"],"description":"Job category associated with the job title."},"requested_by":{"type":["string","null"],"description":"Profile name of the user who requested the change"},"seniority_id":{"type":["string","null"],"format":"uuid","description":"Seniority level identifier."},"document_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataDocumentType"},{"type":"null"}],"description":"Amendment document type"},"legal_context":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataLegalContext"},{"type":"null"}],"description":"Additional details needed for legal input"},"time_off_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataTimeOffType","description":"Type of time off."},"void_deadline":{"type":["string","null"],"format":"date-time","description":"Deadline this SOW to be voided"},"effective_date":{"type":["string","null"],"format":"date-time","description":"Effective date of the amendment."},"seniority_date":{"type":["string","null"],"format":"date","description":"The seniority date represents the employee’s original start date with a previous employer. It is used to preserve employment tenure when the employee transfers to this company. Can be null if not applicable."},"employment_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataEmploymentType","description":"Type of employment."},"sick_leave_days":{"type":["integer","null"],"description":"Number of sick leave days"},"employment_state":{"type":["string","null"],"description":"State of employment."},"probation_period":{"type":["integer","null"],"description":"Duration of the probation period."},"work_schedule_id":{"type":["string","null"],"format":"uuid","description":"Work schedule id"},"fixed_adjustments":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems"},"description":"List of fixed adjustments associated with the amendment request."},"rejection_context":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataRejectionContext"},{"type":"null"}],"description":"Additional details containing rejection reason"},"amendment_statuses":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems"},"description":"List of amendment statuses representing the history and progression of an amendment."},"notice_period_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataNoticePeriodType"},{"type":"null"}],"description":"Type of notice period."},"void_deadline_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVoidDeadlineType"},{"type":"null"}],"description":"Type of void deadline"},"work_hours_per_week":{"type":"string","description":"Number of work hours per week."},"employee_nationality":{"type":"string","description":"Nationality of the employee."},"is_hrx_action_needed":{"type":"boolean","description":"Is HRX action needed."},"variable_compensation":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVariableCompensation","description":"Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended."},"notice_period_time_unit":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit"},{"type":"null"}],"description":"Notice period time unit."},"is_effective_date_updated":{"type":"boolean","description":"Is Effective Date updated."},"work_schedule_rules_version":{"type":["string","null"],"description":"Work schedule rule version."},"notice_period_after_probation":{"type":["string","null"],"description":"Notice period after probation."},"notice_period_during_probation":{"type":["string","null"],"description":"Notice period during probation."},"probation_period_type_for_definite":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite"},{"type":"null"}],"description":"Type of probation period for definite contracts."}},"title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaData"},"eor-amendments_signEORAmendment_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaData"}},"title":"eor-amendments_signEORAmendment_Response_200"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaErrorsItems"},"SignAContractAmendmentEmployeeRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"SignAContractAmendmentEmployeeRequestBadRequestError"},"SignAContractAmendmentEmployeeRequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"SignAContractAmendmentEmployeeRequestNotFoundError"},"SignAContractAmendmentEmployeeRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"SignAContractAmendmentEmployeeRequestInternalServerError"},"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataCustomItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"An optional identifier for the custom object."},"type":{"type":"string","description":"The type of the custom object. Must be one of the valid custom types."},"description":{"type":"string","description":"A required description for the custom object."}},"required":["type","description"],"title":"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataCustomItems"},"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataTimeOffType":{"type":"string","enum":["STANDARD","SPECIFIC","PRORATED"],"description":"Type of time off.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataTimeOffType"},"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataAdditionalInfo":{"type":"object","properties":{"ai_scope_check_public_id":{"type":"string","format":"uuid","description":"Identifier or flag for AI scope validation check"},"job_categorization_log_id":{"type":"string","format":"uuid","description":"Identifier for job categorisation log"}},"description":"Additional metadata related to job validation and categorisation","title":"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataAdditionalInfo"},"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataEmploymentType":{"type":"string","enum":["FULL_TIME","PART_TIME"],"description":"Type of employment.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataEmploymentType"},"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataFixedAdjustmentsItems":{"type":"object","properties":{"id":{"type":"string","description":"The ID of an existing active fixed adjustment to update or delete. Include this in the request only if you are updating or deleting an existing adjustment. Do not include it when creating a new one."},"value":{"type":"string","description":"Value of the fixed adjustment. Must be a positive number, not zero."},"is_deleted":{"type":"boolean","description":"Flag to mark the fixed adjustment as deleted. Required only when the fixed adjustment needs to be removed; omit it otherwise."},"description":{"type":"string","description":"Description of the fixed adjustment."},"is_recurring":{"type":"boolean","description":"Whether the fixed adjustment is recurring. If set to false, it will be treated as a one-time fixed allowance."}},"required":["value","description","is_recurring"],"title":"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataFixedAdjustmentsItems"},"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataNoticePeriodType":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of notice period.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataNoticePeriodType"},"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataVariableCompensationType":{"type":"string","enum":["PERCENTAGE","FIXED"],"description":"Type of variable compensation.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataVariableCompensationType"},"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataVariableCompensationTimeline":{"type":"string","enum":["MONTHLY","QUARTERLY","ANNUALLY","BIANNUALLY"],"description":"How often this compensation occurs. Required when creating a new compensation. Forbidden when updating an existing compensation.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataVariableCompensationTimeline"},"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataVariableCompensation":{"type":"object","properties":{"id":{"type":"string","description":"The ID of an existing active variable compensation to update or delete. Include this in the request only if you are updating or deleting an existing compensation. Do not include it when creating a new one."},"type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataVariableCompensationType","description":"Type of variable compensation."},"title":{"type":"string","description":"The title of the compensation. Required when creating a new compensation. Optional when updating an existing compensation."},"amount":{"type":"number","format":"double","description":"Positive amount for the variable compensation."},"timeline":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataVariableCompensationTimeline","description":"How often this compensation occurs. Required when creating a new compensation. Forbidden when updating an existing compensation."},"is_deleted":{"type":"boolean","description":"Flag to mark the variable compensation as deleted. Required only when the variable compensation needs to be removed; omit it otherwise"},"effective_date":{"type":"string","format":"date","description":"The date when this compensation starts or becomes effective. Required when creating a new compensation. Optional when updating an existing compensation."}},"required":["type","amount"],"description":"Represents a change to an employee’s variable compensation (e.g., bonus or commission). This schema is used for creating new variable compensation items or updating existing ones. Some fields are required when creating, optional when updating, and forbidden when updating, as specified in each field description.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataVariableCompensation"},"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of probation period for definite contracts.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite"},"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"scope":{"type":"string","description":"Scope of the amendment."},"custom":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataCustomItems"},"description":"An optional array of custom objects."},"salary":{"type":"number","format":"double","description":"Salary for the amendment."},"end_date":{"type":"string","format":"date","description":"End date of the employment."},"holidays":{"type":"number","format":"double","description":"Number of holidays."},"job_title":{"type":"string","description":"Job title associated with the amendment."},"start_date":{"type":"string","format":"date","description":"Start date of the employment."},"hourly_rate":{"type":"number","format":"double","description":"Hourly rate of the amendment. The max value supported is 1e19"},"seniority_id":{"type":"string","format":"uuid","description":"Public Id of the seniority level."},"time_off_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataTimeOffType","description":"Type of time off."},"effective_date":{"type":"string","format":"date","description":"Effective date for the amendment."},"seniority_date":{"type":["string","null"],"format":"date","description":"The seniority date represents the employee’s original start date with a previous employer. It is used to preserve employment tenure when the employee transfers to this company. Can be null if not applicable."},"additional_info":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataAdditionalInfo"},{"type":"null"}],"description":"Additional metadata related to job validation and categorisation"},"employment_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataEmploymentType","description":"Type of employment."},"employment_state":{"type":"string","description":"State of employment."},"probation_period":{"type":"number","format":"double","description":"Duration of the probation period."},"fixed_adjustments":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataFixedAdjustmentsItems"},"description":"Array of fixed adjustments to be submitted for the amendment request."},"notice_period_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataNoticePeriodType","description":"Type of notice period."},"work_hours_per_week":{"type":"number","format":"double","description":"Number of work hours per week."},"variable_compensation":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataVariableCompensation","description":"Represents a change to an employee’s variable compensation (e.g., bonus or commission). This schema is used for creating new variable compensation items or updating existing ones. Some fields are required when creating, optional when updating, and forbidden when updating, as specified in each field description."},"notice_period_after_probation":{"type":"number","format":"double","description":"Notice period after probation."},"notice_period_during_probation":{"type":"number","format":"double","description":"Notice period during probation."},"probation_period_type_for_definite":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite","description":"Type of probation period for definite contracts."}},"title":"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaData"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataType":{"type":"string","enum":["INSTANT","OPS","LEGAL","DISABLED","CUSTOM","AUTOMATED"],"description":"Type of amendment","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataType"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataItemsItemsType":{"type":"string","enum":["INSTANT","OPS","LEGAL","DISABLED","CUSTOM","AUTOMATED"],"description":"Type of amendment","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataItemsItemsType"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataItemsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Id of amendment item"},"item":{"type":"string","description":"Amendment item"},"type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataItemsItemsType","description":"Type of amendment"},"new_value":{"type":"string","description":"The new valid value after the attempted change."},"data_point":{"type":"string","description":"The field that is selected for amendment."},"previous_value":{"type":"string","description":"The previous valid value before the attempted change."}},"title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataItemsItems"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataSource":{"type":"string","enum":["APP","PUBLIC_API","APP_BULK_AMENDMENT"],"description":"Source of amendment flow creation.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataSource"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus":{"type":"string","enum":["REJECTED","APPROVED","PENDING_REVIEW","PENDING_LEGAL"],"description":"Current status of the custom amendment item","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataCustomItemsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the custom amendment item"},"type":{"type":"string","description":"Type/context of the custom amendment item"},"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus","description":"Current status of the custom amendment item"},"description":{"type":["string","null"],"description":"Detailed description of the custom amendment item"},"rejection_reason":{"type":["string","null"],"description":"Reason for rejection if the item was rejected"}},"required":["id","type","status"],"title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataCustomItemsItems"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataDocumentType":{"type":"string","enum":["EA","SOW","SOW_EA"],"description":"Amendment document type","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataDocumentType"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataLegalContextStatus":{"type":"string","enum":["REQUEST_LEGAL_REVIEW","WAITING_FOR_ANOTHER_TEAM","WAITING_FOR_HRX_ACTION","DECLINED","SOLVED"],"description":"Current status of the legal review process","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataLegalContextStatus"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataLegalContext":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataLegalContextStatus","description":"Current status of the legal review process"},"details":{"type":"string","description":"Details regarding the legal request"},"jira_ticket":{"type":"string","description":"Jira ticket identifier linked to the legal context"},"jira_web_url":{"type":"string","format":"uri","description":"Link to the Jira ticket for tracking"},"requested_at":{"type":"string","format":"date-time","description":"Timestamp when legal review was requested"}},"description":"Additional details needed for legal input","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataLegalContext"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataTimeOffType":{"type":"string","enum":["STANDARD","SPECIFIC","PRORATED"],"description":"Type of time off.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataTimeOffType"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataEmploymentType":{"type":"string","enum":["FULL_TIME","PART_TIME"],"description":"Type of employment.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataEmploymentType"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus":{"type":"string","enum":["WAITING_FOR_SIGNING","ACTIVE","OUTDATED","CANCELLED"],"description":"Current status of the fixed adjustment.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems":{"type":"object","properties":{"id":{"type":"string","description":"System-generated unique identifier for the fixed adjustment record in an amendment request."},"value":{"type":"string","description":"Value of the fixed adjustment."},"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus","description":"Current status of the fixed adjustment."},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the fixed adjustment was created."},"is_amended":{"type":"boolean","description":"Whether this fixed adjustment was amended from a previous one."},"is_deleted":{"type":"boolean","description":"True if the fixed adjustment was deleted as part of the amendment; otherwise false."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the fixed adjustment was last updated."},"description":{"type":"string","description":"Description of the fixed adjustment."},"is_recurring":{"type":"boolean","description":"Whether the fixed adjustment is recurring. If set to false, it will be treated as a one-time fixed allowance."},"is_country_specific":{"type":"boolean","description":"Whether this fixed adjustment applies only to a specific country."},"parent_fixed_adjustment_id":{"type":["string","null"],"description":"Reference to the parent fixed adjustment, if applicable."}},"required":["id","value","status","created_at","is_amended","updated_at","description","is_recurring","is_country_specific"],"title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataRejectionContext":{"type":"object","properties":{"rejected_at":{"type":"string","format":"date-time","description":"Timestamp of when the rejection occurred"}},"description":"Additional details containing rejection reason","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataRejectionContext"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"Creation date"}},"description":"Metadata about the amendment status, including when it was created.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems":{"type":"object","properties":{"name":{"type":"string","description":"Logical, system-oriented identifier of the amendment status. Can be used to group statuses under a parent category and subgroup them for more granular state tracking. The structure typically follows a dot-separated hierarchy (e.g., 'PARENT','PARENT.CHILD', 'PARENT.CHILD.CHILD.CHILD', ...), which allows logical grouping and filtering of related statuses."},"friendly_name":{"type":"string","description":"Friendly name of amendment status"},"amendment_flow_status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus","description":"Metadata about the amendment status, including when it was created."}},"title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataNoticePeriodType":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of notice period.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataNoticePeriodType"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVoidDeadlineType":{"type":"string","enum":["CUTOFF","START_DATE","END_DATE","EXPIRY"],"description":"Type of void deadline","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVoidDeadlineType"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVariableCompensationType":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVariableCompensationType"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline":{"type":"string","enum":["MONTHLY","QUARTERLY","ANNUALLY","BIANNUALLY"],"description":"How often the compensation is paid — for example monthly, quarterly, annually, or twice a year.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan":{"type":"object","properties":{"details":{"type":"string","description":"Extra details about the incentive plan, if any."},"employee_signature":{"type":"string","description":"The employee’s signature for the incentive plan, if collected."},"employee_signed_at":{"type":"string","format":"date-time","description":"The date and time when the employee signed the incentive plan. Empty if not signed."}},"description":"Details of the incentive plan linked to this compensation, if any.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVariableCompensation":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID assigned by the system to this variable compensation record."},"type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVariableCompensationType","description":"The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary."},"title":{"type":"string","description":"Title or name of the variable compensation."},"amount":{"type":"string","format":"decimal","description":"The value of the compensation. Shown as a string to keep the exact number of decimals."},"timeline":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline","description":"How often the compensation is paid — for example monthly, quarterly, annually, or twice a year."},"parent_id":{"type":["string","null"],"description":"Reference to the parent variable compensation, if applicable. Null if this compensation is not linked to any compensation."},"created_at":{"type":"string","format":"date-time","description":"The date and time when this record was first created in the system."},"is_amended":{"type":"boolean","description":"Shows whether this compensation has been changed as part of an amendment."},"is_deleted":{"type":"boolean","description":"Shows whether this compensation has been deleted."},"updated_at":{"type":"string","format":"date-time","description":"The date and time when this record was last updated."},"effective_date":{"type":"string","format":"date-time","description":"The date when this compensation starts being valid."},"incentive_plan":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan","description":"Details of the incentive plan linked to this compensation, if any."}},"required":["id","type","title","amount","timeline","parent_id","created_at","updated_at","effective_date"],"description":"Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVariableCompensation"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit":{"type":"string","enum":["DAY","WEEK","MONTH"],"description":"Notice period time unit.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of probation period for definite contracts.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Id of amendment"},"type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataType"},{"type":"null"}],"description":"Type of amendment"},"items":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataItemsItems"},"description":"Items of amendment"},"scope":{"type":"string","description":"Scope of the amendment."},"salary":{"type":"string","description":"Salary for the amendment."},"source":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataSource"},{"type":"null"}],"description":"Source of amendment flow creation."},"currency":{"type":"string","description":"Contract currency."},"end_date":{"type":["string","null"],"format":"date-time","description":"End date of the employment."},"holidays":{"type":["integer","null"],"description":"Number of holidays."},"job_code":{"type":["string","null"],"description":"Job code associated with the job title."},"job_title":{"type":"string","description":"Job title associated with the amendment."},"created_at":{"type":"string","format":"date-time","description":"Creation date of the amendment."},"start_date":{"type":"string","format":"date-time","description":"Start date of the employment."},"updated_at":{"type":"string","format":"date-time","description":"Date when amendment is updated"},"hourly_rate":{"type":["string","null"],"description":"Hourly rate of the amendment"},"custom_items":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataCustomItemsItems"},"description":"Custom amendment items associated with the amendment flow"},"job_category":{"type":["string","null"],"description":"Job category associated with the job title."},"requested_by":{"type":["string","null"],"description":"Profile name of the user who requested the change"},"seniority_id":{"type":["string","null"],"format":"uuid","description":"Seniority level identifier."},"document_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataDocumentType"},{"type":"null"}],"description":"Amendment document type"},"legal_context":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataLegalContext"},{"type":"null"}],"description":"Additional details needed for legal input"},"time_off_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataTimeOffType","description":"Type of time off."},"void_deadline":{"type":["string","null"],"format":"date-time","description":"Deadline this SOW to be voided"},"effective_date":{"type":["string","null"],"format":"date-time","description":"Effective date of the amendment."},"seniority_date":{"type":["string","null"],"format":"date","description":"The seniority date represents the employee’s original start date with a previous employer. It is used to preserve employment tenure when the employee transfers to this company. Can be null if not applicable."},"employment_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataEmploymentType","description":"Type of employment."},"sick_leave_days":{"type":["integer","null"],"description":"Number of sick leave days"},"employment_state":{"type":["string","null"],"description":"State of employment."},"probation_period":{"type":["integer","null"],"description":"Duration of the probation period."},"work_schedule_id":{"type":["string","null"],"format":"uuid","description":"Work schedule id"},"fixed_adjustments":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems"},"description":"List of fixed adjustments associated with the amendment request."},"rejection_context":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataRejectionContext"},{"type":"null"}],"description":"Additional details containing rejection reason"},"amendment_statuses":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems"},"description":"List of amendment statuses representing the history and progression of an amendment."},"notice_period_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataNoticePeriodType"},{"type":"null"}],"description":"Type of notice period."},"void_deadline_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVoidDeadlineType"},{"type":"null"}],"description":"Type of void deadline"},"work_hours_per_week":{"type":"string","description":"Number of work hours per week."},"employee_nationality":{"type":"string","description":"Nationality of the employee."},"is_hrx_action_needed":{"type":"boolean","description":"Is HRX action needed."},"variable_compensation":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVariableCompensation","description":"Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended."},"notice_period_time_unit":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit"},{"type":"null"}],"description":"Notice period time unit."},"is_effective_date_updated":{"type":"boolean","description":"Is Effective Date updated."},"work_schedule_rules_version":{"type":["string","null"],"description":"Work schedule rule version."},"notice_period_after_probation":{"type":["string","null"],"description":"Notice period after probation."},"notice_period_during_probation":{"type":["string","null"],"description":"Notice period during probation."},"probation_period_type_for_definite":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite"},{"type":"null"}],"description":"Type of probation period for definite contracts."}},"title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaData"},"eor-amendments_updateContractAmendment_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaData"}},"title":"eor-amendments_updateContractAmendment_Response_200"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaErrorsItems"},"UpdateASpecificEorContractAmendmentRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"UpdateASpecificEorContractAmendmentRequestBadRequestError"},"UpdateASpecificEorContractAmendmentRequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"UpdateASpecificEorContractAmendmentRequestNotFoundError"},"UpdateASpecificEorContractAmendmentRequestConflictError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"UpdateASpecificEorContractAmendmentRequestConflictError"},"UpdateASpecificEorContractAmendmentRequestUnprocessableEntityError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaErrorsItems"},"description":"List of validation or business rule errors."}},"required":["errors"],"title":"UpdateASpecificEorContractAmendmentRequestUnprocessableEntityError"},"UpdateASpecificEorContractAmendmentRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"UpdateASpecificEorContractAmendmentRequestInternalServerError"},"EorContractsContractIdAmendmentsValidatePostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"valid":{"type":["boolean","null"]},"message":{"type":["string","null"]}},"title":"EorContractsContractIdAmendmentsValidatePostResponsesContentApplicationJsonSchemaData"},"eor-amendments_validateEORAmendments_Response_200":{"type":"object","properties":{"data":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsValidatePostResponsesContentApplicationJsonSchemaData"},"description":"Validation results keyed by amendment field"}},"title":"eor-amendments_validateEORAmendments_Response_200"},"EorContractsContractIdAmendmentsValidatePostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"title":"EorContractsContractIdAmendmentsValidatePostResponsesContentApplicationJsonSchemaErrorsItems"},"ValidateAmendmentDataPointsRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsValidatePostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"ValidateAmendmentDataPointsRequestBadRequestError"},"ValidateAmendmentDataPointsRequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsValidatePostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"ValidateAmendmentDataPointsRequestNotFoundError"},"ValidateAmendmentDataPointsRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsValidatePostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"ValidateAmendmentDataPointsRequestInternalServerError"},"EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsPlan":{"type":"object","properties":{"name":{"type":"string","description":"The name of the associated plan."}},"title":"EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsPlan"},"EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvider":{"type":"object","properties":{"name":{"type":"string","description":"The name of the benefit provider."}},"title":"EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvider"},"EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsOfferStatus":{"type":"string","enum":["Offered","Not offered"],"description":"Indicates whether the benefit is offered.","title":"EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsOfferStatus"},"EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsEnrollmentDetailsPlan":{"type":"object","properties":{"name":{"type":"string","description":"The name of the enrolled plan."}},"title":"EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsEnrollmentDetailsPlan"},"EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsEnrollmentDetailsStandard":{"type":"object","properties":{"monthly_cost":{"type":["string","null"],"description":"The standard monthly cost of the benefit."},"employee_monthly_contribution":{"type":["string","null"],"description":"The standard monthly employer contribution."}},"title":"EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsEnrollmentDetailsStandard"},"EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsEnrollmentDetailsCurrentCycle":{"type":"object","properties":{"monthly_cost":{"type":"string","description":"The monthly cost of the current enrollment."},"employee_monthly_contribution":{"type":"string","description":"The employer's monthly contribution for the current enrollment."}},"title":"EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsEnrollmentDetailsCurrentCycle"},"EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsEnrollmentDetails":{"type":"object","properties":{"plan":{"$ref":"#/components/schemas/EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsEnrollmentDetailsPlan"},"status":{"type":"string","description":"The current enrollment status of the benefit."},"standard":{"$ref":"#/components/schemas/EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsEnrollmentDetailsStandard"},"current_cycle":{"$ref":"#/components/schemas/EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsEnrollmentDetailsCurrentCycle"}},"title":"EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsEnrollmentDetails"},"EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the benefit."},"name":{"type":"string","description":"The name of the benefit."},"plan":{"$ref":"#/components/schemas/EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsPlan"},"provider":{"$ref":"#/components/schemas/EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvider"},"offer_status":{"$ref":"#/components/schemas/EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsOfferStatus","description":"Indicates whether the benefit is offered."},"enrollment_details":{"$ref":"#/components/schemas/EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsEnrollmentDetails"}},"title":"EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItems"},"eor-benefits_getEORBenefitsByContractId_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItems"}}},"title":"eor-benefits_getEORBenefitsByContractId_Response_200"},"EorPostRequestBodyContentApplicationJsonSchemaDataClientTeamId":{"oneOf":[{"type":"string"},{"type":"integer","format":"int64"}],"description":"Team identifying information.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataClientTeamId"},"EorPostRequestBodyContentApplicationJsonSchemaDataClientTeam":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataClientTeamId","description":"Team identifying information."}},"required":["id"],"title":"EorPostRequestBodyContentApplicationJsonSchemaDataClientTeam"},"EorPostRequestBodyContentApplicationJsonSchemaDataClientLegalEntityId":{"oneOf":[{"type":"string"},{"type":"integer","format":"int64"}],"description":"Legal entity reference for the client.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataClientLegalEntityId"},"EorPostRequestBodyContentApplicationJsonSchemaDataClientLegalEntity":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataClientLegalEntityId","description":"Legal entity reference for the client."}},"title":"EorPostRequestBodyContentApplicationJsonSchemaDataClientLegalEntity"},"EorPostRequestBodyContentApplicationJsonSchemaDataClient":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataClientTeam"},"legal_entity":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataClientLegalEntity"}},"required":["team"],"description":"Client details for the contract.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataClient"},"EorPostRequestBodyContentApplicationJsonSchemaDataPension":{"type":"object","properties":{"id":{"type":"string","description":"Pension provider id. You can see available pension providers in the country guide endpoint."},"contribution":{"type":"string","description":"Enter the value of pension contribution. You should send this value only if the contribution object is available in the country guide endpoint and the value should be there between minimum and maximum values indicated."}},"description":"Some countries required a pension benefit.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataPension"},"EorPostRequestBodyContentApplicationJsonSchemaDataBenefitsItems":{"type":"object","properties":{"plan_id":{"type":"string","description":"The ID of a benefits plan to include in the calculation."},"cover_all":{"type":"boolean","description":"Flag indicating if benefit will fully cover the employee."},"provider_id":{"type":"string","description":"The ID of a benefits provider to include in the calculation."},"contribution":{"type":"number","format":"double","description":"The amount the client will contribute for the benefit in the currency of the contract. Only taken into account if cover_all is set to false. For Unisure provider contribution is always in USD."},"cover_dependents":{"type":"boolean","description":"Flag indicating if benefit will cover dependents. Only needed if cover_all is set to true."}},"description":"List of additional benefits to include in the calculation","title":"EorPostRequestBodyContentApplicationJsonSchemaDataBenefitsItems"},"EorPostRequestBodyContentApplicationJsonSchemaDataEmployeeAddress":{"type":"object","properties":{"zip":{"type":"string","description":"Zip code."},"city":{"type":"string","description":"City name."},"state":{"type":["string","null"],"description":"State code."},"street":{"type":"string","description":"Street and number."},"country":{"type":"string","description":"Country code."}},"title":"EorPostRequestBodyContentApplicationJsonSchemaDataEmployeeAddress"},"EorPostRequestBodyContentApplicationJsonSchemaDataEmployeePfDeductions":{"type":"string","enum":["12% of Basic","12% of Rs 15,000 (Rs 1,800)"],"description":"Employee's PF deductions. Required only for India contracts.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataEmployeePfDeductions"},"EorPostRequestBodyContentApplicationJsonSchemaDataEmployee":{"type":"object","properties":{"email":{"type":"string","description":"Employee's email address."},"address":{"oneOf":[{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmployeeAddress"},{"type":"null"}]},"last_name":{"type":"string","description":"Employee's last name."},"first_name":{"type":"string","description":"Employee's first name."},"external_id":{"type":"string","description":"External identifier of the employee."},"nationality":{"type":"string","description":"Employee's nationality."},"pf_deductions":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmployeePfDeductions","description":"Employee's PF deductions. Required only for India contracts."}},"required":["last_name","first_name","nationality"],"title":"EorPostRequestBodyContentApplicationJsonSchemaDataEmployee"},"EorPostRequestBodyContentApplicationJsonSchemaDataSeniorityId":{"oneOf":[{"type":"string"},{"type":"integer","format":"int64"}],"description":"Identifier for the seniority level (string or numeric ID).","title":"EorPostRequestBodyContentApplicationJsonSchemaDataSeniorityId"},"EorPostRequestBodyContentApplicationJsonSchemaDataSeniority":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataSeniorityId","description":"Identifier for the seniority level (string or numeric ID)."}},"description":"Seniority selection for the role.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataSeniority"},"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentType":{"type":"string","enum":["Full-time","Part-time"],"description":"Is it a full-time contract or a part-time contract?","title":"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentType"},"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentScopeOfWork1":{"type":"object","properties":{"scope_template_id":{"type":"string","format":"uuid","description":"Scope template UUID."}},"title":"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentScopeOfWork1"},"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentScopeOfWork2":{"type":"object","properties":{"scope_validation_id":{"type":"string","format":"uuid","description":"Scope validation UUID."}},"title":"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentScopeOfWork2"},"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentScopeOfWork":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentScopeOfWork1"},{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentScopeOfWork2"}],"description":"Scope of work; either a string with full text or an object referencing a template/validation UUID.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentScopeOfWork"},"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentTimeOffType":{"type":"string","enum":["STANDARD","SPECIFIC"],"description":"If you want to use standard number of holidays for this employee, choose \"STANDARD\". If you want to enter a specific number of holidays, choose \"SPECIFIC\" and enter the number of days in the holidays field.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentTimeOffType"},"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentNoticePeriodType":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of notice period.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentNoticePeriodType"},"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentProbationPeriodTimeUnit":{"type":"string","enum":["DAY","WEEK","MONTH"],"description":"Time unit of probation period.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentProbationPeriodTimeUnit"},"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentProbationPeriodTypeForDefinite":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of probation period for definite contracts.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentProbationPeriodTypeForDefinite"},"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentNoticePeriodAfterProbationTimeUnit":{"type":"string","enum":["DAY","WEEK","MONTH"],"description":"Time unit of notice period after probation.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentNoticePeriodAfterProbationTimeUnit"},"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentNoticePeriodDuringProbationTimeUnit":{"type":"string","enum":["DAY","WEEK","MONTH"],"description":"Time unit of notice period during probation.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentNoticePeriodDuringProbationTimeUnit"},"EorPostRequestBodyContentApplicationJsonSchemaDataEmployment":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentType","description":"Is it a full-time contract or a part-time contract?"},"state":{"type":["string","null"],"description":"State code of the state/province where the this person will be employed."},"country":{"type":"string","description":"Country code of employment."},"end_date":{"type":["string","null"],"format":"date","description":"End date in ISO-8601 format (YYYY-MM-DD)."},"holidays":{"type":["number","null"],"format":"double","description":"Enter the number of holidays. Leave this field blank if you are choosing \"STANDARD\" time_off_type."},"is_hourly":{"type":"boolean","description":"Is the employee contract hourly instead of salaried?"},"start_date":{"type":"string","format":"date","description":"Start date in ISO-8601 format (YYYY-MM-DD)."},"scope_of_work":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentScopeOfWork","description":"Scope of work; either a string with full text or an object referencing a template/validation UUID."},"time_off_type":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentTimeOffType","description":"If you want to use standard number of holidays for this employee, choose \"STANDARD\". If you want to enter a specific number of holidays, choose \"SPECIFIC\" and enter the number of days in the holidays field."},"seniority_date":{"type":"string","format":"date","description":"Seniority date"},"sick_leave_days":{"type":"integer","description":"Number of sick leave days"},"probation_period":{"type":["number","null"],"format":"double","description":"Number of probation days."},"notice_period_type":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentNoticePeriodType","description":"Type of notice period."},"work_visa_required":{"type":"boolean","default":false,"description":"Do you require Deel to apply for work visa for this person?"},"work_hours_per_week":{"type":"number","format":"double","description":"Employee's work hours per week. Required only if contract is set as hourly."},"probation_period_time_unit":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentProbationPeriodTimeUnit","description":"Time unit of probation period."},"notice_period_after_probation":{"type":["number","null"],"format":"double","description":"Notice period after probation required when type is CUSTOM."},"notice_period_during_probation":{"type":["number","null"],"format":"double","description":"Notice period during probation required when type is CUSTOM."},"employee_completed_past_probation":{"type":"boolean","default":false,"description":"Whether the employee has previously passed the probation period."},"probation_period_type_for_definite":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentProbationPeriodTypeForDefinite","description":"Type of probation period for definite contracts."},"notice_period_after_probation_time_unit":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentNoticePeriodAfterProbationTimeUnit","description":"Time unit of notice period after probation."},"notice_period_during_probation_time_unit":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentNoticePeriodDuringProbationTimeUnit","description":"Time unit of notice period during probation."}},"required":["country","start_date","scope_of_work","work_visa_required"],"description":"Employment contract specific details.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataEmployment"},"EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsFixedAdjustmentsItems":{"type":"object","properties":{"name":{"type":"string","description":"Adjustment name."},"value":{"type":"number","format":"double","description":"Adjustment value."},"opt_out":{"type":"boolean","description":"Whether the adjustment is being opted out of."},"optional":{"type":"boolean","description":"Whether the adjustment is optional."},"description":{"type":"string","description":"Adjustment description."},"is_recurring":{"type":"boolean","description":"Whether the adjustment is paid recurring monthly or one-time on employee's first payroll."},"rule_cost_id":{"type":"string","description":"Identifier of the rule cost associated with the adjustment."},"is_country_specific":{"type":"boolean","description":"Whether this adjustment is country-specific."},"skipping_confirmation_text":{"type":"string","description":"Optional skipping confirmation text shown to the user."}},"title":"EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsFixedAdjustmentsItems"},"EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsSigningBonusPayoutType":{"type":"string","enum":["FIRST_CYCLE","AFTER_PROBATION","AFTER_FIRST_CONTRACT_ANNIVERSARY"],"description":"Should be set only if signing_bonus is set. It defines when the bonus is paid.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsSigningBonusPayoutType"},"EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsVariableCompensationType":{"type":"string","enum":["PERCENTAGE","FIXED"],"description":"Should be set only if variable_compensation is set. It can be PERCENTAGE or FIXED.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsVariableCompensationType"},"EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsVariableCompensationTimeline":{"type":"string","enum":["ANNUALLY","BIANNUALLY","QUARTERLY","MONTHLY"],"description":"Variable compensation timeline.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsVariableCompensationTimeline"},"EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetails":{"type":"object","properties":{"salary":{"type":"number","format":"double","description":"Employee's gross annual salary. Required only if contract is salaried."},"currency":{"type":"string","description":"Salary currency."},"hourly_rate":{"type":"number","format":"double","description":"Employee's hourly rate. Required only if contract is set as hourly."},"signing_bonus":{"type":["number","null"],"format":"double","description":"Signing bonus amount."},"fixed_adjustments":{"type":"array","items":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsFixedAdjustmentsItems"}},"variable_compensation":{"type":["number","null"],"format":"double","description":"Variable compensation. For example, if the person will earn 5% of the gross annual salary as the variable compensation, enter 5."},"signing_bonus_payout_type":{"oneOf":[{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsSigningBonusPayoutType"},{"type":"null"}],"description":"Should be set only if signing_bonus is set. It defines when the bonus is paid."},"variable_compensation_type":{"oneOf":[{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsVariableCompensationType"},{"type":"null"}],"description":"Should be set only if variable_compensation is set. It can be PERCENTAGE or FIXED."},"variable_compensation_title":{"type":"string","description":"Variable compensation title."},"variable_compensation_timeline":{"oneOf":[{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsVariableCompensationTimeline"},{"type":"null"}],"description":"Variable compensation timeline."},"variable_compensation_effective_date":{"type":"string","format":"date","description":"Variable compensation effective date."}},"required":["currency"],"title":"EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetails"},"EorPostRequestBodyContentApplicationJsonSchemaDataQuoteAdditionalFieldsWorkerType":{"type":"string","enum":["Skilled","Unskilled"],"description":"Type of worker.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataQuoteAdditionalFieldsWorkerType"},"EorPostRequestBodyContentApplicationJsonSchemaDataQuoteAdditionalFields":{"type":"object","properties":{"dob":{"type":"string","description":"Employee's date of birth."},"gender":{"type":"string","description":"Employee's gender."},"worker_type":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataQuoteAdditionalFieldsWorkerType","description":"Type of worker."}},"description":"Some countries require additional employee information for employment contracts.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataQuoteAdditionalFields"},"EorPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"client":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataClient","description":"Client details for the contract."},"pension":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataPension","description":"Some countries required a pension benefit."},"benefits":{"type":"array","items":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataBenefitsItems"}},"employee":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmployee"},"job_title":{"type":"string","description":"Employee's job title."},"seniority":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataSeniority","description":"Seniority selection for the role."},"employment":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmployment","description":"Employment contract specific details."},"health_plan_id":{"type":"string","description":"Healthcare plan id. You can see available healthcare plans in the country guide endpoint."},"compensation_details":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetails"},"quote_additional_fields":{"oneOf":[{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataQuoteAdditionalFields"},{"type":"null"}],"description":"Some countries require additional employee information for employment contracts."}},"required":["client","employee","job_title","seniority","employment","compensation_details"],"title":"EorPostRequestBodyContentApplicationJsonSchemaData"},"EorPostResponsesContentApplicationJsonSchemaDataType":{"type":"string","enum":["ongoing_time_based","milestones","time_based","pay_as_you_go_time_based","commission","payg_milestones","payg_tasks","eor","unknown","employee","global_payroll","shield_msa","hris_direct_employee","peo"],"description":"Type of the contract.","title":"EorPostResponsesContentApplicationJsonSchemaDataType"},"EorPostResponsesContentApplicationJsonSchemaDataCostsSummaryTotalsFormattedItems":{"type":"object","properties":{"title":{"type":"string","description":"Display title for the total (e.g., 'Monthly Total')."},"total":{"type":"string","description":"Formatted amount in local currency."},"frequency":{"type":"string","description":"Time period for the total (e.g., monthly, annual)."},"total_supporting":{"type":"string","description":"Formatted amount in supporting currency."}},"title":"EorPostResponsesContentApplicationJsonSchemaDataCostsSummaryTotalsFormattedItems"},"EorPostResponsesContentApplicationJsonSchemaDataCostsSummary":{"type":"object","properties":{"salary":{"type":"string","description":"Annual gross salary in local currency."},"currency":{"type":"string","description":"Local currency code (e.g., BRL, PLN)."},"exchange_rate":{"type":"string","description":"Exchange rate used to convert from local to supporting currency."},"totals_formatted":{"type":"array","items":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCostsSummaryTotalsFormattedItems"},"description":"Formatted summary totals in both local and supporting currencies."},"supporting_currency":{"type":"string","description":"Reference or secondary currency (e.g., USD) used for reporting totals."}},"description":"Top-level overview of costs, including key totals and currency metadata.","title":"EorPostResponsesContentApplicationJsonSchemaDataCostsSummary"},"EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsGroupsItemsCostsItemsTotalsItems":{"type":"object","properties":{"total":{"type":"string","description":"Total cost amount in local currency."},"frequency":{"type":"string","description":"How often this cost occurs (e.g., monthly, annual, one-time)."},"total_supporting":{"type":"string","description":"Total cost amount in the supporting currency."}},"title":"EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsGroupsItemsCostsItemsTotalsItems"},"EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsGroupsItemsCostsItems":{"type":"object","properties":{"label":{"type":"string","description":"Name of the specific cost item (e.g., Salary, Meal Voucher)."},"totals":{"type":"array","items":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsGroupsItemsCostsItemsTotalsItems"},"description":"Monthly and annual totals for the cost item in local and supporting currencies."}},"title":"EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsGroupsItemsCostsItems"},"EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsGroupsItemsTotalsItems":{"type":"object","properties":{"total":{"type":"string","description":"Group total in local currency."},"frequency":{"type":"string","description":"How often the total is calculated (e.g., monthly, annual)."},"total_supporting":{"type":"string","description":"Group total in supporting currency."}},"title":"EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsGroupsItemsTotalsItems"},"EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsGroupsItems":{"type":"object","properties":{"name":{"type":"string","description":"Internal identifier for the group."},"costs":{"type":"array","items":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsGroupsItemsCostsItems"},"description":"Individual cost items within the group."},"label":{"type":"string","description":"Display name for the group (e.g., Gross Salary, Employer Cost)."},"totals":{"type":"array","items":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsGroupsItemsTotalsItems"},"description":"Aggregated totals for all items within the group."},"has_breakdown":{"type":"boolean","description":"Indicates if the group contains multiple detailed cost items to be expanded."}},"title":"EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsGroupsItems"},"EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsTotalsItems":{"type":"object","properties":{"total":{"type":"string","description":"Total cost for the section in local currency."},"frequency":{"type":"string","description":"How often the total is calculated (e.g., monthly, annual)."},"total_supporting":{"type":"string","description":"Total cost for the section in supporting currency."}},"title":"EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsTotalsItems"},"EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsStandaloneItemsItemsTotalsItems":{"type":"object","properties":{"total":{"type":"string","description":"Standalone cost amount in local currency."},"frequency":{"type":"string","description":"How often this cost occurs (e.g., monthly, annual, one-time)."},"total_supporting":{"type":"string","description":"Standalone cost amount in the supporting currency."}},"title":"EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsStandaloneItemsItemsTotalsItems"},"EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsStandaloneItemsItems":{"type":"object","properties":{"name":{"type":"string","description":"Internal identifier for the standalone cost item."},"label":{"type":"string","description":"Display name for the standalone cost item."},"totals":{"type":"array","items":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsStandaloneItemsItemsTotalsItems"},"description":"Monthly and annual totals for the standalone item in local and supporting currencies."}},"title":"EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsStandaloneItemsItems"},"EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItems":{"type":"object","properties":{"name":{"type":"string","description":"Internal identifier for the cost section (e.g., MONTHLY_EMPLOYMENT_BREAKDOWN)."},"label":{"type":"string","description":"Display name for the cost section."},"groups":{"type":"array","items":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsGroupsItems"},"description":"Collections of related costs grouped under a common label."},"totals":{"type":"array","items":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsTotalsItems"},"description":"Overall totals for the section, summing all groups and standalone items."},"is_summarized":{"type":"boolean","description":"Indicates whether the section is presented in summarized form."},"standalone_items":{"type":"array","items":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsStandaloneItemsItems"},"description":"Cost items that do not belong to regular groups, often irregular or one-off costs."}},"title":"EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItems"},"EorPostResponsesContentApplicationJsonSchemaDataCostsAdditionalData":{"type":"object","properties":{"annual_notes":{"type":"array","items":{"type":"string"},"description":"Notes or assumptions specifically relevant to annual cost calculations."},"monthly_notes":{"type":"array","items":{"type":"string"},"description":"Notes or assumptions specifically relevant to monthly cost calculations."},"once_off_notes":{"type":"array","items":{"type":"string"},"description":"Notes regarding one-time costs or irregular payments in the quote."},"additional_notes":{"type":"array","items":{"type":"string"},"description":"General conditions, assumptions, or fees that may apply to the quote."}},"description":"Supplementary notes and contextual information relevant to the cost quote.","title":"EorPostResponsesContentApplicationJsonSchemaDataCostsAdditionalData"},"EorPostResponsesContentApplicationJsonSchemaDataCosts":{"type":"object","properties":{"summary":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCostsSummary","description":"Top-level overview of costs, including key totals and currency metadata."},"sections":{"type":"array","items":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItems"},"description":"Detailed and categorized cost sections including grouped and standalone items."},"additional_data":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCostsAdditionalData","description":"Supplementary notes and contextual information relevant to the cost quote."}},"description":"Detailed breakdown of employment costs including summary totals, sectioned cost groups, and additional context notes.","title":"EorPostResponsesContentApplicationJsonSchemaDataCosts"},"EorPostResponsesContentApplicationJsonSchemaDataClientLegalEntity":{"type":"object","properties":{"name":{"type":"string","description":"Legal entity name"}},"title":"EorPostResponsesContentApplicationJsonSchemaDataClientLegalEntity"},"EorPostResponsesContentApplicationJsonSchemaDataClient":{"type":"object","properties":{"legal_entity":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataClientLegalEntity"}},"description":"Client information for the contract.","title":"EorPostResponsesContentApplicationJsonSchemaDataClient"},"EorPostResponsesContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["new","under_review","waiting_for_employee_contract","waiting_for_client_sign","processing_payment","waiting_for_contractor_sign","waiting_for_eor_sign","waiting_for_employee_sign","awaiting_deposit_payment","in_progress","completed","cancelled","user_cancelled","rejected","waiting_for_client_payment","onboarding"],"description":"Current status of the contract.","title":"EorPostResponsesContentApplicationJsonSchemaDataStatus"},"EorPostResponsesContentApplicationJsonSchemaDataEmployee":{"type":"object","properties":{"email":{"type":"string","description":"Employee's email"},"last_name":{"type":"string","description":"Employee's last name"},"first_name":{"type":"string","description":"Employee's first name"},"legal_name":{"type":"string","description":"Employee's legal name"}},"title":"EorPostResponsesContentApplicationJsonSchemaDataEmployee"},"EorPostResponsesContentApplicationJsonSchemaDataSeniority":{"type":"object","properties":{"id":{"type":"integer","description":"Seniority level ID"},"name":{"type":"string","description":"Seniority level name"}},"required":["id","name"],"description":"Seniority level of the employee","title":"EorPostResponsesContentApplicationJsonSchemaDataSeniority"},"EorPostResponsesContentApplicationJsonSchemaDataEmployment":{"type":"object","properties":{"state":{"type":["string","null"],"description":"State or province of employment"},"country":{"type":"string","description":"Country of employment"},"end_date":{"type":["string","null"],"format":"date-time","description":"Employment end date"},"start_date":{"type":"string","format":"date-time","description":"Employment start date"},"scope_of_work":{"type":"string","description":"Scope of work description."},"time_off_type":{"type":"string","description":"Type of time off for the employee"},"probation_period":{"type":["integer","null"],"description":"Number of probation days"},"work_visa_required":{"type":"boolean","description":"If a work visa is required"},"calculated_holidays":{"type":"string","description":"Number of calculated holidays"}},"description":"Employment contract specific details.","title":"EorPostResponsesContentApplicationJsonSchemaDataEmployment"},"EorPostResponsesContentApplicationJsonSchemaDataHealthPlan":{"type":"object","properties":{"id":{"type":"string","description":"Health plan ID"},"name":{"type":"string","description":"Health plan name"}},"title":"EorPostResponsesContentApplicationJsonSchemaDataHealthPlan"},"EorPostResponsesContentApplicationJsonSchemaDataCompensationDetails":{"type":"object","properties":{"salary":{"type":"string","description":"Gross annual salary"},"currency":{"type":"string","description":"Currency of the salary"},"variable_compensation":{"type":"string","description":"Variable compensation account or percentage"},"variable_compensation_type":{"type":["string","null"],"description":"Type of variable compensation"}},"title":"EorPostResponsesContentApplicationJsonSchemaDataCompensationDetails"},"EorPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"ID of the created contract quote."},"type":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataType","description":"Type of the contract."},"costs":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCosts","description":"Detailed breakdown of employment costs including summary totals, sectioned cost groups, and additional context notes."},"client":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataClient","description":"Client information for the contract."},"status":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataStatus","description":"Current status of the contract."},"employee":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataEmployee"},"job_title":{"type":"string","description":"Employee's job title"},"seniority":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataSeniority","description":"Seniority level of the employee"},"created_at":{"type":"string","format":"date-time","description":"Contract creation timestamp"},"employment":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataEmployment","description":"Employment contract specific details."},"health_plan":{"oneOf":[{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataHealthPlan"},{"type":"null"}]},"compensation_details":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCompensationDetails"}},"title":"EorPostResponsesContentApplicationJsonSchemaData"},"eor-contract_createEORContract_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaData"}},"title":"eor-contract_createEORContract_Response_201"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaTeam":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the team."},"name":{"type":"string","description":"The name of the team."}},"title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaTeam"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaStatus":{"type":"string","enum":["under_review","waiting_for_employee_contract","waiting_for_client_sign","waiting_for_eor_sign","waiting_for_employee_sign","awaiting_deposit_payment","in_progress","completed","cancelled","user_cancelled","rejected"],"description":"The current status of the contract.","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaStatus"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaCreator":{"type":"object","properties":{"name":{"type":"string","description":"The name of the contract creator."},"email":{"type":"string","description":"The email address of the contract creator."},"firstname":{"type":"string","description":"The first name of the contract creator."}},"title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaCreator"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmployee":{"type":"object","properties":{"email":{"type":"string","description":"The email of the employee."},"pic_url":{"type":["string","null"],"description":"URL to employee's picture."},"last_name":{"type":"string","description":"The last name of the employee."},"first_name":{"type":"string","description":"The first name of the employee."},"legal_name":{"type":"string","description":"The legal name of the employee."},"nationality":{"type":"string","description":"Two letter country code of the employee nationality."}},"description":"Employee details","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmployee"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaSeniority":{"type":"object","properties":{"id":{"type":"number","format":"double","description":"The unique identifier for the seniority level."},"name":{"type":"string","description":"The name of the seniority level."}},"title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaSeniority"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaSickDays":{"type":"object","properties":{"max":{"type":["string","null"],"description":"Maximum number of sick days allowed."},"min":{"type":["string","null"],"description":"Minimum number of sick days allowed."}},"description":"Allowed sick days range.","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaSickDays"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaPayrollType":{"type":"string","enum":["BIMONTHLY","MONTHLY"],"description":"Payroll frequency for the contract","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaPayrollType"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaCanAdjustOn":{"type":"object","properties":{"end":{"type":"string","description":"End of the period when adjustments can be made."},"start":{"type":"string","description":"Start of the period when adjustments can be made."}},"description":"Time frame when adjustments can be made.","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaCanAdjustOn"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaContractType":{"type":"string","enum":["eor"],"description":"The type of contract.","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaContractType"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaTimeOffType":{"type":"string","enum":["STANDARD","SPECIFIC","PRORATED"],"description":"Type of time off policy.","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaTimeOffType"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentType":{"type":"string","enum":["Full-time","Part-time"],"description":"The type of employment.","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentType"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSummaryTotalsFormattedItems":{"type":"object","properties":{"title":{"type":"string","description":"Display title for the total (e.g., 'Monthly Total')."},"total":{"type":"string","description":"Formatted amount in local currency."},"frequency":{"type":"string","description":"Time period for the total (e.g., monthly, annual)."},"total_supporting":{"type":"string","description":"Formatted amount in supporting currency."}},"title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSummaryTotalsFormattedItems"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSummary":{"type":"object","properties":{"salary":{"type":"string","description":"Annual gross salary in local currency."},"currency":{"type":"string","description":"Local currency code (e.g., BRL, PLN)."},"exchange_rate":{"type":"string","description":"Exchange rate used to convert from local to supporting currency."},"totals_formatted":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSummaryTotalsFormattedItems"},"description":"Formatted summary totals in both local and supporting currencies."},"supporting_currency":{"type":"string","description":"Reference or secondary currency (e.g., USD) used for reporting totals."}},"description":"Top-level overview of costs, including key totals and currency metadata.","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSummary"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsGroupsItemsCostsItemsTotalsItems":{"type":"object","properties":{"total":{"type":"string","description":"Total cost amount in local currency."},"frequency":{"type":"string","description":"How often this cost occurs (e.g., monthly, annual, one-time)."},"total_supporting":{"type":"string","description":"Total cost amount in the supporting currency."}},"title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsGroupsItemsCostsItemsTotalsItems"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsGroupsItemsCostsItems":{"type":"object","properties":{"label":{"type":"string","description":"Name of the specific cost item (e.g., Salary, Meal Voucher)."},"totals":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsGroupsItemsCostsItemsTotalsItems"},"description":"Monthly and annual totals for the cost item in local and supporting currencies."}},"title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsGroupsItemsCostsItems"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsGroupsItemsTotalsItems":{"type":"object","properties":{"total":{"type":"string","description":"Group total in local currency."},"frequency":{"type":"string","description":"How often the total is calculated (e.g., monthly, annual)."},"total_supporting":{"type":"string","description":"Group total in supporting currency."}},"title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsGroupsItemsTotalsItems"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsGroupsItems":{"type":"object","properties":{"name":{"type":"string","description":"Internal identifier for the group."},"costs":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsGroupsItemsCostsItems"},"description":"Individual cost items within the group."},"label":{"type":"string","description":"Display name for the group (e.g., Gross Salary, Employer Cost)."},"totals":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsGroupsItemsTotalsItems"},"description":"Aggregated totals for all items within the group."},"has_breakdown":{"type":"boolean","description":"Indicates if the group contains multiple detailed cost items to be expanded."}},"title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsGroupsItems"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsTotalsItems":{"type":"object","properties":{"total":{"type":"string","description":"Total cost for the section in local currency."},"frequency":{"type":"string","description":"How often the total is calculated (e.g., monthly, annual)."},"total_supporting":{"type":"string","description":"Total cost for the section in supporting currency."}},"title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsTotalsItems"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsStandaloneItemsItemsTotalsItems":{"type":"object","properties":{"total":{"type":"string","description":"Standalone cost amount in local currency."},"frequency":{"type":"string","description":"How often this cost occurs (e.g., monthly, annual, one-time)."},"total_supporting":{"type":"string","description":"Standalone cost amount in the supporting currency."}},"title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsStandaloneItemsItemsTotalsItems"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsStandaloneItemsItems":{"type":"object","properties":{"name":{"type":"string","description":"Internal identifier for the standalone cost item."},"label":{"type":"string","description":"Display name for the standalone cost item."},"totals":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsStandaloneItemsItemsTotalsItems"},"description":"Monthly and annual totals for the standalone item in local and supporting currencies."}},"title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsStandaloneItemsItems"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItems":{"type":"object","properties":{"name":{"type":"string","description":"Internal identifier for the cost section (e.g., MONTHLY_EMPLOYMENT_BREAKDOWN)."},"label":{"type":"string","description":"Display name for the cost section."},"groups":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsGroupsItems"},"description":"Collections of related costs grouped under a common label."},"totals":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsTotalsItems"},"description":"Overall totals for the section, summing all groups and standalone items."},"is_summarized":{"type":"boolean","description":"Indicates whether the section is presented in summarized form."},"standalone_items":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsStandaloneItemsItems"},"description":"Cost items that do not belong to regular groups, often irregular or one-off costs."}},"title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItems"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsAdditionalData":{"type":"object","properties":{"annual_notes":{"type":"array","items":{"type":"string"},"description":"Notes or assumptions specifically relevant to annual cost calculations."},"monthly_notes":{"type":"array","items":{"type":"string"},"description":"Notes or assumptions specifically relevant to monthly cost calculations."},"once_off_notes":{"type":"array","items":{"type":"string"},"description":"Notes regarding one-time costs or irregular payments in the quote."},"additional_notes":{"type":"array","items":{"type":"string"},"description":"General conditions, assumptions, or fees that may apply to the quote."}},"description":"Supplementary notes and contextual information relevant to the cost quote.","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsAdditionalData"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCosts":{"type":"object","properties":{"summary":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSummary","description":"Top-level overview of costs, including key totals and currency metadata."},"sections":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItems"},"description":"Detailed and categorized cost sections including grouped and standalone items."},"additional_data":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsAdditionalData","description":"Supplementary notes and contextual information relevant to the cost quote."}},"description":"Detailed breakdown of employment costs including summary totals, sectioned cost groups, and additional context notes.","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCosts"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaHiringObjectiveType":{"type":"string","enum":["EXPANDING_TO_NEW_COUNTRY","TEMP_EOR_OPENING_ENTITY","ONE_OFF_HIRE","CONVERTING_CONTRACTOR","OTHER"],"title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaHiringObjectiveType"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaHiringObjective":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaHiringObjectiveType"},"extra_info":{"type":["string","null"]}},"description":"Information about the hiring objective.","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaHiringObjective"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaNoticePeriodType":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of notice period if applicable.","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaNoticePeriodType"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaLastQuoteRejectionRejectedBy":{"type":"object","properties":{"name":{"type":"string","description":"Full name of the rejecting person."},"profile_public_id":{"type":"string","format":"uuid","description":"Public identifier for the rejecting person's profile."}},"description":"Details of the person who rejected.","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaLastQuoteRejectionRejectedBy"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaLastQuoteRejectionRejectionType":{"type":"string","enum":["CLIENT","EOR_AGENT"],"description":"Type of rejection.","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaLastQuoteRejectionRejectionType"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaLastQuoteRejectionRejectionReason":{"type":"string","enum":["TOO_EXPENSIVE","DECIDED_AGAINST_EMPLOYING_EOR","TEST_QUOTE","NOT_SATISFIED_WITH_DEEL","INACCURATE_INFO_JOB_TITLE","INACCURATE_INFO_JOB_DESCRIPTION","INACCURATE_INFO_JOB_DUTIES_SCOPE_OF_WORK","OTHER"],"description":"Reason why the rejection occurred.","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaLastQuoteRejectionRejectionReason"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaLastQuoteRejection":{"type":"object","properties":{"created_at":{"type":"string","description":"Timestamp of when the rejection was made."},"rejected_by":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaLastQuoteRejectionRejectedBy","description":"Details of the person who rejected."},"rejection_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaLastQuoteRejectionRejectionType"},{"type":"null"}],"description":"Type of rejection."},"rejection_reason":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaLastQuoteRejectionRejectionReason","description":"Reason why the rejection occurred."},"rejection_message":{"type":["string","null"],"description":"Optional message explaining the rejection."}},"description":"Timestamp of last quote rejection.","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaLastQuoteRejection"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaWorkScheduleAssignmentSettings":{"type":"string","enum":["NOT_AVAILABLE","SPECIFIC_SCHEDULES","GENERAL_SCHEDULES","ONE_TIME_AMENDMENT"],"description":"Work schedule assignment setting.","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaWorkScheduleAssignmentSettings"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaProbationPeriodTypeForDefinite":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Probation period type for definite contracts.","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaProbationPeriodTypeForDefinite"},"eor-contract_getEORContractDetails_Response_200":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the Deel contract."},"name":{"type":"string","description":"Contract name"},"team":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaTeam"},"salary":{"type":"string","description":"Annual salary as a string to preserve decimal precision."},"status":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaStatus","description":"The current status of the contract."},"creator":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaCreator"},"currency":{"type":"string","description":"The currency used in the contract."},"employee":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmployee","description":"Employee details"},"end_date":{"type":["string","null"],"format":"date-time","description":"The end date of the contract, if applicable."},"timezone":{"type":"string","description":"The timezone of the contract."},"seniority":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaSeniority"},"sick_days":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaSickDays","description":"Allowed sick days range."},"work_visa":{"type":"boolean","description":"Indicates if a work visa is required."},"created_at":{"type":"string","format":"date-time","description":"The date and time when the contract was created."},"start_date":{"type":"string","format":"date-time","description":"The start date of the contract."},"updated_at":{"type":"string","format":"date-time","description":"The date and time when the contract was last updated."},"description":{"type":"string","description":"Contract description"},"signed_date":{"type":["string","null"],"format":"date-time","description":"The date and time when the contract was signed by both parties."},"cancelled_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the contract was cancelled."},"completed_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the contract was completed."},"payroll_type":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaPayrollType","description":"Payroll frequency for the contract"},"can_adjust_on":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaCanAdjustOn"},{"type":"null"}],"description":"Time frame when adjustments can be made."},"contract_type":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaContractType","description":"The type of contract."},"scope_of_work":{"type":"string","description":"Description of job scope and responsibilities."},"signing_bonus":{"type":["string","null"],"description":"One-time bonus paid at contract sign."},"time_off_type":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaTimeOffType","description":"Type of time off policy."},"deposit_months":{"type":["string","null"],"description":"Number of deposit months required."},"effective_date":{"type":"string","format":"date-time","description":"The date and time when the contract is effective."},"job_title_name":{"type":["string","null"],"description":"The contract's job title."},"completion_date":{"type":["string","null"],"format":"date-time","description":"The completion date of the contract."},"employment_type":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentType","description":"The type of employment."},"client_signature":{"type":["string","null"],"description":"The signature of the client."},"client_signed_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the client signed the contract."},"employment_costs":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCosts"},{"type":"null"}],"description":"Detailed breakdown of employment costs including summary totals, sectioned cost groups, and additional context notes."},"employment_state":{"type":["string","null"],"description":"The state of the employment."},"hiring_objective":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaHiringObjective"},{"type":"null"}],"description":"Information about the hiring objective."},"probation_period":{"type":"integer","description":"Number of days in the probation period."},"employee_signed_at":{"type":["string","null"],"format":"date-time","description":"Date and time when the employee signed."},"employment_country":{"type":"string","description":"Two letter country code of the employment country."},"notice_period_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaNoticePeriodType"},{"type":"null"}],"description":"Type of notice period if applicable."},"original_start_date":{"type":"string","format":"date-time","description":"The originally planned start date."},"work_hours_per_week":{"type":"string","description":"Number of work hours per week."},"contractor_signature":{"type":["string","null"],"description":"The signature of the EOR entity representative."},"contractor_signed_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the contractor signed the contract."},"effective_plain_date":{"type":"string","format":"date","description":"The effective date in plain format."},"fixed_adjustment_ids":{"type":["array","null"],"items":{"type":"string"},"description":"List of fixed adjustment ids."},"invited_client_email":{"type":["string","null"],"description":"The email address of the invited client."},"last_quote_rejection":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaLastQuoteRejection"},{"type":"null"}],"description":"Timestamp of last quote rejection."},"completion_plain_date":{"type":["string","null"],"format":"date","description":"The completion date of the contract in plain contract."},"is_onboarding_on_hold":{"type":"boolean","description":"Whether onboarding is currently on hold or not."},"monthly_employer_cost":{"type":"string","description":"Monthly cost to the employer."},"employee_late_sign_start":{"type":["string","null"],"format":"date-time","description":"Date when employee signed late, if applicable."},"is_early_invoice_enabled":{"type":"boolean","description":"Whether early invoicing is enabled or not."},"onboarding_step_duration":{"type":["integer","null"],"description":"Duration of onboarding steps in days."},"variable_compensation_ids":{"type":"array","items":{"type":"string"},"description":"List of variable compensation IDs."},"can_remind_employee_to_sign":{"type":"boolean","description":"Whether reminders to sign the employee resignation can be sent to the employee or not."},"initial_effective_plain_date":{"type":"string","format":"date","description":"The initial effective date in plain format."},"is_foreign_currency_contract":{"type":"boolean","description":"Whether the contract uses foreign currency or not."},"is_employee_onboarding_delayed":{"type":"boolean","description":"Determines if the invite for employee onboarding should be dispatch manually."},"monthly_eor_management_fee_usd":{"type":"string","description":"Monthly EOR management fee in USD."},"work_schedule_assignment_settings":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaWorkScheduleAssignmentSettings","description":"Work schedule assignment setting."},"probation_period_type_for_definite":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaProbationPeriodTypeForDefinite"},{"type":"null"}],"description":"Probation period type for definite contracts."}},"title":"eor-contract_getEORContractDetails_Response_200"},"RetrieveEorContractDetails-v2026-01-01RequestForbiddenError":{"type":"object","properties":{"error":{"type":"string","description":"Contract is not accessible to the user/organization"}},"title":"RetrieveEorContractDetails-v2026-01-01RequestForbiddenError"},"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataScope1":{"type":"object","properties":{"scope_template_id":{"type":"string","format":"uuid","description":"Scope template UUID."},"scope_validation_id":{"type":"string","format":"uuid","description":"Scope validation UUID."}},"title":"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataScope1"},"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataScope":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataScope1"}],"title":"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataScope"},"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataBenefitsItems":{"type":"object","properties":{"plan_id":{"type":["string","null"],"description":"Benefit plan ID"},"cover_all":{"type":"boolean","description":"Indicates if benefit covers all"},"provider_id":{"type":["string","null"],"description":"Benefit provider ID"},"contribution":{"type":["number","null"],"format":"double","description":"Contribution amount"},"cover_dependents":{"type":"boolean","description":"Indicates if benefit covers dependents"}},"description":"Benefit plan details","title":"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataBenefitsItems"},"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataTimeOffType":{"type":"string","enum":["STANDARD","SPECIFIC","PRORATED"],"description":"Type of time off","title":"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataTimeOffType"},"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataEmploymentType":{"type":"string","enum":["Full-time","Part-time"],"description":"Type of employment","title":"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataEmploymentType"},"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataEmployeeAddress":{"type":"object","properties":{"zip":{"type":"string","description":"ZIP/Postal code"},"city":{"type":"string","description":"City of residence"},"phone":{"type":"string","description":"Phone number"},"state":{"type":"string","description":"State of residence"},"street":{"type":"string","description":"Street address"},"country":{"type":"string","description":"Country of residence (can be country code or name)"},"province":{"type":"string","description":"Province of residence"},"calling_code":{"type":"string","description":"Country calling code"}},"required":["city","street","country"],"description":"Employee's address information","title":"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataEmployeeAddress"},"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataHiringObjective":{"type":"string","enum":["EXPANDING_TO_NEW_COUNTRY","TEMP_EOR_OPENING_ENTITY","ONE_OFF_HIRE","CONVERTING_CONTRACTOR","OTHER"],"description":"Objective for hiring","title":"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataHiringObjective"},"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataWorkArrangement":{"type":"string","enum":["REMOTE","ON_SITE_OR_HYBRID"],"description":"Work arrangement type","title":"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataWorkArrangement"},"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataWorkEligibility":{"type":"object","properties":{"key":{"type":"string","description":"Unique identifier for the work eligibility document"},"file_name":{"type":"string","description":"Name of the work eligibility document file"}},"required":["key","file_name"],"description":"Work eligibility documentation","title":"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataWorkEligibility"},"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataContractTermType":{"type":"string","enum":["DEFINITE","INDEFINITE"],"description":"Type of contract term","title":"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataContractTermType"},"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataNoticePeriodType":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of notice period","title":"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataNoticePeriodType"},"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataReasonForFixedTerm":{"type":"string","enum":["SEASONAL_OR_TEMPORARY_WORK","PROJECT_BASED_EMPLOYMENT","REPLACEMENT_FOR_PERMANENT_STAFF","TRIAL_PERIODS_FOR_NEW_ROLES_OR_BUSINESSES"],"description":"Reason for fixed-term contract","title":"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataReasonForFixedTerm"},"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataQuoteAdditionalFieldsEmployeeType":{"type":"string","enum":["Employee","Manager"],"description":"Type of employee","title":"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataQuoteAdditionalFieldsEmployeeType"},"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataQuoteAdditionalFields":{"type":"object","properties":{"employee_type":{"$ref":"#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataQuoteAdditionalFieldsEmployeeType","description":"Type of employee"},"qualifications":{"type":"string","description":"Required qualifications"},"scope_german_translation":{"type":"string","description":"German translation of scope"},"qualifications_german_translation":{"type":"string","description":"German translation of qualifications"}},"description":"Additional quote-specific information","title":"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataQuoteAdditionalFields"},"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataSigningBonusPayoutType":{"type":"string","enum":["FIRST_CYCLE","AFTER_PROBATION","AFTER_FIRST_CONTRACT_ANNIVERSARY"],"default":"FIRST_CYCLE","description":"Determines when the signing bonus will be paid out","title":"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataSigningBonusPayoutType"},"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite":{"type":"string","enum":["CUSTOM","STANDARD"],"description":"Unit of time for probation period","title":"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite"},"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataScope"},"salary":{"type":"number","format":"double","description":"Annual salary amount"},"benefits":{"type":["array","null"],"items":{"$ref":"#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataBenefitsItems"},"description":"Array of employee benefits"},"currency":{"type":"string","description":"Currency code for salary and benefits"},"end_date":{"type":["string","null"],"format":"date","description":"Employment end date"},"holidays":{"type":["number","null"],"format":"double","description":"Number of holiday days per year"},"is_hourly":{"type":["boolean","null"],"description":"Indicates if compensation is hourly"},"job_title":{"type":"string","description":"Job title (cannot be C-level position)"},"work_visa":{"type":["boolean","null"],"description":"Indicates if work visa is required"},"start_date":{"type":"string","format":"date","description":"Employment start date"},"employee_id":{"type":"string","description":"Employee's unique identifier"},"hourly_rate":{"type":["number","null"],"format":"double","description":"Hourly rate (required if is_hourly is true)"},"is_resubmit":{"type":["boolean","null"],"description":"Indicates if this is a resubmission"},"schedule_id":{"type":["string","null"],"description":"Unique identifier for the employee's work schedule"},"seniority_id":{"type":"number","format":"double","description":"Seniority level identifier"},"work_pension":{"type":["boolean","null"],"description":"Indicates if work pension is included"},"signing_bonus":{"type":["number","null"],"format":"double","description":"Signing bonus amount"},"time_off_type":{"$ref":"#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataTimeOffType","description":"Type of time off"},"employee_email":{"type":"string","format":"email","description":"Employee's email address"},"seniority_date":{"type":"string","format":"date","description":"Employee seniority date"},"employment_type":{"$ref":"#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataEmploymentType","description":"Type of employment"},"sick_leave_days":{"type":["number","null"],"format":"double","description":"Number of sick leave days per year"},"employee_address":{"$ref":"#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataEmployeeAddress","description":"Employee's address information"},"employment_state":{"type":["string","null"],"description":"State/Province of employment"},"hiring_objective":{"$ref":"#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataHiringObjective","description":"Objective for hiring"},"probation_period":{"type":["number","null"],"format":"double","description":"Probation period duration"},"work_arrangement":{"oneOf":[{"$ref":"#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataWorkArrangement"},{"type":"null"}],"description":"Work arrangement type"},"work_eligibility":{"$ref":"#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataWorkEligibility","description":"Work eligibility documentation"},"medical_insurance":{"type":"boolean","description":"Medical insurance coverage"},"contract_term_type":{"$ref":"#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataContractTermType","description":"Type of contract term"},"employee_last_name":{"type":"string","description":"Employee's last name"},"employment_country":{"type":"string","description":"Country of employment"},"notice_period_type":{"$ref":"#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataNoticePeriodType","description":"Type of notice period"},"employee_first_name":{"type":"string","description":"Employee's first name"},"work_hours_per_week":{"type":"number","format":"double","description":"Working hours per week"},"employee_nationality":{"type":"string","description":"Employee's nationality"},"reason_for_fixed_term":{"oneOf":[{"$ref":"#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataReasonForFixedTerm"},{"type":"null"}],"description":"Reason for fixed-term contract"},"quote_additional_fields":{"$ref":"#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataQuoteAdditionalFields","description":"Additional quote-specific information"},"signing_bonus_payout_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataSigningBonusPayoutType"},{"type":"null"}],"description":"Determines when the signing bonus will be paid out"},"hiring_objective_extra_info":{"type":["string","null"],"description":"Additional information about hiring objective"},"notice_period_after_probation":{"type":"number","format":"double","description":"Notice period after probation (days)"},"notice_period_during_probation":{"type":"number","format":"double","description":"Notice period during probation (days)"},"is_auto_quote_validation_passed":{"type":["boolean","null"],"description":"Auto quote validation status"},"probation_period_type_for_definite":{"$ref":"#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite","description":"Unit of time for probation period"},"allow_consultant_equipment_reimbursement":{"type":"boolean","description":"Allow equipment reimbursement for consultants"}},"required":["salary","job_title","start_date","employee_email","employment_type","employee_last_name","employment_country","employee_first_name"],"title":"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaData"},"EorContractContractIdPatchResponsesContentApplicationJsonSchemaStatus":{"type":"string","enum":["new","under_review","waiting_for_client_sign","waiting_for_eor_sign","waiting_for_employee_sign","awaiting_deposit_payment","rejected"],"description":"Current status of the contract","title":"EorContractContractIdPatchResponsesContentApplicationJsonSchemaStatus"},"eor-contract_updateEORContract_Response_200":{"type":"object","properties":{"oid":{"type":"string","description":"The unique identifier of the employee contract."},"status":{"$ref":"#/components/schemas/EorContractContractIdPatchResponsesContentApplicationJsonSchemaStatus","description":"Current status of the contract"},"scope_of_work":{"type":"string","description":"Scope of work description."}},"required":["oid","status"],"title":"eor-contract_updateEORContract_Response_200"},"EorContractContractIdPatchResponsesContentApplicationJsonSchemaError":{"type":"object","properties":{"code":{"type":"string","description":"Error code identifier"},"status":{"type":"integer","description":"HTTP status code"},"message":{"type":"string","description":"Error message details"}},"title":"EorContractContractIdPatchResponsesContentApplicationJsonSchemaError"},"UpdateEorContractRequestBadRequestError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/EorContractContractIdPatchResponsesContentApplicationJsonSchemaError"}},"required":["error"],"title":"UpdateEorContractRequestBadRequestError"},"UpdateEorContractRequestForbiddenError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/EorContractContractIdPatchResponsesContentApplicationJsonSchemaError"}},"required":["error"],"title":"UpdateEorContractRequestForbiddenError"},"UpdateEorContractRequestNotFoundError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/EorContractContractIdPatchResponsesContentApplicationJsonSchemaError"}},"required":["error"],"title":"UpdateEorContractRequestNotFoundError"},"UpdateEorContractRequestInternalServerError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/EorContractContractIdPatchResponsesContentApplicationJsonSchemaError"}},"required":["error"],"title":"UpdateEorContractRequestInternalServerError"},"EorContractsContractIdDocumentsGetResponsesContentApplicationJsonSchemaDataItemsDocumentType":{"type":"string","enum":["FRAMEWORK_AGREEMENT"],"description":"The type of document. Currently only FRAMEWORK_AGREEMENT is supported.","title":"EorContractsContractIdDocumentsGetResponsesContentApplicationJsonSchemaDataItemsDocumentType"},"EorContractsContractIdDocumentsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"signature":{"type":["string","null"],"description":"The signature of the client if the document is signed."},"signed_at":{"type":["string","null"],"format":"date-time","description":"The date and time the client signed the document if it is signed."},"document_type":{"$ref":"#/components/schemas/EorContractsContractIdDocumentsGetResponsesContentApplicationJsonSchemaDataItemsDocumentType","description":"The type of document. Currently only FRAMEWORK_AGREEMENT is supported."},"eor_signature":{"type":["string","null"],"description":"The signature of the EOR if the document is signed."},"eor_signed_at":{"type":["string","null"],"format":"date-time","description":"The date and time the EOR signed the document if it is signed."},"client_job_title":{"type":["string","null"],"description":"The job title of the client if the document is signed."}},"required":["document_type"],"title":"EorContractsContractIdDocumentsGetResponsesContentApplicationJsonSchemaDataItems"},"eor-contract-documents_getEORContractDocuments_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdDocumentsGetResponsesContentApplicationJsonSchemaDataItems"}}},"required":["data"],"title":"eor-contract-documents_getEORContractDocuments_Response_200"},"EorContractsContractIdDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"path":{"type":"string","description":"The JSON path where input validation failed"},"message":{"type":"string","description":"A description of the returned error"}},"title":"EorContractsContractIdDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems"},"EorContractsContractIdDocumentsGetResponsesContentApplicationJsonSchemaRequest":{"type":"object","properties":{"url":{"type":"string","description":"The relative URL of the failed request"},"code":{"type":"number","format":"double","description":"The code of the source handler which produced the returned error"},"docs":{"type":"string","description":"A link to the official documentation for the requested endpoint resource"},"method":{"type":"string","description":"The HTTP method of the failed request"},"source":{"type":"string","description":"The source handler which produced the returned error"},"status":{"type":"number","format":"double","description":"The status code of the response"},"api_req_id":{"type":"string","description":"The request ID of the failed request"}},"title":"EorContractsContractIdDocumentsGetResponsesContentApplicationJsonSchemaRequest"},"FetchEorContractDocumentsRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/EorContractsContractIdDocumentsGetResponsesContentApplicationJsonSchemaRequest"}},"title":"FetchEorContractDocumentsRequestBadRequestError"},"EorEmploymentCostPostRequestBodyContentApplicationJsonSchemaDataBenefitsItems":{"type":"object","properties":{"plan_id":{"type":["string","null"],"description":"The ID of the benefits plan, if applicable."},"provider_id":{"type":"string","description":"The ID of the benefits provider."}},"required":["provider_id"],"title":"EorEmploymentCostPostRequestBodyContentApplicationJsonSchemaDataBenefitsItems"},"EorEmploymentCostPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"state":{"type":"string","description":"The state or region within the country, if applicable."},"salary":{"type":"number","format":"double","description":"The base salary for the employee."},"country":{"type":"string","description":"The full name of the country where the employee is based."},"benefits":{"type":["array","null"],"items":{"$ref":"#/components/schemas/EorEmploymentCostPostRequestBodyContentApplicationJsonSchemaDataBenefitsItems"},"description":"A list of selected benefit plans for the employee."},"currency":{"type":"string","description":"The currency in which the costs are calculated."},"country_code":{"type":"string","description":"The two-letter country code where the employee is based."}},"required":["salary","country","currency"],"title":"EorEmploymentCostPostRequestBodyContentApplicationJsonSchemaData"},"EorEmploymentCostPostResponsesContentApplicationJsonSchemaCostsItems":{"type":"object","properties":{"name":{"type":"string","description":"Name of the cost item."},"amount":{"type":"string","description":"Cost amount."},"country":{"type":"string","description":"The country of the cost item."},"frequency":{"type":"string","description":"The frequency of the cost (e.g., monthly, annually)."},"country_code":{"type":"string","description":"ISO Alpha-2 code of the country."}},"title":"EorEmploymentCostPostResponsesContentApplicationJsonSchemaCostsItems"},"EorEmploymentCostPostResponsesContentApplicationJsonSchemaBenefitsDataItems":{"type":"object","properties":{"name":{"type":"string","description":"Benefit name."},"plan":{"type":"string","description":"Benefit plan."},"amount":{"type":"string","description":"Benefit cost."},"fee_amount":{"type":"string","description":"Fees associated with the benefit."}},"title":"EorEmploymentCostPostResponsesContentApplicationJsonSchemaBenefitsDataItems"},"EorEmploymentCostPostResponsesContentApplicationJsonSchemaAdditionalData":{"type":"object","properties":{"additional_notes":{"type":"array","items":{"type":"string"}}},"title":"EorEmploymentCostPostResponsesContentApplicationJsonSchemaAdditionalData"},"cost-calculator_getEmploymentCost_Response_200":{"type":"object","properties":{"costs":{"type":"array","items":{"$ref":"#/components/schemas/EorEmploymentCostPostResponsesContentApplicationJsonSchemaCostsItems"}},"salary":{"type":"string","description":"The base salary for the employee."},"country":{"type":"string","description":"The country where the employee is based."},"currency":{"type":"string","description":"The currency used for cost calculation."},"deel_fee":{"type":"string","description":"The Deel fee for managing the employee."},"frequency":{"type":"string","description":"Frequency of the salary payment (e.g., monthly)."},"total_costs":{"type":"string","description":"Total employment costs."},"country_code":{"type":"string","description":"ISO Alpha-2 code of the country."},"benefits_data":{"type":"array","items":{"$ref":"#/components/schemas/EorEmploymentCostPostResponsesContentApplicationJsonSchemaBenefitsDataItems"}},"employer_costs":{"type":"string","description":"Costs incurred by the employer."},"additional_data":{"$ref":"#/components/schemas/EorEmploymentCostPostResponsesContentApplicationJsonSchemaAdditionalData"},"severance_accural":{"type":"string","description":"Severance accrual costs."}},"title":"cost-calculator_getEmploymentCost_Response_200"},"EorContractOidCancelPostRequestBodyContentApplicationJsonSchemaDataCancellationReason":{"type":"string","enum":["INTERNAL_DECISION","UNSATISFACTORY_EXPERIENCE","EXPLORING_ALTERNATIVE","OFFER_CHANGES"],"description":"Reason for contract termination","title":"EorContractOidCancelPostRequestBodyContentApplicationJsonSchemaDataCancellationReason"},"EorContractOidCancelPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"cancellation_reason":{"$ref":"#/components/schemas/EorContractOidCancelPostRequestBodyContentApplicationJsonSchemaDataCancellationReason","description":"Reason for contract termination"},"cancellation_message":{"type":"string","description":"Message for contract termination"}},"required":["cancellation_reason"],"title":"EorContractOidCancelPostRequestBodyContentApplicationJsonSchemaData"},"eor-hiring_cancelContract_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"eor-hiring_cancelContract_Response_204"},"CancelEorContractRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string","description":"Error message details"}},"title":"CancelEorContractRequestBadRequestError"},"CancelEorContractRequestNotFoundError":{"type":"object","properties":{"error":{"type":"string","description":"Error message details"}},"title":"CancelEorContractRequestNotFoundError"},"EorContractOidDelayOnboardingPatchRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"is_employee_onboarding_delayed":{"type":"boolean","description":"Indicates if the employee onboarding is delayed"}},"required":["is_employee_onboarding_delayed"],"title":"EorContractOidDelayOnboardingPatchRequestBodyContentApplicationJsonSchemaData"},"eor-hiring_delayOnboarding_Response_200":{"type":"object","properties":{"success":{"type":"boolean","description":"Operation success status"},"contractOid":{"type":"string","description":"Contract OID"},"is_employee_onboarding_delayed":{"type":"boolean","description":"Current onboarding delay status"}},"required":["success"],"title":"eor-hiring_delayOnboarding_Response_200"},"DelayEorEmployeeOnboardingRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string","description":"Error message"}},"required":["error"],"title":"DelayEorEmployeeOnboardingRequestBadRequestError"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsType":{"type":"string","enum":["FreeText","Paragraph","SingleSelection","MultiSelection","Address","PhoneNumber","DocumentUpload","Number","Dropdown","DatePicker","Email","CustomDropdown","PresetDropdown","Nested"],"description":"Type of the question.","title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsType"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsSource":{"type":"object","properties":{"url":{"type":"string","description":"API endpoint providing dynamic options."},"definition":{"type":"string","description":"Reference URL for API documentation."},"description":{"type":"string","description":"Description of the data source."}},"description":"Defines dynamic data source for the question.","title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsSource"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsOptionsItems":{"type":"object","properties":{"title":{"type":"string","description":"Display text for the option."},"value":{"type":["string","null"],"description":"Value associated with the option."}},"title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsOptionsItems"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsRequiresItemsValue":{"oneOf":[{"type":"string"},{"type":"number","format":"double"},{"type":"boolean"}],"description":"Expected value for the condition.","title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsRequiresItemsValue"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsRequiresItems":{"type":"object","properties":{"key":{"type":"string","description":"Key of the dependent field."},"value":{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsRequiresItemsValue","description":"Expected value for the condition."},"operator":{"type":["string","null"],"description":"Comparison operator (e.g., 'eq', 'ne')."},"compare_key":{"type":["string","null"],"description":"Key of the field to compare against."}},"title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsRequiresItems"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsMaxValue":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Maximum value allowed.","title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsMaxValue"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsMinValue":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Minimum value allowed.","title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsMinValue"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsDefaultValue":{"oneOf":[{"type":"string"},{"type":"number","format":"double"},{"type":"boolean"}],"description":"Default value to pre-fill in the form.","title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsDefaultValue"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItems":{"type":"object","properties":{"title":{"type":"string","description":"Title of the question."},"source":{"oneOf":[{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsSource"},{"type":"null"}],"description":"Defines dynamic data source for the question."},"options":{"type":["array","null"],"items":{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsOptionsItems"},"description":"List of selectable options for selection-type questions. Value may be of any type."},"is_range":{"type":"boolean","description":"Specifies whether a date picker allows range selection."},"requires":{"type":"array","items":{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsRequiresItems"},"description":"List of conditions that must be met for this rule to apply."},"max_value":{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsMaxValue","description":"Maximum value allowed."},"min_value":{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsMinValue","description":"Minimum value allowed."},"max_length":{"type":["integer","null"],"description":"Maximum character length for text responses."},"min_length":{"type":["integer","null"],"description":"Minimum character length for text responses."},"helper_text":{"type":["string","null"],"description":"Additional information to assist the user."},"is_disabled":{"type":"boolean","description":"If true, the field is disabled and cannot be edited."},"is_required":{"type":"boolean","description":"Indicates if the question is required."},"number_type":{"type":"string","description":"Used for number fields to define the unit or representation."},"default_value":{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsDefaultValue","description":"Default value to pre-fill in the form."},"is_only_digits":{"type":"boolean","description":"Restricts input to numeric characters only, for FreeText questions."},"date_limitation":{"type":["string","null"],"description":"Limits date selection (e.g., blocking past dates). Will always be 'BLOCK_PAST' for now."},"is_multiple_selection":{"type":"boolean","description":"Indicates if the user can select multiple values."},"must_request_validation":{"type":"boolean","description":"Whether additional validation should be triggered for this field."}},"title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItems"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsSource":{"type":"object","properties":{"url":{"type":"string","description":"API endpoint providing dynamic options."},"definition":{"type":"string","description":"Reference URL for API documentation."},"description":{"type":"string","description":"Description of the data source."}},"description":"Defines dynamic data source for the question.","title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsSource"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsOptionsItems":{"type":"object","properties":{"title":{"type":"string","description":"Display text for the option."},"value":{"type":["string","null"],"description":"Value associated with the option."}},"title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsOptionsItems"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsMaxValue":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Maximum value allowed.","title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsMaxValue"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsMinValue":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Minimum value allowed.","title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsMinValue"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsDefaultValue":{"oneOf":[{"type":"string"},{"type":"number","format":"double"},{"type":"boolean"}],"description":"Default value to pre-fill in the form.","title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsDefaultValue"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItems":{"type":"object","properties":{"key":{"type":"string","description":"Unique key identifier for the question."},"type":{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsType","description":"Type of the question."},"rules":{"type":["array","null"],"items":{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItems"},"description":"Validation rules for the question."},"title":{"type":"string","description":"Title of the question."},"source":{"oneOf":[{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsSource"},{"type":"null"}],"description":"Defines dynamic data source for the question."},"options":{"type":["array","null"],"items":{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsOptionsItems"},"description":"List of selectable options for selection-type questions. Value may be of any type."},"is_range":{"type":"boolean","description":"Specifies whether a date picker allows range selection."},"max_value":{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsMaxValue","description":"Maximum value allowed."},"min_value":{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsMinValue","description":"Minimum value allowed."},"max_length":{"type":["integer","null"],"description":"Maximum character length for text responses."},"min_length":{"type":["integer","null"],"description":"Minimum character length for text responses."},"helper_text":{"type":["string","null"],"description":"Additional information to assist the user."},"is_disabled":{"type":"boolean","description":"If true, the field is disabled and cannot be edited."},"is_required":{"type":"boolean","description":"Indicates if the question is required."},"number_type":{"type":"string","description":"Used for number fields to define the unit or representation."},"default_value":{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsDefaultValue","description":"Default value to pre-fill in the form."},"is_only_digits":{"type":"boolean","description":"Restricts input to numeric characters only, for FreeText questions."},"date_limitation":{"type":["string","null"],"description":"Limits date selection (e.g., blocking past dates). Will always be 'BLOCK_PAST' for now."},"is_multiple_selection":{"type":"boolean","description":"Indicates if the user can select multiple values."},"must_request_validation":{"type":"boolean","description":"Whether additional validation should be triggered for this field."}},"required":["key","type","title"],"title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItems"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItems":{"type":"object","properties":{"title":{"type":"string","description":"Title of the section."},"subtitle":{"type":"string","description":"Additional information shown at the top of the section."},"questions":{"type":"array","items":{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItems"},"description":"List of questions within the section."}},"required":["title","questions"],"title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItems"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItems":{"type":"object","properties":{"title":{"type":"string","description":"Title of the form page."},"sections":{"type":"array","items":{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItems"},"description":"Sections within the page."}},"required":["title","sections"],"title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItems"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"pages":{"type":"array","items":{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItems"},"description":"List of pages in the form."}},"required":["pages"],"title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaData"},"eor-hiring_getCreateContractForm_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-hiring_getCreateContractForm_Response_200"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"path":{"type":"string","description":"The JSON path where input validation failed"},"message":{"type":"string","description":"A description of the returned error"}},"title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaRequest":{"type":"object","properties":{"url":{"type":"string","description":"The relative URL of the failed request"},"code":{"type":"number","format":"double","description":"The code of the source handler which produced the returned error"},"docs":{"type":"string","description":"A link to the official documentation for the requested endpoint resource"},"method":{"type":"string","description":"The HTTP method of the failed request"},"source":{"type":"string","description":"The source handler which produced the returned error"},"status":{"type":"number","format":"double","description":"The status code of the response"},"api_req_id":{"type":"string","description":"The request ID of the failed request"}},"title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaRequest"},"FetchEorContractFormRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaRequest"}},"title":"FetchEorContractFormRequestBadRequestError"},"EorStartDateGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"min_start_date":{"type":"string","format":"date-time","description":"The earliest possible employment start date"},"start_date_buffer":{"type":"integer","description":"Number of business days to buffer from today"},"first_payroll_lock":{"type":"integer","description":"Day of month when payroll gets locked"},"is_same_month_payment_country":{"type":"boolean","description":"Whether the employment country requires start date within the same month"}},"required":["min_start_date","start_date_buffer","first_payroll_lock","is_same_month_payment_country"],"title":"EorStartDateGetResponsesContentApplicationJsonSchemaData"},"eor-hiring_getStartDate_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorStartDateGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-hiring_getStartDate_Response_200"},"EorStartDateGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"path":{"type":"string","description":"The JSON path where input validation failed"},"message":{"type":"string","description":"A description of the returned error"}},"title":"EorStartDateGetResponsesContentApplicationJsonSchemaErrorsItems"},"EorStartDateGetResponsesContentApplicationJsonSchemaRequest":{"type":"object","properties":{"url":{"type":"string","description":"The relative URL of the failed request"},"code":{"type":"number","format":"double","description":"The code of the source handler which produced the returned error"},"docs":{"type":"string","description":"A link to the official documentation for the requested endpoint resource"},"method":{"type":"string","description":"The HTTP method of the failed request"},"source":{"type":"string","description":"The source handler which produced the returned error"},"status":{"type":"number","format":"double","description":"The status code of the response"},"api_req_id":{"type":"string","description":"The request ID of the failed request"}},"title":"EorStartDateGetResponsesContentApplicationJsonSchemaRequest"},"FetchStartDateForEorContractsRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorStartDateGetResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/EorStartDateGetResponsesContentApplicationJsonSchemaRequest"}},"title":"FetchStartDateForEorContractsRequestBadRequestError"},"EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaDataAllowancesItems":{"type":"object","properties":{"name":{"type":"string","description":"Allowance name."},"value":{"type":"number","format":"double","description":"Allowance value."},"optional":{"type":"boolean","description":"Indicates if the allowance is optional."},"description":{"type":"string","description":"Allowance description."},"is_recurring":{"type":"boolean","description":"Indicates if the allowance is recurring."},"rule_cost_id":{"type":"string","description":"Unique identifier for the allowance."},"use_contract_currency":{"type":"boolean","description":"Indicates if the allowance uses the contract currency."},"skipping_confirmation_text":{"type":["string","null"],"description":"Confirmation text for opting out of the allowance."}},"title":"EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaDataAllowancesItems"},"EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaDataNonStatutoryItems":{"type":"object","properties":{"name":{"type":"string","description":"Allowance name."},"value":{"type":"number","format":"double","description":"Allowance value."},"currency":{"type":"string","description":"Currency"},"description":{"type":"string","description":"Allowance description."},"is_recurring":{"type":"boolean","description":"Indicates if the allowance is recurring."},"rule_cost_id":{"type":"string","description":"Unique identifier for the allowance."},"use_contract_currency":{"type":"boolean","description":"Indicates if the allowance uses the contract currency."}},"title":"EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaDataNonStatutoryItems"},"EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"allowances":{"type":"array","items":{"$ref":"#/components/schemas/EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaDataAllowancesItems"}},"non_statutory":{"type":"array","items":{"$ref":"#/components/schemas/EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaDataNonStatutoryItems"}}},"title":"EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaData"},"eor-hiring_getAdditionalCosts_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaData"}},"title":"eor-hiring_getAdditionalCosts_Response_200"},"EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"path":{"type":"string","description":"The JSON path where input validation failed"},"message":{"type":"string","description":"A description of the returned error"}},"title":"EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaErrorsItems"},"EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaRequest":{"type":"object","properties":{"url":{"type":"string","description":"The relative URL of the failed request"},"code":{"type":"number","format":"double","description":"The code of the source handler which produced the returned error"},"docs":{"type":"string","description":"A link to the official documentation for the requested endpoint resource"},"method":{"type":"string","description":"The HTTP method of the failed request"},"source":{"type":"string","description":"The source handler which produced the returned error"},"status":{"type":"number","format":"double","description":"The status code of the response"},"api_req_id":{"type":"string","description":"The request ID of the failed request"}},"title":"EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaRequest"},"GetEorAdditionalCostsRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaRequest"}},"title":"GetEorAdditionalCostsRequestBadRequestError"},"EorBenefitsGetParametersEmploymentType":{"type":"string","enum":["Full-time","Part-time"],"title":"EorBenefitsGetParametersEmploymentType"},"EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItemsPlansItemsAttachmentsItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the attachment."},"url":{"type":"string","description":"The url of the attachment."},"label":{"type":"string","description":"The label of the attachment."}},"required":["id","url","label"],"title":"EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItemsPlansItemsAttachmentsItems"},"EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItemsPlansItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the plan."},"name":{"type":"string","description":"The name of the plan."},"price":{"type":"number","format":"double","description":"The price of the plan."},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItemsPlansItemsAttachmentsItems"}}},"required":["id","name","price","attachments"],"title":"EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItemsPlansItems"},"EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItemsAttachmentsItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the attachment."},"url":{"type":"string","description":"The url of the attachment."},"label":{"type":"string","description":"The label of the attachment."}},"required":["id","url","label"],"title":"EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItemsAttachmentsItems"},"EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItemsContributionOptionsItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the contribution."},"amount":{"type":"number","format":"double","description":"Amount."}},"required":["id","amount"],"title":"EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItemsContributionOptionsItems"},"EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the benefit provider."},"name":{"type":"string","description":"The name of the benefit provider."},"type":{"type":"string","description":"Benefit type."},"plans":{"type":"array","items":{"$ref":"#/components/schemas/EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItemsPlansItems"}},"country":{"type":"string","description":"Country code."},"currency":{"type":"string","description":"Currency."},"is_unisure":{"type":"boolean","description":"Indicates if Unisure."},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItemsAttachmentsItems"}},"client_info":{"type":["string","null"],"description":"Client information."},"employee_info":{"type":["string","null"],"description":"Employee information."},"home_page_url":{"type":"string","description":"The home page URL of the benefit provider."},"max_contribution":{"type":["number","null"],"format":"double","description":"Maximum contribution."},"min_contribution":{"type":["number","null"],"format":"double","description":"Minimum contribution."},"contribution_options":{"type":"array","items":{"$ref":"#/components/schemas/EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItemsContributionOptionsItems"}}},"required":["id","name","type","plans","country","currency","is_unisure","attachments","home_page_url","contribution_options"],"title":"EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItems"},"EorBenefitsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"name":{"type":"string","description":"The name of the benefit."},"providers":{"type":"array","items":{"$ref":"#/components/schemas/EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItems"}},"description":{"type":"string","description":"The description of the benefit."},"is_mandatory":{"type":"boolean","description":"Indicates if the benefit is mandatory."},"is_discriminatory":{"type":"boolean","description":"Indicates if the benefit is discriminatory."}},"required":["name","providers","description","is_mandatory","is_discriminatory"],"title":"EorBenefitsGetResponsesContentApplicationJsonSchemaDataItems"},"eor-hiring_getBenefits_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EorBenefitsGetResponsesContentApplicationJsonSchemaDataItems"}}},"required":["data"],"title":"eor-hiring_getBenefits_Response_200"},"EorBenefitsGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"path":{"type":"string","description":"The JSON path where input validation failed"},"message":{"type":"string","description":"A description of the returned error"}},"title":"EorBenefitsGetResponsesContentApplicationJsonSchemaErrorsItems"},"EorBenefitsGetResponsesContentApplicationJsonSchemaRequest":{"type":"object","properties":{"url":{"type":"string","description":"The relative URL of the failed request"},"code":{"type":"number","format":"double","description":"The code of the source handler which produced the returned error"},"docs":{"type":"string","description":"A link to the official documentation for the requested endpoint resource"},"method":{"type":"string","description":"The HTTP method of the failed request"},"source":{"type":"string","description":"The source handler which produced the returned error"},"status":{"type":"number","format":"double","description":"The status code of the response"},"api_req_id":{"type":"string","description":"The request ID of the failed request"}},"title":"EorBenefitsGetResponsesContentApplicationJsonSchemaRequest"},"RetrieveBenefitsByCountryRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorBenefitsGetResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/EorBenefitsGetResponsesContentApplicationJsonSchemaRequest"}},"title":"RetrieveBenefitsByCountryRequestBadRequestError"},"EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataSalaryFrequency":{"type":"string","enum":["monthly","quarterly","annually","specific_month","specific_date"],"description":"Frequency of the salary payment.","title":"EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataSalaryFrequency"},"EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataSalary":{"type":"object","properties":{"max":{"type":["string","null"],"description":"Maximum salary."},"min":{"type":["string","null"],"description":"Minimum salary."},"frequency":{"$ref":"#/components/schemas/EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataSalaryFrequency","description":"Frequency of the salary payment."}},"title":"EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataSalary"},"EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataHoliday":{"type":"object","properties":{"max":{"type":["string","null"],"description":"Maximum holidays."},"min":{"type":["string","null"],"description":"Minimum holidays."},"mostCommon":{"type":["string","null"],"description":"Most common holiday period."}},"title":"EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataHoliday"},"EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataProbation":{"type":"object","properties":{"max":{"type":["number","null"],"format":"double","description":"Maximum probation period."},"min":{"type":["number","null"],"format":"double","description":"Minimum probation period."}},"title":"EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataProbation"},"EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataHealthInsuranceStatus":{"type":"string","enum":["REQUIRED","ENABLED","DISABLED"],"description":"Health insurance status.","title":"EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataHealthInsuranceStatus"},"EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataHealthInsuranceProvidersItems":{"type":"object","properties":{"id":{"type":"string","description":"Provider ID."},"name":{"type":"string","description":"Provider name."}},"title":"EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataHealthInsuranceProvidersItems"},"EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataHealthInsurance":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataHealthInsuranceStatus","description":"Health insurance status."},"providers":{"type":"array","items":{"$ref":"#/components/schemas/EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataHealthInsuranceProvidersItems"}}},"title":"EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataHealthInsurance"},"EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"salary":{"$ref":"#/components/schemas/EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataSalary"},"holiday":{"$ref":"#/components/schemas/EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataHoliday"},"currency":{"type":"string","description":"Country currency."},"probation":{"$ref":"#/components/schemas/EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataProbation"},"health_insurance":{"oneOf":[{"$ref":"#/components/schemas/EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataHealthInsurance"},{"type":"null"}]}},"title":"EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaData"},"eor-hiring_getEORHiringGuideByCountry_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaData"}},"title":"eor-hiring_getEORHiringGuideByCountry_Response_200"},"EorContractsContractIdDocumentsTypeSignPostParametersType":{"type":"string","enum":["FRAMEWORK_AGREEMENT"],"title":"EorContractsContractIdDocumentsTypeSignPostParametersType"},"EorContractsContractIdDocumentsTypeSignPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"signature":{"type":"string","description":"The signature of the client signing the document."},"client_job_title":{"type":"string","description":"The job title of the client signing the document."}},"required":["signature","client_job_title"],"title":"EorContractsContractIdDocumentsTypeSignPostRequestBodyContentApplicationJsonSchemaData"},"EorContractsContractIdDocumentsTypeSignPostResponsesContentApplicationJsonSchemaDataDocumentType":{"type":"string","enum":["FRAMEWORK_AGREEMENT"],"description":"The type of document. Currently only FRAMEWORK_AGREEMENT is supported.","title":"EorContractsContractIdDocumentsTypeSignPostResponsesContentApplicationJsonSchemaDataDocumentType"},"EorContractsContractIdDocumentsTypeSignPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"signature":{"type":["string","null"],"description":"The signature of the client if the document is signed."},"signed_at":{"type":["string","null"],"format":"date-time","description":"The date and time the client signed the document if it is signed."},"document_type":{"$ref":"#/components/schemas/EorContractsContractIdDocumentsTypeSignPostResponsesContentApplicationJsonSchemaDataDocumentType","description":"The type of document. Currently only FRAMEWORK_AGREEMENT is supported."},"eor_signature":{"type":["string","null"],"description":"The signature of the EOR if the document is signed."},"eor_signed_at":{"type":["string","null"],"format":"date-time","description":"The date and time the EOR signed the document if it is signed."},"client_job_title":{"type":["string","null"],"description":"The job title of the client if the document is signed."}},"required":["document_type"],"title":"EorContractsContractIdDocumentsTypeSignPostResponsesContentApplicationJsonSchemaData"},"eor-hiring_signContractDocument_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdDocumentsTypeSignPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-hiring_signContractDocument_Response_200"},"EorContractsContractIdDocumentsTypeSignPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"path":{"type":"string","description":"The JSON path where input validation failed"},"message":{"type":"string","description":"A description of the returned error"}},"title":"EorContractsContractIdDocumentsTypeSignPostResponsesContentApplicationJsonSchemaErrorsItems"},"EorContractsContractIdDocumentsTypeSignPostResponsesContentApplicationJsonSchemaRequest":{"type":"object","properties":{"url":{"type":"string","description":"The relative URL of the failed request"},"code":{"type":"number","format":"double","description":"The code of the source handler which produced the returned error"},"docs":{"type":"string","description":"A link to the official documentation for the requested endpoint resource"},"method":{"type":"string","description":"The HTTP method of the failed request"},"source":{"type":"string","description":"The source handler which produced the returned error"},"status":{"type":"number","format":"double","description":"The status code of the response"},"api_req_id":{"type":"string","description":"The request ID of the failed request"}},"title":"EorContractsContractIdDocumentsTypeSignPostResponsesContentApplicationJsonSchemaRequest"},"SignEorContractDocumentRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdDocumentsTypeSignPostResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/EorContractsContractIdDocumentsTypeSignPostResponsesContentApplicationJsonSchemaRequest"}},"title":"SignEorContractDocumentRequestBadRequestError"},"EorContractsContractIdEmployeeInformationPatchRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"employee_last_name":{"type":"string","description":"The last name of the employee."},"employee_first_name":{"type":"string","description":"The first name of the employee."}},"title":"EorContractsContractIdEmployeeInformationPatchRequestBodyContentApplicationJsonSchemaData"},"EorContractsContractIdEmployeeInformationPatchResponsesContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["new","under_review","waiting_for_client_sign","waiting_for_eor_sign","waiting_for_employee_contract","waiting_for_employee_sign","awaiting_deposit_payment","rejected"],"description":"Current status of the contract","title":"EorContractsContractIdEmployeeInformationPatchResponsesContentApplicationJsonSchemaDataStatus"},"EorContractsContractIdEmployeeInformationPatchResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the employee contract."},"status":{"$ref":"#/components/schemas/EorContractsContractIdEmployeeInformationPatchResponsesContentApplicationJsonSchemaDataStatus","description":"Current status of the contract"},"scope_of_work":{"type":"string","description":"Scope of work description."},"employee_last_name":{"type":"string","description":"The last name of the contract employee."},"employee_first_name":{"type":"string","description":"The first name of the contract employee."}},"required":["id","status"],"title":"EorContractsContractIdEmployeeInformationPatchResponsesContentApplicationJsonSchemaData"},"eor-hiring_updateContractEmployeeInformation_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdEmployeeInformationPatchResponsesContentApplicationJsonSchemaData"}},"title":"eor-hiring_updateContractEmployeeInformation_Response_200"},"EorContractsContractIdEmployeeInformationPatchResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"EorContractsContractIdEmployeeInformationPatchResponsesContentApplicationJsonSchemaErrorsItems"},"UpdateEmployeeInformationForEorContractRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdEmployeeInformationPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"UpdateEmployeeInformationForEorContractRequestBadRequestError"},"UpdateEmployeeInformationForEorContractRequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdEmployeeInformationPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"UpdateEmployeeInformationForEorContractRequestNotFoundError"},"UpdateEmployeeInformationForEorContractRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdEmployeeInformationPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"UpdateEmployeeInformationForEorContractRequestInternalServerError"},"EorJobScopesGetResponsesContentApplicationJsonSchemaItemsTeam":{"type":"object","properties":{"id":{"type":["string","null"],"description":"Unique identifier of the associated team, if any"},"name":{"type":["string","null"],"description":"Name of the team associated with the job scope, if any"}},"title":"EorJobScopesGetResponsesContentApplicationJsonSchemaItemsTeam"},"EorJobScopesGetResponsesContentApplicationJsonSchemaItemsCreatedBy":{"type":"object","properties":{"id":{"type":["string","null"],"description":"Unique identifier of the user who created the job scope"},"name":{"type":["string","null"],"description":"Name of the user who created the job scope"}},"title":"EorJobScopesGetResponsesContentApplicationJsonSchemaItemsCreatedBy"},"EorJobScopesGetResponsesContentApplicationJsonSchemaItemsUpdatedBy":{"type":"object","properties":{"id":{"type":["string","null"],"description":"Unique identifier of the user who last updated the job scope"},"name":{"type":["string","null"],"description":"Name of the user who last updated the job scope"}},"title":"EorJobScopesGetResponsesContentApplicationJsonSchemaItemsUpdatedBy"},"EorJobScopesGetResponsesContentApplicationJsonSchemaItemsSourceType":{"type":"string","enum":["MANUAL","AI"],"description":"Source of the job scope data","title":"EorJobScopesGetResponsesContentApplicationJsonSchemaItemsSourceType"},"EorJobScopesGetResponsesContentApplicationJsonSchemaItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the job scope"},"team":{"$ref":"#/components/schemas/EorJobScopesGetResponsesContentApplicationJsonSchemaItemsTeam"},"title":{"type":"string","description":"Title or name of the job scope"},"content":{"type":"string","description":"Detailed description of the job scope"},"personal":{"type":["string","null"],"description":"Identifier from the team or the profile, whichever is available"},"created_at":{"type":"string","description":"Timestamp of when the job scope was created"},"created_by":{"$ref":"#/components/schemas/EorJobScopesGetResponsesContentApplicationJsonSchemaItemsCreatedBy"},"updated_at":{"type":"string","description":"Timestamp of when the job scope was last updated"},"updated_by":{"$ref":"#/components/schemas/EorJobScopesGetResponsesContentApplicationJsonSchemaItemsUpdatedBy"},"source_type":{"$ref":"#/components/schemas/EorJobScopesGetResponsesContentApplicationJsonSchemaItemsSourceType","description":"Source of the job scope data"},"organization_id":{"type":["string","null"],"description":"Identifier of the associated organization, if any"}},"title":"EorJobScopesGetResponsesContentApplicationJsonSchemaItems"},"EorJobScopesGetResponsesContentApplicationJsonSchemaError":{"type":"string","enum":["No organization is linked with the profile","No teams found for this organization"],"description":"Error message indicating the missing entity","title":"EorJobScopesGetResponsesContentApplicationJsonSchemaError"},"ListOfJobScopeTemplatesForEorContractsRequestNotFoundError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/EorJobScopesGetResponsesContentApplicationJsonSchemaError","description":"Error message indicating the missing entity"}},"title":"ListOfJobScopeTemplatesForEorContractsRequestNotFoundError"},"EorJobScopesValidatePostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"team_id":{"type":"string","format":"uuid","description":"The ID of the team."},"job_scope":{"type":"string","description":"The scope of the job."},"job_title":{"type":"string","description":"The title of the job."},"work_visa":{"type":"boolean","description":"Indicates if a work visa is required."},"client_name":{"type":"string","description":"Optional client name. The validation refuses a job scope if it includes the client name. If not provided, it will be inferred from the legal entity instead."},"employee_name":{"type":"string","description":"The name of the employee."},"special_job_id":{"type":["string","null"],"format":"uuid","description":"The ID of the special job."},"employment_state":{"type":["string","null"],"description":"The state of employment."},"employment_country":{"type":"string","description":"The country of employment."},"employee_nationality":{"type":"string","description":"The nationality of the employee."},"client_legal_entity_id":{"type":"string","format":"uuid","description":"The ID of the client's legal entity."}},"required":["team_id","job_scope","job_title","employee_name","employment_country","client_legal_entity_id"],"description":"details of job scope","title":"EorJobScopesValidatePostRequestBodyContentApplicationJsonSchemaData"},"EorJobScopesValidatePostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"path":{"type":"string","description":"The JSON path where input validation failed"},"message":{"type":"string","description":"A description of the returned error"}},"title":"EorJobScopesValidatePostResponsesContentApplicationJsonSchemaErrorsItems"},"EorJobScopesValidatePostResponsesContentApplicationJsonSchemaDataForCorrectedJobScopeEndpointErrorsForCorrectJobScopeItems":{"type":"object","properties":{"message":{"type":"string","description":"Message with error description"}},"title":"EorJobScopesValidatePostResponsesContentApplicationJsonSchemaDataForCorrectedJobScopeEndpointErrorsForCorrectJobScopeItems"},"EorJobScopesValidatePostResponsesContentApplicationJsonSchemaDataForCorrectedJobScopeEndpoint":{"type":"object","properties":{"anonymized_job_scope":{"type":["string","null"],"description":"Anonymized job scope."},"errors_for_correct_job_scope":{"type":"array","items":{"$ref":"#/components/schemas/EorJobScopesValidatePostResponsesContentApplicationJsonSchemaDataForCorrectedJobScopeEndpointErrorsForCorrectJobScopeItems"},"description":"List of errors for corrected job scope."},"must_create_correct_job_scope":{"type":"boolean","description":"Indicates if a corrected job scope is required."}},"description":"Data for corrected job scope endpoint.","title":"EorJobScopesValidatePostResponsesContentApplicationJsonSchemaDataForCorrectedJobScopeEndpoint"},"eor-job-scopes_validateJobScope_Response_200":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorJobScopesValidatePostResponsesContentApplicationJsonSchemaErrorsItems"},"description":"List of validation errors, if empty the validation was successfully."},"quote_validation_log_public_id":{"type":"string","description":"Id from validation request."},"data_for_corrected_job_scope_endpoint":{"$ref":"#/components/schemas/EorJobScopesValidatePostResponsesContentApplicationJsonSchemaDataForCorrectedJobScopeEndpoint","description":"Data for corrected job scope endpoint."}},"title":"eor-job-scopes_validateJobScope_Response_200"},"EorJobScopesValidatePostResponsesContentApplicationJsonSchemaRequest":{"type":"object","properties":{"url":{"type":"string","description":"The relative URL of the failed request"},"code":{"type":"number","format":"double","description":"The code of the source handler which produced the returned error"},"docs":{"type":"string","description":"A link to the official documentation for the requested endpoint resource"},"method":{"type":"string","description":"The HTTP method of the failed request"},"source":{"type":"string","description":"The source handler which produced the returned error"},"status":{"type":"number","format":"double","description":"The status code of the response"},"api_req_id":{"type":"string","description":"The request ID of the failed request"}},"title":"EorJobScopesValidatePostResponsesContentApplicationJsonSchemaRequest"},"RequestJobScopeValidation-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorJobScopesValidatePostResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/EorJobScopesValidatePostResponsesContentApplicationJsonSchemaRequest"}},"title":"RequestJobScopeValidation-v2026-01-01RequestBadRequestError"},"EorContractsContractIdOffboardingReviewClientSignOffsPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"reviewer_feedback":{"type":["string","null"],"description":"Feedback from the reviewer when the termination is not approved. Required if has_client_approved is false, otherwise optional."},"has_client_approved":{"type":"boolean","description":"Indicates if the client has approved the termination request"},"has_employee_been_notified":{"type":["boolean","null"],"description":"Indicates if the employee has been notified about the termiantion"}},"required":["has_client_approved"],"title":"EorContractsContractIdOffboardingReviewClientSignOffsPostRequestBodyContentApplicationJsonSchemaData"},"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The type/extension of the file"},"created_at":{"type":"string","format":"date-time","description":"The date and time the file was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the file was updated"},"is_additional_supporting_document":{"type":"boolean","description":"Indicates if this is an additional supporting document added after the initial submission"}},"required":["id","name","type","created_at","updated_at","is_additional_supporting_document"],"title":"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems"},"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The type/extension of the file"},"created_at":{"type":"string","format":"date-time","description":"The date and time the file was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the file was updated"}},"required":["id","name","type","created_at"],"title":"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems"},"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus":{"type":"string","enum":["AWAITING_REVIEW","AWAITING_FEEDBACK","FEEDBACK_PROVIDED","APPROVED","CHANGES_REQUESTED_BY_CLIENT","CHANGES_REQUESTED_BY_EMPLOYEE","WAIVED_REVIEW","NOT_RESPONDED","CANCELLED"],"description":"The current status of the document review","title":"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus"},"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType":{"type":"string","enum":["CLIENT","EMPLOYEE"],"description":"The type of reviewer for this document","title":"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType"},"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the document set shared with the employee."},"files":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems"}},"status":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus","description":"The current status of the document review"},"created_at":{"type":"string","format":"date-time","description":"The date and time the document set was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the document set was updated"},"reviewed_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the document was reviewed"},"reviewed_by":{"type":["string","null"],"description":"The name of the reviewer for this document. If the reviewer is not an employee, it will be the name of the client"},"reviewer_type":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType","description":"The type of reviewer for this document"},"reviewer_feedback":{"type":["string","null"],"description":"Feedback provided by the reviewer"},"notification_instructions":{"type":["string","null"],"description":"HTML instructions for the reviewer notification"},"is_employee_notification_required":{"type":"boolean","description":"Indicates if the employee should be notified about this document review"}},"required":["files","status","reviewer_type","is_employee_notification_required"],"title":"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems"},"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsResignationLetter":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the resignation letter"},"signature":{"type":["string","null"],"description":"The signature of the resignation letter"},"signed_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the resignation letter was signed"},"created_at":{"type":"string","format":"date-time","description":"The date and time the resignation letter was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the resignation letter was updated"}},"title":"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsResignationLetter"},"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocuments":{"type":"object","properties":{"supporting":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems"}},"offboarding":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems"},"description":"Document set shared that requires client or employee review"},"resignation_letter":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsResignationLetter"},{"type":"null"}]}},"required":["supporting","offboarding"],"description":"Document management structure for termination workflow including review processes and supporting documents","title":"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocuments"},"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataReason":{"type":"string","enum":["STATUS_CHANGE","RELOCATION","COMPENSATION","RETIREMENT","JOB_ABANDONMENT","WORK_RELATED","PERSONAL","OTHER_OPPORTUNITY","NON_RENEWAL","PROBATION","ASSIGNMENT_ENDED","POSITION_ELIMINATION","FORCE_REDUCTION","DEATH","FOR_CAUSE","PERFORMANCE","MEDICAL","PERFORMANCE_ISSUES","ATTENDANCE_ISSUES","REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE","ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED","OFFER_WAS_REVOKED","EXITING_THE_MARKET","NO_LONGER_WISH_TO_WORK_WITH_DEEL","COMPANY_ACQUIRED","STEALING","MISCONDUCT","FALSIFYING","HARASSMENT","VIOLENCE","REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE_OR_ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED","UNAUTHORIZED_ABSENCES_OR_LACK_OF_ATTENDANCE","STANDARD_RESELLER_PRACTICE","MOVING_EMPLOYEE_TO_INTERNAL_ENTITY","MOVING_EMPLOYEE_TO_DEEL_PEO","OTHER"],"description":"The reason for the termination","title":"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataReason"},"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit":{"type":"string","enum":["BUSINESS_DAY","CALENDAR_DAY","HOUR"],"description":"The unit of measurement for time off tracking","title":"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit"},"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems":{"type":"object","properties":{"used":{"type":"number","format":"double","description":"The amount of time off used in this tracking period"},"end_date":{"type":"string","format":"date-time","description":"The end date of the tracking period"},"start_date":{"type":"string","format":"date-time","description":"The start date of the tracking period"}},"required":["used","end_date","start_date"],"title":"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"},"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit","description":"The unit of measurement for time off tracking"},"policy_type":{"type":"string","description":"The type of time-off policy"},"tracking_periods":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"}},"scheduled_until_end_date":{"type":"number","format":"double","description":"The amount of time off scheduled until the end date of the current tracking period"}},"required":["unit","policy_type","tracking_periods","scheduled_until_end_date"],"title":"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems"},"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails":{"type":"object","properties":{"notes":{"type":["string","null"],"description":"Additional notes or comments about the time-off data"},"updated_by":{"type":["string","null"],"description":"The person or system that last updated the time-off data"},"last_updated_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the time-off data was last updated"}},"title":"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails"},"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff":{"type":"object","properties":{"time_offs":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems"}},"additional_details":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails"},{"type":"null"}]},"is_deel_pto_confirmed":{"type":"boolean","description":"Indicates whether the PTO allocation has been confirmed by Deel's system"}},"required":["time_offs","is_deel_pto_confirmed"],"description":"Time-off usage data including policy information and tracking periods","title":"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff"},"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire":{"type":"string","enum":["YES","NO","DONT_KNOW"],"description":"Parameter to inform whether it would be possible for the client to hire the employee again","title":"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire"},"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestData":{"type":"object","properties":{"reason":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataReason","description":"The reason for the termination"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"reason_detail":{"type":["string","null"],"description":"Optional field to describe the reason behind the resignation request"},"used_time_off":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff","description":"Time-off usage data including policy information and tracking periods"},"desired_end_date":{"type":["string","null"],"format":"date","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"},"eligible_for_rehire":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire"},{"type":"null"}],"description":"Parameter to inform whether it would be possible for the client to hire the employee again"},"eligible_for_rehire_reason":{"type":["string","null"],"description":"Describe if the option DONT_KNOW was selected on eligible_for_rehire"}},"title":"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestData"},"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the offboarding request"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"documents":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocuments","description":"Document management structure for termination workflow including review processes and supporting documents"},"created_at":{"type":"string","format":"date-time","description":"The date and time the offboarding request was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the offboarding request was updated"},"contract_id":{"type":"string","description":"The unique identifier of the employee contract."},"is_sensitive":{"type":"boolean","description":"Indicates if the offboarding request is sensitive. This is used to restrict access to the request only to the requester and the HRX team."},"request_data":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestData"},{"type":"null"}]},"desired_end_date":{"type":["string","null"],"format":"date-time","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"}},"title":"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaData"},"eor-offboarding_createEOROffboardingClientSignOff_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-offboarding_createEOROffboardingClientSignOff_Response_200"},"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code of the handler which produced the returned error"},"field":{"type":"string","description":"The field name where error occurred (null for server errors)"},"message":{"type":"string","description":"Description of the returned error"}},"title":"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems"},"ReviewApproveOrRequestChangesToEorOffboardingDocumentsRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"ReviewApproveOrRequestChangesToEorOffboardingDocumentsRequestBadRequestError"},"ReviewApproveOrRequestChangesToEorOffboardingDocumentsRequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"ReviewApproveOrRequestChangesToEorOffboardingDocumentsRequestUnauthorizedError"},"ReviewApproveOrRequestChangesToEorOffboardingDocumentsRequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"ReviewApproveOrRequestChangesToEorOffboardingDocumentsRequestForbiddenError"},"ReviewApproveOrRequestChangesToEorOffboardingDocumentsRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"ReviewApproveOrRequestChangesToEorOffboardingDocumentsRequestInternalServerError"},"EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaDataQuestionsItems":{"type":"object","properties":{"text":{"type":"string","description":"Specifies the text of additional questions that the client must answer when requesting a termination"},"is_optional":{"type":"boolean","description":"Indicates whether answering the question is optional. If false, client must provide an answer."}},"title":"EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaDataQuestionsItems"},"EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"documents":{"type":["string","null"],"description":"If not null, specifies the documents that the client must upload when requesting a termination"},"questions":{"type":["array","null"],"items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaDataQuestionsItems"},"description":"A list of additional questions that the client must answer when requesting a termination. Some questions are mandatory, while others are optional."}},"description":"Specifies the text of additional questions that the client must answer when requesting a termination","title":"EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaData"},"eor-offboarding_getEORContractOffboardingRequiredInformation_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaData","description":"Specifies the text of additional questions that the client must answer when requesting a termination"}},"required":["data"],"title":"eor-offboarding_getEORContractOffboardingRequiredInformation_Response_200"},"EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code of the handler which produced the returned error"},"field":{"type":"string","description":"The field name where error occurred (null for server errors)"},"message":{"type":"string","description":"Description of the returned error"}},"title":"EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaErrorsItems"},"GetAdditionalInformationRequiredToRequestEmployeeTerminationRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetAdditionalInformationRequiredToRequestEmployeeTerminationRequestBadRequestError"},"GetAdditionalInformationRequiredToRequestEmployeeTerminationRequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetAdditionalInformationRequiredToRequestEmployeeTerminationRequestUnauthorizedError"},"GetAdditionalInformationRequiredToRequestEmployeeTerminationRequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetAdditionalInformationRequiredToRequestEmployeeTerminationRequestForbiddenError"},"GetAdditionalInformationRequiredToRequestEmployeeTerminationRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetAdditionalInformationRequiredToRequestEmployeeTerminationRequestInternalServerError"},"EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataEntitlementsItemsEntitlementUnit":{"type":"string","enum":["BUSINESS_DAY","CALENDAR_DAY","HOUR","WEEK","MONTH","YEAR"],"description":"Unit of time measurement","title":"EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataEntitlementsItemsEntitlementUnit"},"EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataEntitlementsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The entitlement ID"},"used":{"type":"number","format":"double","description":"Amount of time off used in this period"},"requests":{"type":"integer","description":"Number of time off requests in this period"},"created_at":{"type":"string","format":"date-time","description":"When the entitlement was created"},"updated_at":{"type":"string","format":"date-time","description":"When the entitlement was updated"},"tracking_period":{"type":"string","format":"date","description":"The tracking period start date"},"entitlement_unit":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataEntitlementsItemsEntitlementUnit","description":"Unit of time measurement"},"tracking_period_end_date":{"type":"string","format":"date","description":"The tracking period end date"}},"required":["id","used","requests","created_at","updated_at","tracking_period","entitlement_unit","tracking_period_end_date"],"title":"EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataEntitlementsItems"},"EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataTrackingType":{"type":"string","enum":["OFF_PLATFORM","ON_PLATFORM"],"description":"The time off tracking type","title":"EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataTrackingType"},"EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataPolicySettings":{"type":"object","properties":{"entitlement_unit":{"type":"string","description":"The entitlement unit for the policy"},"is_accrued_days_available":{"type":"boolean","description":"Whether accrued days are available"},"is_estimated_payout_available":{"type":"boolean","description":"Whether estimated payout is available"}},"required":["entitlement_unit","is_accrued_days_available","is_estimated_payout_available"],"description":"Policy configuration settings for time off calculations","title":"EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataPolicySettings"},"EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataUpcomingTimeOffsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Time off request ID"},"amount":{"type":"number","format":"double","description":"Amount of time off requested"},"status":{"type":"string","description":"Status of the time off request"},"end_date":{"type":"string","format":"date-time","description":"End date of the time off"},"created_at":{"type":"string","format":"date-time","description":"When the time off request was created"},"start_date":{"type":"string","format":"date-time","description":"Start date of the time off"},"updated_at":{"type":"string","format":"date-time","description":"When the time off request was updated"},"approved_at":{"type":"string","format":"date-time","description":"When the time off was approved"},"requested_at":{"type":"string","format":"date-time","description":"When the time off was requested"}},"required":["id","amount","status","end_date","created_at","start_date","updated_at","approved_at","requested_at"],"title":"EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataUpcomingTimeOffsItems"},"EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"contract_id":{"type":"string","description":"The unique identifier of the employee contract"},"entitlements":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataEntitlementsItems"},"description":"List of entitlement periods sorted by tracking period (descending)"},"tracking_type":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataTrackingType","description":"The time off tracking type"},"policy_settings":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataPolicySettings","description":"Policy configuration settings for time off calculations"},"remaining_balance":{"type":["number","null"],"format":"double","description":"Remaining time off balance"},"upcoming_time_offs":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataUpcomingTimeOffsItems"},"description":"List of upcoming time off requests"},"has_external_integration":{"type":"boolean","description":"Whether the contract has external integration"}},"required":["contract_id","entitlements","tracking_type","policy_settings","upcoming_time_offs","has_external_integration"],"title":"EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaData"},"eor-offboarding_getContractOffboardingTimeOffs_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-offboarding_getContractOffboardingTimeOffs_Response_200"},"EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code of the handler which produced the returned error"},"field":{"type":"string","description":"The field name where error occurred (null for server errors)"},"message":{"type":"string","description":"Description of the returned error"}},"title":"EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveEmployeeTimeOffDataForOffboardingRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveEmployeeTimeOffDataForOffboardingRequestBadRequestError"},"RetrieveEmployeeTimeOffDataForOffboardingRequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveEmployeeTimeOffDataForOffboardingRequestUnauthorizedError"},"RetrieveEmployeeTimeOffDataForOffboardingRequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveEmployeeTimeOffDataForOffboardingRequestForbiddenError"},"RetrieveEmployeeTimeOffDataForOffboardingRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveEmployeeTimeOffDataForOffboardingRequestInternalServerError"},"EorContractsContractIdOffboardingAttachmentsAttachmentIdGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code of the handler which produced the returned error"},"field":{"type":"string","description":"The field name where error occurred (null for server errors)"},"message":{"type":"string","description":"Description of the returned error"}},"title":"EorContractsContractIdOffboardingAttachmentsAttachmentIdGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveOffboardingAttachmentRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingAttachmentsAttachmentIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveOffboardingAttachmentRequestBadRequestError"},"RetrieveOffboardingAttachmentRequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingAttachmentsAttachmentIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveOffboardingAttachmentRequestUnauthorizedError"},"RetrieveOffboardingAttachmentRequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingAttachmentsAttachmentIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveOffboardingAttachmentRequestForbiddenError"},"RetrieveOffboardingAttachmentRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingAttachmentsAttachmentIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveOffboardingAttachmentRequestInternalServerError"},"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The type/extension of the file"},"created_at":{"type":"string","format":"date-time","description":"The date and time the file was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the file was updated"},"is_additional_supporting_document":{"type":"boolean","description":"Indicates if this is an additional supporting document added after the initial submission"}},"required":["id","name","type","created_at","updated_at","is_additional_supporting_document"],"title":"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems"},"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The type/extension of the file"},"created_at":{"type":"string","format":"date-time","description":"The date and time the file was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the file was updated"}},"required":["id","name","type","created_at"],"title":"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems"},"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus":{"type":"string","enum":["AWAITING_REVIEW","AWAITING_FEEDBACK","FEEDBACK_PROVIDED","APPROVED","CHANGES_REQUESTED_BY_CLIENT","CHANGES_REQUESTED_BY_EMPLOYEE","WAIVED_REVIEW","NOT_RESPONDED","CANCELLED"],"description":"The current status of the document review","title":"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus"},"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType":{"type":"string","enum":["CLIENT","EMPLOYEE"],"description":"The type of reviewer for this document","title":"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType"},"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the document set shared with the employee."},"files":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems"}},"status":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus","description":"The current status of the document review"},"created_at":{"type":"string","format":"date-time","description":"The date and time the document set was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the document set was updated"},"reviewed_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the document was reviewed"},"reviewed_by":{"type":["string","null"],"description":"The name of the reviewer for this document. If the reviewer is not an employee, it will be the name of the client"},"reviewer_type":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType","description":"The type of reviewer for this document"},"reviewer_feedback":{"type":["string","null"],"description":"Feedback provided by the reviewer"},"notification_instructions":{"type":["string","null"],"description":"HTML instructions for the reviewer notification"},"is_employee_notification_required":{"type":"boolean","description":"Indicates if the employee should be notified about this document review"}},"required":["files","status","reviewer_type","is_employee_notification_required"],"title":"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems"},"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocuments":{"type":"object","properties":{"supporting":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems"}},"offboarding":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems"},"description":"Document set shared that requires client or employee review"}},"required":["supporting","offboarding"],"description":"Document management structure for termination workflow including review processes and supporting documents","title":"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocuments"},"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataReason":{"type":"string","enum":["STATUS_CHANGE","RELOCATION","COMPENSATION","RETIREMENT","JOB_ABANDONMENT","WORK_RELATED","PERSONAL","OTHER_OPPORTUNITY","NON_RENEWAL","PROBATION","ASSIGNMENT_ENDED","POSITION_ELIMINATION","FORCE_REDUCTION","DEATH","FOR_CAUSE","PERFORMANCE","MEDICAL","PERFORMANCE_ISSUES","ATTENDANCE_ISSUES","REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE","ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED","OFFER_WAS_REVOKED","EXITING_THE_MARKET","NO_LONGER_WISH_TO_WORK_WITH_DEEL","COMPANY_ACQUIRED","STEALING","MISCONDUCT","FALSIFYING","HARASSMENT","VIOLENCE","REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE_OR_ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED","UNAUTHORIZED_ABSENCES_OR_LACK_OF_ATTENDANCE","STANDARD_RESELLER_PRACTICE","MOVING_EMPLOYEE_TO_INTERNAL_ENTITY","MOVING_EMPLOYEE_TO_DEEL_PEO","OTHER"],"description":"The reason for the termination","title":"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataReason"},"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit":{"type":"string","enum":["BUSINESS_DAY","CALENDAR_DAY","HOUR"],"description":"The unit of measurement for time off tracking","title":"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit"},"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems":{"type":"object","properties":{"used":{"type":"number","format":"double","description":"The amount of time off used in this tracking period"},"end_date":{"type":"string","format":"date-time","description":"The end date of the tracking period"},"start_date":{"type":"string","format":"date-time","description":"The start date of the tracking period"}},"required":["used","end_date","start_date"],"title":"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"},"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit","description":"The unit of measurement for time off tracking"},"policy_type":{"type":"string","description":"The type of time-off policy"},"tracking_periods":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"}},"scheduled_until_end_date":{"type":"number","format":"double","description":"The amount of time off scheduled until the end date of the current tracking period"}},"required":["unit","policy_type","tracking_periods","scheduled_until_end_date"],"title":"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems"},"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails":{"type":"object","properties":{"notes":{"type":["string","null"],"description":"Additional notes or comments about the time-off data"},"updated_by":{"type":["string","null"],"description":"The person or system that last updated the time-off data"},"last_updated_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the time-off data was last updated"}},"title":"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails"},"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff":{"type":"object","properties":{"time_offs":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems"}},"additional_details":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails"},{"type":"null"}]},"is_deel_pto_confirmed":{"type":"boolean","description":"Indicates whether the PTO allocation has been confirmed by Deel's system"}},"required":["time_offs","is_deel_pto_confirmed"],"description":"Time-off usage data including policy information and tracking periods","title":"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff"},"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire":{"type":"string","enum":["YES","NO","DONT_KNOW"],"description":"Parameter to inform whether it would be possible for the client to hire the employee again","title":"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire"},"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestData":{"type":"object","properties":{"reason":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataReason","description":"The reason for the termination"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"reason_detail":{"type":["string","null"],"description":"Optional field to describe the reason behind the resignation request"},"used_time_off":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff","description":"Time-off usage data including policy information and tracking periods"},"desired_end_date":{"type":["string","null"],"format":"date","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"},"eligible_for_rehire":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire"},{"type":"null"}],"description":"Parameter to inform whether it would be possible for the client to hire the employee again"},"eligible_for_rehire_reason":{"type":["string","null"],"description":"Describe if the option DONT_KNOW was selected on eligible_for_rehire"}},"title":"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestData"},"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the offboarding request"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"documents":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocuments","description":"Document management structure for termination workflow including review processes and supporting documents"},"created_at":{"type":"string","format":"date-time","description":"The date and time the offboarding request was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the offboarding request was updated"},"contract_id":{"type":"string","description":"The unique identifier of the employee contract."},"is_sensitive":{"type":"boolean","description":"Indicates if the offboarding request is sensitive. This is used to restrict access to the request only to the requester and the HRX team."},"request_data":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestData"},{"type":"null"}]},"desired_end_date":{"type":["string","null"],"format":"date-time","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"}},"title":"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaData"},"eor-offboarding_getContractOffboarding_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-offboarding_getContractOffboarding_Response_200"},"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code of the handler which produced the returned error"},"field":{"type":"string","description":"The field name where error occurred (null for server errors)"},"message":{"type":"string","description":"Description of the returned error"}},"title":"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveOffboardingRequestRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveOffboardingRequestRequestBadRequestError"},"RetrieveOffboardingRequestRequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveOffboardingRequestRequestUnauthorizedError"},"RetrieveOffboardingRequestRequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveOffboardingRequestRequestForbiddenError"},"RetrieveOffboardingRequestRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveOffboardingRequestRequestInternalServerError"},"EorContractsContractIdOffboardingRestrictedDatesGetParametersTerminationType":{"type":"string","enum":["TERMINATION","RESIGNATION"],"title":"EorContractsContractIdOffboardingRestrictedDatesGetParametersTerminationType"},"EorContractsContractIdOffboardingRestrictedDatesGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"restricted_dates":{"type":"array","items":{"type":"string","format":"date-time"},"description":"Dates that are not enabled for selection."},"earliest_available_end_date":{"type":"string","format":"date-time","description":"The earliest date that can be selected as the end date."},"is_out_work_scheduled_allowed":{"type":"boolean","description":"Whether scheduling out of work is allowed."},"is_end_date_allowed_on_holidays":{"type":"boolean","description":"Whether end date selection is allowed on holidays."}},"required":["restricted_dates","earliest_available_end_date","is_out_work_scheduled_allowed","is_end_date_allowed_on_holidays"],"title":"EorContractsContractIdOffboardingRestrictedDatesGetResponsesContentApplicationJsonSchemaData"},"eor-offboarding_getContractOffboardingRestrictedDates_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingRestrictedDatesGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-offboarding_getContractOffboardingRestrictedDates_Response_200"},"EorContractsContractIdOffboardingRestrictedDatesGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code of the handler which produced the returned error"},"field":{"type":"string","description":"The field name where error occurred (null for server errors)"},"message":{"type":"string","description":"Description of the returned error"}},"title":"EorContractsContractIdOffboardingRestrictedDatesGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveRestrictedOffboardingDatesRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingRestrictedDatesGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveRestrictedOffboardingDatesRequestBadRequestError"},"RetrieveRestrictedOffboardingDatesRequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingRestrictedDatesGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveRestrictedOffboardingDatesRequestUnauthorizedError"},"RetrieveRestrictedOffboardingDatesRequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingRestrictedDatesGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveRestrictedOffboardingDatesRequestForbiddenError"},"RetrieveRestrictedOffboardingDatesRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingRestrictedDatesGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveRestrictedOffboardingDatesRequestInternalServerError"},"EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTrackingType":{"type":"string","enum":["ON_PLATFORM","OFF_PLATFORM"],"description":"Type of time off tracking - whether it's tracked on Deel platform or off platform","title":"EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTrackingType"},"EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementsItems":{"type":"object","properties":{"used":{"type":"number","format":"double","description":"Amount of time off used in the period"},"tracking_period":{"type":"string","format":"date","description":"Start date of the tracking period"},"tracking_period_end_date":{"type":"string","format":"date","description":"End date of the tracking period"}},"required":["used","tracking_period","tracking_period_end_date"],"title":"EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementsItems"},"EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementUnit":{"type":"string","enum":["BUSINESS_DAY","CALENDAR_DAY","HOUR","WEEK","MONTH","YEAR"],"description":"Unit of measurement for the time off entitlements","title":"EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementUnit"},"EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffOffPlatformUsedTimeOff":{"type":"object","properties":{"entitlements":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementsItems"},"description":"Array of time off entitlements for different tracking periods"},"total_scheduled":{"type":"number","format":"double","description":"Total amount of time off scheduled until the end date"},"entitlement_unit":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementUnit","description":"Unit of measurement for the time off entitlements"}},"required":["entitlements","total_scheduled","entitlement_unit"],"description":"Required when tracking_type is OFF_PLATFORM, null otherwise","title":"EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffOffPlatformUsedTimeOff"},"EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOff":{"type":"object","properties":{"tracking_type":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTrackingType","description":"Type of time off tracking - whether it's tracked on Deel platform or off platform"},"off_platform_used_time_off":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffOffPlatformUsedTimeOff"},{"type":"null"}],"description":"Required when tracking_type is OFF_PLATFORM, null otherwise"}},"description":"Time-off usage data including policy information and tracking periods","title":"EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOff"},"EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataDeclineReason":{"type":"string","enum":["NOT_AGREE_WITH_END_DATE","NOT_A_RESIGNATION_BUT_TERMINATION","EMPLOYEE_UNDER_REVIEW_OR_INVESTIGATION_FOR_DISCIPLINARY_ACTIONS","OTHER"],"description":"Reason for declining the resignation request","title":"EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataDeclineReason"},"EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataSeveranceType":{"type":"string","enum":["DAYS","WEEKS","MONTHS","CASH"],"description":"Type of severance offered to the employee","title":"EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataSeveranceType"},"EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"used_time_off":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOff","description":"Time-off usage data including policy information and tracking periods"},"decline_reason":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataDeclineReason","description":"Reason for declining the resignation request"},"severance_type":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataSeveranceType","description":"Type of severance offered to the employee"},"severance_amount":{"type":"number","format":"double","description":"Amount of severance offered to the employee"},"decline_reason_detail":{"type":"string","description":"Detailed explanation for declining the resignation request"},"has_client_accepted_resignation_request":{"type":"boolean","description":"Indicates whether the client has accepted the resignation request"}},"title":"EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaData"},"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The type/extension of the file"},"created_at":{"type":"string","format":"date-time","description":"The date and time the file was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the file was updated"},"is_additional_supporting_document":{"type":"boolean","description":"Indicates if this is an additional supporting document added after the initial submission"}},"required":["id","name","type","created_at","updated_at","is_additional_supporting_document"],"title":"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems"},"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The type/extension of the file"},"created_at":{"type":"string","format":"date-time","description":"The date and time the file was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the file was updated"}},"required":["id","name","type","created_at"],"title":"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems"},"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus":{"type":"string","enum":["AWAITING_REVIEW","AWAITING_FEEDBACK","FEEDBACK_PROVIDED","APPROVED","CHANGES_REQUESTED_BY_CLIENT","CHANGES_REQUESTED_BY_EMPLOYEE","WAIVED_REVIEW","NOT_RESPONDED","CANCELLED"],"description":"The current status of the document review","title":"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus"},"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType":{"type":"string","enum":["CLIENT","EMPLOYEE"],"description":"The type of reviewer for this document","title":"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType"},"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the document set shared with the employee."},"files":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems"}},"status":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus","description":"The current status of the document review"},"created_at":{"type":"string","format":"date-time","description":"The date and time the document set was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the document set was updated"},"reviewed_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the document was reviewed"},"reviewed_by":{"type":["string","null"],"description":"The name of the reviewer for this document. If the reviewer is not an employee, it will be the name of the client"},"reviewer_type":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType","description":"The type of reviewer for this document"},"reviewer_feedback":{"type":["string","null"],"description":"Feedback provided by the reviewer"},"notification_instructions":{"type":["string","null"],"description":"HTML instructions for the reviewer notification"},"is_employee_notification_required":{"type":"boolean","description":"Indicates if the employee should be notified about this document review"}},"required":["files","status","reviewer_type","is_employee_notification_required"],"title":"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems"},"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocuments":{"type":"object","properties":{"supporting":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems"}},"offboarding":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems"},"description":"Document set shared that requires client or employee review"}},"required":["supporting","offboarding"],"description":"Document management structure for termination workflow including review processes and supporting documents","title":"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocuments"},"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataReason":{"type":"string","enum":["STATUS_CHANGE","RELOCATION","COMPENSATION","RETIREMENT","JOB_ABANDONMENT","WORK_RELATED","PERSONAL","OTHER_OPPORTUNITY","NON_RENEWAL","PROBATION","ASSIGNMENT_ENDED","POSITION_ELIMINATION","FORCE_REDUCTION","DEATH","FOR_CAUSE","PERFORMANCE","MEDICAL","PERFORMANCE_ISSUES","ATTENDANCE_ISSUES","REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE","ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED","OFFER_WAS_REVOKED","EXITING_THE_MARKET","NO_LONGER_WISH_TO_WORK_WITH_DEEL","COMPANY_ACQUIRED","STEALING","MISCONDUCT","FALSIFYING","HARASSMENT","VIOLENCE","REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE_OR_ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED","UNAUTHORIZED_ABSENCES_OR_LACK_OF_ATTENDANCE","STANDARD_RESELLER_PRACTICE","MOVING_EMPLOYEE_TO_INTERNAL_ENTITY","MOVING_EMPLOYEE_TO_DEEL_PEO","OTHER"],"description":"The reason for the termination","title":"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataReason"},"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit":{"type":"string","enum":["BUSINESS_DAY","CALENDAR_DAY","HOUR"],"description":"The unit of measurement for time off tracking","title":"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit"},"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems":{"type":"object","properties":{"used":{"type":"number","format":"double","description":"The amount of time off used in this tracking period"},"end_date":{"type":"string","format":"date-time","description":"The end date of the tracking period"},"start_date":{"type":"string","format":"date-time","description":"The start date of the tracking period"}},"required":["used","end_date","start_date"],"title":"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"},"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit","description":"The unit of measurement for time off tracking"},"policy_type":{"type":"string","description":"The type of time-off policy"},"tracking_periods":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"}},"scheduled_until_end_date":{"type":"number","format":"double","description":"The amount of time off scheduled until the end date of the current tracking period"}},"required":["unit","policy_type","tracking_periods","scheduled_until_end_date"],"title":"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems"},"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails":{"type":"object","properties":{"notes":{"type":["string","null"],"description":"Additional notes or comments about the time-off data"},"updated_by":{"type":["string","null"],"description":"The person or system that last updated the time-off data"},"last_updated_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the time-off data was last updated"}},"title":"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails"},"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff":{"type":"object","properties":{"time_offs":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems"}},"additional_details":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails"},{"type":"null"}]},"is_deel_pto_confirmed":{"type":"boolean","description":"Indicates whether the PTO allocation has been confirmed by Deel's system"}},"required":["time_offs","is_deel_pto_confirmed"],"description":"Time-off usage data including policy information and tracking periods","title":"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff"},"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire":{"type":"string","enum":["YES","NO","DONT_KNOW"],"description":"Parameter to inform whether it would be possible for the client to hire the employee again","title":"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire"},"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestData":{"type":"object","properties":{"reason":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataReason","description":"The reason for the termination"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"reason_detail":{"type":["string","null"],"description":"Optional field to describe the reason behind the resignation request"},"used_time_off":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff","description":"Time-off usage data including policy information and tracking periods"},"desired_end_date":{"type":["string","null"],"format":"date","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"},"eligible_for_rehire":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire"},{"type":"null"}],"description":"Parameter to inform whether it would be possible for the client to hire the employee again"},"eligible_for_rehire_reason":{"type":["string","null"],"description":"Describe if the option DONT_KNOW was selected on eligible_for_rehire"}},"title":"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestData"},"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the offboarding request"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"documents":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocuments","description":"Document management structure for termination workflow including review processes and supporting documents"},"created_at":{"type":"string","format":"date-time","description":"The date and time the offboarding request was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the offboarding request was updated"},"contract_id":{"type":"string","description":"The unique identifier of the employee contract."},"is_sensitive":{"type":"boolean","description":"Indicates if the offboarding request is sensitive. This is used to restrict access to the request only to the requester and the HRX team."},"request_data":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestData"},{"type":"null"}]},"desired_end_date":{"type":["string","null"],"format":"date-time","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"}},"title":"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaData"},"eor-offboarding_reviewEOROffboardingPTO_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-offboarding_reviewEOROffboardingPTO_Response_201"},"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code of the handler which produced the returned error"},"field":{"type":"string","description":"The field name where error occurred (null for server errors)"},"message":{"type":"string","description":"Description of the returned error"}},"title":"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaErrorsItems"},"SubmitEmployeeResignationPtoReviewRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SubmitEmployeeResignationPtoReviewRequestBadRequestError"},"SubmitEmployeeResignationPtoReviewRequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SubmitEmployeeResignationPtoReviewRequestUnauthorizedError"},"SubmitEmployeeResignationPtoReviewRequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SubmitEmployeeResignationPtoReviewRequestForbiddenError"},"SubmitEmployeeResignationPtoReviewRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SubmitEmployeeResignationPtoReviewRequestInternalServerError"},"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"approved":{"type":"boolean","description":"Indicates if the employee has approved the sign-off review"},"requested_changes":{"type":["string","null"],"description":"Details of requested changes if the review is not approved"},"reviewer_signature":{"type":["string","null"],"description":"Signature of the reviewer if the review is approved"}},"required":["approved","requested_changes","reviewer_signature"],"title":"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostRequestBodyContentApplicationJsonSchemaData"},"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The type/extension of the file"},"created_at":{"type":"string","format":"date-time","description":"The date and time the file was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the file was updated"},"is_additional_supporting_document":{"type":"boolean","description":"Indicates if this is an additional supporting document added after the initial submission"}},"required":["id","name","type","created_at","updated_at","is_additional_supporting_document"],"title":"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems"},"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The type/extension of the file"},"created_at":{"type":"string","format":"date-time","description":"The date and time the file was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the file was updated"}},"required":["id","name","type","created_at"],"title":"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems"},"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus":{"type":"string","enum":["AWAITING_REVIEW","AWAITING_FEEDBACK","FEEDBACK_PROVIDED","APPROVED","CHANGES_REQUESTED_BY_CLIENT","CHANGES_REQUESTED_BY_EMPLOYEE","WAIVED_REVIEW","NOT_RESPONDED","CANCELLED"],"description":"The current status of the document review","title":"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus"},"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType":{"type":"string","enum":["CLIENT","EMPLOYEE"],"description":"The type of reviewer for this document","title":"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType"},"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the document set shared with the employee."},"files":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems"}},"status":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus","description":"The current status of the document review"},"created_at":{"type":"string","format":"date-time","description":"The date and time the document set was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the document set was updated"},"reviewed_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the document was reviewed"},"reviewed_by":{"type":["string","null"],"description":"The name of the reviewer for this document. If the reviewer is not an employee, it will be the name of the client"},"reviewer_type":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType","description":"The type of reviewer for this document"},"reviewer_feedback":{"type":["string","null"],"description":"Feedback provided by the reviewer"},"notification_instructions":{"type":["string","null"],"description":"HTML instructions for the reviewer notification"},"is_employee_notification_required":{"type":"boolean","description":"Indicates if the employee should be notified about this document review"}},"required":["files","status","reviewer_type","is_employee_notification_required"],"title":"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems"},"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsResignationLetter":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the resignation letter"},"signature":{"type":["string","null"],"description":"The signature of the resignation letter"},"signed_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the resignation letter was signed"},"created_at":{"type":"string","format":"date-time","description":"The date and time the resignation letter was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the resignation letter was updated"}},"title":"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsResignationLetter"},"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocuments":{"type":"object","properties":{"supporting":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems"}},"offboarding":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems"},"description":"Document set shared that requires client or employee review"},"resignation_letter":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsResignationLetter"},{"type":"null"}]}},"required":["supporting","offboarding"],"description":"Document management structure for termination workflow including review processes and supporting documents","title":"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocuments"},"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataReason":{"type":"string","enum":["STATUS_CHANGE","RELOCATION","COMPENSATION","RETIREMENT","JOB_ABANDONMENT","WORK_RELATED","PERSONAL","OTHER_OPPORTUNITY","NON_RENEWAL","PROBATION","ASSIGNMENT_ENDED","POSITION_ELIMINATION","FORCE_REDUCTION","DEATH","FOR_CAUSE","PERFORMANCE","MEDICAL","PERFORMANCE_ISSUES","ATTENDANCE_ISSUES","REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE","ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED","OFFER_WAS_REVOKED","EXITING_THE_MARKET","NO_LONGER_WISH_TO_WORK_WITH_DEEL","COMPANY_ACQUIRED","STEALING","MISCONDUCT","FALSIFYING","HARASSMENT","VIOLENCE","REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE_OR_ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED","UNAUTHORIZED_ABSENCES_OR_LACK_OF_ATTENDANCE","STANDARD_RESELLER_PRACTICE","MOVING_EMPLOYEE_TO_INTERNAL_ENTITY","MOVING_EMPLOYEE_TO_DEEL_PEO","OTHER"],"description":"The reason for the termination","title":"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataReason"},"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit":{"type":"string","enum":["BUSINESS_DAY","CALENDAR_DAY","HOUR"],"description":"The unit of measurement for time off tracking","title":"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit"},"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems":{"type":"object","properties":{"used":{"type":"number","format":"double","description":"The amount of time off used in this tracking period"},"end_date":{"type":"string","format":"date-time","description":"The end date of the tracking period"},"start_date":{"type":"string","format":"date-time","description":"The start date of the tracking period"}},"required":["used","end_date","start_date"],"title":"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"},"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit","description":"The unit of measurement for time off tracking"},"policy_type":{"type":"string","description":"The type of time-off policy"},"tracking_periods":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"}},"scheduled_until_end_date":{"type":"number","format":"double","description":"The amount of time off scheduled until the end date of the current tracking period"}},"required":["unit","policy_type","tracking_periods","scheduled_until_end_date"],"title":"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems"},"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails":{"type":"object","properties":{"notes":{"type":["string","null"],"description":"Additional notes or comments about the time-off data"},"updated_by":{"type":["string","null"],"description":"The person or system that last updated the time-off data"},"last_updated_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the time-off data was last updated"}},"title":"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails"},"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff":{"type":"object","properties":{"time_offs":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems"}},"additional_details":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails"},{"type":"null"}]},"is_deel_pto_confirmed":{"type":"boolean","description":"Indicates whether the PTO allocation has been confirmed by Deel's system"}},"required":["time_offs","is_deel_pto_confirmed"],"description":"Time-off usage data including policy information and tracking periods","title":"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff"},"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire":{"type":"string","enum":["YES","NO","DONT_KNOW"],"description":"Parameter to inform whether it would be possible for the client to hire the employee again","title":"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire"},"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestData":{"type":"object","properties":{"reason":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataReason","description":"The reason for the termination"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"reason_detail":{"type":["string","null"],"description":"Optional field to describe the reason behind the resignation request"},"used_time_off":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff","description":"Time-off usage data including policy information and tracking periods"},"desired_end_date":{"type":["string","null"],"format":"date","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"},"eligible_for_rehire":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire"},{"type":"null"}],"description":"Parameter to inform whether it would be possible for the client to hire the employee again"},"eligible_for_rehire_reason":{"type":["string","null"],"description":"Describe if the option DONT_KNOW was selected on eligible_for_rehire"}},"title":"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestData"},"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the offboarding request"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"documents":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocuments","description":"Document management structure for termination workflow including review processes and supporting documents"},"created_at":{"type":"string","format":"date-time","description":"The date and time the offboarding request was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the offboarding request was updated"},"contract_id":{"type":"string","description":"The unique identifier of the employee contract."},"is_sensitive":{"type":"boolean","description":"Indicates if the offboarding request is sensitive. This is used to restrict access to the request only to the requester and the HRX team."},"request_data":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestData"},{"type":"null"}]},"desired_end_date":{"type":["string","null"],"format":"date-time","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"}},"title":"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaData"},"eor-offboarding_reviewEOROffboardingEmployeeSignOffs_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-offboarding_reviewEOROffboardingEmployeeSignOffs_Response_200"},"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code of the handler which produced the returned error"},"field":{"type":"string","description":"The field name where error occurred (null for server errors)"},"message":{"type":"string","description":"Description of the returned error"}},"title":"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems"},"SubmitEmployeeSignOffReviewForOffboardingDocumentsRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SubmitEmployeeSignOffReviewForOffboardingDocumentsRequestBadRequestError"},"SubmitEmployeeSignOffReviewForOffboardingDocumentsRequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SubmitEmployeeSignOffReviewForOffboardingDocumentsRequestUnauthorizedError"},"SubmitEmployeeSignOffReviewForOffboardingDocumentsRequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SubmitEmployeeSignOffReviewForOffboardingDocumentsRequestForbiddenError"},"SubmitEmployeeSignOffReviewForOffboardingDocumentsRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SubmitEmployeeSignOffReviewForOffboardingDocumentsRequestInternalServerError"},"EorWorkersWorkerIdPayslipsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the payslip record."},"to":{"type":["string","null"],"format":"date","description":"End date of the payment period."},"from":{"type":"string","format":"date","description":"Start date of the payment period."},"status":{"type":"string","description":"Status of the payslip (e.g., 'Pending', 'Processed')."}},"required":["id","to","from","status"],"title":"EorWorkersWorkerIdPayslipsGetResponsesContentApplicationJsonSchemaDataItems"},"eor-payslips_getWorkerPayslips_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersWorkerIdPayslipsGetResponsesContentApplicationJsonSchemaDataItems"}}},"required":["data"],"title":"eor-payslips_getWorkerPayslips_Response_200"},"EorContractsContractIdProjectAssignmentAcceptPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"version":{"type":"string","description":"This field is to ensure that the latest version of the project assignment PDF matches the version received from the webhook. If it is not sent, the version validation is not performed and the endpoint returns the PDF. If it is sent, it is checked whether the current version is equal to the version sent; if not, a 409 error occurs, otherwise, the PDF is returned."}},"title":"EorContractsContractIdProjectAssignmentAcceptPostRequestBodyContentApplicationJsonSchemaData"},"eor-project-assignment_acceptProjectAssignment_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"eor-project-assignment_acceptProjectAssignment_Response_204"},"EorContractsContractIdProjectAssignmentAcceptPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"required":["code","message"],"title":"EorContractsContractIdProjectAssignmentAcceptPostResponsesContentApplicationJsonSchemaErrorsItems"},"AcceptEorProjectAssignmentAsClientRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentAcceptPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"AcceptEorProjectAssignmentAsClientRequestBadRequestError"},"AcceptEorProjectAssignmentAsClientRequestConflictError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentAcceptPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"AcceptEorProjectAssignmentAsClientRequestConflictError"},"AcceptEorProjectAssignmentAsClientRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentAcceptPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"AcceptEorProjectAssignmentAsClientRequestInternalServerError"},"EorContractsContractIdProjectAssignmentGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"required":["code","message"],"title":"EorContractsContractIdProjectAssignmentGetResponsesContentApplicationJsonSchemaErrorsItems"},"FetchEorProjectAssignmentPdfRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"FetchEorProjectAssignmentPdfRequestBadRequestError"},"FetchEorProjectAssignmentPdfRequestConflictError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"FetchEorProjectAssignmentPdfRequestConflictError"},"FetchEorProjectAssignmentPdfRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"FetchEorProjectAssignmentPdfRequestInternalServerError"},"EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItemsQuestionsItemsType":{"type":"string","enum":["FreeText","Paragraph","SingleSelection","MultiSelection","Address","PhoneNumber","DocumentUpload","Number","Dropdown","DatePicker","Email"],"description":"Type of the question.","title":"EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItemsQuestionsItemsType"},"EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItemsQuestionsItemsOptionsItems":{"type":"object","properties":{"title":{"type":"string","description":"Display text for the option."},"value":{"type":["string","null"],"description":"Value associated with the option."}},"title":"EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItemsQuestionsItemsOptionsItems"},"EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItemsQuestionsItemsDefaultValue":{"oneOf":[{"type":"string"},{"type":"number","format":"double"},{"type":"boolean"}],"description":"Default value to pre-fill in the form.","title":"EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItemsQuestionsItemsDefaultValue"},"EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItemsQuestionsItems":{"type":"object","properties":{"key":{"type":"string","description":"Unique key identifier for the question."},"type":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItemsQuestionsItemsType","description":"Type of the question."},"title":{"type":"string","description":"Title of the question."},"options":{"type":["array","null"],"items":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItemsQuestionsItemsOptionsItems"},"description":"List of selectable options for selection-type questions. Value may be of any type."},"is_required":{"type":"boolean","description":"Indicates if the question is required."},"default_value":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItemsQuestionsItemsDefaultValue","description":"Default value to pre-fill in the form."},"is_only_digits":{"type":"boolean","description":"Restricts input to numeric characters only, for FreeText questions."}},"required":["key","type","title"],"title":"EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItemsQuestionsItems"},"EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItems":{"type":"object","properties":{"title":{"type":"string","description":"Title of the section."},"subtitle":{"type":"string","description":"Additional information shown at the top of the section."},"questions":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItemsQuestionsItems"},"description":"List of questions within the section."}},"required":["title","questions"],"title":"EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItems"},"EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the resource"},"sections":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItems"},"description":"Sections of questions"},"created_at":{"type":"string","format":"date-time","description":"Timestamp indicating when the resource was created (ISO 8601)."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp indicating when the resource was last updated (ISO 8601)."}},"required":["id","sections","created_at","updated_at"],"title":"EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaData"},"eor-project-assignment_getProjectAssignmentCheckin_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-project-assignment_getProjectAssignmentCheckin_Response_200"},"EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaErrorsItems"},"FetchProjectAssignmentCheckinQuestionnaireDataRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"FetchProjectAssignmentCheckinQuestionnaireDataRequestBadRequestError"},"FetchProjectAssignmentCheckinQuestionnaireDataRequestConflictError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"FetchProjectAssignmentCheckinQuestionnaireDataRequestConflictError"},"FetchProjectAssignmentCheckinQuestionnaireDataRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"FetchProjectAssignmentCheckinQuestionnaireDataRequestInternalServerError"},"EorContractsContractIdProjectAssignmentCheckinPostRequestBodyContentApplicationJsonSchemaDataType":{"type":"string","enum":["EMPLOYEE","CLIENT"],"description":"Indicates who is submitting the form. Can be either 'EMPLOYEE' or 'CLIENT'.","title":"EorContractsContractIdProjectAssignmentCheckinPostRequestBodyContentApplicationJsonSchemaDataType"},"EorContractsContractIdProjectAssignmentCheckinPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentCheckinPostRequestBodyContentApplicationJsonSchemaDataType","description":"Indicates who is submitting the form. Can be either 'EMPLOYEE' or 'CLIENT'."},"version":{"type":"string","description":"Optional version identifier of the form or schema."},"questions_with_answers":{"type":"object","additionalProperties":{"type":"string"},"description":"Map of question IDs to their corresponding answers."}},"required":["type","questions_with_answers"],"description":"Form submission payload containing respondent type, question answers, and optional version.","title":"EorContractsContractIdProjectAssignmentCheckinPostRequestBodyContentApplicationJsonSchemaData"},"eor-project-assignment_checkinProjectAssignment_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"eor-project-assignment_checkinProjectAssignment_Response_204"},"EorContractsContractIdProjectAssignmentCheckinPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"EorContractsContractIdProjectAssignmentCheckinPostResponsesContentApplicationJsonSchemaErrorsItems"},"SubmitProjectAssignmentCheckinQuestionnaireDataRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentCheckinPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SubmitProjectAssignmentCheckinQuestionnaireDataRequestBadRequestError"},"SubmitProjectAssignmentCheckinQuestionnaireDataRequestConflictError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentCheckinPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"SubmitProjectAssignmentCheckinQuestionnaireDataRequestConflictError"},"SubmitProjectAssignmentCheckinQuestionnaireDataRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentCheckinPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SubmitProjectAssignmentCheckinQuestionnaireDataRequestInternalServerError"},"EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaRequestDataTerminationImpact":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"title":{"type":"string","description":"Termination impact title"},"description":{"type":"string","description":"Termination impact description"}},"description":"Custom termination impact data if there is some configured on HR module","title":"EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaRequestDataTerminationImpact"},"EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaRequestDataEligibleForRehire":{"type":"string","enum":["YES","NO","DONT_KNOW"],"description":"Parameter to inform whether it would be possible for the client to hire the employee again","title":"EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaRequestDataEligibleForRehire"},"EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaRequestData":{"type":"object","properties":{"reason":{"type":["string","null"]},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"reason_detail":{"type":["string","null"],"description":"Optional field to describe the reason behind the resignation request"},"desired_end_date":{"type":["string","null"],"format":"date-time","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"},"termination_impact":{"oneOf":[{"$ref":"#/components/schemas/EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaRequestDataTerminationImpact"},{"type":"null"}],"description":"Custom termination impact data if there is some configured on HR module"},"eligible_for_rehire":{"oneOf":[{"$ref":"#/components/schemas/EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaRequestDataEligibleForRehire"},{"type":"null"}],"description":"Parameter to inform whether it would be possible for the client to hire the employee again"},"eligible_for_rehire_reason":{"type":["string","null"],"description":"Describe if the option DONT_KNOW was selected on eligibleForRehire"},"custom_termination_reason_id":{"type":["number","null"],"format":"double","description":"Custom termination reason ID. A custom termination reason can be added on Client HR module"}},"title":"EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaRequestData"},"eor-terminations_getTermination_Response_200":{"type":"object","properties":{"id":{"type":"number","format":"double"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"contract_id":{"type":"string","description":"Public contract oid"},"request_data":{"oneOf":[{"$ref":"#/components/schemas/EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaRequestData"},{"type":"null"}]},"desired_end_date":{"type":["string","null"],"format":"date-time","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"}},"title":"eor-terminations_getTermination_Response_200"},"EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaItems":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"title":"EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaItems"},"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataReason":{"type":"string","enum":["DEEL_COLLECTIONS","STATUS_CHANGE","RELOCATION","COMPENSATION","RETIREMENT","JOB_ABANDONMENT","WORK_RELATED","PERSONAL","OTHER_OPPORTUNITY","NON_RENEWAL","PROBATION","ASSIGNMENT_ENDED","POSITION_ELIMINATION","FORCE_REDUCTION","DEATH","FOR_CAUSE","PERFORMANCE","MEDICAL","PERFORMANCE_ISSUES","ATTENDANCE_ISSUES","REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE","ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED","OFFER_WAS_REVOKED","EXITING_THE_MARKET","NO_LONGER_WISH_TO_WORK_WITH_DEEL","COMPANY_ACQUIRED","STEALING","MISCONDUCT","FALSIFYING","HARASSMENT","VIOLENCE","REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE_OR_ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED","UNAUTHORIZED_ABSENCES_OR_LACK_OF_ATTENDANCE","STANDARD_RESELLER_PRACTICE","MOVING_EMPLOYEE_TO_INTERNAL_ENTITY","MOVING_EMPLOYEE_TO_DEEL_PEO","OTHER"],"description":"Reason why the contract is being terminated","title":"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataReason"},"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffTrackingType":{"type":"string","enum":["ON_PLATFORM","OFF_PLATFORM"],"description":"Type of time off tracking - whether it's tracked on Deel platform or off platform","title":"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffTrackingType"},"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementsItems":{"type":"object","properties":{"used":{"type":"number","format":"double","description":"Amount of time off used in the period"},"tracking_period":{"type":"string","format":"date","description":"Start date of the tracking period"},"tracking_period_end_date":{"type":"string","format":"date","description":"End date of the tracking period"}},"required":["used","tracking_period","tracking_period_end_date"],"title":"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementsItems"},"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementUnit":{"type":"string","enum":["BUSINESS_DAY","CALENDAR_DAY","HOUR","WEEK","MONTH","YEAR"],"description":"Unit of measurement for the time off entitlements","title":"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementUnit"},"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOff":{"type":"object","properties":{"entitlements":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementsItems"},"description":"Array of time off entitlements for different tracking periods"},"total_scheduled":{"type":"number","format":"double","description":"Total amount of time off scheduled until the end date"},"entitlement_unit":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementUnit","description":"Unit of measurement for the time off entitlements"}},"required":["entitlements","total_scheduled","entitlement_unit"],"description":"Required when tracking_type is OFF_PLATFORM, null otherwise","title":"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOff"},"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOff":{"type":"object","properties":{"tracking_type":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffTrackingType","description":"Type of time off tracking - whether it's tracked on Deel platform or off platform"},"off_platform_used_time_off":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOff"},{"type":"null"}],"description":"Required when tracking_type is OFF_PLATFORM, null otherwise"}},"title":"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOff"},"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataSeveranceType":{"type":"string","enum":["DAYS","WEEKS","MONTHS","CASH"],"description":"The type of severance selected by the client. It's an optional field","title":"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataSeveranceType"},"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataAdditionalReason":{"type":"string","enum":["DISSATISFIED_WITH_DEEL_SERVICE","DISSATISFIED_WITH_DEEL_PRICING","DISSATISFIED_WITH_DEEL_PRODUCT"],"description":"An additional reason can be provided in case the reason selected is NO_LONGER_WISH_TO_WORK_WITH_DEEL","title":"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataAdditionalReason"},"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataEligibleForRehire":{"type":"string","enum":["YES","NO","DONT_KNOW"],"description":"Parameter to inform whether it would be possible for the client to hire the employee again","title":"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataEligibleForRehire"},"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataRequiredInformationItems":{"type":"object","properties":{"answer":{"type":["boolean","null"],"description":"The answer to the question"},"question":{"type":"string","description":"The question to be answered"}},"required":["answer","question"],"title":"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataRequiredInformationItems"},"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaData":{"type":"object","properties":{"reason":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataReason","description":"Reason why the contract is being terminated"},"attachments":{"type":"string","format":"binary","description":"This field allows for uploading multiple files at once. Attach any document that is important for the request to terminate the contract. Includes common image formats (JPG, JPEG, PNG, HEIC) and PDF documents."},"is_sensitive":{"type":"boolean","description":"Defines whether the termination is sensitive. In this case, only the person requesting the termination will be able to view the termination, receive emails or notifications."},"reason_detail":{"type":"string","description":"Field to better explain how communication with the employee will be and/or their reaction to the communication, or other necessary information"},"used_time_off":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOff"},"severance_type":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataSeveranceType","description":"The type of severance selected by the client. It's an optional field"},"desired_end_date":{"type":"string","format":"date","description":"The desired end date of the contract. If the date is not provided, Deel HRX team will select the nearest possible date."},"severance_amount":{"type":"integer","description":"The amount of severance needed"},"additional_reason":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataAdditionalReason"},{"type":"null"}],"description":"An additional reason can be provided in case the reason selected is NO_LONGER_WISH_TO_WORK_WITH_DEEL"},"termination_notes":{"type":"array","items":{"type":"string"},"description":"Additional notes can be provided regarding the termination for Deel, like questions and doubts"},"eligible_for_rehire":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataEligibleForRehire"},{"type":"null"}],"description":"Parameter to inform whether it would be possible for the client to hire the employee again"},"is_employee_notified":{"type":"boolean","description":"Defines if employee was informed by client or not before the termination"},"required_information":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataRequiredInformationItems"},"description":"For some countries some data is needed to help to process the termination. The questions comes from another endpoint to get the required information. See GET /eor/:oid/offboarding/required-information to get the questions."},"termination_impact_id":{"type":"string","format":"uuid","description":"Termination impact data if there is some configured on HR module"},"employee_notification_detail":{"type":["string","null"],"description":"If it's an termination contract ending and employee was already informed, should detail the notification to the employee"},"additional_supporting_documents":{"type":"string","format":"binary","description":"This field allows for uploading multiple files at once. Any proof such as correspondence, documentation of previous warnings or attendance records for the reason select above. Includes common image formats (JPG, JPEG, PNG, HEIC) and PDF documents."}},"required":["reason","reason_detail","used_time_off","is_employee_notified"],"title":"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaData"},"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The type/extension of the file"},"created_at":{"type":"string","format":"date-time","description":"The date and time the file was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the file was updated"},"is_additional_supporting_document":{"type":"boolean","description":"Indicates if this is an additional supporting document added after the initial submission"}},"required":["id","name","type","created_at","updated_at","is_additional_supporting_document"],"title":"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems"},"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The type/extension of the file"},"created_at":{"type":"string","format":"date-time","description":"The date and time the file was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the file was updated"}},"required":["id","name","type","created_at"],"title":"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems"},"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus":{"type":"string","enum":["AWAITING_REVIEW","AWAITING_FEEDBACK","FEEDBACK_PROVIDED","APPROVED","CHANGES_REQUESTED_BY_CLIENT","CHANGES_REQUESTED_BY_EMPLOYEE","WAIVED_REVIEW","NOT_RESPONDED","CANCELLED"],"description":"The current status of the document review","title":"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus"},"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType":{"type":"string","enum":["CLIENT","EMPLOYEE"],"description":"The type of reviewer for this document","title":"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType"},"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the document set shared with the employee."},"files":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems"}},"status":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus","description":"The current status of the document review"},"created_at":{"type":"string","format":"date-time","description":"The date and time the document set was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the document set was updated"},"reviewed_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the document was reviewed"},"reviewed_by":{"type":["string","null"],"description":"The name of the reviewer for this document. If the reviewer is not an employee, it will be the name of the client"},"reviewer_type":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType","description":"The type of reviewer for this document"},"reviewer_feedback":{"type":["string","null"],"description":"Feedback provided by the reviewer"},"notification_instructions":{"type":["string","null"],"description":"HTML instructions for the reviewer notification"},"is_employee_notification_required":{"type":"boolean","description":"Indicates if the employee should be notified about this document review"}},"required":["files","status","reviewer_type","is_employee_notification_required"],"title":"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems"},"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocuments":{"type":"object","properties":{"supporting":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems"}},"offboarding":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems"},"description":"Document set shared that requires client or employee review"}},"required":["supporting","offboarding"],"description":"Document management structure for termination workflow including review processes and supporting documents","title":"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocuments"},"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataReason":{"type":"string","enum":["STATUS_CHANGE","RELOCATION","COMPENSATION","RETIREMENT","JOB_ABANDONMENT","WORK_RELATED","PERSONAL","OTHER_OPPORTUNITY","NON_RENEWAL","PROBATION","ASSIGNMENT_ENDED","POSITION_ELIMINATION","FORCE_REDUCTION","DEATH","FOR_CAUSE","PERFORMANCE","MEDICAL","PERFORMANCE_ISSUES","ATTENDANCE_ISSUES","REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE","ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED","OFFER_WAS_REVOKED","EXITING_THE_MARKET","NO_LONGER_WISH_TO_WORK_WITH_DEEL","COMPANY_ACQUIRED","STEALING","MISCONDUCT","FALSIFYING","HARASSMENT","VIOLENCE","REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE_OR_ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED","UNAUTHORIZED_ABSENCES_OR_LACK_OF_ATTENDANCE","STANDARD_RESELLER_PRACTICE","MOVING_EMPLOYEE_TO_INTERNAL_ENTITY","MOVING_EMPLOYEE_TO_DEEL_PEO","OTHER"],"description":"The reason for the termination","title":"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataReason"},"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit":{"type":"string","enum":["BUSINESS_DAY","CALENDAR_DAY","HOUR"],"description":"The unit of measurement for time off tracking","title":"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit"},"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems":{"type":"object","properties":{"used":{"type":"number","format":"double","description":"The amount of time off used in this tracking period"},"end_date":{"type":"string","format":"date-time","description":"The end date of the tracking period"},"start_date":{"type":"string","format":"date-time","description":"The start date of the tracking period"}},"required":["used","end_date","start_date"],"title":"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"},"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit","description":"The unit of measurement for time off tracking"},"policy_type":{"type":"string","description":"The type of time-off policy"},"tracking_periods":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"}},"scheduled_until_end_date":{"type":"number","format":"double","description":"The amount of time off scheduled until the end date of the current tracking period"}},"required":["unit","policy_type","tracking_periods","scheduled_until_end_date"],"title":"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems"},"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails":{"type":"object","properties":{"notes":{"type":["string","null"],"description":"Additional notes or comments about the time-off data"},"updated_by":{"type":["string","null"],"description":"The person or system that last updated the time-off data"},"last_updated_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the time-off data was last updated"}},"title":"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails"},"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff":{"type":"object","properties":{"time_offs":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems"}},"additional_details":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails"},{"type":"null"}]},"is_deel_pto_confirmed":{"type":"boolean","description":"Indicates whether the PTO allocation has been confirmed by Deel's system"}},"required":["time_offs","is_deel_pto_confirmed"],"description":"Time-off usage data including policy information and tracking periods","title":"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff"},"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire":{"type":"string","enum":["YES","NO","DONT_KNOW"],"description":"Parameter to inform whether it would be possible for the client to hire the employee again","title":"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire"},"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestData":{"type":"object","properties":{"reason":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataReason","description":"The reason for the termination"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"reason_detail":{"type":["string","null"],"description":"Optional field to describe the reason behind the resignation request"},"used_time_off":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff","description":"Time-off usage data including policy information and tracking periods"},"desired_end_date":{"type":["string","null"],"format":"date","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"},"eligible_for_rehire":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire"},{"type":"null"}],"description":"Parameter to inform whether it would be possible for the client to hire the employee again"},"eligible_for_rehire_reason":{"type":["string","null"],"description":"Describe if the option DONT_KNOW was selected on eligible_for_rehire"}},"title":"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestData"},"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the offboarding request"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"documents":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocuments","description":"Document management structure for termination workflow including review processes and supporting documents"},"created_at":{"type":"string","format":"date-time","description":"The date and time the offboarding request was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the offboarding request was updated"},"contract_id":{"type":"string","description":"The unique identifier of the employee contract."},"is_sensitive":{"type":"boolean","description":"Indicates if the offboarding request is sensitive. This is used to restrict access to the request only to the requester and the HRX team."},"request_data":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestData"},{"type":"null"}]},"desired_end_date":{"type":["string","null"],"format":"date-time","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"}},"title":"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaData"},"eor-terminations_createOffboardingTermination_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-terminations_createOffboardingTermination_Response_201"},"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code of the handler which produced the returned error"},"field":{"type":"string","description":"The field name where error occurred (null for server errors)"},"message":{"type":"string","description":"Description of the returned error"}},"title":"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaErrorsItems"},"InitiateEorContractTerminationRequestRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"InitiateEorContractTerminationRequestRequestBadRequestError"},"InitiateEorContractTerminationRequestRequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"InitiateEorContractTerminationRequestRequestUnauthorizedError"},"InitiateEorContractTerminationRequestRequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"InitiateEorContractTerminationRequestRequestForbiddenError"},"InitiateEorContractTerminationRequestRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"InitiateEorContractTerminationRequestRequestInternalServerError"},"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataReason":{"type":"string","enum":["EMPLOYEE_IS_MOVING_TO_ANOTHER_COUNTRY","MOVING_EMPLOYEE_TO_INTERNAL_ENTITY","MOVING_EMPLOYEE_TO_DEEL_PEO","EMPLOYEE_FOUND_ANOTHER_JOB","EMPLOYEE_NOT_HAPPY_WITH_BENEFITS","EMPLOYEE_NOT_HAPPY_WITH_SALARY","EMPLOYEE_NOT_HAPPY_WITH_THE_ROLE","EMPLOYEE_NOT_HAPPY_WITH_COMPANY_CULTURE","EMPLOYEE_NOT_HAPPY_WITH_DEEL","EMPLOYEE_PROJECT_ENDED","EMPLOYEE_SWITCHING_TO_OTHER_EOR_PROVIDER","EMPLOYEE_LEFT_ROLE_FOR_PERSONAL_MATTERS","EMPLOYEE_MOVING_FROM_EOR_TO_CONTRACTOR_OR_FREELANCE","WORKER_TYPE_CHANGE","DEEL_COLLECTIONS","EMPLOYEE_DID_NOT_TAKE_THE_OFFER","EMPLOYEE_PROVIDED_NO_REASON","OTHER_BUSINESS_REASONS"],"description":"Reason why the contract is being terminated","title":"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataReason"},"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataAttachmentsItems":{"type":"object","properties":{"key":{"type":"string"},"file_name":{"type":"string"}},"required":["key"],"title":"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataAttachmentsItems"},"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItemsUnit":{"type":"string","enum":["BUSINESS_DAY","CALENDAR_DAY","HOUR","WEEK","MONTH","YEAR"],"description":"Time off unit","title":"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItemsUnit"},"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItemsPolicyType":{"type":"string","enum":["Vacation","Sick leave","Maternity leave","Paternity leave","Parental leave","Bereavement leave","Childcare leave","Civic/public duty leave","Personal leave","Adoption leave","Blood donation leave","Childbirth leave","Disability leave","Doctor's appointment leave","Family & domestic violence leave","Hajj leave","Marriage/wedding leave","Military leave","Moving leave","Pregnancy leave","Study leave","Volunteer leave","Unpaid leave","Paid leave","Other leave","RTT","Regional holiday","Breastfeeding leave","Advanced vacation","Supplementary Leave","Floating Holiday Allowance"],"description":"Time off policy type","title":"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItemsPolicyType"},"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems":{"type":"object","properties":{"used":{"type":"number","format":"double","description":"Time off used in the period"},"end_date":{"type":"string","format":"date-time","description":"Time off start period"},"start_date":{"type":"string","format":"date-time","description":"Time off end period"}},"required":["used"],"title":"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"},"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItems":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItemsUnit","description":"Time off unit"},"policy_type":{"$ref":"#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItemsPolicyType","description":"Time off policy type"},"tracking_periods":{"type":"array","items":{"$ref":"#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"}},"scheduled_until_end_date":{"type":"number","format":"double","description":"Time off escheduled until contract end date"}},"required":["unit"],"title":"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItems"},"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOff":{"type":"object","properties":{"time_offs":{"type":"array","items":{"$ref":"#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItems"},"description":"All time-off used by the employee during contract period"},"additional_details":{"type":["string","null"],"description":"Any additional details regarding time off that HRX should know"},"is_deel_pto_confirmed":{"type":"boolean","description":"Defines whether the client agrees with the time off values that are registered in Deel. If false, it means that the client changed the values."}},"title":"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOff"},"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataSeveranceType":{"type":"string","enum":["DAYS","WEEKS","MONTHS","CASH"],"description":"The type of severance selected by the client. It's an optional field","title":"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataSeveranceType"},"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataAdditionalReason":{"type":"string","enum":["MOVING_TO_INTERNAL_ENTITY_WITH_DEEL_GLOBAL_PAYROLL","MOVING_TO_INTERNAL_ENTITY_WITH_OTHER_PROVIDER"],"description":"An additional reason can be provided in case the reason selected is MOVING_EMPLOYEE_TO_INTERNAL_ENTITY","title":"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataAdditionalReason"},"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataEligibleForRehire":{"type":"string","enum":["YES","NO","DONT_KNOW"],"description":"Parameter to inform whether it would be possible for the client to hire the employee again","title":"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataEligibleForRehire"},"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataData":{"type":"object","properties":{"reason":{"$ref":"#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataReason","description":"Reason why the contract is being terminated"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataAttachmentsItems"},"description":"Any document that is important for the request to terminate the contract"},"is_sensitive":{"type":"boolean","description":"Defines whether the termination is sensitive. In this case, only the person requesting the termination will be able to view the termination, receive emails or notifications."},"reason_detail":{"type":"string","description":"Optional field to describe the reason behind the resignation request"},"used_time_off":{"$ref":"#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOff"},"severance_type":{"$ref":"#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataSeveranceType","description":"The type of severance selected by the client. It's an optional field"},"desired_end_date":{"type":"string","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"},"severance_amount":{"type":"number","format":"double","description":"The amount of severance needed"},"additional_reason":{"oneOf":[{"$ref":"#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataAdditionalReason"},{"type":"null"}],"description":"An additional reason can be provided in case the reason selected is MOVING_EMPLOYEE_TO_INTERNAL_ENTITY"},"termination_notes":{"type":"array","items":{"type":"string"},"description":"Additional notes can be provided regarding the termination for Deel, like questions and doubts"},"eligible_for_rehire":{"oneOf":[{"$ref":"#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataEligibleForRehire"},{"type":"null"}],"description":"Parameter to inform whether it would be possible for the client to hire the employee again"},"termination_impact_id":{"type":"string","format":"uuid","description":"Termination impact data if there is some configured on HR module"},"eligible_for_rehire_reason":{"type":["string","null"],"description":"Describe if the option DONT_KNOW was selected on eligibleForRehire"},"custom_termination_reason_id":{"type":["string","null"],"format":"uuid","description":"Custom termination reason ID. A custom termination reason can be added on Client HR module"},"is_employee_staying_with_deel":{"type":["boolean","null"],"description":"Defines if employee will keep using Deel as provider"}},"required":["reason","used_time_off","is_employee_staying_with_deel"],"title":"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataData"},"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataData"}},"required":["data"],"title":"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaData"},"EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaDataRequestDataTerminationImpact":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"title":{"type":"string","description":"Termination impact title"},"description":{"type":"string","description":"Termination impact description"}},"description":"Custom termination impact data if there is some configured on HR module","title":"EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaDataRequestDataTerminationImpact"},"EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire":{"type":"string","enum":["YES","NO","DONT_KNOW"],"description":"Parameter to inform whether it would be possible for the client to hire the employee again","title":"EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire"},"EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaDataRequestData":{"type":"object","properties":{"reason":{"type":["string","null"]},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"reason_detail":{"type":["string","null"],"description":"Optional field to describe the reason behind the resignation request"},"desired_end_date":{"type":["string","null"],"format":"date-time","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"},"termination_impact":{"oneOf":[{"$ref":"#/components/schemas/EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaDataRequestDataTerminationImpact"},{"type":"null"}],"description":"Custom termination impact data if there is some configured on HR module"},"eligible_for_rehire":{"oneOf":[{"$ref":"#/components/schemas/EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire"},{"type":"null"}],"description":"Parameter to inform whether it would be possible for the client to hire the employee again"},"eligible_for_rehire_reason":{"type":["string","null"],"description":"Describe if the option DONT_KNOW was selected on eligibleForRehire"},"custom_termination_reason_id":{"type":["number","null"],"format":"double","description":"Custom termination reason ID. A custom termination reason can be added on Client HR module"}},"title":"EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaDataRequestData"},"EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"number","format":"double"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"contract_id":{"type":"string","description":"Public contract oid"},"request_data":{"oneOf":[{"$ref":"#/components/schemas/EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaDataRequestData"},{"type":"null"}]},"desired_end_date":{"type":["string","null"],"format":"date-time","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"}},"title":"EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaData"},"eor-terminations_createResignation_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-terminations_createResignation_Response_200"},"EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaItems":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"title":"EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaItems"},"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataReason":{"type":"string","enum":["DEEL_COLLECTIONS","STATUS_CHANGE","RELOCATION","COMPENSATION","RETIREMENT","JOB_ABANDONMENT","WORK_RELATED","PERSONAL","OTHER_OPPORTUNITY","NON_RENEWAL","PROBATION","ASSIGNMENT_ENDED","POSITION_ELIMINATION","FORCE_REDUCTION","DEATH","FOR_CAUSE","PERFORMANCE","MEDICAL","PERFORMANCE_ISSUES","ATTENDANCE_ISSUES","REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE","ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED","OFFER_WAS_REVOKED","EXITING_THE_MARKET","NO_LONGER_WISH_TO_WORK_WITH_DEEL","COMPANY_ACQUIRED","STEALING","MISCONDUCT","FALSIFYING","HARASSMENT","VIOLENCE","REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE_OR_ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED","UNAUTHORIZED_ABSENCES_OR_LACK_OF_ATTENDANCE","STANDARD_RESELLER_PRACTICE","MOVING_EMPLOYEE_TO_INTERNAL_ENTITY","MOVING_EMPLOYEE_TO_DEEL_PEO","OTHER"],"description":"Reason why the contract is being terminated","title":"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataReason"},"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAttachmentsItems":{"type":"object","properties":{"key":{"type":"string"},"file_name":{"type":"string"}},"required":["key"],"title":"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAttachmentsItems"},"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItemsUnit":{"type":"string","enum":["BUSINESS_DAY","CALENDAR_DAY","HOUR","WEEK","MONTH","YEAR"],"description":"Time off unit","title":"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItemsUnit"},"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItemsPolicyType":{"type":"string","enum":["Vacation","Sick leave","Maternity leave","Paternity leave","Parental leave","Bereavement leave","Childcare leave","Civic/public duty leave","Personal leave","Adoption leave","Blood donation leave","Childbirth leave","Disability leave","Doctor's appointment leave","Family & domestic violence leave","Hajj leave","Marriage/wedding leave","Military leave","Moving leave","Pregnancy leave","Study leave","Volunteer leave","Unpaid leave","Paid leave","Other leave","RTT","Regional holiday","Breastfeeding leave","Advanced vacation","Supplementary Leave","Floating Holiday Allowance"],"description":"Time off policy type","title":"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItemsPolicyType"},"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems":{"type":"object","properties":{"used":{"type":"number","format":"double","description":"Time off used in the period"},"end_date":{"type":"string","format":"date-time","description":"Time off start period"},"start_date":{"type":"string","format":"date-time","description":"Time off end period"}},"required":["used"],"title":"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"},"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItems":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItemsUnit","description":"Time off unit"},"policy_type":{"$ref":"#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItemsPolicyType","description":"Time off policy type"},"tracking_periods":{"type":"array","items":{"$ref":"#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"}},"scheduled_until_end_date":{"type":"number","format":"double","description":"Time off escheduled until contract end date"}},"required":["unit"],"title":"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItems"},"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOff":{"type":"object","properties":{"time_offs":{"type":"array","items":{"$ref":"#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItems"},"description":"All time-off used by the employee during contract period"},"additional_details":{"type":["string","null"],"description":"Any additional details regarding time off that HRX should know"},"is_deel_pto_confirmed":{"type":"boolean","description":"Defines whether the client agrees with the time off values ​​that are registered in Deel. If false, it means that the client changed the values."}},"title":"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOff"},"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataSeveranceType":{"type":"string","enum":["DAYS","WEEKS","MONTHS","CASH"],"description":"The type of severance selected by the client. It's an optional field","title":"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataSeveranceType"},"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAdditionalReason":{"type":"string","enum":["DISSATISFIED_WITH_DEEL_SERVICE","DISSATISFIED_WITH_DEEL_PRICING","DISSATISFIED_WITH_DEEL_PRODUCT"],"description":"An additional reason can be provided in case the reason selected is NO_LONGER_WISH_TO_WORK_WITH_DEEL","title":"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAdditionalReason"},"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataEligibleForRehire":{"type":"string","enum":["YES","NO","DONT_KNOW"],"description":"Parameter to inform whether it would be possible for the client to hire the employee again","title":"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataEligibleForRehire"},"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAdditionalCountryDataItems":{"type":"object","properties":{"answer":{"type":["boolean","null"]},"question":{"type":"string"}},"required":["answer","question"],"title":"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAdditionalCountryDataItems"},"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAdditionalSupportingDocumentsItems":{"type":"object","properties":{"key":{"type":"string"},"file_name":{"type":"string"}},"required":["key"],"title":"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAdditionalSupportingDocumentsItems"},"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"reason":{"$ref":"#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataReason","description":"Reason why the contract is being terminated"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAttachmentsItems"},"description":"Any document that is important for the request to terminate the contract"},"is_sensitive":{"type":"boolean","description":"Defines whether the termination is sensitive. In this case, only the person requesting the termination will be able to view the termination, receive emails or notifications."},"reason_detail":{"type":"string","description":"Field to better explain how communication with the employee will be and/or their reaction to the communication, or other necessary information"},"used_time_off":{"$ref":"#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOff"},"severance_type":{"$ref":"#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataSeveranceType","description":"The type of severance selected by the client. It's an optional field"},"desired_end_date":{"type":"string","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"},"severance_amount":{"type":"number","format":"double","description":"The amount of severance needed"},"additional_reason":{"oneOf":[{"$ref":"#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAdditionalReason"},{"type":"null"}],"description":"An additional reason can be provided in case the reason selected is NO_LONGER_WISH_TO_WORK_WITH_DEEL"},"termination_notes":{"type":"array","items":{"type":"string"},"description":"Additional notes can be provided regarding the termination for Deel, like questions and doubts"},"eligible_for_rehire":{"oneOf":[{"$ref":"#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataEligibleForRehire"},{"type":"null"}],"description":"Parameter to inform whether it would be possible for the client to hire the employee again"},"eor_country_data_id":{"type":"number","format":"double","description":"The current country data id"},"is_employee_notified":{"type":"boolean","description":"Defines if employee was informed by client or not before the termination"},"termination_impact_id":{"type":"string","format":"uuid","description":"Termination impact data if there is some configured on HR module"},"additional_country_data":{"type":"array","items":{"$ref":"#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAdditionalCountryDataItems"},"description":"For some countries some data is needed to help Deel to process the termination. The questions comes from another endpoint to get the additional country data"},"custom_termination_reason_id":{"type":"string","format":"uuid","description":"Custom termination reason ID. A custom termination reason can be added on Client HR module"},"employee_notification_detail":{"type":["string","null"],"description":"If it's an termination contract ending and employee was already informed, the employee notification details should be provided"},"additional_supporting_documents":{"type":"array","items":{"$ref":"#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAdditionalSupportingDocumentsItems"},"description":"Any proof such as correspondence, documentation of previous warnings or attendance records for the reason select above."}},"required":["reason","reason_detail","used_time_off","is_employee_notified"],"title":"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaData"},"EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaRequestDataTerminationImpact":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"title":{"type":"string","description":"Termination impact title"},"description":{"type":"string","description":"Termination impact description"}},"description":"Custom termination impact data if there is some configured on HR module","title":"EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaRequestDataTerminationImpact"},"EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaRequestDataEligibleForRehire":{"type":"string","enum":["YES","NO","DONT_KNOW"],"description":"Parameter to inform whether it would be possible for the client to hire the employee again","title":"EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaRequestDataEligibleForRehire"},"EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaRequestData":{"type":"object","properties":{"reason":{"type":["string","null"]},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"reason_detail":{"type":["string","null"],"description":"Optional field to describe the reason behind the resignation request"},"desired_end_date":{"type":["string","null"],"format":"date-time","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"},"termination_impact":{"oneOf":[{"$ref":"#/components/schemas/EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaRequestDataTerminationImpact"},{"type":"null"}],"description":"Custom termination impact data if there is some configured on HR module"},"eligible_for_rehire":{"oneOf":[{"$ref":"#/components/schemas/EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaRequestDataEligibleForRehire"},{"type":"null"}],"description":"Parameter to inform whether it would be possible for the client to hire the employee again"},"eligible_for_rehire_reason":{"type":["string","null"],"description":"Describe if the option DONT_KNOW was selected on eligibleForRehire"},"custom_termination_reason_id":{"type":["number","null"],"format":"double","description":"Custom termination reason ID. A custom termination reason can be added on Client HR module"}},"title":"EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaRequestData"},"eor-terminations_createRegularTermination_Response_200":{"type":"object","properties":{"id":{"type":"number","format":"double"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"contract_id":{"type":"string","description":"Public contract oid"},"request_data":{"oneOf":[{"$ref":"#/components/schemas/EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaRequestData"},{"type":"null"}]},"desired_end_date":{"type":["string","null"],"format":"date-time","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"}},"title":"eor-terminations_createRegularTermination_Response_200"},"EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaItems":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"title":"EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaItems"}},"securitySchemes":{"deelToken":{"type":"http","scheme":"bearer","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n"},"oauth2":{"type":"http","scheme":"bearer","description":"Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/"}}}}