{
  "type": "object",
  "required": [
    "type",
    "requested_at",
    "status"
  ],
  "properties": {
    "type": {
      "$ref": "#/components/schemas/TimeoffsTypeEnum"
    },
    "reason": {
      "type": "string",
      "example": "I have a doctors appointment",
      "nullable": true,
      "description": "Reason for requesting time off."
    },
    "status": {
      "$ref": "#/components/schemas/TimeoffsStatusEnum"
    },
    "reviewer": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TimeoffsProfile"
        }
      ],
      "nullable": true,
      "description": "User who reviewed the time off."
    },
    "requester": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TimeoffsProfile"
        }
      ],
      "nullable": true,
      "description": "Employee who requested the time off."
    },
    "attachments": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TimeoffsAttachments"
        }
      ],
      "nullable": true
    },
    "reviewed_at": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DateTimeString"
        }
      ],
      "example": "2022-08-25T12:09:34.695Z",
      "nullable": true,
      "description": "Timestamp when time off was reviewed."
    },
    "single_date": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DateTimeString"
        }
      ],
      "example": "2022-08-25T12:09:34.695Z",
      "nullable": true
    },
    "requested_at": {
      "$ref": "#/components/schemas/DateTimeString"
    },
    "denial_reason": {
      "type": "string",
      "example": "No time off available",
      "nullable": true,
      "description": "Reason why time off was denied."
    },
    "total_days_used": {
      "type": "string",
      "example": "4.00",
      "description": "Total number of time off days used."
    },
    "date_is_half_day": {
      "type": "boolean",
      "nullable": true,
      "description": "If true, only a single date was specified."
    },
    "days_used_end_year": {
      "type": "string",
      "example": "2.00",
      "description": "Days used at the end year."
    },
    "has_multiple_dates": {
      "type": "boolean",
      "nullable": true,
      "description": "Indicates if multiple time off days are requested."
    },
    "other_timeoff_name": {
      "type": "string",
      "example": "This is time off for a doctor's appointment",
      "nullable": true,
      "description": "Custom title for the time off. Only specify if type is \"OTHER\"."
    },
    "days_used_start_year": {
      "type": "string",
      "example": "2.00",
      "description": "Days used at the start year."
    },
    "end_date_is_half_day": {
      "type": "boolean",
      "description": "Indicates if the last day of time off is a half day."
    },
    "start_date_is_half_day": {
      "type": "boolean",
      "description": "Indicates if the first day of time off is a half day."
    }
  },
  "x-konfig-properties": {
    "type": {
      "example": "VACATION",
      "description": "The type of time off."
    },
    "status": {
      "example": "USED",
      "description": "Status of the time off request."
    },
    "requested_at": {
      "example": "2022-08-25T12:09:34.695Z",
      "description": "Timestamp when time off was requested."
    }
  }
}

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/EorTimeoffs"
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "required": [
    "id",
    "name",
    "eor_contract_id",
    "contract_id",
    "vacations",
    "sick_leaves",
    "others",
    "time_zones"
  ],
  "properties": {
    "id": {
      "$ref": "#/components/schemas/UniqueObjectIdentifier"
    },
    "name": {
      "type": "string",
      "example": "Steve Timeoff"
    },
    "others": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EorClientTimeoffRequests"
      },
      "description": "List of all other employee time offs."
    },
    "vacations": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EorClientTimeoffRequests"
      },
      "description": "List of employee vacation time offs."
    },
    "time_zones": {
      "type": "string"
    },
    "contract_id": {
      "type": "string",
      "example": "7WjJWdsJ113vocUN6Buwn"
    },
    "sick_leaves": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EorClientTimeoffRequests"
      },
      "description": "List of employee sick leave time offs."
    },
    "eor_contract_id": {
      "type": "number",
      "example": 110143
    }
  }
}

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/EorTimeoffsBaseItem"
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "properties": {
    "detail": {
      "type": "string",
      "description": "detail error message"
    },
    "status": {
      "type": "string",
      "description": "same as HTTP status code, e.g. 400, 401, etc."
    },
    "schemas": {
      "type": "array",
      "items": {
        "enum": [
          "urn:ietf:params:scim:api:messages:2.0:Error"
        ],
        "type": "string"
      }
    },
    "scimType": {
      "enum": [
        "uniqueness",
        "tooMany",
        "mutability",
        "sensitive",
        "invalidSyntax",
        "invalidFilter",
        "invalidPath",
        "invalidValue",
        "invalidVers",
        "noTarget"
      ],
      "type": "string",
      "description": "bad request type when status code is 400"
    }
  }
}

