{
  "type": "object",
  "title": "ExpenseResponse",
  "example": {
    "data": {
      "expense": {
        "title": "New desk",
        "amount": 1000,
        "currency": {
          "code": "CZK",
          "name": "Czech Koruna",
          "symbol": "Kč"
        },
        "receipts": [
          {
            "id": "9880b711-file-id-ecf8f551bd78X",
            "name": "id.pdf",
            "type": "id",
            "sub_type": "personal_id",
            "inserted_at": "2021-11-12T17:19:21"
          }
        ],
        "tax_amount": 500,
        "expense_date": "2021-09-03",
        "employment_id": "ba9ead59-e471-4043-a7ea-07dbb105e72c",
        "converted_amount": 1000,
        "converted_currency": {
          "code": "CZK",
          "name": "Czech Koruna",
          "symbol": "Kč"
        },
        "converted_tax_amount": 500
      }
    }
  },
  "required": [
    "data"
  ],
  "x-struct": null,
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "expense"
      ],
      "x-struct": null,
      "properties": {
        "expense": {
          "$ref": "#/components/schemas/Expense"
        }
      },
      "x-validate": null
    }
  },
  "x-validate": null,
  "description": "Expense response"
}

{
  "type": "object",
  "title": "File",
  "example": {
    "id": "9880b711-file-id-ecf8f551bd78",
    "name": "id.pdf",
    "type": "id",
    "sub_type": "personal_id",
    "inserted_at": "2021-11-12T17:19:21"
  },
  "required": [
    "id",
    "inserted_at",
    "name",
    "type"
  ],
  "x-struct": null,
  "properties": {
    "id": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "name": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "type": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "sub_type": {
      "type": "string",
      "nullable": true,
      "x-struct": null,
      "x-validate": null
    },
    "inserted_at": {
      "type": "string",
      "format": "date-time",
      "x-struct": null,
      "x-validate": null
    }
  },
  "x-validate": null,
  "description": "A supported file"
}

{
  "type": "object",
  "title": "FileParams",
  "required": [
    "file",
    "type",
    "employment_id"
  ],
  "x-struct": null,
  "properties": {
    "file": {
      "type": "string",
      "format": "binary",
      "x-struct": null,
      "x-validate": null
    },
    "type": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "employment_id": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    }
  },
  "x-validate": null,
  "description": "Parameters to upload a file"
}

{
  "type": "object",
  "title": "FileResponse",
  "example": {
    "data": {
      "file": {
        "id": "9880b711-file-id-ecf8f551bd78X",
        "name": "id.pdf",
        "type": "id",
        "sub_type": "personal_id",
        "inserted_at": "2021-11-12T17:19:21"
      }
    }
  },
  "x-struct": null,
  "properties": {
    "file": {
      "$ref": "#/components/schemas/File"
    }
  },
  "x-validate": null,
  "description": "A supported file"
}

{
  "type": "object",
  "title": "ForbiddenResponse",
  "example": {
    "message": "Forbidden"
  },
  "required": [
    "message"
  ],
  "x-struct": null,
  "properties": {
    "message": {
      "type": "string",
      "pattern": "Forbidden",
      "x-struct": null,
      "x-validate": null
    }
  },
  "x-validate": null
}

{
  "type": "object",
  "title": "FullParams",
  "x-struct": null,
  "properties": {
    "country": {
      "$ref": "#/components/schemas/Country"
    },
    "full_name": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "job_title": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "company_id": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "manager_id": {
      "type": "string",
      "x-struct": null,
      "x-validate": null,
      "description": "The user id of the manager, who should have an `admin`, `owner` or `people_manager` role.\nYou can find these users by querying the [Company Managers endpoint](https://gateway.remote.com/v1/docs/openapi.html).\n**Update of this field is only available for active employments.**\n"
    },
    "department_id": {
      "type": "string",
      "x-struct": null,
      "x-validate": null,
      "description": "The department of the employment. The department must belong to the same company as the employment.\n"
    },
    "address_details": {
      "type": "object",
      "x-struct": null,
      "x-validate": null,
      "description": "Home address information. As its properties may vary depending on the country,\n               you must query the [Show form schema](https://gateway.remote.com/v1/docs/openapi.html) endpoint\n            passing the country code and `address_details` as path parameters."
    },
    "contract_details": {
      "type": "object",
      "x-struct": null,
      "x-validate": null,
      "description": "Contract information. As its properties may vary depending on the country,\n               you must query the [Show form schema](https://gateway.remote.com/v1/docs/openapi.html) endpoint\n            passing the country code and `contract_details` as path parameters."
    },
    "personal_details": {
      "type": "object",
      "x-struct": null,
      "x-validate": null,
      "description": "Personal details information. As its properties may vary depending on the country,\n               you must query the [Show form schema](https://gateway.remote.com/v1/docs/openapi.html) endpoint\n            passing the country code and `personal_details` as path parameters."
    },
    "basic_information": {
      "type": "object",
      "x-struct": null,
      "x-validate": null,
      "description": "Employment basic information. As its properties may vary depending on the country,\n               you must query the [Show form schema](https://gateway.remote.com/v1/docs/openapi.html) endpoint\n            passing the country code and `employment_basic_information` as path parameters."
    },
    "bank_account_details": {
      "type": "object",
      "x-struct": null,
      "x-validate": null,
      "description": "Bank account information. As its properties may vary depending on the country,\n               you must query the [Show form schema](https://gateway.remote.com/v1/docs/openapi.html) endpoint\n            passing the country code and `bank_account_details` as path parameters."
    },
    "pricing_plan_details": {
      "$ref": "#/components/schemas/PricingPlanDetails"
    },
    "administrative_details": {
      "type": "object",
      "x-struct": null,
      "x-validate": null,
      "description": "Administrative information. As its properties may vary depending on the country,\n               you must query the [Show form schema](https://gateway.remote.com/v1/docs/openapi.html) endpoint\n            passing the country code and `administrative_details` as path parameters."
    },
    "billing_address_details": {
      "type": "object",
      "x-struct": null,
      "x-validate": null,
      "description": "Billing address information. As its properties may vary depending on the country,\n               you must query the [Show form schema](https://gateway.remote.com/v1/docs/openapi.html) endpoint\n            passing the country code and `billing_address_details` as path parameters."
    },
    "emergency_contact_details": {
      "type": "object",
      "x-struct": null,
      "x-validate": null,
      "description": "Emergency contact information. As its properties may vary depending on the country,\n               you must query the [Show form schema](https://gateway.remote.com/v1/docs/openapi.html) endpoint\n            passing the country code and `emergency_contact_details` as path parameters."
    }
  },
  "x-validate": null
}

