{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetHrisEmploymentsPositiveResponse",
  "title": "GetHrisEmploymentsPositiveResponse",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "const": "success"
    },
    "data": {
      "type": "object",
      "properties": {
        "next": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor string that can be passed to the `cursor` query parameter to get the next page. If this is `null`, then there are no more pages."
        },
        "results": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing."
              },
              "remote_id": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key."
              },
              "employee_id": {
                "type": "string",
                "description": "The Kombo ID of the employment\u2019s employee. The ID can be used to retrieve the employee from the `get employees` endpoint."
              },
              "job_title": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "This field can contain historic job titles. Please use the `job_title` field on the employee for the active job title of an employee."
              },
              "pay_rate": {
                "type": [
                  "number",
                  "null"
                ],
                "format": "double",
                "minimum": -1.7976931348623157e+308,
                "description": "The monetary amount paid to an employee."
              },
              "pay_period": {
                "anyOf": [
                  {
                    "type": "string",
                    "enum": [
                      "HOUR",
                      "DAY",
                      "WEEK",
                      "TWO_WEEKS",
                      "HALF_MONTH",
                      "MONTH",
                      "TWO_MONTHS",
                      "QUARTER",
                      "HALF_YEAR",
                      "YEAR"
                    ]
                  },
                  {
                    "type": "string",
                    "description": "If we can't find a clear mapping: The original string passed through."
                  },
                  {
                    "type": "null"
                  }
                ],
                "description": "The time interval which the `pay_rate` is describing.\n\nA `pay_rate` value of `12000` with a `pay_period` of `YEAR` would indicate that the employee receives 12000 over the course of a year. In rare cases where we can\u2019t find a clear mapping, the original string is passed through."
              },
              "pay_frequency": {
                "anyOf": [
                  {
                    "type": "string",
                    "enum": [
                      "DAILY",
                      "WEEKLY",
                      "BIWEEKLY",
                      "MONTHLY",
                      "SEMIMONTHLY",
                      "QUARTERLY",
                      "SEMIANNUALLY",
                      "ANNUALLY",
                      "PRO_RATA"
                    ]
                  },
                  {
                    "type": "string",
                    "description": "If we can't find a clear mapping: The original string passed through."
                  },
                  {
                    "type": "null"
                  }
                ],
                "description": "The time interval at which the employee receives payment.\n\nA `pay_rate` of `12000`, with a `pay_period` of `YEAR`, and a `pay_frequency` of `MONTHLY` would indicate that the employee is paid 1000 every month. In rare cases where we can\u2019t find a clear mapping, the original string is passed through."
              },
              "employment_type": {
                "anyOf": [
                  {
                    "type": "string",
                    "enum": [
                      "FULL_TIME",
                      "PART_TIME",
                      "CONTRACT",
                      "INTERNSHIP",
                      "FREELANCE",
                      "WORKING_STUDENT",
                      "APPRENTICESHIP",
                      "TRAINING"
                    ]
                  },
                  {
                    "type": "string",
                    "description": "If we can't find a clear mapping: The original string passed through."
                  },
                  {
                    "type": "null"
                  }
                ],
                "description": "The employee\u2019s current employment type:\n\n- `FULL_TIME`: the employee is actively employed\n- `PART_TIME`: the employee is working only part of the usual working hours\n- `CONTRACT`: the employee is working temporarily under a contract\n- `INTERNSHIP`: the employee is working as an intern\n- `FREELANCE`: the employee is working as a freelancer\n- `WORKING_STUDENT`: the employee is working as a working student\n- `APPRENTICESHIP`: the employee is working in an apprenticeship\n- `TRAINING`: the employee is working in a training program\n\n In rare cases where we can\u2019t find a clear mapping, the original string is passed through."
              },
              "pay_currency": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "The currency that the employee is paid in. Usually returned in [ISO 4217 currency codes](https://www.iso.org/iso-4217-currency-codes.html)."
              },
              "effective_date": {
                "description": "The date of when the employment started.",
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time",
                "externalDocs": {
                  "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString"
                }
              },
              "changed_at": {
                "description": "The timestamp when this specific record was last modified. This field only updates when properties directly on this record change, NOT when related or nested models change. For filtering that considers nested data changes, use the `updated_after` parameter which will return records when either the record itself OR its related models have been updated.",
                "type": "string",
                "format": "date-time",
                "externalDocs": {
                  "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString"
                }
              },
              "remote_deleted_at": {
                "description": "The date and time the object was deleted in the remote system. Objects are automatically marked as deleted when Kombo can't retrieve them from the remote system anymore. Kombo will also anonymize entries 14 days after they disappear.",
                "type": [
                  "string",
                  "null"
                ],
                "format": "date-time",
                "externalDocs": {
                  "url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString"
                }
              },
              "remote_data": {
                "type": [
                  "object",
                  "null"
                ],
                "additionalProperties": true,
                "description": "Includes the data fetched from the remote system.\nPlease be aware that including this in you scope config might violate other\nscopes that are set.\n\nRemote data always has the endpoint path that we got the data from as the\ntop level key. For example, it could look like: `{ \"/companies\": { ... }}`\n\nThis is not available on all plans. Reach out to Kombo if you need it."
              },
              "custom_fields": {
                "type": [
                  "object",
                  "null"
                ],
                "additionalProperties": true,
                "description": "A key-value store of fields not covered by the schema. [Read more](/custom-fields)"
              },
              "integration_fields": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "The globally unique ID of this object."
                    },
                    "key": {
                      "type": "string",
                      "description": "The key of the field in the remote system."
                    },
                    "type": {
                      "type": "string",
                      "enum": [
                        "DEFAULT",
                        "CUSTOM"
                      ],
                      "description": "- `DEFAULT`: static fields in the remote system.\n- `CUSTOM`: fields that are created/editable by the user."
                    },
                    "value": {
                      "type": "null",
                      "description": "The field's value."
                    },
                    "label": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "The label of the field. (not always available)"
                    }
                  },
                  "required": [
                    "id",
                    "key",
                    "type",
                    "label"
                  ]
                },
                "description": "An array of selected passthrough integration fields. [Read more](/integration-fields)",
                "examples": [
                  [
                    {
                      "id": "5NVFhMpB9Ah6by44tzNjZLyE",
                      "key": "firstName",
                      "type": "DEFAULT",
                      "value": "Frank",
                      "label": "First Name"
                    },
                    {
                      "id": "8nuajYpoRd5GnxEQaaWKUDYQ",
                      "key": "customTshirtSize",
                      "type": "CUSTOM",
                      "value": "XL",
                      "label": "T-Shirt Size"
                    }
                  ]
                ]
              }
            },
            "required": [
              "id",
              "remote_id",
              "employee_id",
              "job_title",
              "pay_rate",
              "pay_currency",
              "effective_date",
              "changed_at",
              "remote_deleted_at",
              "remote_data",
              "custom_fields",
              "integration_fields"
            ],
            "examples": [
              {
                "id": "12vpXR7BeqYNWDShXRgsonnm",
                "remote_id": "859",
                "employee_id": "26vafvWSRmbhNcxJYqjCzuJg",
                "job_title": "Social Media Marketer",
                "pay_rate": 85000,
                "pay_period": "YEAR",
                "pay_frequency": "SEMIMONTHLY",
                "employment_type": "FULL_TIME",
                "pay_currency": "EUR",
                "effective_date": "2021-01-30T00:00:00.000Z",
                "changed_at": "2022-08-07T14:01:29.196Z",
                "remote_deleted_at": null,
                "remote_data": null,
                "custom_fields": {},
                "integration_fields": []
              }
            ]
          }
        }
      },
      "required": [
        "next",
        "results"
      ],
      "examples": [
        {
          "next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
          "results": [
            {
              "id": "12vpXR7BeqYNWDShXRgsonnm",
              "remote_id": "859",
              "employee_id": "26vafvWSRmbhNcxJYqjCzuJg",
              "job_title": "Social Media Marketer",
              "pay_rate": 85000,
              "pay_period": "YEAR",
              "pay_frequency": "SEMIMONTHLY",
              "employment_type": "FULL_TIME",
              "pay_currency": "EUR",
              "effective_date": "2021-01-30T00:00:00.000Z",
              "changed_at": "2022-08-07T14:01:29.196Z",
              "remote_deleted_at": null,
              "remote_data": null,
              "custom_fields": {},
              "integration_fields": []
            }
          ]
        }
      ]
    }
  },
  "required": [
    "status",
    "data"
  ]
}