{
  "type": "object",
  "nullable": false,
  "required": [
    "start_date",
    "country_code",
    "type",
    "compensation_details"
  ],
  "properties": {
    "type": {
      "$ref": "#/components/schemas/ContractTypeEnumForEstimate"
    },
    "start_date": {
      "$ref": "#/components/schemas/DateStringRequired"
    },
    "country_code": {
      "$ref": "#/components/schemas/CountryCode"
    },
    "compensation_details": {
      "type": "object",
      "properties": {
        "scale": {
          "$ref": "#/components/schemas/WorkStatementCycleScaleEnum"
        },
        "amount": {
          "type": "number",
          "example": 2500,
          "minimum": 0,
          "nullable": false,
          "description": "Amount to be paid. Must be a positive number."
        },
        "cycle_end": {
          "type": "number",
          "maximum": 31,
          "minimum": 1,
          "description": "Date invoice cycle ends."
        },
        "currency_code": {
          "$ref": "#/components/schemas/CurrencyCodeRequired"
        },
        "work_week_end": {
          "$ref": "#/components/schemas/WeekDaysEnum"
        },
        "cycle_end_type": {
          "$ref": "#/components/schemas/WorkStatementCycleEndTypeEnum"
        },
        "work_week_start": {
          "$ref": "#/components/schemas/WeekDaysEnum"
        },
        "calculation_type": {
          "enum": [
            "CUSTOM_AMOUNT",
            "WORK_DAYS",
            "CALENDAR_DAYS",
            "FULL_AMOUNT"
          ],
          "type": "string",
          "nullable": false,
          "description": "Either works days or calendar days"
        },
        "payment_due_days": {
          "type": "number",
          "maximum": 90,
          "minimum": 0,
          "nullable": false
        },
        "payment_due_type": {
          "$ref": "#/components/schemas/WorkStatementPaymentDueTypeEnum"
        }
      }
    }
  },
  "x-internal": true,
  "description": "Details of pro rata payment to create."
}

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/EstimateFirstPayment"
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "properties": {
    "risk": {
      "type": "number"
    },
    "rates": {
      "type": "object",
      "example": {
        "USD": 1
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string",
      "description": "Unique key for the file"
    },
    "name": {
      "type": "string",
      "description": "Name of the file"
    }
  }
}

{
  "type": "object",
  "nullable": true,
  "required": [
    "filename",
    "key"
  ],
  "properties": {
    "key": {
      "type": "string",
      "nullable": false,
      "description": "You can call attachments end-point, get key and URL to upload your file."
    },
    "filename": {
      "type": "string",
      "nullable": false,
      "description": "Original filename you used to upload using attachments end-point."
    }
  },
  "x-internal": true,
  "description": "This object is used for linking file attachments to your records."
}

{
  "type": "object",
  "properties": {
    "file": {
      "type": "string",
      "format": "binary",
      "nullable": false,
      "description": "Upload the file you want to attach to this entry."
    }
  },
  "x-internal": true,
  "description": "This is the file you will upload in a multi-part form."
}

{
  "enum": [
    "application/pdf",
    "text/csv",
    "text/plain",
    "image/jpeg",
    "image/png"
  ],
  "type": "string",
  "nullable": false,
  "minLength": 5,
  "x-internal": true,
  "description": "type of files allowed when uploading attachments"
}

{
  "type": "object",
  "properties": {
    "supported": {
      "type": "boolean",
      "default": false
    },
    "maxResults": {
      "type": "integer",
      "format": "int32"
    }
  }
}