{
  "type": "object",
  "title": "FullParams-Deprecated",
  "x-struct": null,
  "properties": {
    "country": {
      "$ref": "#/components/schemas/Country"
    },
    "full_name": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "job_title": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "company_id": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "manager_id": {
      "type": "string",
      "x-struct": null,
      "x-validate": null,
      "description": "The user id of the manager, who should have an `admin`, `owner` or `people_manager` role.\nYou can find these users by querying the [Company Managers endpoint](https://gateway.remote.com/v1/docs/openapi.html).\n**Update of this field is only available for active employments.**\n"
    },
    "personal_email": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "seniority_date": {
      "$ref": "#/components/schemas/EmploymentSeniorityDate"
    },
    "address_details": {
      "type": "object",
      "x-struct": null,
      "x-validate": null,
      "description": "Home address information. As its properties may vary depending on the country,\n               you must query the [Show form schema](https://gateway.remote.com/v1/docs/openapi.html) endpoint\n            passing the country code and `address_details` as path parameters."
    },
    "contract_details": {
      "type": "object",
      "x-struct": null,
      "x-validate": null,
      "description": "Contract information. As its properties may vary depending on the country,\n               you must query the [Show form schema](https://gateway.remote.com/v1/docs/openapi.html) endpoint\n            passing the country code and `contract_details` as path parameters."
    },
    "personal_details": {
      "type": "object",
      "x-struct": null,
      "x-validate": null,
      "description": "Personal details information. As its properties may vary depending on the country,\n               you must query the [Show form schema](https://gateway.remote.com/v1/docs/openapi.html) endpoint\n            passing the country code and `personal_details` as path parameters."
    },
    "bank_account_details": {
      "type": "object",
      "x-struct": null,
      "x-validate": null,
      "description": "Bank account information. As its properties may vary depending on the country,\n               you must query the [Show form schema](https://gateway.remote.com/v1/docs/openapi.html) endpoint\n            passing the country code and `bank_account_details` as path parameters."
    },
    "pricing_plan_details": {
      "$ref": "#/components/schemas/PricingPlanDetails"
    },
    "administrative_details": {
      "type": "object",
      "x-struct": null,
      "x-validate": null,
      "description": "Administrative information. As its properties may vary depending on the country,\n               you must query the [Show form schema](https://gateway.remote.com/v1/docs/openapi.html) endpoint\n            passing the country code and `administrative_details` as path parameters."
    },
    "provisional_start_date": {
      "$ref": "#/components/schemas/ProvisionalStartDate"
    },
    "billing_address_details": {
      "type": "object",
      "x-struct": null,
      "x-validate": null,
      "description": "Billing address information. As its properties may vary depending on the country,\n               you must query the [Show form schema](https://gateway.remote.com/v1/docs/openapi.html) endpoint\n            passing the country code and `billing_address_details` as path parameters."
    },
    "emergency_contact_details": {
      "type": "object",
      "x-struct": null,
      "x-validate": null,
      "description": "Emergency contact information. As its properties may vary depending on the country,\n               you must query the [Show form schema](https://gateway.remote.com/v1/docs/openapi.html) endpoint\n            passing the country code and `emergency_contact_details` as path parameters."
    }
  },
  "x-validate": null,
  "description": "Providing the params in the root level of the request is now deprecated and will be removed in the future.\nPlease, use the \"FullParams\" instead.\n"
}

{
  "type": "string",
  "title": "GenericFile",
  "format": "binary",
  "x-struct": null,
  "x-validate": null
}

{
  "type": "object",
  "title": "Holiday",
  "example": {
    "day": "2021-01-01",
    "name": "New Year's Day",
    "note": "The day after New Year's Eve",
    "observed_day": "2021-01-02"
  },
  "required": [
    "name",
    "day"
  ],
  "x-struct": null,
  "properties": {
    "day": {
      "type": "string",
      "format": "date",
      "x-struct": null,
      "x-validate": null,
      "description": "Date of the holiday"
    },
    "name": {
      "type": "string",
      "x-struct": null,
      "x-validate": null,
      "description": "Name of the holiday"
    },
    "note": {
      "type": "string",
      "nullable": true,
      "x-struct": null,
      "x-validate": null,
      "description": "Notes about the holiday"
    },
    "observed_day": {
      "type": "string",
      "format": "date",
      "nullable": true,
      "x-struct": null,
      "x-validate": null,
      "description": "Date when the holiday is observed"
    }
  },
  "x-validate": null
}

{
  "type": "object",
  "title": "HolidaysResponse",
  "example": {
    "data": [
      {
        "day": "2021-01-01",
        "name": "New Year's Day",
        "note": "The day after New Year's Eve",
        "observed_day": "2021-01-02"
      }
    ]
  },
  "x-struct": null,
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Holiday"
      },
      "x-struct": null,
      "x-validate": null
    }
  },
  "x-validate": null,
  "description": "Holidays response"
}

{
  "type": "object",
  "title": "IdentityClientCredentialsResponse",
  "example": {
    "data": {
      "client_id": "1pws9iw986yq1ec57h159q29l",
      "integration": {
        "name": "integration_partner",
        "display_name": "Integration Display Name",
        "contact_email": "partner_admin@example.com"
      }
    }
  },
  "required": [
    "data"
  ],
  "x-struct": null,
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "client_id",
        "integration"
      ],
      "x-struct": null,
      "properties": {
        "client_id": {
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "integration": {
          "$ref": "#/components/schemas/IdentityIntegration"
        }
      },
      "x-validate": null
    }
  },
  "x-validate": null
}

