EORContractBenefitsContainer
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/EORContractBenefits"
}
},
"x-internal": true
}
EORPayslipDownloadUrlContainer
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/PayslipDownloadUrl"
}
},
"x-internal": true
}
EORPayslipsListContainer
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Payslips"
}
}
}
}
Email
{
"type": "object",
"required": [
"type",
"value"
],
"properties": {
"type": {
"enum": [
"work"
],
"type": "string",
"example": "work",
"description": "The type of email."
},
"value": {
"type": "string",
"example": "work.email@example.com",
"description": "The email address."
},
"primary": {
"type": "boolean",
"default": false,
"example": true
}
}
}
EmailType
{
"type": "string",
"format": "email",
"nullable": true,
"minLength": 5,
"x-internal": true,
"description": "User's email address."
}
EmailTypeRequired
{
"type": "string",
"format": "email",
"minLength": 5,
"x-internal": true,
"description": "Worker's email address."
}
Employee
{
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "9b9fc43a-a90c-4615-ac50-baf1e314b53e",
"description": "Unique identifier for the employee."
},
"state": {
"type": "string",
"example": "Active",
"description": "The state of the employee."
},
"emails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Email"
},
"description": "An array of the employee's email addresses."
},
"country": {
"type": "string",
"example": "USA",
"description": "The country of the employee."
},
"timezone": {
"type": "string",
"example": "EST",
"description": "The timezone of the employee."
},
"addresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Address"
}
},
"full_name": {
"type": "string",
"example": "John Doe",
"description": "The full name of the employee."
},
"job_title": {
"type": "string",
"example": "Access Field Technician",
"description": "The job title of the employee."
},
"last_name": {
"type": "string",
"example": "Doe",
"description": "The last name of the employee."
},
"seniority": {
"type": "string",
"example": "Junior (Individual Contributor Level 1)",
"description": "The seniority level of the employee."
},
"birth_date": {
"type": "string",
"example": "1990-01-01T00:00:00.000Z",
"description": "The birth date of the employee."
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2023-03-21T10:27:25.950Z",
"description": "The creation timestamp of the employee record."
},
"department": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/UniqueObjectIdentifier"
},
"name": {
"type": "string",
"example": "Delivery team"
},
"parent": {
"type": "string",
"example": "Research and Development"
}
},
"description": "The department of the employee."
},
"first_name": {
"type": "string",
"example": "John",
"description": "The first name of the employee."
},
"start_date": {
"type": "string",
"format": "date",
"example": "2023-03-20T00:00:00.000Z",
"description": "The date the employee started working."
},
"updated_at": {
"$ref": "#/components/schemas/DateTimeString",
"description": "Date time of the last update."
},
"employments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmploymentDetail"
},
"description": "An array of the employee's employment details."
},
"hiring_type": {
"type": "string",
"example": "contractor",
"description": "The type of hiring of the employee."
},
"nationality": {
"type": "string",
"example": "American",
"description": "The nationality of the employee."
},
"hiring_status": {
"type": "string",
"example": "onboarding",
"description": "The current hiring status of the employee."
},
"work_location": {
"type": "string",
"example": "Remote",
"description": "The work location of the employee."
},
"direct_manager": {
"type": "object",
"nullable": false,
"properties": {
"id": {
"type": "string",
"example": "642b0547-9d80-4d35-a085-fd977ef209ef"
},
"last_name": {
"type": "string",
"example": "John"
},
"first_name": {
"type": "string",
"example": "Doe"
},
"work_email": {
"type": "string",
"example": "john.doe@example.com"
}
},
"description": "The direct manager of the employee."
},
"direct_reports": {
"type": "array",
"items": {
"type": "object",
"nullable": false,
"properties": {
"id": {
"type": "string",
"example": "642b0547-9d80-4d35-a085-fd977ef209ef"
},
"last_name": {
"type": "string",
"example": "John"
},
"first_name": {
"type": "string",
"example": "Doe"
},
"work_email": {
"type": "string",
"example": "john.doe@example.com"
}
}
},
"description": "The direct reports to the employee."
},
"completion_date": {
"type": "string",
"example": "2023-06-20T00:00:00.000Z",
"nullable": true,
"description": "The completion date of the task or project."
},
"new_hiring_status": {
"type": "string",
"example": "onboarding_overdue",
"description": "The new hiring status of the employee."
},
"client_legal_entity": {
"$ref": "#/components/schemas/PeopleClientLegalEntity",
"description": "The legal entity of the client."
},
"direct_reports_count": {
"type": "integer",
"example": 0,
"description": "The count of direct reports to the employee."
}
}
}
EmployeeAgreementDownloadContainer
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/EmployeeAgreementDownloadObject"
}
},
"x-internal": true
}
EmployeeAgreementDownloadObject
{
"type": "object",
"properties": {
"url": {
"type": "string",
"example": "https://s3URL/letsdeel.com/employee-agreement/12345.pdf",
"description": "URL to requested employee agreement to download."
},
"expires_at": {
"type": "string",
"format": "date-time",
"example": "2020-03-31T10:58:49.780Z",
"description": "Expiration date time of download URL."
}
}
}
EmployeeContractSignatureToCreate
{
"type": "object",
"required": [
"signature"
],
"properties": {
"signature": {
"type": "string",
"minLength": 2,
"description": "Signature of employee."
}
},
"x-internal": true
}
EmployeeContractSignatureToCreateContainer
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/EmployeeContractSignatureToCreate"
}
},
"x-internal": true
}
EmployeeList
{
"properties": {
"id": {
"type": "string",
"example": "a7cc0404-0a13-442a-92d0-dfcbc7e6f1ad"
},
"team": {
"type": "string",
"example": "John's Team"
},
"email": {
"type": "string",
"example": "john@example.com"
},
"state": {
"type": "string",
"example": "CO"
},
"country": {
"type": "string",
"example": "BR"
},
"pic_url": {
"type": "string",
"format": "nullable"
},
"team_id": {
"type": "number",
"example": 245062
},
"payments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rate": {
"type": "number",
"example": 4000
},
"scale": {
"type": "string",
"example": "monthly"
},
"currency": {
"type": "string",
"example": "BRL"
},
"contract_name": {
"type": "string",
"example": "Demo.1"
}
}
}
},
"timezone": {
"type": "string",
"example": "America/Sao_Paulo"
},
"full_name": {
"type": "string",
"example": "John Smith"
},
"job_title": {
"type": "string",
"example": "Director"
},
"last_name": {
"type": "string",
"example": "Smith"
},
"seniority": {
"type": "string",
"example": "Junior (Individual Contributor Level 1)"
},
"birth_date": {
"type": "string",
"example": "1984-12-26T00:00:00.000Z"
},
"first_name": {
"type": "string",
"example": "John"
},
"start_date": {
"type": "string",
"example": "2022-07-01T03:00:00.000Z"
},
"hiring_type": {
"type": "string",
"example": "contractor"
},
"hiring_status": {
"type": "string",
"example": "active"
},
"personal_email": {
"type": "string",
"example": "john@example.com"
},
"completion_date": {
"type": "string",
"example": "2023-11-12T02:59:59.999Z"
},
"monthly_payment": {
"type": "object",
"properties": {
"count": {
"type": "number",
"example": 10
}
}
},
"client_legal_entity": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/UniqueObjectIdentifier"
},
"name": {
"type": "string",
"example": "John.test2"
}
}
},
"hourly_report_total": {
"type": "string",
"example": "8017.8000"
}
},
"x-internal": true
}
EmployeeListContainer
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeeList"
}
}
},
"x-internal": true
}
EmployeePayslipsList
{
"type": "object",
"required": [
"id",
"from",
"to",
"filename",
"status",
"rejected_at",
"reject_reason",
"uploaded_at",
"published_at",
"schedule_publishing_date",
"created_at",
"updated_at",
"url"
],
"properties": {
"id": {
"type": "string",
"example": "9K1rw5vwkZX2"
},
"to": {
"type": "string",
"format": "date-time",
"example": "2023-08-31T00:00:00.000Z"
},
"url": {
"type": "string",
"example": "http://example.com/file.pdf"
},
"from": {
"type": "string",
"format": "date-time",
"example": "2023-08-01T00:00:00.000Z"
},
"status": {
"type": "string",
"example": "PUBLISHED"
},
"filename": {
"type": "string",
"example": "payslip_demo.pdf"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2023-09-08T08:44:20.289Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2023-09-08T08:44:20.289Z"
},
"rejected_at": {
"type": "string",
"format": "date-time",
"example": "2023-08-29T00:00:00.000Z"
},
"uploaded_at": {
"type": "string",
"format": "date-time",
"example": "2023-09-08T08:44:20.464Z"
},
"published_at": {
"type": "string",
"format": "date-time",
"example": "2023-09-08T08:44:20.289Z"
},
"reject_reason": {
"type": "string",
"example": "Something wrong"
},
"schedule_publishing_date": {
"type": "string",
"format": "date-time",
"example": "2023-09-08T08:44:20.289Z"
}
},
"x-internal": true
}
EmployeePayslipsListContainer
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeePayslipsList"
}
}
}
}
EmployeeTaxDocumentsList
{
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "9AmobdjMwXOq"
},
"url": {
"type": "string",
"example": "https://example.com/file.pdf"
},
"type": {
"type": "string",
"example": "Tax Document"
},
"year": {
"type": "number",
"example": 2023
},
"country": {
"type": "string",
"example": "IL"
}
},
"x-internal": true
}
EmployeeTaxDocumentsListContainer
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeeTaxDocumentsList"
}
}
}
}
EmployeeTimeoffsContainer
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeeTimeoffsItem"
},
"description": "List of employee time offs."
}
},
"x-internal": true
}
EmployeeTimeoffsCreationContainer
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/EmployeeTimeoffsItemResponse"
}
},
"x-internal": true
}
EmployeeTimeoffsEntitlementsContainer
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeeTimeoffsEntitlementsItem"
},
"description": "List of employee time offs entitlements."
}
},
"x-internal": true
}
EmployeeTimeoffsEntitlementsItem
{
"type": "object",
"required": [
"year",
"tracking_period",
"vacation_allowed",
"vacation_rollover",
"vacation_expired",
"vacation_payout",
"vacation_requested",
"vacation_approved",
"vacation_used",
"vacation_total",
"sick_leave_requested",
"sick_leave_approved",
"sick_leave_used",
"sick_leave_total",
"sick_leave_allowed",
"other_leave_requested",
"other_leave_approved",
"other_leave_used",
"other_leave_total"
],
"properties": {
"year": {
"type": "number",
"example": 2023
},
"vacation_used": {
"type": "string",
"example": "7.00"
},
"vacation_total": {
"type": "string",
"example": "7.00"
},
"sick_leave_used": {
"type": "string",
"example": "0.00"
},
"tracking_period": {
"type": "string",
"example": "2023-01-01T00:00:00.000Z"
},
"vacation_payout": {
"type": "string",
"example": "0.00"
},
"other_leave_used": {
"type": "string",
"example": "0.00"
},
"sick_leave_total": {
"type": "string",
"example": "0.00"
},
"vacation_allowed": {
"type": "string",
"example": "0.00"
},
"vacation_expired": {
"type": "string",
"example": "0.00"
},
"other_leave_total": {
"type": "string",
"example": "0.00"
},
"vacation_approved": {
"type": "string",
"example": "0.00"
},
"vacation_rollover": {
"type": "string",
"example": "0.00"
},
"sick_leave_allowed": {
"type": "string",
"example": "395.00"
},
"vacation_requested": {
"type": "string",
"example": "0.00"
},
"sick_leave_approved": {
"type": "string",
"example": "0.00"
},
"other_leave_approved": {
"type": "string",
"example": "0.00"
},
"sick_leave_requested": {
"type": "string",
"example": "0.00"
},
"other_leave_requested": {
"type": "string",
"example": "0.00"
}
}
}
EmployeeTimeoffsItem
{
"type": "object",
"required": [
"time_off_id",
"reason",
"type",
"requested_at",
"reviewed_at",
"with_multiple_dates",
"created_at",
"updated_at",
"status",
"other_time_off_name",
"denial_reason",
"requester",
"reviewer",
"days_used_start_year",
"days_used_end_year",
"days_used",
"start_date",
"end_date",
"is_start_date_half_day",
"is_end_date_half_day",
"attachments",
"change_request"
],
"properties": {
"type": {
"enum": [
"VACATION",
"SICK_LEAVE",
"OTHER"
],
"type": "string",
"example": "VACATION",
"description": "Time off type."
},
"reason": {
"type": "string",
"example": "I need to relax."
},
"end_date": {
"type": "string",
"example": "2024-02-25T23:00:00.000Z"
},
"reviewer": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Rabia Arikdogan"
}
}
},
"days_used": {
"type": "string",
"example": "0.50"
},
"requester": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Carlos from deel"
}
}
},
"created_at": {
"type": "string",
"example": "2023-08-03T22:00:00.000Z"
},
"start_date": {
"type": "string",
"example": "2024-02-23T23:00:00.000Z"
},
"updated_at": {
"type": "string",
"example": "2023-08-03T22:00:00.000Z"
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"example": "924177_SC_l73xijJk-Xn1xfeN4V.jpeg"
},
"attachment_id": {
"type": "string",
"example": "3759767d-2737-4284-8263-65099896f7c3"
},
"file_extension": {
"type": "string",
"example": "pdf"
}
}
},
"example": []
},
"reviewed_at": {
"type": "string",
"example": "2023-08-03T22:00:00.000Z"
},
"time_off_id": {
"$ref": "#/components/schemas/UniqueObjectIdentifier",
"nullable": true
},
"requested_at": {
"type": "string",
"example": "2023-08-03T22:00:00.000Z"
},
"denial_reason": {
"type": "string",
"example": false,
"nullable": true
},
"change_request": {
"type": "string",
"example": "",
"nullable": true
},
"days_used_end_year": {
"type": "string",
"example": "0.00"
},
"with_multiple_dates": {
"type": "boolean",
"example": false
},
"days_used_start_year": {
"type": "string",
"example": "0.50"
},
"is_end_date_half_day": {
"type": "boolean",
"example": true
},
"is_start_date_half_day": {
"type": "boolean",
"example": false
}
}
}
EmployeeTimeoffsItemResponse
{
"type": "object",
"properties": {
"type": {
"enum": [
"VACATION",
"SICK_LEAVE",
"OTHER"
],
"type": "string",
"example": "VACATION",
"description": "Time off type."
},
"reason": {
"type": "string",
"example": "I need to relax."
},
"end_date": {
"type": "string",
"example": "2024-02-25T23:00:00.000Z"
},
"days_used": {
"type": "string",
"example": "0.50"
},
"policy_id": {
"type": "string",
"example": "85cae186-c0b2-4b92-b554-d8eb1f0fdc1d"
},
"requester": {
"$ref": "#/components/schemas/RequesterTimeOff"
},
"created_at": {
"type": "string",
"example": "2023-08-03T22:00:00.000Z"
},
"is_updated": {
"type": "boolean",
"example": false
},
"start_date": {
"type": "string",
"example": "2024-02-23T23:00:00.000Z"
},
"updated_at": {
"type": "string",
"example": "2023-08-03T22:00:00.000Z"
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "3759767d-2737-4284-8263-65099896f7c3"
},
"filename": {
"type": "string",
"example": "test.pdf"
},
"created_at": {
"type": "string",
"example": "2023-08-04T09:03:31.577Z"
},
"updated_at": {
"type": "string",
"example": "2023-08-04T09:03:31.577Z"
},
"time_off_id": {
"type": "string",
"example": "eb0b38d1-4851-4560-87fd-c57b7cf19e5f"
}
}
},
"example": []
},
"policy_name": {
"type": "string",
"example": "Vacation - unlimited days"
},
"reviewed_at": {
"type": "string",
"example": "2023-08-03T22:00:00.000Z"
},
"single_date": {
"type": "string",
"example": "2023-08-03T22:00:00.000Z"
},
"time_off_id": {
"type": "string",
"example": "bca1738c-194a-48e7-a26d-89fddca5bff3"
},
"requested_at": {
"type": "string",
"example": "2023-08-03T22:00:00.000Z"
},
"denial_reason": {
"type": "boolean",
"example": false
},
"change_request": {
"type": "string",
"example": ""
},
"applied_changes": {
"type": "array",
"items": {},
"example": []
},
"policy_type_name": {
"type": "string",
"example": "Vacation"
},
"time_off_type_id": {
"type": "string",
"example": "e0a91fd6-0646-41ae-84a9-ca3d2f761793"
},
"days_used_end_year": {
"type": "string",
"example": "0.00"
},
"can_request_changes": {
"type": "boolean",
"example": false
},
"with_multiple_dates": {
"type": "boolean",
"example": false
},
"days_used_start_year": {
"type": "string",
"example": "0.50"
},
"is_end_date_half_day": {
"type": "boolean",
"example": true
},
"is_start_date_half_day": {
"type": "boolean",
"example": false
}
}
}
EmployeeTimeoffsPoliciesContainer
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmployeeTimeoffsPoliciesItem"
},
"description": "List of employee time offs policies."
}
},
"x-internal": true
}
EmployeeTimeoffsPoliciesItem
{
"type": "object",
"required": [
"id",
"type",
"name",
"description",
"unit_amount",
"used",
"tracking_start_date",
"tracking_end_date",
"entitlement"
],
"properties": {
"id": {
"type": "string",
"example": "9K1rw5vwkZX2",
"description": "Unique identifier for the time off policy."
},
"name": {
"type": "string",
"example": "Vacation",
"description": "Name of the time off policy."
},
"type": {
"type": "string",
"example": "VACATION",
"description": "Type of time off policy."
},
"used": {
"type": "number",
"example": 10,
"nullable": true,
"description": "Used time off policy."
},
"description": {
"type": "string",
"example": "Vacation policy",
"description": "Description of the time off policy."
},
"entitlement": {
"type": "object",
"properties": {
"unit": {
"type": "string",
"example": "CALENDAR_DAY",
"nullable": true,
"description": "Unit of the time off policy."
},
"total": {
"example": 20,
"nullable": true,
"description": "Total time off policy."
},
"accrued": {
"type": "string",
"example": "2.55",
"nullable": true,
"description": "Accrued time off policy."
},
"unit_amount": {
"example": 20,
"nullable": true,
"description": "Unit amount of the time off policy."
},
"accrual_unit": {
"type": "string",
"example": "BUSINESS_DAY",
"nullable": true,
"description": "Accrual unit of the time off policy."
},
"accrual_amount": {
"type": "string",
"example": 0,
"nullable": true,
"description": "Accrual amount of the time off policy."
}
}
},
"unit_amount": {
"type": "number",
"example": 20,
"description": "Unit amount of the time off policy."
},
"tracking_end_date": {
"format": "date-time",
"example": "2023-08-31T00:00:00.000Z",
"nullable": true,
"description": "End date of the time off policy."
},
"tracking_start_date": {
"format": "date-time",
"example": "2023-08-01T00:00:00.000Z",
"nullable": true,
"description": "Start date of the time off policy."
}
}
}
Employment
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the employment."
},
"name": {
"type": "string",
"description": "The name of the employment."
},
"team": {
"$ref": "#/components/schemas/Team",
"description": "The team associated with the employment."
},
"email": {
"type": "string",
"description": "The email associated with the employment."
},
"state": {
"type": "string",
"description": "The state associated with the employment."
},
"country": {
"type": "string",
"description": "The country associated with the employment."
},
"payment": {
"$ref": "#/components/schemas/PeoplePayment",
"description": "The payment information associated with the employment."
},
"is_ended": {
"type": "boolean",
"description": "Indicates whether the employment has ended."
},
"timezone": {
"type": "string",
"description": "The timezone associated with the employment."
},
"job_title": {
"type": "string",
"description": "The job title associated with the employment."
},
"seniority": {
"type": "string",
"description": "The seniority level associated with the employment."
},
"start_date": {
"type": "string",
"description": "The start date of the employment."
},
"work_email": {
"type": "string",
"description": "The work email associated with the employment."
},
"hiring_type": {
"type": "string",
"description": "The hiring type associated with the employment."
},
"hiring_status": {
"type": "string",
"description": "The hiring status associated with the employment."
},
"completion_date": {
"type": "string",
"description": "The completion date of the employment."
},
"contract_status": {
"type": "string",
"description": "The contract status associated with the employment."
},
"voluntarily_left": {
"type": "boolean",
"description": "Indicates whether the employment was left voluntarily."
},
"client_legal_entity": {
"$ref": "#/components/schemas/PeopleClientLegalEntity",
"description": "The client legal entity associated with the employment."
},
"has_eor_termination": {
"type": "boolean",
"description": "Indicates whether the employment had an EOR termination."
},
"contract_is_archived": {
"type": "boolean",
"description": "Indicates whether the employment's contract is archived."
}
}
}
EmploymentDetail
{
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "mzj524j",
"description": "Unique identifier for the employment."
},
"name": {
"type": "string",
"example": "Khizar Naeem",
"description": "Name of the employee."
},
"team": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/UniqueObjectIdentifier"
},
"name": {
"type": "string",
"description": "The team name."
}
},
"description": "The team to which the employee belongs."
},
"email": {
"type": "string",
"example": "some@example.com",
"description": "The work email of the employee."
},
"state": {
"type": "string",
"example": "Active",
"description": "The state of employment."
},
"country": {
"type": "string",
"example": "USA",
"description": "The country of employment."
},
"payment": {
"$ref": "#/components/schemas/PeoplePayment",
"description": "The payment information associated with the employment."
},
"is_ended": {
"type": "boolean",
"example": false,
"description": "Whether the employment has ended."
},
"timezone": {
"type": "string",
"example": "EST",
"description": "The timezone of the employment."
},
"job_title": {
"type": "string",
"example": "Access Field Technician",
"description": "The job title of the employment."
},
"seniority": {
"type": "string",
"example": "Junior (Individual Contributor Level 1)",
"description": "The seniority level of the employment."
},
"start_date": {
"type": "string",
"format": "date",
"example": "2023-03-20T00:00:00.000Z",
"description": "The start date of the employment."
},
"work_email": {
"type": "string",
"example": "work.email@example.com",
"description": "The work email of the employment."
},
"hiring_type": {
"type": "string",
"example": "contractor",
"description": "The type of hiring of the employment."
},
"hiring_status": {
"type": "string",
"example": "onboarding",
"description": "The current hiring status of the employment."
},
"completion_date": {
"type": "string",
"example": "2023-06-20T00:00:00.000Z",
"description": "The completion date of the employment contract."
},
"contract_status": {
"type": "string",
"example": "waiting_for_client_sign",
"description": "The status of the employment contract."
},
"voluntarily_left": {
"type": "string",
"example": "No",
"description": "Whether the employee voluntarily left the employment."
},
"contract_coverage": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"no_coverage"
],
"description": "The coverage of the employment contract."
},
"new_hiring_status": {
"type": "string",
"example": "onboarding_overdue",
"description": "The new hiring status of the employment."
},
"client_legal_entity": {
"$ref": "#/components/schemas/PeopleClientLegalEntity",
"description": "The legal entity of the client in the employment."
},
"has_eor_termination": {
"type": "string",
"example": "No",
"description": "Whether the employment has an EOR termination."
},
"contract_is_archived": {
"type": "boolean",
"example": false,
"description": "Whether the employment contract is archived."
},
"contract_has_contractor": {
"type": "boolean",
"example": true,
"description": "Whether the contract has a contractor."
},
"is_user_contract_deleted": {
"type": "boolean",
"example": false,
"description": "Whether the user contract is deleted."
},
"hris_direct_employee_invitation": {
"type": "string",
"example": "Invited",
"description": "The HRIS direct employee invitation status."
}
}
}
EmploymentDetailsOfContract
{
"type": "object",
"required": [
"type",
"days_per_week",
"hours_per_day",
"probation_period",
"paid_vacation_days"
],
"properties": {
"type": {
"type": "string"
},
"state": {
"type": "string",
"example": "CO",
"nullable": true,
"description": "State code."
},
"country": {
"$ref": "#/components/schemas/CountryCode"
},
"days_per_week": {
"type": "number"
},
"hours_per_day": {
"type": "number"
},
"probation_period": {
"type": "number",
"nullable": true
},
"paid_vacation_days": {
"type": "number"
}
},
"x-internal": true
}
EnterpriseUser
{
"type": "object",
"properties": {
"manager": {
"$ref": "#/components/schemas/Manager"
},
"costCenter": {
"type": "string",
"example": 12345,
"description": "Legal entity."
},
"department": {
"type": "string",
"example": "Engineering",
"description": "Employee's department in Deel HR."
},
"organization": {
"type": "string",
"example": 45321,
"description": "Organization name in Deel."
}
}
}
EorClientTimeoffRequests
{
"type": "object",
"required": [
"requests"
],
"properties": {
"year": {
"type": "number",
"example": 2022
},
"requests": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EorTimeoffsBaseItem"
},
"description": "List of time offs."
},
"yearly_limit": {
"type": "number",
"description": "Total number of days off allowed per year."
},
"days_requested": {
"type": "number",
"description": "Days off requested by employee."
},
"yearly_requests": {
"type": "number",
"description": "Total number of time off requests this year."
},
"current_approved": {
"type": "number",
"description": "Days off approved."
},
"over_annual_limit": {
"type": "boolean",
"description": "Too many days off requested by employee."
}
}
}
EorClientTimeoffs
{
"required": [
"employees",
"total_requests"
],
"properties": {
"employees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EorTimeoffsEmployeeItem"
},
"description": "List of employee time offs."
},
"total_requests": {
"type": "number"
}
}
}
EorClientTimeoffsContainer
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/EorClientTimeoffs"
}
},
"x-internal": true
}
EorContractCreated
{
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": false,
"description": "Id of the contract quote created"
},
"type": {
"$ref": "#/components/schemas/ContractTypeEnum"
},
"client": {
"type": "object",
"properties": {
"legal_entity": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Legal entity name."
}
}
}
}
},
"status": {
"$ref": "#/components/schemas/ContractStatusEnum"
},
"employee": {
"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."
}
}
},
"job_title": {
"type": "string",
"example": "Designer",
"description": "Employee's job title."
},
"seniority": {
"$ref": "#/components/schemas/Seniority"
},
"created_at": {
"$ref": "#/components/schemas/DateTimeString"
},
"employment": {
"type": "object",
"properties": {
"state": {
"type": "string",
"nullable": true,
"description": "State code of the state/province where the this person will be employed."
},
"country": {
"type": "string",
"description": "Country of employement."
},
"end_date": {
"$ref": "#/components/schemas/DateString"
},
"start_date": {
"$ref": "#/components/schemas/DateString"
},
"scope_of_work": {
"type": "string",
"example": "A designer works on the entire process of defining requirements, visualizing and creating graphics including illustrations or logos. Also, the designer works on shaping the visual aspects of websites, product packaging, and more.",
"description": "Scope of work description."
},
"time_off_type": {
"type": "string",
"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."
},
"probation_period": {
"type": "number",
"nullable": true,
"description": "Number of probation days."
},
"work_visa_required": {
"type": "boolean",
"description": "Do you require Deel to apply for work visa for this person?"
},
"calculated_holidays": {
"type": "string",
"description": "Number of calculate holidays for this contract."
}
}
},
"health_plan": {
"type": "object",
"nullable": true,
"properties": {
"id": {
"type": "string",
"description": "Health plan ID"
},
"name": {
"type": "string",
"description": "Health plan name"
}
}
},
"compensation_details": {
"type": "object",
"properties": {
"salary": {
"type": "number",
"description": "Gross annual salary."
},
"currency": {
"type": "string",
"description": "Currency of gross annual salary."
},
"variable_compensation": {
"type": "string",
"description": "Variable compensation acount or percentage."
},
"variable_compensation_type": {
"type": "string",
"nullable": true,
"description": "Type fo variable compensation."
}
}
}
}
}
EorContractCreatedContainer
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/EorContractCreated"
}
},
"x-internal": true
}
EorContractToCreate
{
"type": "object",
"required": [
"employment",
"employee",
"job_title",
"seniority",
"client",
"compensation_details"
],
"properties": {
"client": {
"type": "object",
"required": [
"team"
],
"properties": {
"team": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"$ref": "#/components/schemas/UniqueObjectIdentifier",
"description": "Enter the Id of team this person will be hired in. Use /teams endpoint to retrieve a list of teams in your organization."
}
}
},
"legal_entity": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/UniqueObjectIdentifier",
"description": "Enter the Id of legal entity under which you want to hire this person. Use /legal-entities endpoint to retrieve a list of legal entities in your organization."
}
}
}
}
},
"pension": {
"$ref": "#/components/schemas/PensionEORContractToCreate"
},
"employee": {
"type": "object",
"required": [
"first_name",
"last_name",
"nationality"
],
"properties": {
"email": {
"type": "string",
"example": "employee@email.com",
"description": "Employee's email address."
},
"address": {
"type": "object",
"nullable": true,
"properties": {
"zip": {
"type": "string",
"example": "44000",
"description": "Zip code."
},
"city": {
"type": "string",
"example": "Denver",
"description": "City name."
},
"state": {
"type": "string",
"example": "CO",
"nullable": true,
"description": "State code."
},
"street": {
"type": "string",
"example": "Deel Street 500",
"description": "Street and number."
},
"country": {
"$ref": "#/components/schemas/CountryCode"
}
}
},
"last_name": {
"type": "string",
"example": "Doe",
"description": "Employee's last name."
},
"first_name": {
"type": "string",
"example": "Jane",
"description": "Employee's first name."
},
"nationality": {
"type": "string",
"example": "US",
"description": "Employee's nationality."
}
}
},
"job_title": {
"type": "string",
"description": "Employee's job title."
},
"seniority": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/UniqueObjectIdentifier",
"description": "Enter the Id retrieved from the seniority lookup endpoint. Enter 34 for \"Not Applicable\"."
}
}
},
"employment": {
"type": "object",
"required": [
"country",
"start_date",
"work_visa_required"
],
"properties": {
"type": {
"enum": [
"Full-time",
"Part-time"
],
"type": "string",
"description": "Is it a full-time contract or a part-time contract?"
},
"state": {
"type": "string",
"nullable": true,
"description": "State code of the state/province where the this person will be employed."
},
"country": {
"$ref": "#/components/schemas/CountryCode"
},
"end_date": {
"$ref": "#/components/schemas/DateString"
},
"holidays": {
"type": "number",
"nullable": true,
"description": "Enter the number of holidays. Leave this field blank if you are chooseing \"STANDARD\" time_off_type."
},
"start_date": {
"$ref": "#/components/schemas/DateStringRequired"
},
"scope_of_work": {
"type": "string",
"description": "Scope of work description."
},
"time_off_type": {
"enum": [
"STANDARD",
"SPECIFIC"
],
"type": "string",
"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."
},
"probation_period": {
"type": "number",
"nullable": true,
"description": "Number of probation days."
},
"work_visa_required": {
"type": "boolean",
"default": false,
"description": "Do you require Deel to apply for work visa for this person?"
}
}
},
"health_plan_id": {
"type": "string",
"description": "Healthcare plan id. You can see available healthcare plans in the country guide endpoint."
},
"compensation_details": {
"type": "object",
"required": [
"currency"
],
"properties": {
"salary": {
"type": "number",
"description": "Employee's gross annual salary."
},
"currency": {
"type": "string",
"description": "Salary currency."
},
"variable_compensation": {
"type": "number",
"nullable": true,
"description": "Variable compensation. For example, if the person will earn 5% of the gross annual salary as the variable compensation, enter 5."
},
"variable_compensation_type": {
"enum": [
"PERCENTAGE",
"FIXED",
null
],
"type": "string",
"nullable": true,
"description": "Should be set only if variable_compensation is set. It can be PERCENTAGE or FIXED."
}
}
},
"quote_additional_fields": {
"type": "object",
"nullable": true,
"properties": {
"dob": {
"type": "string",
"description": "Employee's date of birth."
},
"gender": {
"type": "string",
"description": "Employee's gender."
},
"worker_type": {
"enum": [
"Skilled",
"Unskilled"
],
"type": "string",
"description": "Type of worker."
}
},
"description": "Some countries require additional employee information for employment contracts."
}
}
}
EorContractToCreateContainer
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/EorContractToCreate"
}
},
"x-internal": true
}
EorCountryValidations
{
"type": "object",
"properties": {
"salary": {
"type": "object",
"properties": {
"max": {
"type": "string",
"example": "2649300.00",
"description": "Maximum wage allowed for a legally compliant contract."
},
"min": {
"type": "string",
"example": "14544.00",
"description": "Minimum wage for a legally compliant contract."
},
"frequency": {
"$ref": "#/components/schemas/SalaryFrequencyScaleEnum",
"type": "string"
}
},
"description": "Salary range."
},
"holiday": {
"type": "object",
"properties": {
"min": {
"type": "string",
"example": "20",
"description": "Minimum number of holidays required for a legally compliant contract."
}
},
"description": "Range of the number of holidays."
},
"pension": {
"type": "object",
"nullable": true,
"properties": {
"status": {
"$ref": "#/components/schemas/BenefitStatusEnum",
"description": "Pension benefit status."
},
"providers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PensionProvider"
}
}
},
"description": "If it is there, you must specify the pension benefit when creating an EOR contract."
},
"currency": {
"type": "string",
"example": "BRL",
"description": "Country currency."
},
"probation": {
"type": "object",
"properties": {
"max": {
"type": "number",
"example": 90,
"description": "Maximum probation days allowed for a legally compliant contract."
},
"min": {
"type": "string",
"format": "nullable",
"description": "Minimum probation days required for a legally compliant contract."
}
},
"description": "Probation period range."
},
"sick_days": {
"type": "object",
"properties": {
"max": {
"type": "string",
"format": "nullable",
"description": "Maximum number of sick days allowed for a legally compliant contract."
},
"min": {
"type": "string",
"example": "0",
"description": "Minimum number of sick days required for a legally compliant contract."
}
}
},
"insurance_fee": {
"type": "string",
"example": "15.00",
"description": "Insurance fee."
},
"work_schedule": {
"type": "object",
"properties": {
"days": {
"type": "object",
"properties": {
"max": {
"type": "string",
"example": "6"
}
}
},
"hours": {
"type": "object",
"properties": {
"max": {
"type": "string",
"example": "10"
}
}
}
},
"description": "Employee's Work schedule in days and hours."
},
"health_insurance": {
"type": "object",
"nullable": true,
"properties": {
"status": {
"$ref": "#/components/schemas/BenefitStatusEnum",
"description": "Health insurance status."
},
"providers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HealthInsuranceProvider"
}
}
}
},
"mandatory_fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EorField"
}
},
"definite_contract": {
"type": "object",
"properties": {
"type": {
"enum": [
"ALLOWED_WITHOUT_LIMITATION",
"ALLOWED_WITH_MAXIMUM_LIMITATION",
"NOT_ALLOWED"
],
"type": "string",
"example": "ALLOWED_WITH_MAXIMUM_LIMITATION"
},
"maximum_limitation": {
"type": "number",
"example": 36
}
},
"description": "Conditions to make definitive contract."
},
"part_time_holiday": {
"type": "object",
"properties": {
"min": {
"type": "string",
"example": "15",
"description": "Minimum number of holidays required for a legally compliant contract."
},
"type": {
"enum": [
"PRORATED",
"STANDARD",
"SPECIFIC"
],
"type": "string",
"example": "SPECIFIC"
}
},
"description": "Holiday type and range for part-time contracts."
},
"start_date_buffer": {
"type": "number",
"example": 5,
"description": "Calculate employee's minimum start date using the start date buffer. Today's date + (number of business days x start_date_buffer) = Minimum start date."
},
"part_time_probation": {
"type": "object",
"properties": {
"max": {
"type": "number",
"example": 60,
"description": "Maximum probation days allowed for a legally compliant contract."
},
"min": {
"type": "number",
"example": 30,
"description": "Minimum probation days required for a legally compliant contract."
}
},
"description": "Probation period range for part-time contracts."
},
"hiring_guide_country_name": {
"type": "string",
"example": "brazil",
"description": "Country name."
},
"adjustments_information_box": {
"type": "string",
"example": "Not allowed to contract people under 21.",
"description": "Country specific notes and information."
}
}
}
EorCountryValidationsContainer
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/EorCountryValidations"
}
},
"x-internal": true
}
EorEmployeeCostCalculationRequestBody
{
"type": "object",
"required": [
"salary",
"country",
"currency"
],
"properties": {
"salary": {
"type": "number",
"example": 50000,
"minimum": 1,
"description": "The gross annual salary of the employee."
},
"country": {
"type": "string",
"example": "Germany",
"description": "The country of employment."
},
"benefits": {
"type": "array",
"items": {
"type": "object",
"required": [
"provider_id"
],
"properties": {
"plan_id": {
"type": "string",
"example": "00000000-0000-0000-0000-000000000000",
"nullable": true,
"description": "The ID of a benefits plan to include in the calculation."
},
"provider_id": {
"type": "string",
"example": "00000000-0000-0000-0000-000000000000",
"description": "The ID of a benefits provider to include in the calculation."
}
}
},
"nullable": true,
"description": "Benefits which should be included in the calculation."
},
"currency": {
"type": "string",
"example": "EUR",
"description": "The currency that the salary is paid in."
}
}
}
EorEmployeeCostCalculationRequestBodyContainer
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/EorEmployeeCostCalculationRequestBody"
}
},
"x-internal": true
}
EorEmployeeCostCalculationResponse
{
"type": "object",
"properties": {
"costs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Health Insurance Estimate",
"description": "The name of the cost item."
},
"amount": {
"type": "string",
"example": 500,
"description": "The amount or price of the cost item."
},
"country": {
"type": "string",
"example": "Germany",
"description": "The country that the cost item is associated with."
},
"frequency": {
"type": "string",
"example": "Monthly",
"description": "The frequency that the cost item must be paid."
},
"country_code": {
"type": "string",
"example": "DE",
"description": "The country code for the country that the cost item is associated with."
}
}
},
"description": "The various costs associated with employment in the specified country."
},
"salary": {
"type": "string",
"example": 5000,
"description": "The gross annual salary of the employee."
},
"country": {
"type": "string",
"example": "Germany",
"description": "The country of employment."
},
"currency": {
"type": "string",
"example": "EUR",
"description": "The currency of the employee salary."
},
"deel_fee": {
"type": "string",
"example": 500,
"description": "The monthly Deel fee."
},
"frequency": {
"type": "string",
"example": "Monthly",
"description": "The frequency that the salary is paid out to the employee."
},
"total_costs": {
"type": "string",
"example": 10000,
"description": "Total monthly cost including salary, Deel fee, severance accrual and employer costs."
},
"country_code": {
"type": "string",
"example": "DE",
"description": "The country code for the country of employment."
},
"benefits_data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Healthcare",
"description": "The name of the benefit item."
},
"plan": {
"type": "string",
"description": "The name of the benefit plan."
},
"amount": {
"type": "string",
"example": 50,
"description": "The amount or price of the benefit item."
},
"fee_amount": {
"type": "string",
"example": 10,
"description": "The amount or price of the fee associated with the benefit item."
}
}
},
"description": "The various benefits costs involved in the calculation, if any."
},
"employer_costs": {
"type": "string",
"example": 1000,
"description": "Total monthly employer costs. Does not include Deel fee, salary and severance accrual."
},
"additional_data": {
"type": "object",
"properties": {
"additional_notes": {
"type": "array",
"items": {
"type": "string",
"example": "Kindly note that employment process X is mandatory for this country.",
"description": "A textual note describing important additional data regarding the employement process."
}
}
},
"description": "Textual notes describing important additional data regarding the employement process or costs."
},
"severance_accrual": {
"type": "string",
"example": 1000,
"description": "Monthly funds to cover future potential severance payments to the employee."
}
}
}
EorEmployeeCostCalculationResponseContainer
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/EorEmployeeCostCalculationResponse"
}
},
"x-internal": true
}
EorEntitlementListItem
{
"type": "object",
"properties": {
"year": {
"type": "number",
"example": 2022
},
"rollover_type": {
"$ref": "#/components/schemas/EorHolidaysRolloverType"
},
"vacation_used": {
"type": "string",
"example": "5",
"description": "Vacation days used by the employee."
},
"vacation_total": {
"type": "string",
"example": "5",
"description": "Total number of vacation days requested, approved and used."
},
"sick_leave_used": {
"type": "string",
"example": "5",
"description": "Sick days used by the employee."
},
"other_leave_used": {
"type": "string",
"example": "5",
"description": "Other type of time off days used by the employee."
},
"sick_leave_total": {
"type": "string",
"example": "5",
"description": "Total number of sick days requested, approved and used."
},
"vacation_allowed": {
"type": "string",
"example": "16",
"description": "Minimum vacation allowed."
},
"other_leave_total": {
"type": "string",
"example": "5",
"description": "Total number of other type of time off days requested, approved and used."
},
"vacation_approved": {
"type": "string",
"example": "5",
"description": "Vacation days approved."
},
"sick_leave_allowed": {
"type": "string",
"example": "16",
"description": "Maximum sick leave allowed."
},
"vacation_requested": {
"type": "string",
"example": "5",
"description": "Vacation days requested by the employee."
},
"max_rollover_yearly": {
"type": "string",
"format": "nullable",
"example": "3"
},
"sick_leave_approved": {
"type": "string",
"example": "5",
"description": "Sick days approved."
},
"other_leave_approved": {
"type": "string",
"example": "5",
"description": "Other type of time off days approved."
},
"sick_leave_requested": {
"type": "string",
"example": "5",
"description": "Sick days requested by the employee."
},
"other_leave_requested": {
"type": "string",
"example": "5",
"description": "Other type of time off requested by the employee."
}
},
"description": "Entitlement Item for a given year.",
"x-konfig-properties": {
"rollover_type": {
"example": "EXPIRATION"
}
}
}
EorEntitlements
{
"type": "object",
"required": [
"entitlements"
],
"properties": {
"entitlements": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EorEntitlementListItem"
},
"description": "List of entitlements."
}
},
"description": "Time-off Entitlements for EOR contracts."
}
EorEntitlementsContainer
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/EorEntitlements"
}
},
"x-internal": true
}
EorField
{
"type": "object",
"properties": {
"label": {
"type": "string",
"example": "Country of birth"
},
"options": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"Afghanistan (AF)",
"Canada (CA)",
"Zimbabwe (ZW)"
]
},
"input_type": {
"type": "string",
"example": "select"
},
"is_optional": {
"type": "boolean",
"example": false
},
"property_name": {
"type": "string",
"example": "countryOfBirth"
}
},
"description": "Mandatory EOR field."
}
EorHolidaysRolloverType
{
"enum": [
"EXPIRATION",
"PAY_OUT",
"UNLIMITED_ROLLOVER",
"LIMITED_ROLLOVER",
"UNSET"
],
"type": "string"
}
EorQuoteBase
{
"type": "object",
"properties": {
"currency": {
"$ref": "#/components/schemas/CurrencyCodeRequired",
"description": "Local currency"
},
"cba_total": {
"type": "number",
"example": 900,
"description": "Total CBA in local currency"
},
"created_at": {
"$ref": "#/components/schemas/DateString",
"description": "Quote creation date"
},
"updated_at": {
"$ref": "#/components/schemas/DateString",
"description": "Quote updated date"
},
"salary_total": {
"type": "number",
"example": 900,
"description": "Total salary in local currency"
},
"annual_salary": {
"type": "number",
"example": 900,
"description": "Annual Salary in local currency"
},
"cba_total_usd": {
"type": "number",
"example": 900,
"description": "Total CBA in USD"
},
"breakdown_costs": {
"$ref": "#/components/schemas/BreakdownCostsQuote",
"description": "Breakdown costs"
},
"salary_total_usd": {
"type": "number",
"example": 900,
"description": "Total salary in USD"
},
"gross_salary_total": {
"type": "number",
"example": 900,
"description": "Total gross salary in local currency"
},
"mobility_fee_total": {
"type": "number",
"example": 900,
"description": "Total mobility fee in local currency"
},
"monthly_cost_total": {
"type": "number",
"example": 900,
"description": "Total monthly cost in local currency"
},
"platform_fee_total": {
"type": "number",
"example": 900,
"description": "Total platform fee in local currency"
},
"employer_cost_total": {
"type": "number",
"example": 900,
"description": "Total employer cost in local currency"
},
"gross_salary_total_usd": {
"type": "number",
"example": 900,
"description": "Total gross salary in USD"
},
"mobility_fee_total_usd": {
"type": "number",
"example": 900,
"description": "Total mobility fee in USD"
},
"monthly_cost_total_usd": {
"type": "number",
"example": 900,
"description": "Total monthly cost in USD"
},
"platform_fee_total_usd": {
"type": "number",
"example": 900,
"description": "Total platform fee in USD"
},
"employer_cost_total_usd": {
"type": "number",
"example": 900,
"description": "Total employer cost in USD"
},
"severance_accrual_total": {
"type": "number",
"example": 900,
"description": "Total severance accrual in local currency"
},
"recurring_allowance_total": {
"type": "number",
"example": 900,
"description": "Total recurring allowance in local currency"
},
"severance_accrual_total_usd": {
"type": "number",
"example": 900,
"description": "Total severance accrual in USD"
},
"recurring_allowance_total_usd": {
"type": "number",
"example": 900,
"description": "Total recurring allowance in USD"
}
},
"description": "EOR quote approved by Deel"
}
EorQuotePayload
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/EorQuoteBase"
},
{
"type": "object",
"properties": {
"contract_id": {
"type": "string",
"description": "Contract id"
},
"country_code": {
"$ref": "#/components/schemas/CountryCode"
},
"country_name": {
"type": "string",
"example": "Argentina",
"description": "Country Name"
},
"contract_name": {
"type": "string",
"example": "My EOR Contract",
"description": "Contract name"
}
}
}
],
"description": "EOR quote approved by Deel"
}
EorTimeoffs
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EorTimeoffsBaseItem"
},
"description": "List of time offs."
}