{
  "type": "object",
  "required": [
    "daily_rate",
    "total",
    "remaining_days",
    "last_cycle",
    "calculation_type",
    "workweek_start",
    "workweek_end"
  ],
  "properties": {
    "total": {
      "type": "string",
      "example": "5.8571",
      "nullable": false,
      "description": "Total amount to pay."
    },
    "daily_rate": {
      "type": "string",
      "example": "5.8571",
      "nullable": false,
      "description": "The daily rate paid."
    },
    "last_cycle": {
      "properties": {
        "end": {
          "$ref": "#/components/schemas/DateTimeStringRequired"
        },
        "start": {
          "$ref": "#/components/schemas/DateTimeStringRequired"
        },
        "completion_date": {
          "$ref": "#/components/schemas/DateTimeStringRequired"
        }
      },
      "description": "The last payment cycle."
    },
    "workweek_end": {
      "type": "number",
      "default": 5,
      "nullable": false,
      "description": "The day the work week starts, 0 to 6"
    },
    "remaining_days": {
      "type": "string",
      "example": "5.8571",
      "nullable": false,
      "description": "Dais remaining to end the contract."
    },
    "workweek_start": {
      "type": "number",
      "default": 1,
      "nullable": false,
      "description": "The day the work week starts, 0 to 6"
    },
    "calculation_type": {
      "enum": [
        "CUSTOM_AMOUNT",
        "WORK_DAYS",
        "CALENDAR_DAYS",
        "FULL_AMOUNT"
      ],
      "type": "string",
      "nullable": false,
      "description": "Either works days or calendar days"
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/FinalPaymentCalculated"
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "nullable": false,
  "properties": {
    "due": {
      "$ref": "#/components/schemas/DateStringRequired"
    }
  },
  "x-internal": true,
  "description": "First payment date"
}

{
  "type": "object",
  "required": [
    "legal_entity",
    "team"
  ],
  "properties": {
    "team": {
      "type": "object",
      "required": [
        "id"
      ],
      "properties": {
        "id": {
          "$ref": "#/components/schemas/UniqueObjectIdentifier",
          "description": "Enter the Id of the team this person will be hired in. Use /teams endpoint to retrieve a list of teams in your organization."
        }
      }
    },
    "legal_entity": {
      "type": "object",
      "required": [
        "id"
      ],
      "properties": {
        "id": {
          "$ref": "#/components/schemas/UniqueObjectIdentifier",
          "description": "Enter the Id of the legal entity under which you want to hire this person. Use /legal-entities endpoint to retrieve a list of legal entities in your organization."
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Id of the contract 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 address."
        },
        "last_name": {
          "type": "string",
          "description": "Employee's last name."
        },
        "first_name": {
          "type": "string",
          "description": "Employee's first name."
        },
        "employee_number": {
          "type": "string",
          "description": "Employee's number."
        }
      }
    },
    "job_title": {
      "type": "string",
      "example": "Designer",
      "description": "Employee's job title."
    },
    "created_at": {
      "$ref": "#/components/schemas/DateTimeString"
    },
    "employment": {
      "type": "object",
      "properties": {
        "type": {
          "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 this person will be employed."
        },
        "country": {
          "type": "string",
          "description": "Country of employment."
        },
        "end_date": {
          "$ref": "#/components/schemas/DateString",
          "description": "Employment end date in Deel."
        },
        "holidays": {
          "type": "object",
          "properties": {
            "allowance": {
              "type": "number",
              "description": "Number of holidays."
            },
            "start_date": {
              "$ref": "#/components/schemas/DateString"
            }
          }
        },
        "start_date": {
          "$ref": "#/components/schemas/DateString",
          "description": "Employment start date in Deel."
        },
        "work_visa_required": {
          "type": "boolean",
          "description": "Do you require Deel to apply for a work visa for this person?"
        }
      }
    },
    "compensation_details": {
      "type": "object",
      "properties": {
        "scale": {
          "type": "string",
          "description": "Scale at which the salary is paid."
        },
        "salary": {
          "type": "number",
          "description": "Gross annual/month salary."
        },
        "currency": {
          "type": "string",
          "description": "Currency of gross annual/month salary."
        }
      }
    }
  }
}

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/GPContractCreated"
    }
  },
  "x-internal": true
}

{
  "enum": [
    "YEAR",
    "MONTH",
    "HOUR"
  ],
  "type": "string",
  "example": "YEAR",
  "description": "The scale to which a given salary applies."
}

{
  "enum": [
    "ACTIVE",
    "UPCOMING",
    "OUTDATED"
  ],
  "type": "string",
  "example": "ACTIVE",
  "description": "The status of a salary amendment."
}

{
  "enum": [
    "Full-time",
    "Part-time"
  ],
  "type": "string",
  "description": "Is it a full-time contract or a part-time contract?"
}