{
  "type": "object",
  "title": "IdentityCompany",
  "example": {
    "id": "afe4dc8d-0c4a-41fe-9fbf-62b752524bdeX",
    "name": "Company"
  },
  "required": [
    "name",
    "id"
  ],
  "x-struct": null,
  "properties": {
    "id": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "name": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    }
  },
  "x-validate": null
}

{
  "type": "object",
  "title": "IdentityCompanyAccessTokenResponse",
  "example": {
    "data": {
      "user": {
        "id": "4117f18a-5ccf-473a-b970-608b75f5fafb",
        "name": "Jane Smith",
        "email": "email@example.com",
        "status": "created"
      },
      "company": {
        "id": "afe4dc8d-0c4a-41fe-9fbf-62b752524bde",
        "name": "Company"
      },
      "client_id": "1pws9iw986yq1ec57h159q29l",
      "integration": {
        "name": "integration_partner",
        "display_name": "Integration Display Name",
        "contact_email": "partner_admin@example.com"
      }
    }
  },
  "required": [
    "data"
  ],
  "x-struct": null,
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "client_id",
        "company",
        "integration",
        "user"
      ],
      "x-struct": null,
      "properties": {
        "user": {
          "$ref": "#/components/schemas/IdentityUser"
        },
        "company": {
          "$ref": "#/components/schemas/IdentityCompany"
        },
        "client_id": {
          "type": "string",
          "x-struct": null,
          "x-validate": null
        },
        "integration": {
          "$ref": "#/components/schemas/IdentityIntegration"
        }
      },
      "x-validate": null
    }
  },
  "x-validate": null
}

{
  "type": "object",
  "oneOf": [
    {
      "$ref": "#/components/schemas/IdentityClientCredentialsResponse"
    },
    {
      "$ref": "#/components/schemas/IdentityCompanyAccessTokenResponse"
    },
    {
      "$ref": "#/components/schemas/IdentityCustomerAccessTokenResponse"
    }
  ],
  "title": "IdentityCurrentResponse",
  "x-struct": null,
  "x-validate": null
}

{
  "type": "object",
  "title": "IdentityCustomerAccessTokenResponse",
  "example": {
    "data": {
      "user": {
        "id": "4117f18a-5ccf-473a-b970-608b75f5fafbX",
        "name": "Jane Smith",
        "email": "email@example.com",
        "status": "created"
      },
      "company": {
        "id": "afe4dc8d-0c4a-41fe-9fbf-62b752524bdeX",
        "name": "Company"
      }
    }
  },
  "required": [
    "data"
  ],
  "x-struct": null,
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "company",
        "user"
      ],
      "x-struct": null,
      "properties": {
        "user": {
          "$ref": "#/components/schemas/IdentityUser"
        },
        "company": {
          "$ref": "#/components/schemas/IdentityCompany"
        }
      },
      "x-validate": null
    }
  },
  "x-validate": null
}

{
  "type": "object",
  "title": "IdentityIntegration",
  "example": {
    "name": "integration_partner",
    "display_name": "Integration Display Name",
    "contact_email": "partner_admin@example.com"
  },
  "required": [
    "contact_email",
    "display_name",
    "name"
  ],
  "x-struct": null,
  "properties": {
    "name": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "display_name": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "contact_email": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    }
  },
  "x-validate": null
}

{
  "type": "object",
  "title": "IdentityUser",
  "example": {
    "id": "4117f18a-5ccf-473a-b970-608b75f5fafbX",
    "name": "Jane Smith",
    "email": "email@example.com",
    "status": "created"
  },
  "required": [
    "email",
    "name",
    "id",
    "status"
  ],
  "x-struct": null,
  "properties": {
    "id": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "name": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "email": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "status": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    }
  },
  "x-validate": null
}

{
  "type": "object",
  "title": "IdentityVerificationResponse",
  "x-struct": null,
  "properties": {
    "data": {
      "type": "object",
      "x-struct": null,
      "properties": {},
      "x-validate": null
    }
  },
  "x-validate": null,
  "description": "Identity Verification response"
}

{
  "type": "object",
  "title": "Incentive",
  "example": {
    "id": "0073fcb5-b669-4e4a-b963-2a47744e75a1X",
    "note": "Signing bonus",
    "type": "signing_bonus",
    "amount": 50000,
    "status": "pending",
    "employment_id": "5e55386e-4f4f-4def-92f4-bdc19a5ce77d",
    "effective_date": "2021-12-20",
    "amount_tax_type": "net",
    "expected_payout_date": "2021-12-31",
    "recurring_incentive_id": "1c130827-f95c-4495-b7cb-5876dce686b8"
  },
  "required": [
    "id",
    "employment_id",
    "type",
    "status",
    "amount",
    "amount_tax_type",
    "effective_date"
  ],
  "x-struct": null,
  "properties": {
    "id": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "note": {
      "type": "string",
      "nullable": true,
      "x-struct": null,
      "x-validate": null
    },
    "type": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "amount": {
      "type": "integer",
      "x-struct": null,
      "x-validate": null
    },
    "status": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "employment_id": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "effective_date": {
      "type": "string",
      "format": "date",
      "nullable": true,
      "x-struct": null,
      "x-validate": null
    },
    "amount_tax_type": {
      "$ref": "#/components/schemas/AmountTaxType"
    },
    "expected_payout_date": {
      "type": "string",
      "format": "date",
      "nullable": true,
      "x-struct": null,
      "x-validate": null
    },
    "recurring_incentive_id": {
      "type": "string",
      "nullable": true,
      "x-struct": null,
      "x-validate": null
    }
  },
  "x-validate": null
}

{
  "type": "object",
  "title": "IncentiveResponse",
  "x-struct": null,
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "incentive"
      ],
      "x-struct": null,
      "properties": {
        "incentive": {
          "$ref": "#/components/schemas/Incentive"
        }
      },
      "x-validate": null
    }
  },
  "x-validate": null,
  "description": "Incentive response"
}

{
  "type": "object",
  "anyOf": [
    {
      "$ref": "#/components/schemas/ValidationError"
    },
    {
      "$ref": "#/components/schemas/MessageResponse"
    }
  ],
  "title": "InternalServerErrorResponse",
  "x-struct": null,
  "x-validate": null
}

