Kombo · Schema
PatchHrisEmployeesEmployeeIdPositiveResponse
ATSEmbedded iPaaSHRISLMSPayrollUnified API
Properties
| Name | Type | Description |
|---|---|---|
| status | string | |
| data | object | |
| warnings | array | These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/PatchHrisEmployeesEmployeeIdPositiveResponse",
"title": "PatchHrisEmployeesEmployeeIdPositiveResponse",
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "success"
},
"data": {
"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",
"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_number": {
"type": [
"string",
"null"
],
"description": "The employee\u2019s organization-internal employee number."
},
"first_name": {
"type": [
"string",
"null"
],
"description": "The employee\u2019s first name."
},
"last_name": {
"type": [
"string",
"null"
],
"description": "The employee\u2019s last name."
},
"nationality": {
"type": [
"string",
"null"
],
"description": "The employee\u2019s nationality."
},
"display_full_name": {
"type": [
"string",
"null"
],
"description": "The employee\u2019s full name, including any middle names. Not all HR systems provide an explicit display name, so we recommend falling back to `first_name` and `last_name`."
},
"job_title": {
"type": [
"string",
"null"
],
"description": "The employee\u2019s job title."
},
"work_email": {
"type": [
"string",
"null"
],
"pattern": "^(?!\\.)(?!.*\\.\\.)([\\w'+-.]*)[\\w+-]@([\\da-z][\\da-z-]*\\.)+[a-z]{2,}$",
"description": "The employee\u2019s work email address. If the email address is invalid, we will set this to `null`."
},
"personal_email": {
"type": [
"string",
"null"
],
"pattern": "^(?!\\.)(?!.*\\.\\.)([\\w'+-.]*)[\\w+-]@([\\da-z][\\da-z-]*\\.)+[a-z]{2,}$",
"description": "The employee\u2019s personal email address. If the email address is invalid, we will set this to `null`."
},
"mobile_phone_number": {
"type": [
"string",
"null"
],
"description": "The employee\u2019s mobile phone number."
},
"ssn": {
"type": [
"string",
"null"
],
"description": "The employee\u2019s social security number"
},
"tax_id": {
"type": [
"string",
"null"
],
"description": "The employee\u2019s tax ID."
},
"gender": {
"anyOf": [
{
"type": "string",
"enum": [
"MALE",
"FEMALE",
"NON_BINARY",
"NOT_SPECIFIED"
]
},
{
"type": "string",
"description": "If we can't find a clear mapping: The original string passed through."
},
{
"type": "null"
}
],
"description": "The employee\u2019s gender."
},
"ethnicity": {
"anyOf": [
{
"type": "string",
"enum": [
"WHITE",
"ASIAN",
"HISPANIC_LATINO",
"HAWAIIAN",
"NATIVE_AMERICAN",
"BLACK_AFRICAN_AMERICAN",
"MULTIPLE_ETHNICITIES",
"DECLINE_TO_SPECIFY"
]
},
{
"type": "string",
"description": "If we can't find a clear mapping: The original string passed through."
},
{
"type": "null"
}
],
"description": "The employee\u2019s ethnicity. In rare cases where we can\u2019t find a clear mapping, the original string is passed through."
},
"marital_status": {
"anyOf": [
{
"type": "string",
"enum": [
"SINGLE",
"MARRIED",
"DOMESTIC_PARTNERSHIP",
"WIDOWED",
"DIVORCED",
"SEPARATED",
"NOT_MARRIED"
]
},
{
"type": "string",
"description": "If we can't find a clear mapping: The original string passed through."
},
{
"type": "null"
}
],
"description": "The employee\u2019s current marital status. In rare cases where we can\u2019t find a clear mapping, the original string is passed through."
},
"employment_status": {
"anyOf": [
{
"type": "string",
"enum": [
"ACTIVE",
"PENDING",
"INACTIVE",
"LEAVE"
]
},
{
"type": "string",
"description": "If we can't find a clear mapping: The original string passed through."
},
{
"type": "null"
}
],
"description": "The employee\u2019s current employment status:\n\n- `ACTIVE`: the employee is **actively employed**\n- `PENDING`: the employee is **not actively employed yet** (but they signed their contract or are part of an onboarding process)\n- `INACTIVE`: the employee is **not actively employed** anymore\n- `LEAVE`: the employee is still employed but **currently on leave** (note that not all HR systems support this status \u2014 use our absences API for detailed information)\n\n 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."
},
"weekly_hours": {
"type": [
"number",
"null"
],
"format": "double",
"minimum": -1.7976931348623157e+308,
"description": "The employee\u2019s weekly working hours."
},
"avatar": {
"type": [
"string",
"null"
],
"description": "URL to the employee\u2019s avatar. This is either the raw URL from the HR system (in cases where it can be requested without short-lived authentication) _or_ a URL to a temporarily cached version of the file hosted by Kombo. Kombo will delete the cached file after its deletion in the source system."
},
"work_location_id": {
"type": [
"string",
"null"
],
"description": "The Kombo ID of the employee\u2019s work location. The ID can be used to retrieve the work location from the `get work locations` endpoint."
},
"legal_entity_id": {
"type": [
"string",
"null"
],
"description": "The Kombo ID of the employee\u2019s legal entity. The ID can be used to retrieve the legal entity from the `get legal entities` endpoint."
},
"manager_id": {
"type": [
"string",
"null"
],
"description": "The Kombo ID of the employee\u2019s manager. The ID can be used to retrieve the manager from the `get employees` endpoint."
},
"home_address": {
"type": [
"object",
"null"
],
"properties": {
"city": {
"type": [
"string",
"null"
]
},
"country": {
"type": [
"string",
"null"
],
"description": "Contains the ISO2 country code if possible. If not, it contains the original value."
},
"raw": {
"type": [
"string",
"null"
],
"description": "If we have address data, this is filled with the raw address string."
},
"state": {
"type": [
"string",
"null"
]
},
"street_1": {
"type": [
"string",
"null"
],
"description": "If we can parse the address data, this field contains the first part of the street information."
},
"street_2": {
"type": [
"string",
"null"
]
},
"zip_code": {
"type": [
"string",
"null"
]
}
},
"description": "The employee\u2019s home address."
},
"bank_accounts": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"iban": {
"type": [
"string",
"null"
],
"description": "The internationally unique IBAN identifying this account. If we detect a valid IBAN from the account number and this field would otherwise be empty, we will automatically populate this field."
},
"bic": {
"type": [
"string",
"null"
],
"description": "The internationally unique BIC/SWIFT code identifying the bank behind this account. If we detect a valid BIC from the domestic bank routing number and this field would otherwise be empty, we will automatically populate this field."
},
"account_number": {
"type": [
"string",
"null"
],
"description": "The bank-specific account number. Some companies use the account number field to put the IBAN here."
},
"holder_name": {
"type": [
"string",
"null"
],
"description": "The name of the holder of this account."
},
"bank_name": {
"type": [
"string",
"null"
],
"description": "The name of the bank behind this account."
},
"domestic_bank_routing": {
"type": [
"object",
"null"
],
"properties": {
"number": {
"type": "string",
"description": "Bank routing number (e.g. DE Bankleitzahl, GB Sort Code, US ABA routing number, AU BSB code). This field is not formatted and therefore might contain delimiters (eg. 01-23-45)."
},
"type": {
"type": [
"string",
"null"
],
"enum": [
"GB_SORT_CODE",
"DE_BANKLEITZAHL",
"US_ABA_ROUTING_TRANSIT_NUMBER",
"CA_ROUTING_NUMBER",
"AU_BSB_CODE",
"FR_RIB"
],
"description": "Enum of the routing type, prefixed with the iso-3166-1-alpha-2 banks origin country. If there is uncertainty about the type, it will be set to null."
}
},
"required": [
"number",
"type"
]
}
}
},
"description": "The employee\u2019s bank accounts."
},
"date_of_birth": {
"description": "The employee\u2019s date of birth.",
"type": [
"string",
"null"
],
"format": "date-time",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString"
}
},
"start_date": {
"description": "The date the employee started working for the organization.",
"type": [
"string",
"null"
],
"format": "date-time",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString"
}
},
"termination_date": {
"description": "The date when the employment ends. Can be in the past or future.",
"type": [
"string",
"null"
],
"format": "date-time",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString"
}
},
"remote_created_at": {
"description": "The date and time the object was created in the remote system.",
"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."
}
},
"required": [
"id",
"remote_id",
"employee_number",
"first_name",
"last_name",
"nationality",
"display_full_name",
"job_title",
"mobile_phone_number",
"ssn",
"tax_id",
"weekly_hours",
"avatar",
"work_location_id",
"legal_entity_id",
"manager_id",
"date_of_birth",
"start_date",
"termination_date",
"remote_created_at",
"changed_at",
"remote_deleted_at",
"remote_data"
],
"examples": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"employee_number": "3243422",
"first_name": "John",
"last_name": "Doe",
"nationality": "French",
"display_full_name": "John Doe",
"job_title": "Integrations Team Lead",
"work_email": "[email protected]",
"personal_email": "[email protected]",
"mobile_phone_number": "801-555-4687",
"ssn": "555-32-6395",
"tax_id": "12 345 678 901",
"gender": "MALE",
"ethnicity": "BLACK_AFRICAN_AMERICAN",
"marital_status": "MARRIED",
"employment_status": "INACTIVE",
"employment_type": "FULL_TIME",
"weekly_hours": 40,
"avatar": "https://resources.bamboohr.com/images/photo_person_150x150.png",
"work_location_id": "7E2gyuv6TmvtByzBxW9Sxt53",
"legal_entity_id": "xB32bied320csBSsl3XWdlw33",
"manager_id": "9pf2pxBB8VX8EQMC9aipW2Bo",
"home_address": {
"city": "Berlin",
"country": "DE",
"raw": "Sonnenallee 63\n12045 Berlin\nGermany",
"state": "Berlin",
"street_1": "Sonnenallee 63",
"street_2": null,
"zip_code": "12045"
},
"bank_accounts": [
{
"account_number": "1234567890",
"bank_name": "Commerzbank",
"bic": "COBADEFFXXX",
"domestic_bank_routing": {
"number": "34567890",
"type": "DE_BANKLEITZAHL"
},
"holder_name": "John Doe",
"iban": "DE12345678901234567890"
}
],
"date_of_birth": "1986-01-01T00:00:00.000Z",
"start_date": "2020-04-07T00:00:00.000Z",
"termination_date": "2022-05-20T00:00:00.000Z",
"remote_created_at": "2020-04-07T12:32:01.000Z",
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null,
"remote_data": null
}
]
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
},
"description": "These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console."
}
},
"required": [
"status",
"data",
"warnings"
]
}