{
  "type": "object",
  "required": [
    "employee",
    "employment",
    "job_title",
    "client",
    "compensation_details"
  ],
  "properties": {
    "client": {
      "$ref": "#/components/schemas/GPClient"
    },
    "employee": {
      "type": "object",
      "required": [
        "first_name",
        "last_name",
        "email",
        "address",
        "work_email"
      ],
      "properties": {
        "email": {
          "$ref": "#/components/schemas/EmailTypeRequired",
          "example": "employee@email.com",
          "description": "Employee's email address."
        },
        "address": {
          "type": "object",
          "required": [
            "street",
            "city",
            "zip",
            "country"
          ],
          "properties": {
            "zip": {
              "type": "string",
              "example": "44000",
              "description": "Zip code."
            },
            "city": {
              "type": "string",
              "example": "Denver",
              "description": "City name."
            },
            "state": {
              "type": "string",
              "example": "CO",
              "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."
        },
        "work_email": {
          "$ref": "#/components/schemas/EmailTypeRequired",
          "example": "work@email.com",
          "description": "Employee's work email address."
        },
        "nationality": {
          "type": "string",
          "example": "US",
          "description": "Employee's nationality."
        },
        "employee_number": {
          "type": "string",
          "example": "100",
          "description": "Employee's number."
        }
      }
    },
    "job_title": {
      "type": "string",
      "description": "Employee's job title."
    },
    "employment": {
      "type": "object",
      "required": [
        "type",
        "start_date",
        "holidays"
      ],
      "properties": {
        "type": {
          "$ref": "#/components/schemas/GPContractStatusTypeEnum"
        },
        "holidays": {
          "type": "object",
          "required": [
            "allowance",
            "start_date"
          ],
          "properties": {
            "allowance": {
              "type": "number",
              "description": "Enter the number of holidays."
            },
            "start_date": {
              "$ref": "#/components/schemas/DateStringRequired"
            }
          }
        },
        "start_date": {
          "$ref": "#/components/schemas/DateStringRequired",
          "description": "Employment start date in Deel."
        }
      },
      "x-konfig-properties": {}
    },
    "compensation_details": {
      "type": "object",
      "required": [
        "salary",
        "scale"
      ],
      "properties": {
        "scale": {
          "enum": [
            "YEAR",
            "MONTH"
          ],
          "type": "string",
          "default": "YEAR",
          "description": "Defines the scale at which the salary is paid."
        },
        "salary": {
          "type": "number",
          "description": "Employee's gross annual/month salary."
        },
        "currency": {
          "$ref": "#/components/schemas/CurrencyCodeRequired",
          "example": "BRL",
          "description": "Salary currency."
        }
      }
    }
  }
}

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/GPContractToCreate"
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/GPEmployeeAddressUpdateData"
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "properties": {
    "zip": {
      "type": "string",
      "example": "12345",
      "description": "Zip code."
    },
    "city": {
      "type": "string",
      "example": "London",
      "description": "City name."
    },
    "street": {
      "type": "string",
      "example": "123 Deel Street",
      "description": "Street name."
    }
  }
}

{
  "type": "object",
  "properties": {
    "zip": {
      "type": "string",
      "example": "12345",
      "description": "Zip code."
    },
    "city": {
      "type": "string",
      "example": "Denver",
      "description": "City name."
    },
    "state": {
      "type": "string",
      "example": "CO",
      "description": "State name."
    },
    "street": {
      "type": "string",
      "example": "123 Deel Street",
      "description": "Street name."
    },
    "country": {
      "$ref": "#/components/schemas/CountryCode"
    },
    "updated_at": {
      "$ref": "#/components/schemas/DateTimeStringRequired"
    }
  }
}

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/GPEmployeeAddressUpdated"
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/GPEmployeeCompensationUpdateData"
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "required": [
    "scale",
    "salary",
    "effective_date"
  ],
  "properties": {
    "scale": {
      "$ref": "#/components/schemas/GPContractSalaryScaleEnum"
    },
    "salary": {
      "type": "number",
      "example": 50000,
      "description": "Compensation salary."
    },
    "effective_date": {
      "$ref": "#/components/schemas/DateStringRequired"
    }
  }
}

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "scale": {
        "$ref": "#/components/schemas/GPContractSalaryScaleEnum"
      },
      "salary": {
        "type": "number",
        "example": 50000,
        "description": "Compensation salary."
      },
      "status": {
        "$ref": "#/components/schemas/GPContractSalaryStatusEnum"
      },
      "effective_date": {
        "$ref": "#/components/schemas/DateStringRequired"
      }
    }
  }
}

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/GPEmployeeCompensationUpdated"
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/GPEmployeeInformationUpdateData"
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "properties": {
    "gender": {
      "type": "string",
      "description": "Employee's gender."
    },
    "last_name": {
      "type": "string",
      "example": "Doe",
      "description": "Last name of the employee."
    },
    "first_name": {
      "type": "string",
      "example": "Jane",
      "description": "First name of the employee."
    },
    "middle_name": {
      "type": "string",
      "example": "Jay",
      "description": "Middle name of the employee."
    },
    "date_of_birth": {
      "$ref": "#/components/schemas/DateString"
    },
    "marital_status": {
      "$ref": "#/components/schemas/MaritalStatusEnum",
      "example": "Single"
    },
    "employee_number": {
      "type": "string",
      "description": "Employee's number."
    }
  }
}

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/GPEmployeeInformationUpdateData"
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/GPEmployeePTOUpdateData"
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "required": [
    "accrual_start_date",
    "yearly_allowance"
  ],
  "properties": {
    "yearly_allowance": {
      "type": "string",
      "example": "15",
      "description": "Enter the number of holidays."
    },
    "accrual_start_date": {
      "$ref": "#/components/schemas/DateStringRequired",
      "description": "Date when the employee starts to accrue PTO."
    }
  }
}

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/GPPayrollEventReports"
    }
  },
  "x-internal": true
}