{
  "type": "object",
  "title": "JSONSchema",
  "example": {
    "schema": {
      "type": "object",
      "required": [
        "ssn"
      ],
      "properties": {
        "ssn": {
          "type": "string",
          "title": "Social security number",
          "pattern": "^[0-9]{3}-[0-9]{2}-(?!0{4})[0-9]{4}$",
          "x-jsf-presentation": {
            "mask": "999-99-9999",
            "inputType": "text",
            "maskSecret": 4,
            "maskPlaceholder": "AAA-GG-SSSS"
          }
        }
      },
      "x-jsf-order": [
        "ssn"
      ]
    },
    "version": 7
  },
  "x-struct": null,
  "properties": {
    "schema": {
      "type": "object",
      "required": [
        "properties"
      ],
      "x-struct": null,
      "properties": {
        "required": {
          "type": "array",
          "items": {
            "type": "string",
            "x-struct": null,
            "x-validate": null
          },
          "x-struct": null,
          "x-validate": null
        },
        "properties": {
          "type": "object",
          "x-struct": null,
          "x-validate": null,
          "additionalProperties": true
        },
        "x-jsf-order": {
          "type": "array",
          "items": {
            "type": "string",
            "x-struct": null,
            "x-validate": null
          },
          "x-struct": null,
          "x-validate": null
        }
      },
      "x-validate": null
    },
    "version": {
      "type": "integer",
      "x-struct": null,
      "x-validate": null
    }
  },
  "x-validate": null,
  "description": "JSON Schema"
}

{
  "type": "object",
  "title": "JSONSchemaResponse",
  "example": {
    "data": {
      "schema": {
        "type": "object",
        "required": [
          "ssn"
        ],
        "properties": {
          "ssn": {
            "type": "string",
            "title": "Social security number",
            "pattern": "^[0-9]{3}-[0-9]{2}-(?!0{4})[0-9]{4}$",
            "x-jsf-presentation": {
              "mask": "999-99-9999",
              "inputType": "text",
              "maskSecret": 4,
              "maskPlaceholder": "AAA-GG-SSSS"
            }
          }
        },
        "x-jsf-order": [
          "ssn"
        ]
      },
      "version": 7
    }
  },
  "x-struct": null,
  "properties": {
    "data": {
      "$ref": "#/components/schemas/JSONSchema"
    }
  },
  "x-validate": null,
  "description": "JSON Schema Response"
}

{
  "type": "object",
  "title": "ListCompanyDepartmentsPaginatedResponse",
  "example": {
    "data": {
      "company_departments": [
        {
          "id": "89c4fbb2-cd1f-4334-8e4b-280f8795bbd8",
          "name": "Marketing",
          "company_id": "669f9e18-889f-4c2c-95b8-67795a3113cc"
        }
      ]
    },
    "total_count": 1,
    "total_pages": 1,
    "current_page": 1
  },
  "required": [
    "data",
    "current_page",
    "total_pages",
    "total_count"
  ],
  "x-struct": null,
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "company_departments"
      ],
      "x-struct": null,
      "properties": {
        "company_departments": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/CompanyDepartment"
          },
          "x-struct": null,
          "x-validate": null
        }
      },
      "x-validate": null
    },
    "total_count": {
      "type": "integer",
      "x-struct": null,
      "x-validate": null
    },
    "total_pages": {
      "type": "integer",
      "x-struct": null,
      "x-validate": null
    },
    "current_page": {
      "type": "integer",
      "x-struct": null,
      "x-validate": null
    }
  },
  "x-validate": null
}

{
  "type": "object",
  "title": "ListContractAmendmentResponse",
  "example": {
    "total_count": 1,
    "total_pages": 1,
    "current_page": 1,
    "contract_amendments": [
      {
        "id": "ba310525-9282-40c9-8977-14d844bf891aX",
        "status": "submitted",
        "job_title": "Engineer",
        "requested_by": "5a31f3c1-d7a7-4311-89cb-928959d3d540",
        "submitted_at": "2023-04-13T13:35:06Z",
        "employment_id": "1e74fdc2-7420-4eef-ab0a-b794cbbef4e1",
        "reason_for_change": "annual_pay_adjustment",
        "requested_effective_date": "2023-04-13T13:35:06Z"
      }
    ]
  },
  "x-struct": null,
  "properties": {
    "data": {
      "type": "object",
      "x-struct": null,
      "properties": {
        "total_count": {
          "type": "integer",
          "x-struct": null,
          "x-validate": null,
          "description": "The total number of records in the result"
        },
        "total_pages": {
          "type": "integer",
          "x-struct": null,
          "x-validate": null,
          "description": "The total number of pages the user can go through"
        },
        "current_page": {
          "type": "integer",
          "x-struct": null,
          "x-validate": null,
          "description": "The current page among all of the total_pages"
        },
        "contract_amendments": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/MinimalContractAmendment"
          },
          "x-struct": null,
          "x-validate": null
        }
      },
      "x-validate": null
    }
  },
  "x-validate": null,
  "description": "Response schema listing many contract_amendments"
}

{
  "type": "object",
  "title": "ListEmploymentContractResponse",
  "example": {
    "data": {
      "employment_contracts": [
        {
          "status": "active",
          "country": {
            "code": "CAN",
            "name": "Canada"
          },
          "job_title": "Engineer",
          "contract_id": "20a72f86-contract-id-9e4942a902ff",
          "activated_at": "2021-07-15T18:18:17Z",
          "compensation": {
            "amount": 33000,
            "currency_code": "CAD"
          },
          "effective_at": "2021-07-15T18:18:17Z",
          "contract_details": {},
          "amendment_contract_id": "e31adae1-contract-id-af5fba7dd803"
        }
      ]
    }
  },
  "required": [
    "data"
  ],
  "x-struct": null,
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "employment_contracts"
      ],
      "x-struct": null,
      "properties": {
        "employment_contracts": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/EmploymentContract"
          },
          "x-struct": null,
          "x-validate": null
        }
      },
      "x-validate": null
    }
  },
  "x-validate": null
}