{
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "id",
      "status",
      "start_date",
      "end_date",
      "lock_date"
    ],
    "properties": {
      "id": {
        "type": "string",
        "example": "clqmd5qb07xwevi01cd5kb6kw"
      },
      "status": {
        "type": "string",
        "example": "OPEN"
      },
      "end_date": {
        "$ref": "#/components/schemas/DateTimeStringRequired"
      },
      "lock_date": {
        "$ref": "#/components/schemas/DateTimeStringRequired"
      },
      "start_date": {
        "$ref": "#/components/schemas/DateTimeStringRequired"
      }
    }
  }
}

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/PayslipDownloadUrl"
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Payslips"
      }
    }
  }
}

{
  "type": "object",
  "required": [
    "status",
    "id"
  ],
  "properties": {
    "id": {
      "$ref": "#/components/schemas/UniqueObjectIdentifier"
    },
    "status": {
      "$ref": "#/components/schemas/InvoiceAdjustmentStatusEnum"
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/GenericReportReviewCreatedList"
    }
  },
  "x-internal": true
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/GenericReportReviewCreated"
  },
  "x-internal": true
}

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "created"
      ],
      "properties": {
        "created": {
          "type": "boolean"
        }
      }
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "created"
      ],
      "properties": {
        "id": {
          "$ref": "#/components/schemas/UniqueObjectIdentifier"
        },
        "created": {
          "type": "boolean"
        }
      }
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "deleted"
      ],
      "properties": {
        "deleted": {
          "type": "boolean",
          "nullable": false,
          "description": "Confirms the deletion."
        }
      }
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "updated"
      ],
      "properties": {
        "updated": {
          "type": "boolean"
        }
      }
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "url": {
          "type": "string",
          "example": "https://s3URL/letsdeel.com/contract_requirement_templates/12345.pdf",
          "description": "The URL for the requested compliance document template."
        },
        "expires_at": {
          "type": "string",
          "format": "date-time",
          "example": "2020-03-31T10:58:49.780Z",
          "description": "Expiration date time of download URL."
        }
      }
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "documents"
      ],
      "properties": {
        "documents": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "$ref": "#/components/schemas/UniqueObjectIdentifier",
                "description": "The unique identifier of the document."
              },
              "name": {
                "type": "string",
                "example": "Example Document",
                "description": "The name of the document."
              },
              "country": {
                "type": "string",
                "example": "GB",
                "description": "The country associated with this document."
              },
              "fillable": {
                "type": "boolean",
                "example": false,
                "description": "Denotes if the document is available to fill out on Deel."
              },
              "filenames": {
                "type": "array",
                "items": {
                  "type": "string",
                  "example": "myComplianceDocument.pdf",
                  "description": "A file name for an uploaded document."
                },
                "description": "The list of filenames for the associated uploaded documents."
              },
              "description": {
                "type": "string",
                "example": "This document is needed for tax purposes.",
                "description": "A short description of the document."
              },
              "is_optional": {
                "type": "boolean",
                "example": false,
                "description": "Denotes if the document is optional or required."
              },
              "uploaded_at": {
                "type": "string",
                "example": "2023-01-01T12:00:00.000Z",
                "description": "The timestamp when this document was uploaded / supplied to Deel."
              },
              "has_template": {
                "type": "boolean",
                "example": true,
                "description": "Denotes if this document has a template available for download"
              }
            }
          }
        }
      }
    }
  },
  "x-internal": true
}