{
  "type": "object",
  "title": "ListEmploymentCustomFieldsResponse",
  "example": {
    "total_count": 1,
    "total_pages": 1,
    "current_page": 1,
    "custom_fields": [
      {
        "id": "01c0e4d2-f41b-11ed-9d3f-cb3ecccebb58",
        "name": "Internal ID",
        "type": "string"
      }
    ]
  },
  "x-struct": null,
  "properties": {
    "data": {
      "type": "object",
      "x-struct": null,
      "properties": {
        "total_count": {
          "type": "integer",
          "x-struct": null,
          "x-validate": null,
          "description": "The total number of records in the result"
        },
        "total_pages": {
          "type": "integer",
          "x-struct": null,
          "x-validate": null,
          "description": "The total number of pages the user can go through"
        },
        "current_page": {
          "type": "integer",
          "x-struct": null,
          "x-validate": null,
          "description": "The current page among all of the total_pages"
        },
        "custom_fields": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/EmploymentCustomField"
          },
          "x-struct": null,
          "x-validate": null
        }
      },
      "x-validate": null
    }
  },
  "x-validate": null,
  "description": "Response schema listing many custom_fields"
}

{
  "type": "object",
  "title": "ListEmploymentsResponse",
  "example": {
    "employments": [
      {
        "id": "add736b8-employment-id-a76ccae2abe8",
        "type": "employee",
        "status": "created",
        "country": {
          "code": "AUS",
          "name": "Australia"
        },
        "full_name": "Jane Smith",
        "job_title": "Engineer",
        "department": null,
        "department_id": null,
        "personal_email": "janesmith@company.com"
      }
    ],
    "total_count": 1,
    "total_pages": 1,
    "current_page": 1
  },
  "x-struct": null,
  "properties": {
    "data": {
      "type": "object",
      "x-struct": null,
      "properties": {
        "employments": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/MinimalEmployment"
          },
          "x-struct": null,
          "x-validate": null
        },
        "total_count": {
          "type": "integer",
          "x-struct": null,
          "x-validate": null,
          "description": "The total number of records in the result"
        },
        "total_pages": {
          "type": "integer",
          "x-struct": null,
          "x-validate": null,
          "description": "The total number of pages the user can go through"
        },
        "current_page": {
          "type": "integer",
          "x-struct": null,
          "x-validate": null,
          "description": "The current page among all of the total_pages"
        }
      },
      "x-validate": null
    }
  },
  "x-validate": null,
  "description": "Response schema listing many employments"
}

{
  "type": "object",
  "title": "ListExpenseResponse",
  "example": {
    "expenses": [
      {
        "title": "New desk",
        "amount": 1000,
        "currency": {
          "code": "CZK",
          "name": "Czech Koruna",
          "symbol": "Kč"
        },
        "receipts": [
          {
            "id": "9880b711-file-id-ecf8f551bd78X",
            "name": "id.pdf",
            "type": "id",
            "sub_type": "personal_id",
            "inserted_at": "2021-11-12T17:19:21"
          }
        ],
        "tax_amount": 500,
        "expense_date": "2021-09-03",
        "employment_id": "ba9ead59-e471-4043-a7ea-07dbb105e72c",
        "converted_amount": 1000,
        "converted_currency": {
          "code": "CZK",
          "name": "Czech Koruna",
          "symbol": "Kč"
        },
        "converted_tax_amount": 500
      }
    ],
    "total_count": 1,
    "total_pages": 1,
    "current_page": 1
  },
  "x-struct": null,
  "properties": {
    "data": {
      "type": "object",
      "x-struct": null,
      "properties": {
        "expenses": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/Expense"
          },
          "x-struct": null,
          "x-validate": null
        },
        "total_count": {
          "type": "integer",
          "x-struct": null,
          "x-validate": null,
          "description": "The total number of records in the result"
        },
        "total_pages": {
          "type": "integer",
          "x-struct": null,
          "x-validate": null,
          "description": "The total number of pages the user can go through"
        },
        "current_page": {
          "type": "integer",
          "x-struct": null,
          "x-validate": null,
          "description": "The current page among all of the total_pages"
        }
      },
      "x-validate": null
    }
  },
  "x-validate": null,
  "description": "Response schema listing many expenses"
}

{
  "type": "object",
  "title": "ListIncentivesResponse",
  "example": {
    "incentives": [
      {
        "id": "0073fcb5-b669-4e4a-b963-2a47744e75a1X",
        "note": "Signing bonus",
        "type": "signing_bonus",
        "amount": 50000,
        "status": "pending",
        "employment_id": "5e55386e-4f4f-4def-92f4-bdc19a5ce77d",
        "effective_date": "2021-12-20",
        "amount_tax_type": "net",
        "expected_payout_date": "2021-12-31",
        "recurring_incentive_id": "1c130827-f95c-4495-b7cb-5876dce686b8"
      }
    ],
    "total_count": 1,
    "total_pages": 1,
    "current_page": 1
  },
  "x-struct": null,
  "properties": {
    "data": {
      "type": "object",
      "x-struct": null,
      "properties": {
        "incentives": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/Incentive"
          },
          "x-struct": null,
          "x-validate": null
        },
        "total_count": {
          "type": "integer",
          "x-struct": null,
          "x-validate": null,
          "description": "The total number of records in the result"
        },
        "total_pages": {
          "type": "integer",
          "x-struct": null,
          "x-validate": null,
          "description": "The total number of pages the user can go through"
        },
        "current_page": {
          "type": "integer",
          "x-struct": null,
          "x-validate": null,
          "description": "The current page among all of the total_pages"
        }
      },
      "x-validate": null
    }
  },
  "x-validate": null,
  "description": "Response schema listing many incentives"
}

{
  "type": "object",
  "title": "ListOffboardingResponse",
  "example": {
    "total_count": 1,
    "total_pages": 1,
    "current_page": 1,
    "offboardings": [
      {
        "id": "ba310525-9282-40c9-8977-14d844bf891aX",
        "type": "termination",
        "status": "submitted",
        "confidential": false,
        "requested_by": "5a31f3c1-d7a7-4311-89cb-928959d3d540",
        "submitted_at": "2023-04-13T13:35:06Z",
        "employment_id": "1e74fdc2-7420-4eef-ab0a-b794cbbef4e1",
        "termination_date": "2023-12-20",
        "employee_awareness": {
          "date": "2023-12-12",
          "note": "optional text to add details"
        },
        "termination_reason": "workforce_reduction",
        "additional_comments": "",
        "agrees_to_pto_amount": "true",
        "risk_assessment_reasons": [
          "pregnant_or_breastfeeding",
          "family_leave"
        ],
        "proposed_termination_date": "2023-12-20",
        "will_challenge_termination": true,
        "will_challenge_termination_description": "additional details for the offboarding risk assessment"
      }
    ]
  },
  "x-struct": null,
  "properties": {
    "data": {
      "type": "object",
      "x-struct": null,
      "properties": {
        "total_count": {
          "type": "integer",
          "x-struct": null,
          "x-validate": null,
          "description": "The total number of records in the result"
        },
        "total_pages": {
          "type": "integer",
          "x-struct": null,
          "x-validate": null,
          "description": "The total number of pages the user can go through"
        },
        "current_page": {
          "type": "integer",
          "x-struct": null,
          "x-validate": null,
          "description": "The current page among all of the total_pages"
        },
        "offboardings": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/Offboarding"
          },
          "x-struct": null,
          "x-validate": null
        }
      },
      "x-validate": null
    }
  },
  "x-validate": null,
  "description": "Response schema listing many offboardings"
}

{
  "type": "object",
  "title": "ListPayslipsResponse",
  "example": {
    "payslips": [
      {
        "id": "93t3j-employment-id-9suej43X",
        "issued_at": "2021-07-01",
        "employment_id": "98d3f-employment-id-1oi45n",
        "expected_payout_date": "2021-07-01",
        "net_pay_source_amount": 1000000,
        "net_pay_converted_amount": 1500000
      }
    ],
    "total_count": 1,
    "total_pages": 1,
    "current_page": 1
  },
  "x-struct": null,
  "properties": {
    "data": {
      "type": "object",
      "x-struct": null,
      "properties": {
        "payslips": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/Payslip"
          },
          "x-struct": null,
          "x-validate": null
        },
        "total_count": {
          "type": "integer",
          "x-struct": null,
          "x-validate": null,
          "description": "The total number of records in the result"
        },
        "total_pages": {
          "type": "integer",
          "x-struct": null,
          "x-validate": null,
          "description": "The total number of pages the user can go through"
        },
        "current_page": {
          "type": "integer",
          "x-struct": null,
          "x-validate": null,
          "description": "The current page among all of the total_pages"
        }
      },
      "x-validate": null
    }
  },
  "x-validate": null,
  "description": "Response schema listing many payslips"
}

{
  "type": "object",
  "title": "ListRecurringIncentivesResponse",
  "example": {
    "total_count": 1,
    "total_pages": 1,
    "current_page": 1,
    "recurring_incentives": [
      {
        "id": "0073fcb5-b669-4e4a-b963-2a47744e75a1X",
        "note": "Monthly stipend to buy food",
        "type": "meal_allowance",
        "amount": 50000,
        "status": "active",
        "end_date": "2022-12-20",
        "start_date": "2021-12-20",
        "employment_id": "5e55386e-4f4f-4def-92f4-bdc19a5ce77d",
        "amount_tax_type": "net"
      }
    ]
  },
  "x-struct": null,
  "properties": {
    "data": {
      "type": "object",
      "x-struct": null,
      "properties": {
        "total_count": {
          "type": "integer",
          "x-struct": null,
          "x-validate": null,
          "description": "The total number of records in the result"
        },
        "total_pages": {
          "type": "integer",
          "x-struct": null,
          "x-validate": null,
          "description": "The total number of pages the user can go through"
        },
        "current_page": {
          "type": "integer",
          "x-struct": null,
          "x-validate": null,
          "description": "The current page among all of the total_pages"
        },
        "recurring_incentives": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/RecurringIncentive"
          },
          "x-struct": null,
          "x-validate": null
        }
      },
      "x-validate": null
    }
  },
  "x-validate": null,
  "description": "Response schema listing many recurring_incentives"
}

{
  "type": "object",
  "title": "ListTimeoffResponse",
  "example": {
    "timeoffs": [
      {
        "id": "0073fcb5-b669-4e4a-b963-2a47744e75a1X",
        "notes": "Some notes",
        "status": "approved",
        "document": {
          "id": "9880b711-file-id-ecf8f551bd78X",
          "name": "id.pdf",
          "type": "id",
          "sub_type": "personal_id",
          "inserted_at": "2021-11-12T17:19:21"
        },
        "end_date": "2021-12-21",
        "timezone": "Asia/Kolkata",
        "start_date": "2021-12-20",
        "timeoff_days": [
          {
            "day": "2021-12-20",
            "hours": 8
          },
          {
            "day": "2021-12-21",
            "hours": 8
          }
        ],
        "timeoff_type": "paid_time_off",
        "employment_id": "5e55386e-4f4f-4def-92f4-bdc19a5ce77d"
      }
    ],
    "total_count": 1,
    "total_pages": 1,
    "current_page": 1
  },
  "x-struct": null,
  "properties": {
    "data": {
      "type": "object",
      "x-struct": null,
      "properties": {
        "timeoffs": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/Timeoff"
          },
          "x-struct": null,
          "x-validate": null
        },
        "total_count": {
          "type": "integer",
          "x-struct": null,
          "x-validate": null,
          "description": "The total number of records in the result"
        },
        "total_pages": {
          "type": "integer",
          "x-struct": null,
          "x-validate": null,
          "description": "The total number of pages the user can go through"
        },
        "current_page": {
          "type": "integer",
          "x-struct": null,
          "x-validate": null,
          "description": "The current page among all of the total_pages"
        }
      },
      "x-validate": null
    }
  },
  "x-validate": null,
  "description": "Response schema listing many timeoffs"
}

{
  "type": "object",
  "title": "ListTimeoffTypesResponse",
  "x-struct": null,
  "properties": {
    "data": {
      "type": "object",
      "x-struct": null,
      "properties": {
        "name": {
          "$ref": "#/components/schemas/TimeoffType"
        },
        "description": {
          "type": "string",
          "nullable": true,
          "x-struct": null,
          "x-validate": null
        }
      },
      "x-validate": null
    }
  },
  "x-validate": null,
  "description": "Time off types response"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/BenefitTier"
    }
  ],
  "title": "MaybeBenefitTier",
  "example": {
    "id": "66297cfd-cf60-4cf4-a70f-ac2561d92b04",
    "name": "Premium 2023 (Medical, Dental and Vision)",
    "providers": [
      {
        "id": "88297cfd-cf60-4cf4-a70f-ac2861d92b87",
        "name": "Health Provider"
      }
    ]
  },
  "nullable": true,
  "x-struct": null,
  "x-validate": null
}

{
  "type": "object",
  "title": "MessageResponse",
  "required": [
    "message"
  ],
  "x-struct": null,
  "properties": {
    "message": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    }
  },
  "x-validate": null
}

{
  "type": "object",
  "title": "MinimalContractAmendment",
  "example": {
    "id": "ba310525-9282-40c9-8977-14d844bf891aX",
    "status": "submitted",
    "job_title": "Engineer",
    "requested_by": "5a31f3c1-d7a7-4311-89cb-928959d3d540",
    "submitted_at": "2023-04-13T13:35:06Z",
    "employment_id": "1e74fdc2-7420-4eef-ab0a-b794cbbef4e1",
    "reason_for_change": "annual_pay_adjustment",
    "requested_effective_date": "2023-04-13T13:35:06Z"
  },
  "required": [
    "id",
    "employment_id",
    "status",
    "requested_by",
    "submitted_at",
    "requested_effective_date",
    "reason_for_change"
  ],
  "x-struct": null,
  "properties": {
    "id": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "status": {
      "enum": [
        "submitted",
        "in_review",
        "done",
        "canceled",
        "deleted"
      ],
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "job_title": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "requested_by": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "submitted_at": {
      "type": "string",
      "format": "datetime",
      "x-struct": null,
      "x-validate": null
    },
    "employment_id": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "reason_for_change": {
      "enum": [
        "annual_pay_adjustment",
        "country_rule_change",
        "error_correction",
        "job_change_reevaluation",
        "promotion",
        "other"
      ],
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "requested_effective_date": {
      "type": "string",
      "format": "datetime",
      "x-struct": null,
      "x-validate": null
    }
  },
  "x-validate": null,
  "description": "Minimal Contract Amendment"
}

{
  "type": "object",
  "title": "MinimalCountry",
  "example": {
    "code": "PRT",
    "name": "Portugal",
    "slug": "portugal-ab18d96a-a9fd-42c0-9688-24f963d8bdc1",
    "alpha_2_code": "PT"
  },
  "required": [
    "alpha_2_code",
    "code",
    "name",
    "slug"
  ],
  "x-struct": null,
  "properties": {
    "code": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "name": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "slug": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "features": {
      "type": "array",
      "items": {
        "type": "string",
        "x-struct": null,
        "x-validate": null
      },
      "x-struct": null,
      "x-validate": null
    },
    "alpha_2_code": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    }
  },
  "x-validate": null
}

{
  "type": "object",
  "title": "MinimalEmployment",
  "example": {
    "id": "add736b8-employment-id-a76ccae2abe8X",
    "type": "employee",
    "status": "created",
    "country": {
      "code": "AUS",
      "name": "Australia"
    },
    "full_name": "Jane Smith",
    "job_title": "Engineer",
    "department": null,
    "department_id": null,
    "personal_email": "janesmith@company.com"
  },
  "required": [
    "country",
    "full_name",
    "id",
    "job_title",
    "personal_email",
    "status",
    "type"
  ],
  "x-struct": null,
  "properties": {
    "id": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "type": {
      "enum": [
        "employee",
        "contractor",
        "direct_employee",
        "global_payroll_employee"
      ],
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "status": {
      "$ref": "#/components/schemas/EmploymentStatus"
    },
    "country": {
      "$ref": "#/components/schemas/Country"
    },
    "full_name": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "job_title": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "department": {
      "type": "string",
      "nullable": true,
      "x-struct": null,
      "x-validate": null,
      "description": "Name of related department, if any. Otherwise, null."
    },
    "department_id": {
      "type": "string",
      "title": "Slug",
      "example": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
      "nullable": true,
      "x-struct": null,
      "x-validate": null,
      "description": "Unique ID of related department, if any. Otherwise, null."
    },
    "personal_email": {
      "type": "string",
      "format": "email",
      "x-struct": null,
      "x-validate": null
    }
  },
  "x-validate": null,
  "description": "Minimal information of an employment."
}

{
  "type": "object",
  "title": "MinimalRegion",
  "example": {
    "code": "USA",
    "name": "United States",
    "slug": "663e0b79-c893-45ff-a1b2-f6dcabc098b5"
  },
  "required": [
    "name",
    "slug"
  ],
  "x-struct": null,
  "properties": {
    "code": {
      "type": "string",
      "nullable": true,
      "x-struct": null,
      "x-validate": null
    },
    "name": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "slug": {
      "type": "string",
      "x-struct": null,
      "x-validate": null
    },
    "status": {
      "$ref": "#/components/schemas/RegionStatus"
    },
    "child_regions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/MinimalRegion"
      },
      "x-struct": null,
      "x-validate": null
    }
  },
  "x-validate": null
}

{
  "type": "object",
  "title": "NotFoundResponse",
  "example": {
    "message": "{resource} not found"
  },
  "x-struct": null,
  "properties": {
    "message": {
      "type": "string",
      "pattern": "Not Found",
      "x-struct": null,
      "x-validate": null
    }
  },
  "x-validate": null
}

{
  "type": "string",
  "title": "NullableApproverId",
  "example": "51546f60-dd71-4223-9312-4efede68a497",
  "nullable": true,
  "x-struct": null,
  "x-validate": null,
  "description": "The field matches the `id` of a user in the\nRemote Platform that has permission to approve time off\nrequests. [Available users][] can be found fetching\nthe [List Company Manager][] endpoint.\n\n[Available users]: https://support.remote.com/hc/en-us/articles/360054668651-Approving-Declining-time-off-requests#h_01G0014GZKZ3EMN6P7C99HAK55\n[List Company Manager]: https://gateway.remote.com/v1/docs/openapi.html#tag/Company-Managers\n"
}

{
  "type": "string",
  "title": "NullableDateTime",
  "format": "datetime",
  "example": "2021-07-15T18:18:17",
  "nullable": true,
  "x-struct": null,
  "x-validate": null,
  "description": "Optional UTC date time in YYYY-MM-DDTHH:mm:ss format"
}

{
  "type": "object",
  "oneOf": [
    {
      "$ref": "#/components/schemas/AuthorizationCodeParams"
    },
    {
      "$ref": "#/components/schemas/ClientCredentialsParams"
    },
    {
      "$ref": "#/components/schemas/RefreshTokenParams"
    }
  ],
  "title": "OAuth2TokenParams",
  "example": {
    "code": "eyJhbG...xb6H0",
    "grant_type": "authorization_code"
  },
  "x-struct": null,
  "properties": {
    "code": {
      "type": "string",
      "example": "eyJhbG...xb6H0"
    },
    "grant_type": {
      "type": "string",
      "example": "authorization_code"
    }
  },
  "x-validate": null
}

{
  "type": "object",
  "oneOf": [
    {
      "$ref": "#/components/schemas/AuthorizationCodeResponse"
    },
    {
      "$ref": "#/components/schemas/BaseTokenResponse"
    },
    {
      "$ref": "#/components/schemas/RefreshTokenResponse"
    }
  ],
  "title": "OAuth2Tokens",
  "x-struct": null,
  "x-validate": null
}

{
  "type": "object",
  "title": "Offboarding",
  "example": {
    "id": "ba310525-9282-40c9-8977-14d844bf891aX",
    "type": "termination",
    "status": "submitted",
    "confidential": false,
    "requested_by": "5a31f3c1-d7a7-4311-89cb-928959d3d540",
    "submitted_at": "2023-04-13T13:35:06Z",
    "employment_id": "1e74fdc2-7420-4eef-ab0a-b794cbbef4e1",
    "termination_date": "2023-12-20",
    "employee_awareness": {
      "date": "2023-12-12",
      "note": "optional text to add details"
    },
    "termination_reason": "workforce_reduction",
    "additional_comments": "",
    "agrees_to_pto_amount": "true",
    "risk_assessment_reasons": [
      "pregnant_or_breastfeeding",
      "family_leave"
    ],
    "proposed_termination_date": "2023-12-20",
    "will_challenge_termination": true,
    "will_challenge_termination_description": "additional details for the offboarding risk assessment"
  },
  "x-struct": null,
  "properties": {
    "offboarding": {
      "type": "object",
      "oneOf": [
        {
          "$ref": "#/components/schemas/ResignationOffboarding"
        },
        {
          "$ref": "#/components/schemas/TerminationOffboarding"
        }
      ],
      "x-struct": null,
      "x-validate": null
    }
  },
  "x-validate": null,
  "description": "Offboarding"
}

{
  "type": "object",
  "title": "OffboardingFile",
  "required": [
    "name",
    "content"
  ],
  "x-struct": null,
  "properties": {
    "name": {
      "type": "string",
      "x-struct": null,
      "x-validate": null,
      "description": "The file name"
    },
    "content": {
      "type": "string",
      "format": "binary",
      "x-struct": null,
      "x-validate": null,
      "description": "The content in base64 encoding"
    }
  },
  "x-validate": null
}

{
  "type": "object",
  "title": "OffboardingResponse",
  "example": {
    "data": {
      "offboarding": {
        "id": "ba310525-9282-40c9-8977-14d844bf891aX",
        "type": "termination",
        "status": "submitted",
        "confidential": false,
        "requested_by": "5a31f3c1-d7a7-4311-89cb-928959d3d540",
        "submitted_at": "2023-04-13T13:35:06Z",
        "employment_id": "1e74fdc2-7420-4eef-ab0a-b794cbbef4e1",
        "termination_date": "2023-12-20",
        "employee_awareness": {
          "date": "2023-12-12",
          "note": "optional text to add details"
        },
        "termination_reason": "workforce_reduction",
        "additional_comments": "",
        "agrees_to_pto_amount": "true",
        "risk_assessment_reasons": [
          "pregnant_or_breastfeeding",
          "family_leave"
        ],
        "proposed_termination_date": "2023-12-20",
        "will_challenge_termination": true,
        "will_challenge_termination_description": "additional details for the offboarding risk assessment"
      }
    }
  },
  "x-struct": null,
  "properties": {
    "data": {
      "$ref": "#/components/schemas/Offboarding"
    }
  },
  "x-validate": null,
  "description": "Offboarding response"
}

{
  "type": "object",
  "title": "OfferedBenefitGroup",
  "example": {
    "benefit_group": {
      "id": "54297cfd-cf60-4cf4-a70f-ac2061d72b44",
      "name": "Health",
      "policy_end_date": "2024-12-31",
      "policy_start_date": "2024-01-01"
    },
    "employee_stats": {
      "number_of_employees_offered": 12,
      "number_of_employees_enrolled": 10
    },
    "offered_benefit_tiers": [
      {
        "benefit_tier": {
          "id": "66297cfd-cf60-4cf4-a70f-ac2561d92b04X",
          "name": "Premium 2023 (Medical, Dental and Vision)",
          "providers": [
            {
              "id": "88297cfd-cf60-4cf4-a70f-ac2861d92b87X",
              "name": "Health Provider"
            }
          ]
        },
        "employee_stats": {
          "number_of_employees_offered": 12,
          "number_of_employees_enrolled": 10
        }
      }
    ]
  },
  "required": [
    "benefit_group",
    "employee_stats",
    "offered_benefit_tiers"
  ],
  "x-struct": null,
  "properties": {
    "benefit_group": {
      "$ref": "#/components/schemas/BenefitGroup"
    },
    "employee_stats": {
      "$ref": "#/components/schemas/EmployeeStats"
    },
    "offered_benefit_tiers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OfferedBenefitTier"
      },
      "x-struct": null,
      "x-validate": null
    }
  },
  "x-validate": null
}