{ "openapi": "3.0.3", "info": { "title": "Merge HRIS API", "version": "1.0", "description": "The unified API for building rich integrations with multiple HR Information System platforms.", "contact": { "name": "Merge Team", "url": "https://www.merge.dev/", "email": "hello@merge.dev" } }, "paths": { "/account-details": { "get": { "operationId": "account_details_retrieve", "description": "Get details for a linked account.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true } ], "tags": [ "account-details" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountDetails" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/account-token/{public_token}": { "get": { "operationId": "account_token_retrieve", "description": "Returns the account token for the end user with the provided public token.", "parameters": [ { "in": "path", "name": "public_token", "schema": { "type": "string" }, "required": true } ], "tags": [ "account-token" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountToken" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/account-token/regenerate": { "post": { "operationId": "account_token_regenerate_create", "description": "Exchange Linked Account account tokens.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true } ], "tags": [ "account-token" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegenerateAccountToken" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/async-passthrough": { "post": { "operationId": "async_passthrough_create", "description": "Asynchronously pull data from an endpoint not currently supported by Merge.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true } ], "tags": [ "async-passthrough" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataPassthroughRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DataPassthroughRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DataPassthroughRequest" } } }, "required": true }, "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncPassthroughReciept" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/async-passthrough/{async_passthrough_receipt_id}": { "get": { "operationId": "async_passthrough_retrieve", "description": "Retrieves data from earlier async-passthrough POST request", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "path", "name": "async_passthrough_receipt_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "async-passthrough" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteResponse" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/audit-trail": { "get": { "operationId": "audit_trail_list", "description": "Gets a list of audit trail events.", "parameters": [ { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "The pagination cursor value.", "examples": { "CursorExample": { "value": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", "summary": "Cursor Example" } } }, { "in": "query", "name": "end_date", "schema": { "type": "string" }, "description": "If included, will only include audit trail events that occurred before this time" }, { "in": "query", "name": "event_type", "schema": { "type": "string" }, "description": "If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED`, `CHANGED_SELECTIVE_SYNC_FILTERS`, `ADDED_PARTNER_CREDENTIALS`, `UPDATED_PARTNER_CREDENTIALS`, `REMOVED_PARTNER_CREDENTIALS`, `CHANGED_PARTNER_CREDENTIAL_SOURCE`" }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page. The maximum limit is 100.", "schema": { "type": "integer" } }, { "in": "query", "name": "start_date", "schema": { "type": "string" }, "description": "If included, will only include audit trail events that occurred after this time" }, { "in": "query", "name": "user_email", "schema": { "type": "string" }, "description": "If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email." } ], "tags": [ "audit-trail" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedAuditLogEventList" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/available-actions": { "get": { "operationId": "available_actions_retrieve", "description": "Returns a list of models and actions available for an account.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true } ], "tags": [ "available-actions" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailableActions" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/bank-info": { "get": { "operationId": "bank_info_list", "description": "Returns a list of `BankInfo` objects.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "query", "name": "account_type", "schema": { "type": "string", "nullable": true, "enum": [ "CHECKING", "SAVINGS" ] }, "description": "If provided, will only return BankInfo's with this account type. Options: ('SAVINGS', 'CHECKING')\n\n" }, { "in": "query", "name": "bank_name", "schema": { "type": "string", "nullable": true }, "description": "If provided, will only return BankInfo's with this bank name." }, { "in": "query", "name": "created_after", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, will only return objects created after this datetime." }, { "in": "query", "name": "created_before", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, will only return objects created before this datetime." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "The pagination cursor value.", "examples": { "CursorExample": { "value": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", "summary": "Cursor Example" } } }, { "in": "query", "name": "employee_id", "schema": { "type": "string" }, "description": "If provided, will only return bank accounts for this employee.", "examples": { "EmployeeId": { "summary": "employee_id" } } }, { "in": "query", "name": "expand", "schema": { "type": "string", "enum": [ "employee" ] }, "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.", "examples": { "ExpandEmployee": { "value": "employee", "summary": "Expand Employee" } } }, { "in": "query", "name": "include_deleted_data", "schema": { "type": "boolean" }, "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)." }, { "in": "query", "name": "include_remote_data", "schema": { "type": "boolean" }, "description": "Whether to include the original data Merge fetched from the third-party to produce these models." }, { "in": "query", "name": "include_shell_data", "schema": { "type": "boolean" }, "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)." }, { "in": "query", "name": "modified_after", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, only objects synced by Merge after this date time will be returned." }, { "in": "query", "name": "modified_before", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, only objects synced by Merge before this date time will be returned." }, { "in": "query", "name": "order_by", "schema": { "type": "string", "enum": [ "-remote_created_at", "remote_created_at" ] }, "description": "Overrides the default ordering for this endpoint. Possible values include: remote_created_at, -remote_created_at.", "x-fern-enum": { "remote_created_at": { "name": "RemoteCreatedAtAscending" }, "-remote_created_at": { "name": "RemoteCreatedAtDescending" } } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page. The maximum limit is 100.", "schema": { "type": "integer" } }, { "in": "query", "name": "remote_fields", "schema": { "type": "string", "enum": [ "account_type" ] }, "description": "Deprecated. Use show_enum_origins.", "examples": { "OriginalEnumValuesAccountType": { "value": "account_type", "summary": "Original Enum Values Account_type" } } }, { "in": "query", "name": "remote_id", "schema": { "type": "string", "nullable": true }, "description": "The API provider's ID for the given object." }, { "in": "query", "name": "show_enum_origins", "schema": { "type": "string", "enum": [ "account_type" ] }, "description": "A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)", "examples": { "OriginalEnumValuesAccountType": { "value": "account_type", "summary": "Original Enum Values Account_type" } } }, { "in": "query", "name": "show_native_enum_values", "schema": { "type": "boolean" }, "description": "Whether to include the third party's original value for each enum field as `_native`, alongside Merge's normalized ``." } ], "tags": [ "bank-info" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedBankInfoList" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/bank-info/{id}": { "get": { "operationId": "bank_info_retrieve", "description": "Returns a `BankInfo` object with the given `id`.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "query", "name": "expand", "schema": { "type": "string", "enum": [ "employee" ] }, "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.", "examples": { "ExpandEmployee": { "value": "employee", "summary": "Expand Employee" } } }, { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "query", "name": "include_remote_data", "schema": { "type": "boolean" }, "description": "Whether to include the original data Merge fetched from the third-party to produce these models." }, { "in": "query", "name": "include_shell_data", "schema": { "type": "boolean" }, "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)." }, { "in": "query", "name": "remote_fields", "schema": { "type": "string", "enum": [ "account_type" ] }, "description": "Deprecated. Use show_enum_origins.", "examples": { "OriginalEnumValuesAccountType": { "value": "account_type", "summary": "Original Enum Values Account_type" } } }, { "in": "query", "name": "show_enum_origins", "schema": { "type": "string", "enum": [ "account_type" ] }, "description": "A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)", "examples": { "OriginalEnumValuesAccountType": { "value": "account_type", "summary": "Original Enum Values Account_type" } } }, { "in": "query", "name": "show_native_enum_values", "schema": { "type": "boolean" }, "description": "Whether to include the third party's original value for each enum field as `_native`, alongside Merge's normalized ``." } ], "tags": [ "bank-info" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankInfo" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/benefits": { "get": { "operationId": "benefits_list", "description": "Returns a list of `Benefit` objects.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "query", "name": "created_after", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, will only return objects created after this datetime." }, { "in": "query", "name": "created_before", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, will only return objects created before this datetime." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "The pagination cursor value.", "examples": { "CursorExample": { "value": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", "summary": "Cursor Example" } } }, { "in": "query", "name": "employee_id", "schema": { "type": "string" }, "description": "If provided, will return the benefits associated with the employee.", "examples": { "EmployeeId": { "summary": "employee_id" } } }, { "in": "query", "name": "expand", "schema": { "type": "string", "enum": [ "employee" ] }, "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.", "examples": { "ExpandEmployee": { "value": "employee", "summary": "Expand Employee" } } }, { "in": "query", "name": "include_deleted_data", "schema": { "type": "boolean" }, "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)." }, { "in": "query", "name": "include_remote_data", "schema": { "type": "boolean" }, "description": "Whether to include the original data Merge fetched from the third-party to produce these models." }, { "in": "query", "name": "include_shell_data", "schema": { "type": "boolean" }, "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)." }, { "in": "query", "name": "modified_after", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, only objects synced by Merge after this date time will be returned." }, { "in": "query", "name": "modified_before", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, only objects synced by Merge before this date time will be returned." }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page. The maximum limit is 100.", "schema": { "type": "integer" } }, { "in": "query", "name": "remote_id", "schema": { "type": "string", "nullable": true }, "description": "The API provider's ID for the given object." } ], "tags": [ "benefits" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedBenefitList" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/benefits/{id}": { "get": { "operationId": "benefits_retrieve", "description": "Returns a `Benefit` object with the given `id`.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "query", "name": "expand", "schema": { "type": "string", "enum": [ "employee" ] }, "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.", "examples": { "ExpandEmployee": { "value": "employee", "summary": "Expand Employee" } } }, { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "query", "name": "include_remote_data", "schema": { "type": "boolean" }, "description": "Whether to include the original data Merge fetched from the third-party to produce these models." }, { "in": "query", "name": "include_shell_data", "schema": { "type": "boolean" }, "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)." } ], "tags": [ "benefits" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Benefit" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/companies": { "get": { "operationId": "companies_list", "description": "Returns a list of `Company` objects.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "query", "name": "created_after", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, will only return objects created after this datetime." }, { "in": "query", "name": "created_before", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, will only return objects created before this datetime." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "The pagination cursor value.", "examples": { "CursorExample": { "value": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", "summary": "Cursor Example" } } }, { "in": "query", "name": "include_deleted_data", "schema": { "type": "boolean" }, "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)." }, { "in": "query", "name": "include_remote_data", "schema": { "type": "boolean" }, "description": "Whether to include the original data Merge fetched from the third-party to produce these models." }, { "in": "query", "name": "include_shell_data", "schema": { "type": "boolean" }, "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)." }, { "in": "query", "name": "modified_after", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, only objects synced by Merge after this date time will be returned." }, { "in": "query", "name": "modified_before", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, only objects synced by Merge before this date time will be returned." }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page. The maximum limit is 100.", "schema": { "type": "integer" } }, { "in": "query", "name": "remote_id", "schema": { "type": "string", "nullable": true }, "description": "The API provider's ID for the given object." } ], "tags": [ "companies" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedCompanyList" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/companies/{id}": { "get": { "operationId": "companies_retrieve", "description": "Returns a `Company` object with the given `id`.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "query", "name": "include_remote_data", "schema": { "type": "boolean" }, "description": "Whether to include the original data Merge fetched from the third-party to produce these models." }, { "in": "query", "name": "include_shell_data", "schema": { "type": "boolean" }, "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)." } ], "tags": [ "companies" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/default-scopes": { "get": { "operationId": "default_scopes_retrieve", "description": "Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).", "tags": [ "scopes" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonModelScopeAPI" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/delete-account": { "post": { "operationId": "delete_account_delete", "description": "Delete a linked account.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true } ], "tags": [ "delete-account" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "description": "No response body" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/dependents": { "get": { "operationId": "dependents_list", "description": "Returns a list of `Dependent` objects.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "query", "name": "created_after", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, will only return objects created after this datetime." }, { "in": "query", "name": "created_before", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, will only return objects created before this datetime." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "The pagination cursor value.", "examples": { "CursorExample": { "value": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", "summary": "Cursor Example" } } }, { "in": "query", "name": "employee_id", "schema": { "type": "string" }, "description": "If provided, will only return dependents for this employee.", "examples": { "EmployeeId": { "summary": "employee_id" } } }, { "in": "query", "name": "include_deleted_data", "schema": { "type": "boolean" }, "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)." }, { "in": "query", "name": "include_remote_data", "schema": { "type": "boolean" }, "description": "Whether to include the original data Merge fetched from the third-party to produce these models." }, { "in": "query", "name": "include_sensitive_fields", "schema": { "type": "boolean" }, "description": "Whether to include sensitive fields (such as social security numbers) in the response." }, { "in": "query", "name": "include_shell_data", "schema": { "type": "boolean" }, "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)." }, { "in": "query", "name": "modified_after", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, only objects synced by Merge after this date time will be returned." }, { "in": "query", "name": "modified_before", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, only objects synced by Merge before this date time will be returned." }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page. The maximum limit is 100.", "schema": { "type": "integer" } }, { "in": "query", "name": "remote_id", "schema": { "type": "string", "nullable": true }, "description": "The API provider's ID for the given object." } ], "tags": [ "dependents" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDependentList" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC_BETA" } }, "/dependents/{id}": { "get": { "operationId": "dependents_retrieve", "description": "Returns a `Dependent` object with the given `id`.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "query", "name": "include_remote_data", "schema": { "type": "boolean" }, "description": "Whether to include the original data Merge fetched from the third-party to produce these models." }, { "in": "query", "name": "include_sensitive_fields", "schema": { "type": "boolean" }, "description": "Whether to include sensitive fields (such as social security numbers) in the response." }, { "in": "query", "name": "include_shell_data", "schema": { "type": "boolean" }, "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)." } ], "tags": [ "dependents" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dependent" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC_BETA" } }, "/employee-payroll-runs": { "get": { "operationId": "employee_payroll_runs_list", "description": "Returns a list of `EmployeePayrollRun` objects.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "query", "name": "created_after", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, will only return objects created after this datetime." }, { "in": "query", "name": "created_before", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, will only return objects created before this datetime." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "The pagination cursor value.", "examples": { "CursorExample": { "value": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", "summary": "Cursor Example" } } }, { "in": "query", "name": "employee_id", "schema": { "type": "string" }, "description": "If provided, will only return employee payroll runs for this employee.", "examples": { "EmployeeId": { "summary": "employee_id" } } }, { "in": "query", "name": "ended_after", "schema": { "type": "string", "format": "date-time", "nullable": true }, "description": "If provided, will only return employee payroll runs ended after this datetime." }, { "in": "query", "name": "ended_before", "schema": { "type": "string", "format": "date-time", "nullable": true }, "description": "If provided, will only return employee payroll runs ended before this datetime." }, { "in": "query", "name": "expand", "schema": { "type": "string", "enum": [ "employee", "employee,payroll_run", "payroll_run" ] }, "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.", "examples": { "ExpandEmployee,PayrollRun": { "value": "employee,payroll_run", "summary": "Expand Employee, Payroll_run" } } }, { "in": "query", "name": "include_deleted_data", "schema": { "type": "boolean" }, "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)." }, { "in": "query", "name": "include_remote_data", "schema": { "type": "boolean" }, "description": "Whether to include the original data Merge fetched from the third-party to produce these models." }, { "in": "query", "name": "include_shell_data", "schema": { "type": "boolean" }, "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)." }, { "in": "query", "name": "modified_after", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, only objects synced by Merge after this date time will be returned." }, { "in": "query", "name": "modified_before", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, only objects synced by Merge before this date time will be returned." }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page. The maximum limit is 100.", "schema": { "type": "integer" } }, { "in": "query", "name": "payroll_run_id", "schema": { "type": "string" }, "description": "If provided, will only return employee payroll runs for this employee.", "examples": { "PayrollRunId": { "summary": "payroll_run_id" } } }, { "in": "query", "name": "remote_id", "schema": { "type": "string", "nullable": true }, "description": "The API provider's ID for the given object." }, { "in": "query", "name": "started_after", "schema": { "type": "string", "format": "date-time", "nullable": true }, "description": "If provided, will only return employee payroll runs started after this datetime." }, { "in": "query", "name": "started_before", "schema": { "type": "string", "format": "date-time", "nullable": true }, "description": "If provided, will only return employee payroll runs started before this datetime." } ], "tags": [ "employee-payroll-runs" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedEmployeePayrollRunList" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC_BETA" } }, "/employee-payroll-runs/{id}": { "get": { "operationId": "employee_payroll_runs_retrieve", "description": "Returns an `EmployeePayrollRun` object with the given `id`.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "query", "name": "expand", "schema": { "type": "string", "enum": [ "employee", "employee,payroll_run", "payroll_run" ] }, "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.", "examples": { "ExpandEmployee,PayrollRun": { "value": "employee,payroll_run", "summary": "Expand Employee, Payroll_run" } } }, { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "query", "name": "include_remote_data", "schema": { "type": "boolean" }, "description": "Whether to include the original data Merge fetched from the third-party to produce these models." }, { "in": "query", "name": "include_shell_data", "schema": { "type": "boolean" }, "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)." } ], "tags": [ "employee-payroll-runs" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeePayrollRun" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC_BETA" } }, "/employees": { "get": { "operationId": "employees_list", "description": "Returns a list of `Employee` objects.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "query", "name": "company_id", "schema": { "type": "string" }, "description": "If provided, will only return employees for this company.", "examples": { "CompanyId": { "summary": "company_id" } } }, { "in": "query", "name": "created_after", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, will only return objects created after this datetime." }, { "in": "query", "name": "created_before", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, will only return objects created before this datetime." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "The pagination cursor value.", "examples": { "CursorExample": { "value": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", "summary": "Cursor Example" } } }, { "in": "query", "name": "display_full_name", "schema": { "type": "string", "nullable": true }, "description": "If provided, will only return employees with this display name." }, { "in": "query", "name": "employee_number", "schema": { "type": "string", "nullable": true }, "description": "If provided, will only return employees with this employee number." }, { "in": "query", "name": "employment_status", "schema": { "type": "string", "nullable": true, "enum": [ "ACTIVE", "INACTIVE", "PENDING" ] }, "description": "If provided, will only return employees with this employment status.\n\n" }, { "in": "query", "name": "employment_type", "schema": { "type": "string" }, "description": "If provided, will only return employees that have an employment of the specified employment type." }, { "in": "query", "name": "expand", "schema": { "type": "string", "enum": [ "company", "company,pay_group", "employments", "employments,company", "employments,company,pay_group", "employments,groups", "employments,groups,company", "employments,groups,company,pay_group", "employments,groups,home_location", "employments,groups,home_location,company", "employments,groups,home_location,company,pay_group", "employments,groups,home_location,manager", "employments,groups,home_location,manager,company", "employments,groups,home_location,manager,company,pay_group", "employments,groups,home_location,manager,pay_group", "employments,groups,home_location,manager,team", "employments,groups,home_location,manager,team,company", "employments,groups,home_location,manager,team,company,pay_group", "employments,groups,home_location,manager,team,pay_group", "employments,groups,home_location,pay_group", "employments,groups,home_location,team", "employments,groups,home_location,team,company", "employments,groups,home_location,team,company,pay_group", "employments,groups,home_location,team,pay_group", "employments,groups,home_location,work_location", "employments,groups,home_location,work_location,company", "employments,groups,home_location,work_location,company,pay_group", "employments,groups,home_location,work_location,manager", "employments,groups,home_location,work_location,manager,company", "employments,groups,home_location,work_location,manager,company,pay_group", "employments,groups,home_location,work_location,manager,pay_group", "employments,groups,home_location,work_location,manager,team", "employments,groups,home_location,work_location,manager,team,company", "employments,groups,home_location,work_location,manager,team,company,pay_group", "employments,groups,home_location,work_location,manager,team,pay_group", "employments,groups,home_location,work_location,pay_group", "employments,groups,home_location,work_location,team", "employments,groups,home_location,work_location,team,company", "employments,groups,home_location,work_location,team,company,pay_group", "employments,groups,home_location,work_location,team,pay_group", "employments,groups,manager", "employments,groups,manager,company", "employments,groups,manager,company,pay_group", "employments,groups,manager,pay_group", "employments,groups,manager,team", "employments,groups,manager,team,company", "employments,groups,manager,team,company,pay_group", "employments,groups,manager,team,pay_group", "employments,groups,pay_group", "employments,groups,team", "employments,groups,team,company", "employments,groups,team,company,pay_group", "employments,groups,team,pay_group", "employments,groups,work_location", "employments,groups,work_location,company", "employments,groups,work_location,company,pay_group", "employments,groups,work_location,manager", "employments,groups,work_location,manager,company", "employments,groups,work_location,manager,company,pay_group", "employments,groups,work_location,manager,pay_group", "employments,groups,work_location,manager,team", "employments,groups,work_location,manager,team,company", "employments,groups,work_location,manager,team,company,pay_group", "employments,groups,work_location,manager,team,pay_group", "employments,groups,work_location,pay_group", "employments,groups,work_location,team", "employments,groups,work_location,team,company", "employments,groups,work_location,team,company,pay_group", "employments,groups,work_location,team,pay_group", "employments,home_location", "employments,home_location,company", "employments,home_location,company,pay_group", "employments,home_location,manager", "employments,home_location,manager,company", "employments,home_location,manager,company,pay_group", "employments,home_location,manager,pay_group", "employments,home_location,manager,team", "employments,home_location,manager,team,company", "employments,home_location,manager,team,company,pay_group", "employments,home_location,manager,team,pay_group", "employments,home_location,pay_group", "employments,home_location,team", "employments,home_location,team,company", "employments,home_location,team,company,pay_group", "employments,home_location,team,pay_group", "employments,home_location,work_location", "employments,home_location,work_location,company", "employments,home_location,work_location,company,pay_group", "employments,home_location,work_location,manager", "employments,home_location,work_location,manager,company", "employments,home_location,work_location,manager,company,pay_group", "employments,home_location,work_location,manager,pay_group", "employments,home_location,work_location,manager,team", "employments,home_location,work_location,manager,team,company", "employments,home_location,work_location,manager,team,company,pay_group", "employments,home_location,work_location,manager,team,pay_group", "employments,home_location,work_location,pay_group", "employments,home_location,work_location,team", "employments,home_location,work_location,team,company", "employments,home_location,work_location,team,company,pay_group", "employments,home_location,work_location,team,pay_group", "employments,manager", "employments,manager,company", "employments,manager,company,pay_group", "employments,manager,pay_group", "employments,manager,team", "employments,manager,team,company", "employments,manager,team,company,pay_group", "employments,manager,team,pay_group", "employments,pay_group", "employments,team", "employments,team,company", "employments,team,company,pay_group", "employments,team,pay_group", "employments,work_location", "employments,work_location,company", "employments,work_location,company,pay_group", "employments,work_location,manager", "employments,work_location,manager,company", "employments,work_location,manager,company,pay_group", "employments,work_location,manager,pay_group", "employments,work_location,manager,team", "employments,work_location,manager,team,company", "employments,work_location,manager,team,company,pay_group", "employments,work_location,manager,team,pay_group", "employments,work_location,pay_group", "employments,work_location,team", "employments,work_location,team,company", "employments,work_location,team,company,pay_group", "employments,work_location,team,pay_group", "groups", "groups,company", "groups,company,pay_group", "groups,home_location", "groups,home_location,company", "groups,home_location,company,pay_group", "groups,home_location,manager", "groups,home_location,manager,company", "groups,home_location,manager,company,pay_group", "groups,home_location,manager,pay_group", "groups,home_location,manager,team", "groups,home_location,manager,team,company", "groups,home_location,manager,team,company,pay_group", "groups,home_location,manager,team,pay_group", "groups,home_location,pay_group", "groups,home_location,team", "groups,home_location,team,company", "groups,home_location,team,company,pay_group", "groups,home_location,team,pay_group", "groups,home_location,work_location", "groups,home_location,work_location,company", "groups,home_location,work_location,company,pay_group", "groups,home_location,work_location,manager", "groups,home_location,work_location,manager,company", "groups,home_location,work_location,manager,company,pay_group", "groups,home_location,work_location,manager,pay_group", "groups,home_location,work_location,manager,team", "groups,home_location,work_location,manager,team,company", "groups,home_location,work_location,manager,team,company,pay_group", "groups,home_location,work_location,manager,team,pay_group", "groups,home_location,work_location,pay_group", "groups,home_location,work_location,team", "groups,home_location,work_location,team,company", "groups,home_location,work_location,team,company,pay_group", "groups,home_location,work_location,team,pay_group", "groups,manager", "groups,manager,company", "groups,manager,company,pay_group", "groups,manager,pay_group", "groups,manager,team", "groups,manager,team,company", "groups,manager,team,company,pay_group", "groups,manager,team,pay_group", "groups,pay_group", "groups,team", "groups,team,company", "groups,team,company,pay_group", "groups,team,pay_group", "groups,work_location", "groups,work_location,company", "groups,work_location,company,pay_group", "groups,work_location,manager", "groups,work_location,manager,company", "groups,work_location,manager,company,pay_group", "groups,work_location,manager,pay_group", "groups,work_location,manager,team", "groups,work_location,manager,team,company", "groups,work_location,manager,team,company,pay_group", "groups,work_location,manager,team,pay_group", "groups,work_location,pay_group", "groups,work_location,team", "groups,work_location,team,company", "groups,work_location,team,company,pay_group", "groups,work_location,team,pay_group", "home_location", "home_location,company", "home_location,company,pay_group", "home_location,manager", "home_location,manager,company", "home_location,manager,company,pay_group", "home_location,manager,pay_group", "home_location,manager,team", "home_location,manager,team,company", "home_location,manager,team,company,pay_group", "home_location,manager,team,pay_group", "home_location,pay_group", "home_location,team", "home_location,team,company", "home_location,team,company,pay_group", "home_location,team,pay_group", "home_location,work_location", "home_location,work_location,company", "home_location,work_location,company,pay_group", "home_location,work_location,manager", "home_location,work_location,manager,company", "home_location,work_location,manager,company,pay_group", "home_location,work_location,manager,pay_group", "home_location,work_location,manager,team", "home_location,work_location,manager,team,company", "home_location,work_location,manager,team,company,pay_group", "home_location,work_location,manager,team,pay_group", "home_location,work_location,pay_group", "home_location,work_location,team", "home_location,work_location,team,company", "home_location,work_location,team,company,pay_group", "home_location,work_location,team,pay_group", "manager", "manager,company", "manager,company,pay_group", "manager,pay_group", "manager,team", "manager,team,company", "manager,team,company,pay_group", "manager,team,pay_group", "pay_group", "team", "team,company", "team,company,pay_group", "team,pay_group", "work_location", "work_location,company", "work_location,company,pay_group", "work_location,manager", "work_location,manager,company", "work_location,manager,company,pay_group", "work_location,manager,pay_group", "work_location,manager,team", "work_location,manager,team,company", "work_location,manager,team,company,pay_group", "work_location,manager,team,pay_group", "work_location,pay_group", "work_location,team", "work_location,team,company", "work_location,team,company,pay_group", "work_location,team,pay_group" ] }, "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.", "examples": { "ExpandEmployments,Groups,HomeLocation,WorkLocation,Manager,Team,Company,PayGroup": { "value": "employments,groups,home_location,work_location,manager,team,company,pay_group", "summary": "Expand Employments, Groups, Home_location, Work_location, Manager, Team, Company, Pay_group" } } }, { "in": "query", "name": "first_name", "schema": { "type": "string", "nullable": true }, "description": "If provided, will only return employees with this first name." }, { "in": "query", "name": "groups", "schema": { "type": "string" }, "description": "If provided, will only return employees matching the group ids; multiple groups can be separated by commas." }, { "in": "query", "name": "home_location_id", "schema": { "type": "string" }, "description": "If provided, will only return employees for this home location.", "examples": { "HomeLocationId": { "summary": "home_location_id" } } }, { "in": "query", "name": "include_deleted_data", "schema": { "type": "boolean" }, "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)." }, { "in": "query", "name": "include_remote_data", "schema": { "type": "boolean" }, "description": "Whether to include the original data Merge fetched from the third-party to produce these models." }, { "in": "query", "name": "include_sensitive_fields", "schema": { "type": "boolean" }, "description": "Whether to include sensitive fields (such as social security numbers) in the response." }, { "in": "query", "name": "include_shell_data", "schema": { "type": "boolean" }, "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)." }, { "in": "query", "name": "job_title", "schema": { "type": "string" }, "description": "If provided, will only return employees that have an employment of the specified job title." }, { "in": "query", "name": "last_name", "schema": { "type": "string", "nullable": true }, "description": "If provided, will only return employees with this last name." }, { "in": "query", "name": "manager_id", "schema": { "type": "string" }, "description": "If provided, will only return employees for this manager.", "examples": { "ManagerId": { "summary": "manager_id" } } }, { "in": "query", "name": "modified_after", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, only objects synced by Merge after this date time will be returned." }, { "in": "query", "name": "modified_before", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, only objects synced by Merge before this date time will be returned." }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page. The maximum limit is 100.", "schema": { "type": "integer" } }, { "in": "query", "name": "pay_group_id", "schema": { "type": "string" }, "description": "If provided, will only return employees for this pay group", "examples": { "PayGroupId": { "summary": "pay_group_id" } } }, { "in": "query", "name": "personal_email", "schema": { "type": "string" }, "description": "If provided, will only return Employees with this personal email" }, { "in": "query", "name": "remote_fields", "schema": { "type": "string", "enum": [ "employment_status", "employment_status,ethnicity", "employment_status,ethnicity,gender", "employment_status,ethnicity,gender,marital_status", "employment_status,ethnicity,marital_status", "employment_status,gender", "employment_status,gender,marital_status", "employment_status,marital_status", "ethnicity", "ethnicity,gender", "ethnicity,gender,marital_status", "ethnicity,marital_status", "gender", "gender,marital_status", "marital_status" ] }, "description": "Deprecated. Use show_enum_origins.", "examples": { "OriginalEnumValuesEmploymentStatus,Ethnicity,Gender,MaritalStatus": { "value": "employment_status,ethnicity,gender,marital_status", "summary": "Original Enum Values Employment_status, Ethnicity, Gender, Marital_status" } } }, { "in": "query", "name": "remote_id", "schema": { "type": "string", "nullable": true }, "description": "The API provider's ID for the given object." }, { "in": "query", "name": "show_enum_origins", "schema": { "type": "string", "enum": [ "employment_status", "employment_status,ethnicity", "employment_status,ethnicity,gender", "employment_status,ethnicity,gender,marital_status", "employment_status,ethnicity,marital_status", "employment_status,gender", "employment_status,gender,marital_status", "employment_status,marital_status", "ethnicity", "ethnicity,gender", "ethnicity,gender,marital_status", "ethnicity,marital_status", "gender", "gender,marital_status", "marital_status" ] }, "description": "A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)", "examples": { "OriginalEnumValuesEmploymentStatus,Ethnicity,Gender,MaritalStatus": { "value": "employment_status,ethnicity,gender,marital_status", "summary": "Original Enum Values Employment_status, Ethnicity, Gender, Marital_status" } } }, { "in": "query", "name": "show_native_enum_values", "schema": { "type": "boolean" }, "description": "Whether to include the third party's original value for each enum field as `_native`, alongside Merge's normalized ``." }, { "in": "query", "name": "started_after", "schema": { "type": "string", "format": "date-time", "nullable": true }, "description": "If provided, will only return employees that started after this datetime." }, { "in": "query", "name": "started_before", "schema": { "type": "string", "format": "date-time", "nullable": true }, "description": "If provided, will only return employees that started before this datetime." }, { "in": "query", "name": "team_id", "schema": { "type": "string" }, "description": "If provided, will only return employees for this team.", "examples": { "TeamId": { "summary": "team_id" } } }, { "in": "query", "name": "terminated_after", "schema": { "type": "string", "format": "date-time", "nullable": true }, "description": "If provided, will only return employees that were terminated after this datetime." }, { "in": "query", "name": "terminated_before", "schema": { "type": "string", "format": "date-time", "nullable": true }, "description": "If provided, will only return employees that were terminated before this datetime." }, { "in": "query", "name": "work_email", "schema": { "type": "string" }, "description": "If provided, will only return Employees with this work email" }, { "in": "query", "name": "work_location_id", "schema": { "type": "string" }, "description": "If provided, will only return employees for this location.", "examples": { "WorkLocationId": { "summary": "work_location_id" } } } ], "tags": [ "employees" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedEmployeeList" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" }, "post": { "operationId": "employees_create", "description": "Creates an `Employee` object with the given values.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "query", "name": "is_debug_mode", "schema": { "type": "boolean" }, "description": "Whether to include debug fields (such as log file links) in the response." }, { "in": "query", "name": "run_async", "schema": { "type": "boolean" }, "description": "Whether or not third-party updates should be run asynchronously." } ], "tags": [ "employees" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeEndpointRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/EmployeeEndpointRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/EmployeeEndpointRequest" } } }, "required": true }, "security": [ { "tokenAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeResponse" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_HIDDEN" } }, "/employees/{id}": { "get": { "operationId": "employees_retrieve", "description": "Returns an `Employee` object with the given `id`.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "query", "name": "expand", "schema": { "type": "string", "enum": [ "company", "company,pay_group", "employments", "employments,company", "employments,company,pay_group", "employments,groups", "employments,groups,company", "employments,groups,company,pay_group", "employments,groups,home_location", "employments,groups,home_location,company", "employments,groups,home_location,company,pay_group", "employments,groups,home_location,manager", "employments,groups,home_location,manager,company", "employments,groups,home_location,manager,company,pay_group", "employments,groups,home_location,manager,pay_group", "employments,groups,home_location,manager,team", "employments,groups,home_location,manager,team,company", "employments,groups,home_location,manager,team,company,pay_group", "employments,groups,home_location,manager,team,pay_group", "employments,groups,home_location,pay_group", "employments,groups,home_location,team", "employments,groups,home_location,team,company", "employments,groups,home_location,team,company,pay_group", "employments,groups,home_location,team,pay_group", "employments,groups,home_location,work_location", "employments,groups,home_location,work_location,company", "employments,groups,home_location,work_location,company,pay_group", "employments,groups,home_location,work_location,manager", "employments,groups,home_location,work_location,manager,company", "employments,groups,home_location,work_location,manager,company,pay_group", "employments,groups,home_location,work_location,manager,pay_group", "employments,groups,home_location,work_location,manager,team", "employments,groups,home_location,work_location,manager,team,company", "employments,groups,home_location,work_location,manager,team,company,pay_group", "employments,groups,home_location,work_location,manager,team,pay_group", "employments,groups,home_location,work_location,pay_group", "employments,groups,home_location,work_location,team", "employments,groups,home_location,work_location,team,company", "employments,groups,home_location,work_location,team,company,pay_group", "employments,groups,home_location,work_location,team,pay_group", "employments,groups,manager", "employments,groups,manager,company", "employments,groups,manager,company,pay_group", "employments,groups,manager,pay_group", "employments,groups,manager,team", "employments,groups,manager,team,company", "employments,groups,manager,team,company,pay_group", "employments,groups,manager,team,pay_group", "employments,groups,pay_group", "employments,groups,team", "employments,groups,team,company", "employments,groups,team,company,pay_group", "employments,groups,team,pay_group", "employments,groups,work_location", "employments,groups,work_location,company", "employments,groups,work_location,company,pay_group", "employments,groups,work_location,manager", "employments,groups,work_location,manager,company", "employments,groups,work_location,manager,company,pay_group", "employments,groups,work_location,manager,pay_group", "employments,groups,work_location,manager,team", "employments,groups,work_location,manager,team,company", "employments,groups,work_location,manager,team,company,pay_group", "employments,groups,work_location,manager,team,pay_group", "employments,groups,work_location,pay_group", "employments,groups,work_location,team", "employments,groups,work_location,team,company", "employments,groups,work_location,team,company,pay_group", "employments,groups,work_location,team,pay_group", "employments,home_location", "employments,home_location,company", "employments,home_location,company,pay_group", "employments,home_location,manager", "employments,home_location,manager,company", "employments,home_location,manager,company,pay_group", "employments,home_location,manager,pay_group", "employments,home_location,manager,team", "employments,home_location,manager,team,company", "employments,home_location,manager,team,company,pay_group", "employments,home_location,manager,team,pay_group", "employments,home_location,pay_group", "employments,home_location,team", "employments,home_location,team,company", "employments,home_location,team,company,pay_group", "employments,home_location,team,pay_group", "employments,home_location,work_location", "employments,home_location,work_location,company", "employments,home_location,work_location,company,pay_group", "employments,home_location,work_location,manager", "employments,home_location,work_location,manager,company", "employments,home_location,work_location,manager,company,pay_group", "employments,home_location,work_location,manager,pay_group", "employments,home_location,work_location,manager,team", "employments,home_location,work_location,manager,team,company", "employments,home_location,work_location,manager,team,company,pay_group", "employments,home_location,work_location,manager,team,pay_group", "employments,home_location,work_location,pay_group", "employments,home_location,work_location,team", "employments,home_location,work_location,team,company", "employments,home_location,work_location,team,company,pay_group", "employments,home_location,work_location,team,pay_group", "employments,manager", "employments,manager,company", "employments,manager,company,pay_group", "employments,manager,pay_group", "employments,manager,team", "employments,manager,team,company", "employments,manager,team,company,pay_group", "employments,manager,team,pay_group", "employments,pay_group", "employments,team", "employments,team,company", "employments,team,company,pay_group", "employments,team,pay_group", "employments,work_location", "employments,work_location,company", "employments,work_location,company,pay_group", "employments,work_location,manager", "employments,work_location,manager,company", "employments,work_location,manager,company,pay_group", "employments,work_location,manager,pay_group", "employments,work_location,manager,team", "employments,work_location,manager,team,company", "employments,work_location,manager,team,company,pay_group", "employments,work_location,manager,team,pay_group", "employments,work_location,pay_group", "employments,work_location,team", "employments,work_location,team,company", "employments,work_location,team,company,pay_group", "employments,work_location,team,pay_group", "groups", "groups,company", "groups,company,pay_group", "groups,home_location", "groups,home_location,company", "groups,home_location,company,pay_group", "groups,home_location,manager", "groups,home_location,manager,company", "groups,home_location,manager,company,pay_group", "groups,home_location,manager,pay_group", "groups,home_location,manager,team", "groups,home_location,manager,team,company", "groups,home_location,manager,team,company,pay_group", "groups,home_location,manager,team,pay_group", "groups,home_location,pay_group", "groups,home_location,team", "groups,home_location,team,company", "groups,home_location,team,company,pay_group", "groups,home_location,team,pay_group", "groups,home_location,work_location", "groups,home_location,work_location,company", "groups,home_location,work_location,company,pay_group", "groups,home_location,work_location,manager", "groups,home_location,work_location,manager,company", "groups,home_location,work_location,manager,company,pay_group", "groups,home_location,work_location,manager,pay_group", "groups,home_location,work_location,manager,team", "groups,home_location,work_location,manager,team,company", "groups,home_location,work_location,manager,team,company,pay_group", "groups,home_location,work_location,manager,team,pay_group", "groups,home_location,work_location,pay_group", "groups,home_location,work_location,team", "groups,home_location,work_location,team,company", "groups,home_location,work_location,team,company,pay_group", "groups,home_location,work_location,team,pay_group", "groups,manager", "groups,manager,company", "groups,manager,company,pay_group", "groups,manager,pay_group", "groups,manager,team", "groups,manager,team,company", "groups,manager,team,company,pay_group", "groups,manager,team,pay_group", "groups,pay_group", "groups,team", "groups,team,company", "groups,team,company,pay_group", "groups,team,pay_group", "groups,work_location", "groups,work_location,company", "groups,work_location,company,pay_group", "groups,work_location,manager", "groups,work_location,manager,company", "groups,work_location,manager,company,pay_group", "groups,work_location,manager,pay_group", "groups,work_location,manager,team", "groups,work_location,manager,team,company", "groups,work_location,manager,team,company,pay_group", "groups,work_location,manager,team,pay_group", "groups,work_location,pay_group", "groups,work_location,team", "groups,work_location,team,company", "groups,work_location,team,company,pay_group", "groups,work_location,team,pay_group", "home_location", "home_location,company", "home_location,company,pay_group", "home_location,manager", "home_location,manager,company", "home_location,manager,company,pay_group", "home_location,manager,pay_group", "home_location,manager,team", "home_location,manager,team,company", "home_location,manager,team,company,pay_group", "home_location,manager,team,pay_group", "home_location,pay_group", "home_location,team", "home_location,team,company", "home_location,team,company,pay_group", "home_location,team,pay_group", "home_location,work_location", "home_location,work_location,company", "home_location,work_location,company,pay_group", "home_location,work_location,manager", "home_location,work_location,manager,company", "home_location,work_location,manager,company,pay_group", "home_location,work_location,manager,pay_group", "home_location,work_location,manager,team", "home_location,work_location,manager,team,company", "home_location,work_location,manager,team,company,pay_group", "home_location,work_location,manager,team,pay_group", "home_location,work_location,pay_group", "home_location,work_location,team", "home_location,work_location,team,company", "home_location,work_location,team,company,pay_group", "home_location,work_location,team,pay_group", "manager", "manager,company", "manager,company,pay_group", "manager,pay_group", "manager,team", "manager,team,company", "manager,team,company,pay_group", "manager,team,pay_group", "pay_group", "team", "team,company", "team,company,pay_group", "team,pay_group", "work_location", "work_location,company", "work_location,company,pay_group", "work_location,manager", "work_location,manager,company", "work_location,manager,company,pay_group", "work_location,manager,pay_group", "work_location,manager,team", "work_location,manager,team,company", "work_location,manager,team,company,pay_group", "work_location,manager,team,pay_group", "work_location,pay_group", "work_location,team", "work_location,team,company", "work_location,team,company,pay_group", "work_location,team,pay_group" ] }, "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.", "examples": { "ExpandEmployments,Groups,HomeLocation,WorkLocation,Manager,Team,Company,PayGroup": { "value": "employments,groups,home_location,work_location,manager,team,company,pay_group", "summary": "Expand Employments, Groups, Home_location, Work_location, Manager, Team, Company, Pay_group" } } }, { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "query", "name": "include_remote_data", "schema": { "type": "boolean" }, "description": "Whether to include the original data Merge fetched from the third-party to produce these models." }, { "in": "query", "name": "include_sensitive_fields", "schema": { "type": "boolean" }, "description": "Whether to include sensitive fields (such as social security numbers) in the response." }, { "in": "query", "name": "include_shell_data", "schema": { "type": "boolean" }, "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)." }, { "in": "query", "name": "remote_fields", "schema": { "type": "string", "enum": [ "employment_status", "employment_status,ethnicity", "employment_status,ethnicity,gender", "employment_status,ethnicity,gender,marital_status", "employment_status,ethnicity,marital_status", "employment_status,gender", "employment_status,gender,marital_status", "employment_status,marital_status", "ethnicity", "ethnicity,gender", "ethnicity,gender,marital_status", "ethnicity,marital_status", "gender", "gender,marital_status", "marital_status" ] }, "description": "Deprecated. Use show_enum_origins.", "examples": { "OriginalEnumValuesEmploymentStatus,Ethnicity,Gender,MaritalStatus": { "value": "employment_status,ethnicity,gender,marital_status", "summary": "Original Enum Values Employment_status, Ethnicity, Gender, Marital_status" } } }, { "in": "query", "name": "show_enum_origins", "schema": { "type": "string", "enum": [ "employment_status", "employment_status,ethnicity", "employment_status,ethnicity,gender", "employment_status,ethnicity,gender,marital_status", "employment_status,ethnicity,marital_status", "employment_status,gender", "employment_status,gender,marital_status", "employment_status,marital_status", "ethnicity", "ethnicity,gender", "ethnicity,gender,marital_status", "ethnicity,marital_status", "gender", "gender,marital_status", "marital_status" ] }, "description": "A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)", "examples": { "OriginalEnumValuesEmploymentStatus,Ethnicity,Gender,MaritalStatus": { "value": "employment_status,ethnicity,gender,marital_status", "summary": "Original Enum Values Employment_status, Ethnicity, Gender, Marital_status" } } }, { "in": "query", "name": "show_native_enum_values", "schema": { "type": "boolean" }, "description": "Whether to include the third party's original value for each enum field as `_native`, alongside Merge's normalized ``." } ], "tags": [ "employees" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Employee" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/employees/ignore/{model_id}": { "post": { "operationId": "employees_ignore_create", "description": "Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The \"reason\" and \"message\" fields in the request body will be stored for audit purposes.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "path", "name": "model_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "employees" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IgnoreCommonModelRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/IgnoreCommonModelRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/IgnoreCommonModelRequest" } } }, "required": true }, "security": [ { "tokenAuth": [] } ], "responses": { "200": { "description": "No response body" } }, "x-extra-tags": [ "ignore-model" ] } }, "/employees/meta/post": { "get": { "operationId": "employees_meta_post_retrieve", "description": "Returns metadata for `Employee` POSTs.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true } ], "tags": [ "employees" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetaResponse" } } }, "description": "" } }, "x-merge-meta-post": "META_POST", "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/employer-benefits": { "get": { "operationId": "employer_benefits_list", "description": "Returns a list of `EmployerBenefit` objects.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "query", "name": "created_after", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, will only return objects created after this datetime." }, { "in": "query", "name": "created_before", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, will only return objects created before this datetime." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "The pagination cursor value.", "examples": { "CursorExample": { "value": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", "summary": "Cursor Example" } } }, { "in": "query", "name": "include_deleted_data", "schema": { "type": "boolean" }, "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)." }, { "in": "query", "name": "include_remote_data", "schema": { "type": "boolean" }, "description": "Whether to include the original data Merge fetched from the third-party to produce these models." }, { "in": "query", "name": "include_shell_data", "schema": { "type": "boolean" }, "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)." }, { "in": "query", "name": "modified_after", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, only objects synced by Merge after this date time will be returned." }, { "in": "query", "name": "modified_before", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, only objects synced by Merge before this date time will be returned." }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page. The maximum limit is 100.", "schema": { "type": "integer" } }, { "in": "query", "name": "remote_id", "schema": { "type": "string", "nullable": true }, "description": "The API provider's ID for the given object." } ], "tags": [ "employer-benefits" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedEmployerBenefitList" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC_BETA" } }, "/employer-benefits/{id}": { "get": { "operationId": "employer_benefits_retrieve", "description": "Returns an `EmployerBenefit` object with the given `id`.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "query", "name": "include_remote_data", "schema": { "type": "boolean" }, "description": "Whether to include the original data Merge fetched from the third-party to produce these models." }, { "in": "query", "name": "include_shell_data", "schema": { "type": "boolean" }, "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)." } ], "tags": [ "employer-benefits" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployerBenefit" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC_BETA" } }, "/employments": { "get": { "operationId": "employments_list", "description": "Returns a list of `Employment` objects.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "query", "name": "created_after", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, will only return objects created after this datetime." }, { "in": "query", "name": "created_before", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, will only return objects created before this datetime." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "The pagination cursor value.", "examples": { "CursorExample": { "value": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", "summary": "Cursor Example" } } }, { "in": "query", "name": "employee_id", "schema": { "type": "string" }, "description": "If provided, will only return employments for this employee.", "examples": { "EmployeeId": { "summary": "employee_id" } } }, { "in": "query", "name": "expand", "schema": { "type": "string", "enum": [ "employee", "employee,pay_group", "pay_group" ] }, "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.", "examples": { "ExpandEmployee,PayGroup": { "value": "employee,pay_group", "summary": "Expand Employee, Pay_group" } } }, { "in": "query", "name": "include_deleted_data", "schema": { "type": "boolean" }, "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)." }, { "in": "query", "name": "include_remote_data", "schema": { "type": "boolean" }, "description": "Whether to include the original data Merge fetched from the third-party to produce these models." }, { "in": "query", "name": "include_shell_data", "schema": { "type": "boolean" }, "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)." }, { "in": "query", "name": "modified_after", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, only objects synced by Merge after this date time will be returned." }, { "in": "query", "name": "modified_before", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, only objects synced by Merge before this date time will be returned." }, { "in": "query", "name": "order_by", "schema": { "type": "string", "enum": [ "-effective_date", "effective_date" ] }, "description": "Overrides the default ordering for this endpoint. Possible values include: effective_date, -effective_date.", "x-fern-enum": { "effective_date": { "name": "EffectiveDateAscending" }, "-effective_date": { "name": "EffectiveDateDescending" } } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page. The maximum limit is 100.", "schema": { "type": "integer" } }, { "in": "query", "name": "remote_fields", "schema": { "type": "string", "enum": [ "employment_type", "employment_type,flsa_status", "employment_type,flsa_status,pay_frequency", "employment_type,flsa_status,pay_frequency,pay_period", "employment_type,flsa_status,pay_period", "employment_type,pay_frequency", "employment_type,pay_frequency,pay_period", "employment_type,pay_period", "flsa_status", "flsa_status,pay_frequency", "flsa_status,pay_frequency,pay_period", "flsa_status,pay_period", "pay_frequency", "pay_frequency,pay_period", "pay_period" ] }, "description": "Deprecated. Use show_enum_origins.", "examples": { "OriginalEnumValuesEmploymentType,FlsaStatus,PayFrequency,PayPeriod": { "value": "employment_type,flsa_status,pay_frequency,pay_period", "summary": "Original Enum Values Employment_type, Flsa_status, Pay_frequency, Pay_period" } } }, { "in": "query", "name": "remote_id", "schema": { "type": "string", "nullable": true }, "description": "The API provider's ID for the given object." }, { "in": "query", "name": "show_enum_origins", "schema": { "type": "string", "enum": [ "employment_type", "employment_type,flsa_status", "employment_type,flsa_status,pay_frequency", "employment_type,flsa_status,pay_frequency,pay_period", "employment_type,flsa_status,pay_period", "employment_type,pay_frequency", "employment_type,pay_frequency,pay_period", "employment_type,pay_period", "flsa_status", "flsa_status,pay_frequency", "flsa_status,pay_frequency,pay_period", "flsa_status,pay_period", "pay_frequency", "pay_frequency,pay_period", "pay_period" ] }, "description": "A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)", "examples": { "OriginalEnumValuesEmploymentType,FlsaStatus,PayFrequency,PayPeriod": { "value": "employment_type,flsa_status,pay_frequency,pay_period", "summary": "Original Enum Values Employment_type, Flsa_status, Pay_frequency, Pay_period" } } }, { "in": "query", "name": "show_native_enum_values", "schema": { "type": "boolean" }, "description": "Whether to include the third party's original value for each enum field as `_native`, alongside Merge's normalized ``." } ], "tags": [ "employments" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedEmploymentList" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/employments/{id}": { "get": { "operationId": "employments_retrieve", "description": "Returns an `Employment` object with the given `id`.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "query", "name": "expand", "schema": { "type": "string", "enum": [ "employee", "employee,pay_group", "pay_group" ] }, "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.", "examples": { "ExpandEmployee,PayGroup": { "value": "employee,pay_group", "summary": "Expand Employee, Pay_group" } } }, { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "query", "name": "include_remote_data", "schema": { "type": "boolean" }, "description": "Whether to include the original data Merge fetched from the third-party to produce these models." }, { "in": "query", "name": "include_shell_data", "schema": { "type": "boolean" }, "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)." }, { "in": "query", "name": "remote_fields", "schema": { "type": "string", "enum": [ "employment_type", "employment_type,flsa_status", "employment_type,flsa_status,pay_frequency", "employment_type,flsa_status,pay_frequency,pay_period", "employment_type,flsa_status,pay_period", "employment_type,pay_frequency", "employment_type,pay_frequency,pay_period", "employment_type,pay_period", "flsa_status", "flsa_status,pay_frequency", "flsa_status,pay_frequency,pay_period", "flsa_status,pay_period", "pay_frequency", "pay_frequency,pay_period", "pay_period" ] }, "description": "Deprecated. Use show_enum_origins.", "examples": { "OriginalEnumValuesEmploymentType,FlsaStatus,PayFrequency,PayPeriod": { "value": "employment_type,flsa_status,pay_frequency,pay_period", "summary": "Original Enum Values Employment_type, Flsa_status, Pay_frequency, Pay_period" } } }, { "in": "query", "name": "show_enum_origins", "schema": { "type": "string", "enum": [ "employment_type", "employment_type,flsa_status", "employment_type,flsa_status,pay_frequency", "employment_type,flsa_status,pay_frequency,pay_period", "employment_type,flsa_status,pay_period", "employment_type,pay_frequency", "employment_type,pay_frequency,pay_period", "employment_type,pay_period", "flsa_status", "flsa_status,pay_frequency", "flsa_status,pay_frequency,pay_period", "flsa_status,pay_period", "pay_frequency", "pay_frequency,pay_period", "pay_period" ] }, "description": "A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)", "examples": { "OriginalEnumValuesEmploymentType,FlsaStatus,PayFrequency,PayPeriod": { "value": "employment_type,flsa_status,pay_frequency,pay_period", "summary": "Original Enum Values Employment_type, Flsa_status, Pay_frequency, Pay_period" } } }, { "in": "query", "name": "show_native_enum_values", "schema": { "type": "boolean" }, "description": "Whether to include the third party's original value for each enum field as `_native`, alongside Merge's normalized ``." } ], "tags": [ "employments" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Employment" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/field-mappings": { "get": { "operationId": "field_mappings_retrieve", "description": "Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "query", "name": "exclude_remote_field_metadata", "schema": { "type": "boolean" }, "description": "If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations." } ], "tags": [ "field-mapping" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldMappingApiInstanceResponse" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" }, "post": { "operationId": "field_mappings_create", "description": "Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "query", "name": "exclude_remote_field_metadata", "schema": { "type": "boolean" }, "description": "If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations." }, { "in": "query", "name": "remote_data_iteration_count", "schema": { "type": "integer" }, "description": "Number of common model instances to iterate through when fetching remote data for field mappings. Defaults to 250 if not provided." } ], "tags": [ "field-mapping" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFieldMappingRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CreateFieldMappingRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CreateFieldMappingRequest" } } }, "required": true }, "security": [ { "tokenAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldMappingInstanceResponse" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/field-mappings/{field_mapping_id}": { "patch": { "operationId": "field_mappings_partial_update", "description": "Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "path", "name": "field_mapping_id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "query", "name": "remote_data_iteration_count", "schema": { "type": "integer" }, "description": "Number of common model instances to iterate through when fetching remote data for field mappings. Defaults to 250 if not provided." } ], "tags": [ "field-mapping" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedEditFieldMappingRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedEditFieldMappingRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedEditFieldMappingRequest" } } } }, "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldMappingInstanceResponse" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" }, "delete": { "operationId": "field_mappings_destroy", "description": "Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "path", "name": "field_mapping_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "field-mapping" ], "security": [ { "tokenAuth": [] } ], "responses": { "204": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldMappingInstanceResponse" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/generate-key": { "post": { "operationId": "generate_key_create", "description": "Create a remote key.", "tags": [ "generate-key" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateRemoteKeyRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/GenerateRemoteKeyRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/GenerateRemoteKeyRequest" } } }, "required": true }, "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteKey" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/groups": { "get": { "operationId": "groups_list", "description": "Returns a list of `Group` objects.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "query", "name": "created_after", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, will only return objects created after this datetime." }, { "in": "query", "name": "created_before", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, will only return objects created before this datetime." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "The pagination cursor value.", "examples": { "CursorExample": { "value": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", "summary": "Cursor Example" } } }, { "in": "query", "name": "expand", "schema": { "type": "string", "enum": [ "parent_group" ] }, "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.", "examples": { "ExpandParentGroup": { "value": "parent_group", "summary": "Expand Parent_group" } } }, { "in": "query", "name": "include_deleted_data", "schema": { "type": "boolean" }, "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)." }, { "in": "query", "name": "include_remote_data", "schema": { "type": "boolean" }, "description": "Whether to include the original data Merge fetched from the third-party to produce these models." }, { "in": "query", "name": "include_shell_data", "schema": { "type": "boolean" }, "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)." }, { "in": "query", "name": "is_commonly_used_as_team", "schema": { "type": "string" }, "description": "If provided, specifies whether to return only Group objects which refer to a team in the third party platform. Note that this is an opinionated view based on how a team may be represented in the third party platform." }, { "in": "query", "name": "modified_after", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, only objects synced by Merge after this date time will be returned." }, { "in": "query", "name": "modified_before", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, only objects synced by Merge before this date time will be returned." }, { "in": "query", "name": "names", "schema": { "type": "string" }, "description": "If provided, will only return groups with these names. Multiple values can be separated by commas." }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page. The maximum limit is 100.", "schema": { "type": "integer" } }, { "in": "query", "name": "remote_fields", "schema": { "type": "string", "enum": [ "type" ] }, "description": "Deprecated. Use show_enum_origins.", "examples": { "OriginalEnumValuesType": { "value": "type", "summary": "Original Enum Values Type" } } }, { "in": "query", "name": "remote_id", "schema": { "type": "string", "nullable": true }, "description": "The API provider's ID for the given object." }, { "in": "query", "name": "show_enum_origins", "schema": { "type": "string", "enum": [ "type" ] }, "description": "A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)", "examples": { "OriginalEnumValuesType": { "value": "type", "summary": "Original Enum Values Type" } } }, { "in": "query", "name": "show_native_enum_values", "schema": { "type": "boolean" }, "description": "Whether to include the third party's original value for each enum field as `_native`, alongside Merge's normalized ``." }, { "in": "query", "name": "types", "schema": { "type": "string" }, "description": "If provided, will only return groups of these types. Multiple values can be separated by commas." } ], "tags": [ "groups" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedGroupList" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/groups/{id}": { "get": { "operationId": "groups_retrieve", "description": "Returns a `Group` object with the given `id`.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "query", "name": "expand", "schema": { "type": "string", "enum": [ "parent_group" ] }, "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.", "examples": { "ExpandParentGroup": { "value": "parent_group", "summary": "Expand Parent_group" } } }, { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "query", "name": "include_remote_data", "schema": { "type": "boolean" }, "description": "Whether to include the original data Merge fetched from the third-party to produce these models." }, { "in": "query", "name": "include_shell_data", "schema": { "type": "boolean" }, "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)." }, { "in": "query", "name": "remote_fields", "schema": { "type": "string", "enum": [ "type" ] }, "description": "Deprecated. Use show_enum_origins.", "examples": { "OriginalEnumValuesType": { "value": "type", "summary": "Original Enum Values Type" } } }, { "in": "query", "name": "show_enum_origins", "schema": { "type": "string", "enum": [ "type" ] }, "description": "A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)", "examples": { "OriginalEnumValuesType": { "value": "type", "summary": "Original Enum Values Type" } } }, { "in": "query", "name": "show_native_enum_values", "schema": { "type": "boolean" }, "description": "Whether to include the third party's original value for each enum field as `_native`, alongside Merge's normalized ``." } ], "tags": [ "groups" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/groups/types": { "get": { "operationId": "groups_types_list", "description": "Returns a list of distinct group type values from the Groups common model.", "summary": "Get group types", "parameters": [ { "in": "query", "name": "include_deleted_data", "schema": { "type": "boolean" }, "description": "Whether to include data that was marked as deleted by third party webhooks." }, { "in": "query", "name": "show_enum_origins", "schema": { "type": "string" }, "description": "A comma separated list of enum field names for which you'd like the original values instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)" } ], "tags": [ "groups" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "types": { "type": "array", "items": { "type": "string" }, "description": "List of distinct group types" } }, "example": { "types": [ "DEPARTMENT", "COST_CENTER" ] } } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC_BETA" } }, "/issues": { "get": { "operationId": "issues_list", "description": "Gets all issues for Organization.", "parameters": [ { "in": "query", "name": "account_token", "schema": { "type": "string" } }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "The pagination cursor value.", "examples": { "CursorExample": { "value": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", "summary": "Cursor Example" } } }, { "in": "query", "name": "end_date", "schema": { "type": "string" }, "description": "If included, will only include issues whose most recent action occurred before this time" }, { "in": "query", "name": "end_user_organization_name", "schema": { "type": "string" } }, { "in": "query", "name": "first_incident_time_after", "schema": { "type": "string", "format": "date-time", "nullable": true }, "description": "If provided, will only return issues whose first incident time was after this datetime." }, { "in": "query", "name": "first_incident_time_before", "schema": { "type": "string", "format": "date-time", "nullable": true }, "description": "If provided, will only return issues whose first incident time was before this datetime." }, { "in": "query", "name": "include_muted", "schema": { "type": "string" }, "description": "If true, will include muted issues" }, { "in": "query", "name": "integration_name", "schema": { "type": "string" } }, { "in": "query", "name": "last_incident_time_after", "schema": { "type": "string", "format": "date-time", "nullable": true }, "description": "If provided, will only return issues whose last incident time was after this datetime." }, { "in": "query", "name": "last_incident_time_before", "schema": { "type": "string", "format": "date-time", "nullable": true }, "description": "If provided, will only return issues whose last incident time was before this datetime." }, { "in": "query", "name": "linked_account_id", "schema": { "type": "string" }, "description": "If provided, will only include issues pertaining to the linked account passed in." }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page. The maximum limit is 100.", "schema": { "type": "integer" } }, { "in": "query", "name": "start_date", "schema": { "type": "string" }, "description": "If included, will only include issues whose most recent action occurred after this time" }, { "in": "query", "name": "status", "schema": { "type": "string", "enum": [ "ONGOING", "RESOLVED" ] }, "description": "Status of the issue." } ], "tags": [ "issues" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedIssueList" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/issues/{id}": { "get": { "operationId": "issues_retrieve", "description": "Get a specific issue.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "issues" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Issue" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/link-token": { "post": { "operationId": "link_token_create", "description": "Creates a link token to be used when linking a new end user. The link token expires after single use.", "tags": [ "link-token" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndUserDetailsRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/EndUserDetailsRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/EndUserDetailsRequest" } } }, "required": true }, "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkToken" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/linked-account-scopes": { "get": { "operationId": "linked_account_scopes_retrieve", "description": "Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes).", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true } ], "tags": [ "scopes" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonModelScopeAPI" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" }, "post": { "operationId": "linked_account_scopes_create", "description": "Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true } ], "tags": [ "scopes" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkedAccountCommonModelScopeDeserializerRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/LinkedAccountCommonModelScopeDeserializerRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/LinkedAccountCommonModelScopeDeserializerRequest" } } }, "required": true }, "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonModelScopeAPI" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC_BETA" } }, "/linked-accounts": { "get": { "operationId": "linked_accounts_list", "description": "List linked accounts for your organization.", "parameters": [ { "in": "query", "name": "category", "schema": { "type": "string", "nullable": true, "enum": [ "accounting", "ats", "chat", "crm", "filestorage", "hris", "knowledgebase", "mktg", "ticketing" ] }, "description": "Options: `hris`, `ats`, `accounting`, `ticketing`, `crm`, `mktg`, `filestorage`, `knowledgebase`, `chat`" }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "The pagination cursor value.", "examples": { "CursorExample": { "value": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", "summary": "Cursor Example" } } }, { "in": "query", "name": "end_user_email_address", "schema": { "type": "string" }, "description": "If provided, will only return linked accounts associated with the given email address." }, { "in": "query", "name": "end_user_organization_name", "schema": { "type": "string" }, "description": "If provided, will only return linked accounts associated with the given organization name." }, { "in": "query", "name": "end_user_origin_id", "schema": { "type": "string" }, "description": "If provided, will only return linked accounts associated with the given origin ID." }, { "in": "query", "name": "end_user_origin_ids", "schema": { "type": "string" }, "description": "Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once." }, { "in": "query", "name": "id", "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "ids", "schema": { "type": "string" }, "description": "Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once." }, { "in": "query", "name": "include_duplicates", "schema": { "type": "boolean" }, "description": "If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account." }, { "in": "query", "name": "integration_name", "schema": { "type": "string" }, "description": "If provided, will only return linked accounts associated with the given integration name." }, { "in": "query", "name": "is_test_account", "schema": { "type": "string" }, "description": "If included, will only include test linked accounts. If not included, will only include non-test linked accounts." }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page. The maximum limit is 100.", "schema": { "type": "integer" } }, { "in": "query", "name": "status", "schema": { "type": "string" }, "description": "Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`" } ], "tags": [ "linked-accounts" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedAccountDetailsAndActionsList" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/linked-accounts/{linked_account_id}": { "patch": { "operationId": "linked_accounts_partial_update", "description": "Update a linked account.", "parameters": [ { "in": "path", "name": "linked_account_id", "schema": { "type": "string", "format": "uuid" }, "required": true } ], "tags": [ "linked-accounts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedLinkedAccountPatchDeserializerRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedLinkedAccountPatchDeserializerRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedLinkedAccountPatchDeserializerRequest" } } } }, "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkedAccountPatchResponse" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_HIDDEN" } }, "/locations": { "get": { "operationId": "locations_list", "description": "Returns a list of `Location` objects.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "query", "name": "created_after", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, will only return objects created after this datetime." }, { "in": "query", "name": "created_before", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, will only return objects created before this datetime." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "The pagination cursor value.", "examples": { "CursorExample": { "value": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", "summary": "Cursor Example" } } }, { "in": "query", "name": "include_deleted_data", "schema": { "type": "boolean" }, "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)." }, { "in": "query", "name": "include_remote_data", "schema": { "type": "boolean" }, "description": "Whether to include the original data Merge fetched from the third-party to produce these models." }, { "in": "query", "name": "include_shell_data", "schema": { "type": "boolean" }, "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)." }, { "in": "query", "name": "location_type", "schema": { "type": "string", "nullable": true, "enum": [ "HOME", "WORK" ] }, "description": "If provided, will only return locations with this location type\n\n" }, { "in": "query", "name": "modified_after", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, only objects synced by Merge after this date time will be returned." }, { "in": "query", "name": "modified_before", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, only objects synced by Merge before this date time will be returned." }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page. The maximum limit is 100.", "schema": { "type": "integer" } }, { "in": "query", "name": "remote_fields", "schema": { "type": "string", "enum": [ "country", "country,location_type", "location_type" ] }, "description": "Deprecated. Use show_enum_origins.", "examples": { "OriginalEnumValuesCountry,LocationType": { "value": "country,location_type", "summary": "Original Enum Values Country, Location_type" } } }, { "in": "query", "name": "remote_id", "schema": { "type": "string", "nullable": true }, "description": "The API provider's ID for the given object." }, { "in": "query", "name": "show_enum_origins", "schema": { "type": "string", "enum": [ "country", "country,location_type", "location_type" ] }, "description": "A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)", "examples": { "OriginalEnumValuesCountry,LocationType": { "value": "country,location_type", "summary": "Original Enum Values Country, Location_type" } } }, { "in": "query", "name": "show_native_enum_values", "schema": { "type": "boolean" }, "description": "Whether to include the third party's original value for each enum field as `_native`, alongside Merge's normalized ``." } ], "tags": [ "locations" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedLocationList" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/locations/{id}": { "get": { "operationId": "locations_retrieve", "description": "Returns a `Location` object with the given `id`.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "query", "name": "include_remote_data", "schema": { "type": "boolean" }, "description": "Whether to include the original data Merge fetched from the third-party to produce these models." }, { "in": "query", "name": "include_shell_data", "schema": { "type": "boolean" }, "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)." }, { "in": "query", "name": "remote_fields", "schema": { "type": "string", "enum": [ "country", "country,location_type", "location_type" ] }, "description": "Deprecated. Use show_enum_origins.", "examples": { "OriginalEnumValuesCountry,LocationType": { "value": "country,location_type", "summary": "Original Enum Values Country, Location_type" } } }, { "in": "query", "name": "show_enum_origins", "schema": { "type": "string", "enum": [ "country", "country,location_type", "location_type" ] }, "description": "A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)", "examples": { "OriginalEnumValuesCountry,LocationType": { "value": "country,location_type", "summary": "Original Enum Values Country, Location_type" } } }, { "in": "query", "name": "show_native_enum_values", "schema": { "type": "boolean" }, "description": "Whether to include the third party's original value for each enum field as `_native`, alongside Merge's normalized ``." } ], "tags": [ "locations" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Location" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/passthrough": { "post": { "operationId": "passthrough_create", "description": "Pull data from an endpoint not currently supported by Merge.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true } ], "tags": [ "passthrough" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataPassthroughRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DataPassthroughRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DataPassthroughRequest" } } }, "required": true }, "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteResponse" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/pay-groups": { "get": { "operationId": "pay_groups_list", "description": "Returns a list of `PayGroup` objects.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "query", "name": "created_after", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, will only return objects created after this datetime." }, { "in": "query", "name": "created_before", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, will only return objects created before this datetime." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "The pagination cursor value.", "examples": { "CursorExample": { "value": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", "summary": "Cursor Example" } } }, { "in": "query", "name": "include_deleted_data", "schema": { "type": "boolean" }, "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)." }, { "in": "query", "name": "include_remote_data", "schema": { "type": "boolean" }, "description": "Whether to include the original data Merge fetched from the third-party to produce these models." }, { "in": "query", "name": "include_shell_data", "schema": { "type": "boolean" }, "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)." }, { "in": "query", "name": "modified_after", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, only objects synced by Merge after this date time will be returned." }, { "in": "query", "name": "modified_before", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, only objects synced by Merge before this date time will be returned." }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page. The maximum limit is 100.", "schema": { "type": "integer" } }, { "in": "query", "name": "remote_id", "schema": { "type": "string", "nullable": true }, "description": "The API provider's ID for the given object." } ], "tags": [ "pay-groups" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedPayGroupList" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/pay-groups/{id}": { "get": { "operationId": "pay_groups_retrieve", "description": "Returns a `PayGroup` object with the given `id`.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "query", "name": "include_remote_data", "schema": { "type": "boolean" }, "description": "Whether to include the original data Merge fetched from the third-party to produce these models." }, { "in": "query", "name": "include_shell_data", "schema": { "type": "boolean" }, "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)." } ], "tags": [ "pay-groups" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayGroup" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/payroll-runs": { "get": { "operationId": "payroll_runs_list", "description": "Returns a list of `PayrollRun` objects.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "query", "name": "created_after", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, will only return objects created after this datetime." }, { "in": "query", "name": "created_before", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, will only return objects created before this datetime." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "The pagination cursor value.", "examples": { "CursorExample": { "value": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", "summary": "Cursor Example" } } }, { "in": "query", "name": "ended_after", "schema": { "type": "string", "format": "date-time", "nullable": true }, "description": "If provided, will only return payroll runs ended after this datetime." }, { "in": "query", "name": "ended_before", "schema": { "type": "string", "format": "date-time", "nullable": true }, "description": "If provided, will only return payroll runs ended before this datetime." }, { "in": "query", "name": "include_deleted_data", "schema": { "type": "boolean" }, "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)." }, { "in": "query", "name": "include_remote_data", "schema": { "type": "boolean" }, "description": "Whether to include the original data Merge fetched from the third-party to produce these models." }, { "in": "query", "name": "include_shell_data", "schema": { "type": "boolean" }, "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)." }, { "in": "query", "name": "modified_after", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, only objects synced by Merge after this date time will be returned." }, { "in": "query", "name": "modified_before", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, only objects synced by Merge before this date time will be returned." }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page. The maximum limit is 100.", "schema": { "type": "integer" } }, { "in": "query", "name": "remote_fields", "schema": { "type": "string", "enum": [ "run_state", "run_state,run_type", "run_type" ] }, "description": "Deprecated. Use show_enum_origins.", "examples": { "OriginalEnumValuesRunState,RunType": { "value": "run_state,run_type", "summary": "Original Enum Values Run_state, Run_type" } } }, { "in": "query", "name": "remote_id", "schema": { "type": "string", "nullable": true }, "description": "The API provider's ID for the given object." }, { "in": "query", "name": "run_type", "schema": { "type": "string", "nullable": true, "enum": [ "CORRECTION", "OFF_CYCLE", "REGULAR", "SIGN_ON_BONUS", "TERMINATION" ] }, "description": "If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS')\n\n" }, { "in": "query", "name": "show_enum_origins", "schema": { "type": "string", "enum": [ "run_state", "run_state,run_type", "run_type" ] }, "description": "A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)", "examples": { "OriginalEnumValuesRunState,RunType": { "value": "run_state,run_type", "summary": "Original Enum Values Run_state, Run_type" } } }, { "in": "query", "name": "show_native_enum_values", "schema": { "type": "boolean" }, "description": "Whether to include the third party's original value for each enum field as `_native`, alongside Merge's normalized ``." }, { "in": "query", "name": "started_after", "schema": { "type": "string", "format": "date-time", "nullable": true }, "description": "If provided, will only return payroll runs started after this datetime." }, { "in": "query", "name": "started_before", "schema": { "type": "string", "format": "date-time", "nullable": true }, "description": "If provided, will only return payroll runs started before this datetime." } ], "tags": [ "payroll-runs" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedPayrollRunList" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC_BETA" } }, "/payroll-runs/{id}": { "get": { "operationId": "payroll_runs_retrieve", "description": "Returns a `PayrollRun` object with the given `id`.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "query", "name": "include_remote_data", "schema": { "type": "boolean" }, "description": "Whether to include the original data Merge fetched from the third-party to produce these models." }, { "in": "query", "name": "include_shell_data", "schema": { "type": "boolean" }, "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)." }, { "in": "query", "name": "remote_fields", "schema": { "type": "string", "enum": [ "run_state", "run_state,run_type", "run_type" ] }, "description": "Deprecated. Use show_enum_origins.", "examples": { "OriginalEnumValuesRunState,RunType": { "value": "run_state,run_type", "summary": "Original Enum Values Run_state, Run_type" } } }, { "in": "query", "name": "show_enum_origins", "schema": { "type": "string", "enum": [ "run_state", "run_state,run_type", "run_type" ] }, "description": "A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)", "examples": { "OriginalEnumValuesRunState,RunType": { "value": "run_state,run_type", "summary": "Original Enum Values Run_state, Run_type" } } }, { "in": "query", "name": "show_native_enum_values", "schema": { "type": "boolean" }, "description": "Whether to include the third party's original value for each enum field as `_native`, alongside Merge's normalized ``." } ], "tags": [ "payroll-runs" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayrollRun" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC_BETA" } }, "/regenerate-key": { "post": { "operationId": "regenerate_key_create", "description": "Exchange remote keys.", "tags": [ "regenerate-key" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteKeyForRegenerationRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/RemoteKeyForRegenerationRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/RemoteKeyForRegenerationRequest" } } }, "required": true }, "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteKey" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/remote-fields": { "get": { "operationId": "remote_fields_retrieve", "description": "Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "query", "name": "common_models", "schema": { "type": "string" }, "description": "A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models." }, { "in": "query", "name": "include_example_values", "schema": { "type": "string" }, "description": "If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers." } ], "tags": [ "field-mapping" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoteFieldAPIResponse" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/selective-sync/conditions": { "get": { "operationId": "selective_sync_conditions_list", "description": "Returns a list of `SelectiveSyncCondition` objects.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true } ], "tags": [ "selective-sync" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectiveSyncConditionList" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC_BETA" } }, "/sync-status": { "get": { "operationId": "sync_status_list", "description": "Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "The pagination cursor value.", "examples": { "CursorExample": { "value": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", "summary": "Cursor Example" } } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page. The maximum limit is 100.", "schema": { "type": "integer" } } ], "tags": [ "sync-status" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedSyncStatusList" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/sync-status/resync": { "post": { "operationId": "sync_status_resync_create", "description": "Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true } ], "tags": [ "force-resync" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SyncStatus" } } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/target-fields": { "get": { "operationId": "target_fields_retrieve", "description": "Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true } ], "tags": [ "field-mapping" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalTargetFieldAPIResponse" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" }, "post": { "operationId": "target_fields_create", "description": "Create a new organization-wide Target Field. Target Fields are custom fields that your organization defines to collect supplemental data from integrations. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true } ], "tags": [ "field-mapping" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTargetFieldRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CreateTargetFieldRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CreateTargetFieldRequest" } } }, "required": true }, "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalTargetFieldAPIResponse" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/teams": { "get": { "operationId": "teams_list", "description": "Returns a list of `Team` objects.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "query", "name": "created_after", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, will only return objects created after this datetime." }, { "in": "query", "name": "created_before", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, will only return objects created before this datetime." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "The pagination cursor value.", "examples": { "CursorExample": { "value": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", "summary": "Cursor Example" } } }, { "in": "query", "name": "expand", "schema": { "type": "string", "enum": [ "parent_team" ] }, "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.", "examples": { "ExpandParentTeam": { "value": "parent_team", "summary": "Expand Parent_team" } } }, { "in": "query", "name": "include_deleted_data", "schema": { "type": "boolean" }, "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)." }, { "in": "query", "name": "include_remote_data", "schema": { "type": "boolean" }, "description": "Whether to include the original data Merge fetched from the third-party to produce these models." }, { "in": "query", "name": "include_shell_data", "schema": { "type": "boolean" }, "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)." }, { "in": "query", "name": "modified_after", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, only objects synced by Merge after this date time will be returned." }, { "in": "query", "name": "modified_before", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, only objects synced by Merge before this date time will be returned." }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page. The maximum limit is 100.", "schema": { "type": "integer" } }, { "in": "query", "name": "parent_team_id", "schema": { "type": "string" }, "description": "If provided, will only return teams with this parent team.", "examples": { "ParentTeamId": { "summary": "parent_team_id" } } }, { "in": "query", "name": "remote_id", "schema": { "type": "string", "nullable": true }, "description": "The API provider's ID for the given object." } ], "tags": [ "teams" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedTeamList" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/teams/{id}": { "get": { "operationId": "teams_retrieve", "description": "Returns a `Team` object with the given `id`.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "query", "name": "expand", "schema": { "type": "string", "enum": [ "parent_team" ] }, "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.", "examples": { "ExpandParentTeam": { "value": "parent_team", "summary": "Expand Parent_team" } } }, { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "query", "name": "include_remote_data", "schema": { "type": "boolean" }, "description": "Whether to include the original data Merge fetched from the third-party to produce these models." }, { "in": "query", "name": "include_shell_data", "schema": { "type": "boolean" }, "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)." } ], "tags": [ "teams" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Team" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/time-off": { "get": { "operationId": "time_off_list", "description": "Returns a list of `TimeOff` objects.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "query", "name": "approver_id", "schema": { "type": "string" }, "description": "If provided, will only return time off for this approver.", "examples": { "ApproverId": { "summary": "approver_id" } } }, { "in": "query", "name": "created_after", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, will only return objects created after this datetime." }, { "in": "query", "name": "created_before", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, will only return objects created before this datetime." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "The pagination cursor value.", "examples": { "CursorExample": { "value": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", "summary": "Cursor Example" } } }, { "in": "query", "name": "employee_id", "schema": { "type": "string" }, "description": "If provided, will only return time off for this employee.", "examples": { "EmployeeId": { "summary": "employee_id" } } }, { "in": "query", "name": "ended_after", "schema": { "type": "string", "format": "date-time", "nullable": true }, "description": "If provided, will only return employees that ended after this datetime." }, { "in": "query", "name": "ended_before", "schema": { "type": "string", "format": "date-time", "nullable": true }, "description": "If provided, will only return time-offs that ended before this datetime." }, { "in": "query", "name": "expand", "schema": { "type": "string", "enum": [ "approver", "employee", "employee,approver" ] }, "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.", "examples": { "ExpandEmployee,Approver": { "value": "employee,approver", "summary": "Expand Employee, Approver" } } }, { "in": "query", "name": "include_deleted_data", "schema": { "type": "boolean" }, "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)." }, { "in": "query", "name": "include_remote_data", "schema": { "type": "boolean" }, "description": "Whether to include the original data Merge fetched from the third-party to produce these models." }, { "in": "query", "name": "include_shell_data", "schema": { "type": "boolean" }, "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)." }, { "in": "query", "name": "modified_after", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, only objects synced by Merge after this date time will be returned." }, { "in": "query", "name": "modified_before", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, only objects synced by Merge before this date time will be returned." }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page. The maximum limit is 100.", "schema": { "type": "integer" } }, { "in": "query", "name": "remote_fields", "schema": { "type": "string", "enum": [ "request_type", "request_type,status", "request_type,status,units", "request_type,units", "status", "status,units", "units" ] }, "description": "Deprecated. Use show_enum_origins.", "examples": { "OriginalEnumValuesRequestType,Status,Units": { "value": "request_type,status,units", "summary": "Original Enum Values Request_type, Status, Units" } } }, { "in": "query", "name": "remote_id", "schema": { "type": "string", "nullable": true }, "description": "The API provider's ID for the given object." }, { "in": "query", "name": "request_type", "schema": { "type": "string", "nullable": true, "enum": [ "BEREAVEMENT", "JURY_DUTY", "LEAVE", "PERSONAL", "SICK", "VACATION", "VOLUNTEER" ] }, "description": "If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT', 'LEAVE')\n\n" }, { "in": "query", "name": "show_enum_origins", "schema": { "type": "string", "enum": [ "request_type", "request_type,status", "request_type,status,units", "request_type,units", "status", "status,units", "units" ] }, "description": "A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)", "examples": { "OriginalEnumValuesRequestType,Status,Units": { "value": "request_type,status,units", "summary": "Original Enum Values Request_type, Status, Units" } } }, { "in": "query", "name": "show_native_enum_values", "schema": { "type": "boolean" }, "description": "Whether to include the third party's original value for each enum field as `_native`, alongside Merge's normalized ``." }, { "in": "query", "name": "started_after", "schema": { "type": "string", "format": "date-time", "nullable": true }, "description": "If provided, will only return time-offs that started after this datetime." }, { "in": "query", "name": "started_before", "schema": { "type": "string", "format": "date-time", "nullable": true }, "description": "If provided, will only return time-offs that started before this datetime." }, { "in": "query", "name": "status", "schema": { "type": "string", "nullable": true, "enum": [ "APPROVED", "CANCELLED", "DECLINED", "DELETED", "REQUESTED" ] }, "description": "If provided, will only return TimeOff with this status. Options: ('REQUESTED', 'APPROVED', 'DECLINED', 'CANCELLED', 'DELETED')\n\n" } ], "tags": [ "time-off" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedTimeOffList" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" }, "post": { "operationId": "time_off_create", "description": "Creates a `TimeOff` object with the given values.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "query", "name": "is_debug_mode", "schema": { "type": "boolean" }, "description": "Whether to include debug fields (such as log file links) in the response." }, { "in": "query", "name": "run_async", "schema": { "type": "boolean" }, "description": "Whether or not third-party updates should be run asynchronously." } ], "tags": [ "time-off" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeOffEndpointRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TimeOffEndpointRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/TimeOffEndpointRequest" } } }, "required": true }, "security": [ { "tokenAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeOffResponse" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC_BETA" } }, "/time-off-balances": { "get": { "operationId": "time_off_balances_list", "description": "Returns a list of `TimeOffBalance` objects.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "query", "name": "created_after", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, will only return objects created after this datetime." }, { "in": "query", "name": "created_before", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, will only return objects created before this datetime." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "The pagination cursor value.", "examples": { "CursorExample": { "value": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", "summary": "Cursor Example" } } }, { "in": "query", "name": "employee_id", "schema": { "type": "string" }, "description": "If provided, will only return time off balances for this employee.", "examples": { "EmployeeId": { "summary": "employee_id" } } }, { "in": "query", "name": "expand", "schema": { "type": "string", "enum": [ "employee" ] }, "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.", "examples": { "ExpandEmployee": { "value": "employee", "summary": "Expand Employee" } } }, { "in": "query", "name": "include_deleted_data", "schema": { "type": "boolean" }, "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)." }, { "in": "query", "name": "include_remote_data", "schema": { "type": "boolean" }, "description": "Whether to include the original data Merge fetched from the third-party to produce these models." }, { "in": "query", "name": "include_shell_data", "schema": { "type": "boolean" }, "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)." }, { "in": "query", "name": "modified_after", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, only objects synced by Merge after this date time will be returned." }, { "in": "query", "name": "modified_before", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, only objects synced by Merge before this date time will be returned." }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page. The maximum limit is 100.", "schema": { "type": "integer" } }, { "in": "query", "name": "policy_type", "schema": { "type": "string", "nullable": true, "enum": [ "BEREAVEMENT", "JURY_DUTY", "PERSONAL", "SICK", "VACATION", "VOLUNTEER" ] }, "description": "If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')\n\n" }, { "in": "query", "name": "remote_fields", "schema": { "type": "string", "enum": [ "policy_type" ] }, "description": "Deprecated. Use show_enum_origins.", "examples": { "OriginalEnumValuesPolicyType": { "value": "policy_type", "summary": "Original Enum Values Policy_type" } } }, { "in": "query", "name": "remote_id", "schema": { "type": "string", "nullable": true }, "description": "The API provider's ID for the given object." }, { "in": "query", "name": "show_enum_origins", "schema": { "type": "string", "enum": [ "policy_type" ] }, "description": "A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)", "examples": { "OriginalEnumValuesPolicyType": { "value": "policy_type", "summary": "Original Enum Values Policy_type" } } }, { "in": "query", "name": "show_native_enum_values", "schema": { "type": "boolean" }, "description": "Whether to include the third party's original value for each enum field as `_native`, alongside Merge's normalized ``." } ], "tags": [ "time-off-balances" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedTimeOffBalanceList" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/time-off-balances/{id}": { "get": { "operationId": "time_off_balances_retrieve", "description": "Returns a `TimeOffBalance` object with the given `id`.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "query", "name": "expand", "schema": { "type": "string", "enum": [ "employee" ] }, "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.", "examples": { "ExpandEmployee": { "value": "employee", "summary": "Expand Employee" } } }, { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "query", "name": "include_remote_data", "schema": { "type": "boolean" }, "description": "Whether to include the original data Merge fetched from the third-party to produce these models." }, { "in": "query", "name": "include_shell_data", "schema": { "type": "boolean" }, "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)." }, { "in": "query", "name": "remote_fields", "schema": { "type": "string", "enum": [ "policy_type" ] }, "description": "Deprecated. Use show_enum_origins.", "examples": { "OriginalEnumValuesPolicyType": { "value": "policy_type", "summary": "Original Enum Values Policy_type" } } }, { "in": "query", "name": "show_enum_origins", "schema": { "type": "string", "enum": [ "policy_type" ] }, "description": "A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)", "examples": { "OriginalEnumValuesPolicyType": { "value": "policy_type", "summary": "Original Enum Values Policy_type" } } }, { "in": "query", "name": "show_native_enum_values", "schema": { "type": "boolean" }, "description": "Whether to include the third party's original value for each enum field as `_native`, alongside Merge's normalized ``." } ], "tags": [ "time-off-balances" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeOffBalance" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/time-off/{id}": { "get": { "operationId": "time_off_retrieve", "description": "Returns a `TimeOff` object with the given `id`.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "query", "name": "expand", "schema": { "type": "string", "enum": [ "approver", "employee", "employee,approver" ] }, "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.", "examples": { "ExpandEmployee,Approver": { "value": "employee,approver", "summary": "Expand Employee, Approver" } } }, { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "query", "name": "include_remote_data", "schema": { "type": "boolean" }, "description": "Whether to include the original data Merge fetched from the third-party to produce these models." }, { "in": "query", "name": "include_shell_data", "schema": { "type": "boolean" }, "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)." }, { "in": "query", "name": "remote_fields", "schema": { "type": "string", "enum": [ "request_type", "request_type,status", "request_type,status,units", "request_type,units", "status", "status,units", "units" ] }, "description": "Deprecated. Use show_enum_origins.", "examples": { "OriginalEnumValuesRequestType,Status,Units": { "value": "request_type,status,units", "summary": "Original Enum Values Request_type, Status, Units" } } }, { "in": "query", "name": "show_enum_origins", "schema": { "type": "string", "enum": [ "request_type", "request_type,status", "request_type,status,units", "request_type,units", "status", "status,units", "units" ] }, "description": "A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)", "examples": { "OriginalEnumValuesRequestType,Status,Units": { "value": "request_type,status,units", "summary": "Original Enum Values Request_type, Status, Units" } } }, { "in": "query", "name": "show_native_enum_values", "schema": { "type": "boolean" }, "description": "Whether to include the third party's original value for each enum field as `_native`, alongside Merge's normalized ``." } ], "tags": [ "time-off" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeOff" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/time-off/meta/post": { "get": { "operationId": "time_off_meta_post_retrieve", "description": "Returns metadata for `TimeOff` POSTs.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true } ], "tags": [ "time-off" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetaResponse" } } }, "description": "" } }, "x-merge-meta-post": "META_POST", "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/timesheet-entries": { "get": { "operationId": "timesheet_entries_list", "description": "Returns a list of `TimesheetEntry` objects.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "query", "name": "created_after", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, will only return objects created after this datetime." }, { "in": "query", "name": "created_before", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, will only return objects created before this datetime." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "The pagination cursor value.", "examples": { "CursorExample": { "value": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", "summary": "Cursor Example" } } }, { "in": "query", "name": "employee_id", "schema": { "type": "string" }, "description": "If provided, will only return timesheet entries for this employee.", "examples": { "EmployeeId": { "summary": "employee_id" } } }, { "in": "query", "name": "ended_after", "schema": { "type": "string", "format": "date-time", "nullable": true }, "description": "If provided, will only return timesheet entries ended after this datetime." }, { "in": "query", "name": "ended_before", "schema": { "type": "string", "format": "date-time", "nullable": true }, "description": "If provided, will only return timesheet entries ended before this datetime." }, { "in": "query", "name": "expand", "schema": { "type": "string", "enum": [ "employee" ] }, "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.", "examples": { "ExpandEmployee": { "value": "employee", "summary": "Expand Employee" } } }, { "in": "query", "name": "include_deleted_data", "schema": { "type": "boolean" }, "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)." }, { "in": "query", "name": "include_remote_data", "schema": { "type": "boolean" }, "description": "Whether to include the original data Merge fetched from the third-party to produce these models." }, { "in": "query", "name": "include_shell_data", "schema": { "type": "boolean" }, "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)." }, { "in": "query", "name": "modified_after", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, only objects synced by Merge after this date time will be returned." }, { "in": "query", "name": "modified_before", "schema": { "type": "string", "format": "date-time" }, "description": "If provided, only objects synced by Merge before this date time will be returned." }, { "in": "query", "name": "order_by", "schema": { "type": "string", "enum": [ "-start_time", "start_time" ] }, "description": "Overrides the default ordering for this endpoint. Possible values include: start_time, -start_time.", "x-fern-enum": { "start_time": { "name": "StartTimeAscending" }, "-start_time": { "name": "StartTimeDescending" } } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page. The maximum limit is 100.", "schema": { "type": "integer" } }, { "in": "query", "name": "remote_id", "schema": { "type": "string", "nullable": true }, "description": "The API provider's ID for the given object." }, { "in": "query", "name": "started_after", "schema": { "type": "string", "format": "date-time", "nullable": true }, "description": "If provided, will only return timesheet entries started after this datetime." }, { "in": "query", "name": "started_before", "schema": { "type": "string", "format": "date-time", "nullable": true }, "description": "If provided, will only return timesheet entries started before this datetime." } ], "tags": [ "timesheet-entries" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedTimesheetEntryList" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" }, "post": { "operationId": "timesheet_entries_create", "description": "Creates a `TimesheetEntry` object with the given values.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "query", "name": "is_debug_mode", "schema": { "type": "boolean" }, "description": "Whether to include debug fields (such as log file links) in the response." }, { "in": "query", "name": "run_async", "schema": { "type": "boolean" }, "description": "Whether or not third-party updates should be run asynchronously." } ], "tags": [ "timesheet-entries" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimesheetEntryEndpointRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TimesheetEntryEndpointRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/TimesheetEntryEndpointRequest" } } }, "required": true }, "security": [ { "tokenAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimesheetEntryResponse" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/timesheet-entries/{id}": { "get": { "operationId": "timesheet_entries_retrieve", "description": "Returns a `TimesheetEntry` object with the given `id`.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true }, { "in": "query", "name": "expand", "schema": { "type": "string", "enum": [ "employee" ] }, "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.", "examples": { "ExpandEmployee": { "value": "employee", "summary": "Expand Employee" } } }, { "in": "path", "name": "id", "schema": { "type": "string", "format": "uuid" }, "required": true }, { "in": "query", "name": "include_remote_data", "schema": { "type": "boolean" }, "description": "Whether to include the original data Merge fetched from the third-party to produce these models." }, { "in": "query", "name": "include_shell_data", "schema": { "type": "boolean" }, "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)." } ], "tags": [ "timesheet-entries" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimesheetEntry" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/timesheet-entries/meta/post": { "get": { "operationId": "timesheet_entries_meta_post_retrieve", "description": "Returns metadata for `TimesheetEntry` POSTs.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true } ], "tags": [ "timesheet-entries" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetaResponse" } } }, "description": "" } }, "x-merge-meta-post": "META_POST", "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } }, "/webhook-receivers": { "get": { "operationId": "webhook_receivers_list", "description": "Returns a list of `WebhookReceiver` objects.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true } ], "tags": [ "webhook-receivers" ], "security": [ { "tokenAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookReceiver" } } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" }, "post": { "operationId": "webhook_receivers_create", "description": "Creates a `WebhookReceiver` object with the given values.", "parameters": [ { "in": "header", "name": "X-Account-Token", "schema": { "type": "string" }, "description": "Token identifying the end user.", "required": true } ], "tags": [ "webhook-receivers" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookReceiverRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/WebhookReceiverRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/WebhookReceiverRequest" } } }, "required": true }, "security": [ { "tokenAuth": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookReceiver" } } }, "description": "" } }, "x-endpoint-availability": "ENDPOINT_AVAILABILITY_PUBLIC" } } }, "components": { "schemas": { "AccountDetails": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "example": "0496d4c2-42e6-4072-80b3-7b69bfdc76fd" }, "integration": { "type": "string", "readOnly": true, "example": "BambooHR" }, "integration_slug": { "type": "string", "readOnly": true, "example": "bamboohr" }, "category": { "allOf": [ { "$ref": "#/components/schemas/CategoryEnum" } ], "nullable": true, "example": "hris" }, "end_user_origin_id": { "type": "string", "readOnly": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "end_user_organization_name": { "type": "string", "readOnly": true, "example": "Waystar Royco" }, "end_user_email_address": { "type": "string", "format": "email", "readOnly": true, "example": "kendall.roy@waystar-royco.com" }, "status": { "type": "string", "readOnly": true, "example": "COMPLETE" }, "webhook_listener_url": { "type": "string", "format": "uri", "readOnly": true, "example": "https://api.merge.dev/api/integrations/webhook-listener/7fc3mee0UW8ecV4" }, "is_duplicate": { "type": "boolean", "nullable": true, "readOnly": true, "description": "Whether a Production Linked Account's credentials match another existing Production Linked Account. This field is `null` for Test Linked Accounts, incomplete Production Linked Accounts, and ignored duplicate Production Linked Account sets.", "example": true }, "account_type": { "type": "string", "readOnly": true, "example": "PRODUCTION" }, "completed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "The time at which account completes the linking flow.", "example": "2024-08-26T20:11:19.277118Z" }, "instance_id": { "type": "string", "nullable": true, "readOnly": true }, "instance_display_value": { "type": "string", "nullable": true, "readOnly": true } }, "x-merge-category": "hris" }, "AccountDetailsAndActions": { "type": "object", "description": "# The LinkedAccount Object\n### Description\nThe `LinkedAccount` object is used to represent an end user's link with a specific integration.\n\n### Usage Example\nView a list of your organization's `LinkedAccount` objects.", "properties": { "id": { "type": "string", "example": "e59b1821-f85c-4e28-a6b3-1804156f3563" }, "category": { "allOf": [ { "$ref": "#/components/schemas/CategoryEnum" } ], "example": "hris" }, "status": { "allOf": [ { "$ref": "#/components/schemas/AccountDetailsAndActionsStatusEnum" } ], "example": "INCOMPLETE" }, "status_detail": { "type": "string", "example": "Invalid login credentials" }, "end_user_origin_id": { "type": "string", "example": "3ac95cde-6c7f-4eef-afec-be710b42308d" }, "end_user_organization_name": { "type": "string", "example": "Foo Bar, LLC" }, "end_user_email_address": { "type": "string", "example": "hradmin@foobar.dev" }, "subdomain": { "type": "string", "description": "The tenant or domain the customer has provided access to.", "example": "foobar" }, "webhook_listener_url": { "type": "string", "example": "https://api.merge.dev/api/integrations/webhook-listener/7fc3mee0UW8ecV4" }, "is_duplicate": { "type": "boolean", "nullable": true, "description": "Whether a Production Linked Account's credentials match another existing Production Linked Account. This field is `null` for Test Linked Accounts, incomplete Production Linked Accounts, and ignored duplicate Production Linked Account sets.", "example": true }, "integration": { "$ref": "#/components/schemas/AccountDetailsAndActionsIntegration", "example": { "name": "SAP SuccessFactors", "categories": [ "hris", "ats" ], "image": "https://cdn.merge.dev/SuccessFactors_Logo.png", "square_image": "https://cdn.merge.dev/SuccessFactors_Square_Logo.jpg", "color": "#F6A704", "slug": "sap-successfactors", "passthrough_available": true, "available_model_operations": [ { "model_name": "Candidate", "available_operations": [ "FETCH", "CREATE" ], "required_post_parameters": [ "remote_user_id" ], "supported_fields": [ "first_name", "last_name", "company", "title" ] } ] } }, "account_type": { "type": "string", "example": "PRODUCTION" }, "completed_at": { "type": "string", "format": "date-time", "example": "2024-08-26T20:11:19.277118Z" }, "integration_specific_fields": { "type": "object", "additionalProperties": {}, "example": { "integration_specific_field": "Varies by platform" } } }, "required": [ "account_type", "completed_at", "end_user_email_address", "end_user_organization_name", "id", "status", "webhook_listener_url" ], "x-merge-sample-json": "{\"id\": \"e59b1821-f85c-4e28-a6b3-1804156f3563\", \"category\": \"hris\", \"status\": \"INCOMPLETE\", \"status_detail\": \"Invalid login credentials\", \"end_user_origin_id\": \"3ac95cde-6c7f-4eef-afec-be710b42308d\", \"end_user_organization_name\": \"Foo Bar, LLC\", \"end_user_email_address\": \"hradmin@foobar.dev\", \"webhook_listener_url\": \"https://api.merge.dev/api/integrations/webhook-listener/7fc3mee0UW8ecV4\", \"is_duplicate\": true, \"integration\": {\"name\": \"SAP SuccessFactors\", \"categories\": [\"hris\", \"ats\"], \"image\": \"https://cdn.merge.dev/SuccessFactors_Logo.png\", \"square_image\": \"https://cdn.merge.dev/SuccessFactors_Square_Logo.jpg\", \"color\": \"#F6A704\", \"slug\": \"sap-successfactors\", \"passthrough_available\": true, \"available_model_operations\": [{\"model_name\": \"Candidate\", \"available_operations\": [\"FETCH\", \"CREATE\"], \"required_post_parameters\": [\"remote_user_id\"], \"supported_fields\": [\"first_name\", \"last_name\", \"company\", \"title\"]}]}}", "x-merge-category": "hris" }, "AccountDetailsAndActionsIntegration": { "type": "object", "properties": { "name": { "type": "string" }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CategoriesEnum" } }, "image": { "type": "string" }, "square_image": { "type": "string" }, "color": { "type": "string" }, "slug": { "type": "string" }, "passthrough_available": { "type": "boolean" }, "available_model_operations": { "type": "array", "items": { "$ref": "#/components/schemas/ModelOperation" } } }, "required": [ "categories", "color", "name", "passthrough_available", "slug" ], "x-merge-category": "hris" }, "AccountDetailsAndActionsStatusEnum": { "enum": [ "COMPLETE", "INCOMPLETE", "RELINK_NEEDED", "IDLE" ], "type": "string", "x-merge-category": "hris" }, "AccountIntegration": { "type": "object", "properties": { "name": { "type": "string", "description": "Company name." }, "abbreviated_name": { "type": "string", "nullable": true, "description": "Optional. This shortened name appears in places with limited space, usually in conjunction with the platform's logo (e.g., Merge Link menu).

Example: Workforce Now (in lieu of ADP Workforce Now), SuccessFactors (in lieu of SAP SuccessFactors)" }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CategoriesEnum" }, "description": "Category or categories this integration belongs to. Multiple categories should be comma separated, i.e. [ats, hris].", "readOnly": true }, "image": { "type": "string", "format": "uri", "nullable": true, "description": "Company logo in rectangular shape." }, "square_image": { "type": "string", "format": "uri", "nullable": true, "description": "Company logo in square shape." }, "color": { "type": "string", "description": "The color of this integration used for buttons and text throughout the app and landing pages. Choose a darker, saturated color.", "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", "maxLength": 18 }, "slug": { "type": "string", "readOnly": true }, "api_endpoints_to_documentation_urls": { "type": "object", "additionalProperties": {}, "description": "Mapping of API endpoints to documentation urls for support. Example: {'GET': [['/common-model-scopes', 'https://docs.merge.dev/accounting/common-model-scopes/#common_model_scopes_retrieve'],['/common-model-actions', 'https://docs.merge.dev/accounting/common-model-actions/#common_model_actions_retrieve']], 'POST': []}" }, "webhook_setup_guide_url": { "type": "string", "nullable": true, "description": "Setup guide URL for third party webhook creation. Exposed in Merge Docs." }, "category_beta_status": { "type": "object", "description": "Category or categories this integration is in beta status for.", "readOnly": true } }, "required": [ "name" ], "x-merge-category": "hris" }, "AccountToken": { "type": "object", "properties": { "account_token": { "type": "string", "example": "T9klMDQrcHdm9jrtHuOS2Nf06BIHwMNjpPXPMB" }, "integration": { "$ref": "#/components/schemas/AccountIntegration", "example": { "name": "SAP SuccessFactors", "categories": [ "hris", "ats" ], "image": "https://cdn.merge.dev/SuccessFactors_Logo.png", "square_image": "https://cdn.merge.dev/SuccessFactors_Square_Logo.jpg", "color": "#F6A704", "slug": "sap-successfactors" } }, "id": { "type": "string", "example": "0496d4c2-42e6-4072-80b3-7b69bfdc76fd" } }, "required": [ "account_token", "id", "integration" ], "x-merge-category": "hris" }, "AccountTypeEnum": { "enum": [ "SAVINGS", "CHECKING" ], "type": "string", "x-merge-category": "hris" }, "AdvancedMetadata": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "display_name": { "type": "string" }, "description": { "type": "string" }, "is_required": { "type": "boolean" }, "is_custom": { "type": "boolean" }, "field_choices": { "type": "array", "items": {} } }, "required": [ "id" ], "x-merge-category": "hris" }, "AsyncPassthroughReciept": { "type": "object", "properties": { "async_passthrough_receipt_id": { "type": "string", "format": "uuid", "example": "fd29020f-2695-445e-922e-dcd5e81903fd" } }, "required": [ "async_passthrough_receipt_id" ], "x-merge-category": "hris" }, "AuditLogEvent": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "example": "b5ceea2a-7171-47ce-8090-165cfce5572c" }, "user_name": { "type": "string", "nullable": true, "description": "The User's full name at the time of this Event occurring.", "maxLength": 200, "example": "Gil Feig" }, "user_email": { "type": "string", "format": "email", "nullable": true, "description": "The User's email at the time of this Event occurring.", "maxLength": 254, "example": "hello@merge.dev" }, "linked_account_id": { "type": "string", "format": "uuid", "nullable": true, "description": "The id of the Linked Account this event was performed on, when the actor is an End User acting inside Merge Link." }, "role": { "allOf": [ { "$ref": "#/components/schemas/RoleEnum" } ], "description": "Designates the role of the user (or SYSTEM/API if action not taken by a user) at the time of this Event occurring.", "example": "ADMIN" }, "ip_address": { "type": "string", "maxLength": 45, "example": "192.0.2.123" }, "event_type": { "allOf": [ { "$ref": "#/components/schemas/EventTypeEnum" } ], "description": "Designates the type of event that occurred.", "example": "CHANGED_SCOPES" }, "event_description": { "type": "string", "example": "Organization-wide Scopes for model hris.Employee updated from Read to Read+Write" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "event_description", "event_type", "ip_address", "role" ], "x-merge-category": "hris" }, "AvailableActions": { "type": "object", "description": "# The AvailableActions Object\n### Description\nThe `Activity` object is used to see all available model/operation combinations for an integration.\n\n### Usage Example\nFetch all the actions available for the `Zenefits` integration.", "properties": { "integration": { "$ref": "#/components/schemas/AccountIntegration", "example": { "name": "Lever", "categories": [ "ats" ], "image": "https://merge-api-production.s3.amazonaws.com/media/Lever_Logo.png", "square_image": "https://merge-api-production.s3.amazonaws.com/media/Lever_Square_Logo.png", "color": "#262A34", "is_in_beta": "true", "api_endpoints_to_documentation_urls": "{'GET': [('/common-model-scopes', 'https://docs.merge.dev/accounting/common-model-scopes/#common_model_scopes_retrieve')], 'POST': []}" } }, "passthrough_available": { "type": "boolean", "example": true }, "available_model_operations": { "type": "array", "items": { "$ref": "#/components/schemas/ModelOperation" }, "example": [ { "model_name": "Candidate", "available_operations": [ "FETCH", "CREATE" ], "required_post_parameters": [ "remote_user_id" ], "supported_fields": [ "first_name", "last_name", "company", "title" ] } ] } }, "required": [ "integration", "passthrough_available" ], "x-merge-category": "hris" }, "BankInfo": { "type": "object", "description": "# The BankInfo Object\n### Description\nThe `BankInfo` object is used to represent the Bank Account information for an Employee.\n\n### Usage Example\nFetch from the `LIST BankInfo` endpoint and filter by `ID` to show all bank information.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "example": "fd1e0fb5-8f92-4ec9-9f32-179cf732867d" }, "remote_id": { "type": "string", "nullable": true, "description": "The third-party API ID of the matching object.", "example": "123234" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was created by Merge.", "example": "2021-09-15T00:00:00Z" }, "modified_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was modified by Merge.", "example": "2021-10-16T00:00:00Z" }, "employee": { "type": "string", "format": "uuid", "description": "The employee with this bank account.", "nullable": true, "example": "a3617eb4-dfe3-426f-921e-a65fc1661e10", "x-merge-expands-to": "Employee" }, "account_number": { "type": "string", "nullable": true, "description": "The account number.", "maxLength": 100, "example": "439291590" }, "routing_number": { "type": "string", "nullable": true, "description": "The routing number.", "example": "089690059" }, "bank_name": { "type": "string", "nullable": true, "description": "The bank name.", "example": "Chase" }, "account_type": { "allOf": [ { "$ref": "#/components/schemas/AccountTypeEnum" } ], "nullable": true, "description": "The bank account type", "example": "CHECKING" }, "remote_created_at": { "type": "string", "format": "date-time", "nullable": true, "description": "When the matching bank object was created in the third party system.", "example": "2021-12-06T10:11:26Z" }, "remote_was_deleted": { "type": "boolean", "readOnly": true, "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)." }, "field_mappings": { "type": "object", "nullable": true, "properties": { "organization_defined_targets": { "type": "object", "additionalProperties": true }, "linked_account_defined_targets": { "type": "object", "additionalProperties": true } }, "readOnly": true, "example": { "organization_defined_targets": { "custom_key": "custom_value" }, "linked_account_defined_targets": { "custom_key": "custom_value" } } }, "remote_data": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteData" }, "readOnly": true, "nullable": true, "example": [ { "path": "/bank-info", "data": [ "Varies by platform" ] } ] }, "account_type_native": { "type": "string", "readOnly": true, "nullable": true, "description": "The third-party value for `account_type` before Merge normalized it. Returned only when `show_native_enum_values=true`." } }, "x-merge-expands": "{\"employee\": \"Employee\"}", "x-merge-category": "hris" }, "Benefit": { "type": "object", "description": "# The Benefit Object\n### Description\nThe `Benefit` object is used to represent a benefit that an employee has enrolled in.\n\n### Usage Example\nFetch from the `LIST Benefits` endpoint and filter by `ID` to show all benefits.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "example": "3fe5ae7a-f1ba-4529-b7af-84e86dc6d232" }, "remote_id": { "type": "string", "nullable": true, "description": "The third-party API ID of the matching object.", "example": "19202938" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was created by Merge.", "example": "2021-09-15T00:00:00Z" }, "modified_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was modified by Merge.", "example": "2021-10-16T00:00:00Z" }, "employee": { "type": "string", "format": "uuid", "description": "The employee on the plan.", "nullable": true, "example": "d2f972d0-2526-434b-9409-4c3b468e08f0", "x-merge-expands-to": "Employee" }, "provider_name": { "type": "string", "nullable": true, "description": "The name of the benefit provider.", "example": "Blue Shield of California" }, "benefit_plan_type": { "type": "string", "nullable": true, "description": "The type of benefit plan", "deprecated": true }, "employee_contribution": { "type": "number", "format": "double", "nullable": true, "description": "The employee's contribution.", "example": 23.65 }, "company_contribution": { "type": "number", "format": "double", "nullable": true, "description": "The company's contribution.", "example": 150.0 }, "start_date": { "type": "string", "format": "date-time", "nullable": true, "description": "The day and time the benefit started.", "example": "2020-11-15 00:59:25.309761+00:00" }, "end_date": { "type": "string", "format": "date-time", "nullable": true, "description": "The day and time the benefit ended.", "example": "2021-10-15 00:23:25.309761+00:00" }, "employer_benefit": { "type": "string", "format": "uuid", "nullable": true, "description": "The employer benefit plan the employee is enrolled in.", "example": "025fjlc6-6000-430a-848e-aafacbadf4fe" }, "remote_was_deleted": { "type": "boolean", "readOnly": true, "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)." }, "field_mappings": { "type": "object", "nullable": true, "properties": { "organization_defined_targets": { "type": "object", "additionalProperties": true }, "linked_account_defined_targets": { "type": "object", "additionalProperties": true } }, "readOnly": true, "example": { "organization_defined_targets": { "custom_key": "custom_value" }, "linked_account_defined_targets": { "custom_key": "custom_value" } } }, "remote_data": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteData" }, "readOnly": true, "nullable": true, "example": [ { "path": "/benefits", "data": [ "Varies by platform" ] } ] } }, "x-merge-expands": "{\"employee\": \"Employee\"}", "x-merge-category": "hris" }, "BenefitPlanTypeEnum": { "enum": [ "MEDICAL", "HEALTH_SAVINGS", "INSURANCE", "RETIREMENT", "OTHER" ], "type": "string", "x-merge-category": "hris" }, "CategoriesEnum": { "enum": [ "hris", "ats", "accounting", "ticketing", "crm", "mktg", "filestorage", "knowledgebase" ], "type": "string", "x-merge-category": "hris" }, "CategoryEnum": { "enum": [ "hris", "ats", "accounting", "ticketing", "crm", "mktg", "filestorage", "knowledgebase" ], "type": "string", "x-merge-category": "hris" }, "CommonModelScopeAPI": { "type": "object", "properties": { "common_models": { "type": "array", "items": { "$ref": "#/components/schemas/IndividualCommonModelScopeDeserializer" }, "description": "The common models you want to update the scopes for", "example": [ { "model_name": "Employee", "model_permissions": { "READ": { "is_enabled": true }, "WRITE": { "is_enabled": false } }, "field_permissions": { "enabled_fields": [ "avatar", "created_at", "custom_fields", "date_of_birth", "first_name", "gender", "remote_created_at", "remote_data" ], "disabled_fields": [ "company", "employments", "groups", "home_location", "manager", "work_location" ] } } ] } }, "required": [ "common_models" ], "x-merge-category": "hris" }, "CommonModelScopesBodyRequest": { "type": "object", "properties": { "model_id": { "type": "string", "minLength": 1, "example": "hris.Employee" }, "enabled_actions": { "type": "array", "items": { "$ref": "#/components/schemas/EnabledActionsEnum" }, "example": [ "READ", "WRITE" ] }, "disabled_fields": { "type": "array", "items": { "type": "string", "minLength": 1 }, "example": [ "first_name" ] } }, "required": [ "disabled_fields", "enabled_actions", "model_id" ], "x-merge-category": "hris" }, "Company": { "type": "object", "description": "# The Company Object\n### Description\nThe `Company` object is used to represent a company within the HRIS / Payroll system.\n\n### Usage Example\nFetch from the `LIST Companies` endpoint and filter by `ID` to show all companies.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "example": "1b998423-db0a-4037-a4cf-f79c60cb67b3" }, "remote_id": { "type": "string", "nullable": true, "description": "The third-party API ID of the matching object.", "example": "19202938" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was created by Merge.", "example": "2021-09-15T00:00:00Z" }, "modified_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was modified by Merge.", "example": "2021-10-16T00:00:00Z" }, "legal_name": { "type": "string", "nullable": true, "description": "The company's legal name.", "example": "Waystar Royco, Inc." }, "display_name": { "type": "string", "nullable": true, "description": "The company's display name.", "example": "Waystar Royco" }, "eins": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true, "description": "The company's Employer Identification Numbers.", "example": [ "12-3456789", "12-3451111", "11-0011000" ] }, "remote_was_deleted": { "type": "boolean", "readOnly": true, "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)." }, "field_mappings": { "type": "object", "nullable": true, "properties": { "organization_defined_targets": { "type": "object", "additionalProperties": true }, "linked_account_defined_targets": { "type": "object", "additionalProperties": true } }, "readOnly": true, "example": { "organization_defined_targets": { "custom_key": "custom_value" }, "linked_account_defined_targets": { "custom_key": "custom_value" } } }, "remote_data": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteData" }, "readOnly": true, "nullable": true, "example": [ { "path": "/companies", "data": [ "Varies by platform" ] } ] } }, "x-merge-category": "hris" }, "CompletedAccountInitialScreenEnum": { "enum": [ "SELECTIVE_SYNC" ], "type": "string", "x-merge-category": "hris" }, "CountryEnum": { "enum": [ "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "CV", "KH", "CM", "CA", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "SZ", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "KP", "MK", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "KR", "SS", "ES", "LK", "SD", "SR", "SJ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "UM", "US", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW" ], "type": "string", "description": "The country code in ISO 3166-1 alpha-2 format.", "x-merge-category": "hris" }, "CreateFieldMappingRequest": { "type": "object", "properties": { "target_field_name": { "type": "string", "minLength": 1, "description": "The name of the target field you want this remote field to map to. Required if organization_wide_target_field is not provided.", "example": "example_target_field_name" }, "target_field_description": { "type": "string", "minLength": 1, "description": "The description of the target field you want this remote field to map to. Required if organization_wide_target_field is not provided.", "example": "this is a example description of the target field" }, "organization_wide_target_field": { "type": "string", "minLength": 1, "description": "The name or key of an existing Organization-wide target field to map to. When provided, target_field_name and target_field_description are optional.", "example": "employee_favorite_team" }, "is_integration_wide": { "type": "boolean", "default": false, "description": "If true, creates an integration-wide field mapping that applies to all Linked Accounts for the integration. Requires organization_wide_target_field.", "example": true }, "remote_field_traversal_path": { "type": "array", "items": {}, "description": "The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.", "example": [ "example_remote_field" ] }, "remote_method": { "type": "string", "minLength": 1, "description": "The method of the remote endpoint where the remote field is coming from.", "example": "GET" }, "remote_url_path": { "type": "string", "minLength": 1, "description": "The path of the remote endpoint where the remote field is coming from.", "example": "/example-url-path" }, "common_model_name": { "type": "string", "minLength": 1, "description": "The name of the Common Model that the remote field corresponds to in a given category.", "example": "ExampleCommonModel" }, "jmes_path": { "type": "string", "minLength": 1, "description": "DEPRECATED: Use 'advanced_mapping_expression' instead." }, "advanced_mapping_expression": { "type": "string", "minLength": 1, "description": "A JSONata expression used to transform the remote field data.", "example": "$[0].example_jsonata" } }, "required": [ "common_model_name", "remote_field_traversal_path", "remote_method", "remote_url_path" ], "x-merge-category": "hris" }, "CreateTargetFieldRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "description": "The name of the target field.", "example": "employee_favorite_team" }, "description": { "type": "string", "minLength": 1, "default": "", "description": "The description of the target field.", "example": "Every employee's favorite sports team" }, "common_model": { "type": "string", "minLength": 1, "description": "The name of the Common Model to associate the target field with.", "example": "Employee" } }, "required": [ "common_model", "name" ], "x-merge-category": "hris" }, "DataPassthroughRequest": { "type": "object", "description": "# The DataPassthrough Object\n### Description\nThe `DataPassthrough` object is used to send information to an otherwise-unsupported third-party endpoint.\n\n### Usage Example\nCreate a `DataPassthrough` to get team hierarchies from your Rippling integration.", "properties": { "method": { "allOf": [ { "$ref": "#/components/schemas/MethodEnum" } ], "example": "POST" }, "path": { "type": "string", "minLength": 1, "description": "The path of the request in the third party's platform.", "example": "/scooters" }, "base_url_override": { "type": "string", "nullable": true, "minLength": 1, "description": "An optional override of the third party's base url for the request.", "example": "https://api.example.com" }, "data": { "type": "string", "nullable": true, "minLength": 1, "description": "The data with the request. You must include a `request_format` parameter matching the data's format", "example": "{\"company\": \"Lime\", \"model\": \"Gen 2.5\"}" }, "multipart_form_data": { "type": "array", "items": { "$ref": "#/components/schemas/MultipartFormFieldRequest" }, "nullable": true, "description": "Pass an array of `MultipartFormField` objects in here instead of using the `data` param if `request_format` is set to `MULTIPART`." }, "headers": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "The headers to use for the request (Merge will handle the account's authorization headers). `Content-Type` header is required for passthrough. Choose content type corresponding to expected format of receiving server.", "example": { "EXTRA-HEADER": "value" } }, "request_format": { "allOf": [ { "$ref": "#/components/schemas/RequestFormatEnum" } ], "nullable": true, "example": "JSON" }, "normalize_response": { "type": "boolean", "description": "Optional. If true, the response will always be an object of the form `{\"type\": T, \"value\": ...}` where `T` will be one of `string, boolean, number, null, array, object`." } }, "required": [ "method", "path" ], "x-merge-category": "hris" }, "DebugModeLog": { "type": "object", "properties": { "log_id": { "type": "string", "example": "99433219-8017-4acd-bb3c-ceb23d663832" }, "dashboard_view": { "type": "string", "example": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832" }, "log_summary": { "$ref": "#/components/schemas/DebugModelLogSummary", "example": { "url": "www.exampleintegration.com/api/v1/exampleapi", "method": "POST", "status_code": 200 } } }, "required": [ "dashboard_view", "log_id", "log_summary" ], "x-merge-sample-json": "{\"log_id\": \"99433219-8017-4acd-bb3c-ceb23d663832\", \"dashboard_view\": \"https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832\", \"log_summary\": {\"url\": \"www.exampleintegration.com/api/v1/exampleapi\", \"method\": \"POST\", \"status_code\": 200}}", "x-merge-category": "hris" }, "DebugModelLogSummary": { "type": "object", "properties": { "url": { "type": "string", "example": "www.exampleintegration.com/api/v1/exampleapi" }, "method": { "type": "string", "example": "POST" }, "status_code": { "type": "integer", "example": 200 } }, "required": [ "method", "status_code", "url" ], "x-merge-sample-json": "{\"url\": \"www.exampleintegration.com/api/v1/exampleapi\", \"method\": \"POST\", \"status_code\": 200}", "x-merge-category": "hris" }, "Deduction": { "type": "object", "description": "# The Deduction Object\n### Description\nThe `Deduction` object is used to represent an array of the wages withheld from total earnings for the purpose of paying taxes.\n\n### Usage Example\nFetch from the `LIST Deductions` endpoint and filter by `ID` to show all deductions.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "example": "5fd439fc-1b64-4755-b275-64918936c365" }, "remote_id": { "type": "string", "nullable": true, "description": "The third-party API ID of the matching object.", "example": "93478612" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was created by Merge.", "example": "2021-09-15T00:00:00Z" }, "modified_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was modified by Merge.", "example": "2021-10-16T00:00:00Z" }, "employee_payroll_run": { "type": "string", "format": "uuid", "nullable": true, "example": "35347df1-95e7-46e2-93cc-66f1191edca5" }, "name": { "type": "string", "nullable": true, "description": "The deduction's name.", "example": "Social Security" }, "employee_deduction": { "type": "number", "format": "double", "nullable": true, "description": "The amount of money that is withheld from an employee's gross pay by the employee.", "example": 34.54 }, "company_deduction": { "type": "number", "format": "double", "nullable": true, "description": "The amount of money that is withheld on behalf of an employee by the company.", "example": 78.78 }, "remote_was_deleted": { "type": "boolean", "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)." }, "field_mappings": { "type": "object", "nullable": true, "properties": { "organization_defined_targets": { "type": "object", "additionalProperties": true }, "linked_account_defined_targets": { "type": "object", "additionalProperties": true } }, "readOnly": true, "example": { "organization_defined_targets": { "custom_key": "custom_value" }, "linked_account_defined_targets": { "custom_key": "custom_value" } } }, "remote_data": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteData" }, "readOnly": true, "nullable": true, "example": [ { "path": "/payroll-deduction", "data": [ "Varies by platform" ] } ] } }, "x-merge-nested-write-allowed": true, "x-merge-category": "hris" }, "Dependent": { "type": "object", "description": "# The Dependent Object\n### Description\nThe `Dependent` object is used to represent a dependent (e.g. child, spouse, domestic partner, etc) of an `Employee`\n\n### Usage Example\nFetch from the `LIST Dependents` endpoint and filter by `ID` to show all dependents.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "example": "025fjlc6-6000-430a-848e-aafacbadf4fe" }, "remote_id": { "type": "string", "nullable": true, "description": "The third-party API ID of the matching object.", "example": "19202940" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was created by Merge.", "example": "2021-09-15T00:00:00Z" }, "modified_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was modified by Merge.", "example": "2021-10-16T00:00:00Z" }, "first_name": { "type": "string", "nullable": true, "description": "The dependents's first name.", "example": "Greg" }, "middle_name": { "type": "string", "nullable": true, "description": "The dependents's middle name.", "example": "A" }, "last_name": { "type": "string", "nullable": true, "description": "The dependents's last name.", "example": "Hirsch" }, "relationship": { "allOf": [ { "$ref": "#/components/schemas/RelationshipEnum" } ], "nullable": true, "description": "The dependent's relationship to the employee.", "example": "CHILD" }, "employee": { "type": "string", "format": "uuid", "nullable": true, "description": "The employee this person is a dependent of.", "example": "0958cbc6-6040-430a-848e-aafacbadf4ae" }, "date_of_birth": { "type": "string", "format": "date-time", "nullable": true, "description": "The dependent's date of birth.", "example": "1990-11-10T00:00:00Z" }, "gender": { "allOf": [ { "$ref": "#/components/schemas/GenderEnum" } ], "nullable": true, "description": "The dependent's gender.", "example": "MALE" }, "phone_number": { "type": "string", "nullable": true, "description": "The dependent's phone number.", "maxLength": 50, "example": "+1234567890" }, "home_location": { "type": "string", "format": "uuid", "nullable": true, "description": "The dependents's home address.", "example": "d2f972d0-2526-434b-9409-4c3b468e08f0" }, "is_student": { "type": "boolean", "nullable": true, "description": "Whether or not the dependent is a student" }, "ssn": { "type": "string", "nullable": true, "description": "The dependents's social security number.", "maxLength": 50, "example": "1234567890" }, "remote_was_deleted": { "type": "boolean", "readOnly": true, "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)." }, "field_mappings": { "type": "object", "nullable": true, "properties": { "organization_defined_targets": { "type": "object", "additionalProperties": true }, "linked_account_defined_targets": { "type": "object", "additionalProperties": true } }, "readOnly": true, "example": { "organization_defined_targets": { "custom_key": "custom_value" }, "linked_account_defined_targets": { "custom_key": "custom_value" } } }, "remote_data": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteData" }, "readOnly": true, "nullable": true, "example": [ { "path": "/dependent", "data": [ "Varies by platform" ] } ] } }, "x-merge-category": "hris" }, "Earning": { "type": "object", "description": "# The Earning Object\n### Description\nThe `Earning` object is used to represent an array of different compensations that an employee receives within specific wage categories.\n\n### Usage Example\nFetch from the `LIST Earnings` endpoint and filter by `ID` to show all earnings.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "example": "babbced6-3a81-4775-8da2-490dc6385259" }, "remote_id": { "type": "string", "nullable": true, "description": "The third-party API ID of the matching object.", "example": "52802" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was created by Merge.", "example": "2021-09-15T00:00:00Z" }, "modified_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was modified by Merge.", "example": "2021-10-16T00:00:00Z" }, "employee_payroll_run": { "type": "string", "format": "uuid", "nullable": true, "example": "35347df1-95e7-46e2-93cc-66f1191edca5" }, "amount": { "type": "number", "format": "double", "nullable": true, "description": "The amount earned.", "example": 1002.34 }, "type": { "allOf": [ { "$ref": "#/components/schemas/EarningTypeEnum" } ], "nullable": true, "description": "The type of earning.", "example": "SALARY" }, "remote_was_deleted": { "type": "boolean", "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)." }, "field_mappings": { "type": "object", "nullable": true, "properties": { "organization_defined_targets": { "type": "object", "additionalProperties": true }, "linked_account_defined_targets": { "type": "object", "additionalProperties": true } }, "readOnly": true, "example": { "organization_defined_targets": { "custom_key": "custom_value" }, "linked_account_defined_targets": { "custom_key": "custom_value" } } }, "remote_data": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteData" }, "readOnly": true, "nullable": true } }, "x-merge-nested-write-allowed": true, "x-merge-category": "hris" }, "EarningTypeEnum": { "enum": [ "SALARY", "REIMBURSEMENT", "OVERTIME", "BONUS" ], "type": "string", "x-merge-category": "hris" }, "Employee": { "type": "object", "description": "# The Employee Object\n### Description\nThe `Employee` object is used to represent any person who has been employed by a company. By default, it returns all employees. To filter for only active employees, set the `employment_status` query parameter to `ACTIVE`.\n\n### Usage Example\nFetch from the `LIST Employee` endpoint and filter by `ID` to show all employees.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "example": "0958cbc6-6040-430a-848e-aafacbadf4ae" }, "remote_id": { "type": "string", "nullable": true, "description": "The third-party API ID of the matching object.", "example": "19202938" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was created by Merge.", "example": "2021-09-15T00:00:00Z" }, "modified_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was modified by Merge.", "example": "2021-10-16T00:00:00Z" }, "employee_number": { "type": "string", "nullable": true, "description": "The employee's number that appears in the third-party integration's UI.", "example": "2" }, "company": { "type": "string", "format": "uuid", "description": "The ID of the employee's company.", "nullable": true, "example": "8d9fd929-436c-4fd4-a48b-0c61f68d6178", "x-merge-expands-to": "Company" }, "first_name": { "type": "string", "nullable": true, "description": "The employee's first name.", "example": "Greg" }, "last_name": { "type": "string", "nullable": true, "description": "The employee's last name.", "example": "Hirsch" }, "preferred_name": { "type": "string", "nullable": true, "description": "The employee's preferred first name.", "example": "Greg the egg" }, "display_full_name": { "type": "string", "nullable": true, "description": "The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.", "example": "Cousin Greg Hirsch" }, "username": { "type": "string", "nullable": true, "description": "The employee's username that appears in the remote UI.", "example": "cousingreg" }, "groups": { "type": "array", "items": { "type": "string", "format": "uuid", "nullable": true }, "example": [ "21a54124-397f-494d-985e-3c5b330b8a68" ], "x-merge-expands-to": "Group" }, "work_email": { "type": "string", "format": "email", "nullable": true, "description": "The employee's work email.", "maxLength": 254, "example": "greg@merge.dev" }, "personal_email": { "type": "string", "format": "email", "nullable": true, "description": "The employee's personal email.", "maxLength": 254, "example": "greg@gmail.com" }, "mobile_phone_number": { "type": "string", "nullable": true, "description": "The employee's mobile phone number.", "example": "+1234567890" }, "employments": { "type": "array", "items": { "type": "string", "format": "uuid", "nullable": true }, "example": [ "17a54124-287f-494d-965e-3c5b330c9a68" ], "description": "Array of `Employment` IDs for this Employee.", "x-merge-expands-to": "Employment" }, "home_location": { "type": "string", "format": "uuid", "description": "The employee's home address.", "nullable": true, "example": "d2f972d0-2526-434b-9409-4c3b468e08f0", "x-merge-expands-to": "Location" }, "work_location": { "type": "string", "format": "uuid", "description": "The employee's work address.", "nullable": true, "example": "9efbc633-3387-4306-aa55-e2c635e6bb4f", "x-merge-expands-to": "Location" }, "manager": { "type": "string", "format": "uuid", "description": "The employee ID of the employee's manager.", "nullable": true, "example": "0048ea5b-911e-4dff-9364-92070dea62ff", "x-merge-expands-to": "Employee" }, "team": { "type": "string", "format": "uuid", "description": "The employee's team.", "nullable": true, "deprecated": true, "x-merge-expands-to": "Team" }, "pay_group": { "type": "string", "format": "uuid", "description": "The employee's pay group", "nullable": true, "example": "ad1264e2-39be-4787-b749-f1aade9e3405", "x-merge-expands-to": "PayGroup" }, "ssn": { "type": "string", "nullable": true, "description": "The employee's social security number.", "maxLength": 100, "example": "1234567890" }, "gender": { "allOf": [ { "$ref": "#/components/schemas/GenderEnum" } ], "nullable": true, "description": "The employee's gender.", "example": "MALE" }, "ethnicity": { "allOf": [ { "$ref": "#/components/schemas/EthnicityEnum" } ], "nullable": true, "description": "The employee's ethnicity.", "example": "WHITE" }, "marital_status": { "allOf": [ { "$ref": "#/components/schemas/MaritalStatusEnum" } ], "nullable": true, "description": "The employee's filing status as related to marital status.", "example": "SINGLE" }, "date_of_birth": { "type": "string", "format": "date-time", "nullable": true, "description": "The employee's date of birth.", "example": "1990-11-10T00:00:00Z" }, "hire_date": { "type": "string", "format": "date-time", "nullable": true, "description": "The date that the employee was hired, usually the day that an offer letter is signed. If an employee has multiple hire dates from previous employments, this represents the most recent hire date. Note: If you're looking for the employee's start date, refer to the start_date field.", "deprecated": true, "example": "2020-10-10T00:00:00Z" }, "start_date": { "type": "string", "format": "date-time", "nullable": true, "description": "The date that the employee started working. If an employee was rehired, the most recent start date will be returned.", "example": "2020-10-11T00:00:00Z" }, "remote_created_at": { "type": "string", "format": "date-time", "nullable": true, "description": "When the third party's employee was created.", "example": "2020-10-11T00:00:00Z" }, "employment_status": { "allOf": [ { "$ref": "#/components/schemas/EmploymentStatusEnum" } ], "nullable": true, "description": "The employment status of the employee.", "example": "INACTIVE" }, "termination_date": { "type": "string", "format": "date-time", "nullable": true, "description": "The employee's termination date.", "example": "2021-10-12T00:00:00Z" }, "avatar": { "type": "string", "format": "uri", "nullable": true, "maxLength": 2000, "example": "http://alturl.com/h2h8m", "description": "The URL of the employee's avatar image." }, "employee_url": { "type": "string", "format": "uri", "nullable": true, "description": "The 3rd party URL of the employee.", "maxLength": 2000, "example": "https://www.workday.com/wday/v2/employee/19202938" }, "custom_fields": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "Custom fields configured for a given model." }, "remote_was_deleted": { "type": "boolean", "readOnly": true, "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)." }, "field_mappings": { "type": "object", "nullable": true, "properties": { "organization_defined_targets": { "type": "object", "additionalProperties": true }, "linked_account_defined_targets": { "type": "object", "additionalProperties": true } }, "readOnly": true, "example": { "organization_defined_targets": { "custom_key": "custom_value" }, "linked_account_defined_targets": { "custom_key": "custom_value" } } }, "remote_data": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteData" }, "readOnly": true, "nullable": true, "example": [ { "path": "/people", "data": [ "Varies by platform" ] } ] }, "employment_status_native": { "type": "string", "readOnly": true, "nullable": true, "description": "The third-party value for `employment_status` before Merge normalized it. Returned only when `show_native_enum_values=true`." }, "ethnicity_native": { "type": "string", "readOnly": true, "nullable": true, "description": "The third-party value for `ethnicity` before Merge normalized it. Returned only when `show_native_enum_values=true`." }, "gender_native": { "type": "string", "readOnly": true, "nullable": true, "description": "The third-party value for `gender` before Merge normalized it. Returned only when `show_native_enum_values=true`." }, "marital_status_native": { "type": "string", "readOnly": true, "nullable": true, "description": "The third-party value for `marital_status` before Merge normalized it. Returned only when `show_native_enum_values=true`." } }, "x-merge-expands": "{\"company\": \"Company\", \"employments\": \"Employment\", \"groups\": \"Group\", \"home_location\": \"Location\", \"manager\": \"Employee\", \"pay_group\": \"PayGroup\", \"team\": \"Team\", \"work_location\": \"Location\"}", "x-merge-category": "hris" }, "EmployeeEndpointRequest": { "type": "object", "properties": { "model": { "$ref": "#/components/schemas/EmployeeRequest" } }, "required": [ "model" ], "x-merge-category": "hris" }, "EmployeePayrollRun": { "type": "object", "description": "# The EmployeePayrollRun Object\n### Description\nThe `EmployeePayrollRun` object is used to represent an employee's pay statement for a specific payroll run.\n\n### Usage Example\nFetch from the `LIST EmployeePayrollRun` endpoint and filter by `ID` to show all employee payroll runs.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "example": "fb8c55b6-1cb8-4b4c-9fb6-17924231619d" }, "remote_id": { "type": "string", "nullable": true, "description": "The third-party API ID of the matching object.", "example": "19202938" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was created by Merge.", "example": "2021-09-15T00:00:00Z" }, "modified_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was modified by Merge.", "example": "2021-10-16T00:00:00Z" }, "employee": { "type": "string", "format": "uuid", "description": "The employee whose payroll is being run.", "nullable": true, "example": "d2f972d0-2526-434b-9409-4c3b468e08f0", "x-merge-expands-to": "Employee" }, "payroll_run": { "type": "string", "format": "uuid", "description": "The payroll being run.", "nullable": true, "example": "35347df1-95e7-46e2-93cc-66f1191edca5", "x-merge-expands-to": "PayrollRun" }, "gross_pay": { "type": "number", "format": "double", "nullable": true, "description": "The total earnings throughout a given period for an employee before any deductions are made.", "example": 1342.67 }, "net_pay": { "type": "number", "format": "double", "nullable": true, "description": "The take-home pay throughout a given period for an employee after deductions are made.", "example": 865.78 }, "start_date": { "type": "string", "format": "date-time", "nullable": true, "description": "The day and time the payroll run started.", "example": "2020-11-08T00:00:00Z" }, "end_date": { "type": "string", "format": "date-time", "nullable": true, "description": "The day and time the payroll run ended.", "example": "2020-11-09T00:00:00Z" }, "check_date": { "type": "string", "format": "date-time", "nullable": true, "description": "The day and time the payroll run was checked.", "example": "2020-11-10T00:00:00Z" }, "earnings": { "type": "array", "items": { "$ref": "#/components/schemas/Earning" }, "readOnly": true, "example": [ { "employee_payroll_run": "35347df1-95e7-46e2-93cc-66f1191edca5", "amount": 1002.34, "type": "SALARY" }, { "employee_payroll_run": "35347df1-95e7-46e2-93cc-66f1191edca5", "amount": 8342.34, "type": "OVERTIME" } ] }, "deductions": { "type": "array", "items": { "$ref": "#/components/schemas/Deduction" }, "readOnly": true, "example": [ { "employee_payroll_run": "35347df1-95e7-46e2-93cc-66f1191edca5", "name": "Social Security", "employee_deduction": 34.54, "company_deduction": 78.78 } ] }, "taxes": { "type": "array", "items": { "$ref": "#/components/schemas/Tax" }, "readOnly": true, "example": [ { "employee_payroll_run": "35347df1-95e7-46e2-93cc-66f1191edca5", "name": "California State Income Tax", "amount": 100.25, "employer_tax": "False" } ] }, "remote_was_deleted": { "type": "boolean", "readOnly": true, "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)." }, "field_mappings": { "type": "object", "nullable": true, "properties": { "organization_defined_targets": { "type": "object", "additionalProperties": true }, "linked_account_defined_targets": { "type": "object", "additionalProperties": true } }, "readOnly": true, "example": { "organization_defined_targets": { "custom_key": "custom_value" }, "linked_account_defined_targets": { "custom_key": "custom_value" } } }, "remote_data": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteData" }, "readOnly": true, "nullable": true, "example": [ { "path": "/employee-payroll", "data": [ "Varies by platform" ] } ] } }, "x-merge-expands": "{\"employee\": \"Employee\", \"payroll_run\": \"PayrollRun\"}", "x-merge-category": "hris" }, "EmployeeRequest": { "type": "object", "description": "# The Employee Object\n### Description\nThe `Employee` object is used to represent any person who has been employed by a company. By default, it returns all employees. To filter for only active employees, set the `employment_status` query parameter to `ACTIVE`.\n\n### Usage Example\nFetch from the `LIST Employee` endpoint and filter by `ID` to show all employees.", "properties": { "employee_number": { "type": "string", "nullable": true, "description": "The employee's number that appears in the third-party integration's UI.", "example": "2" }, "company": { "type": "string", "format": "uuid", "description": "The ID of the employee's company.", "nullable": true, "example": "8d9fd929-436c-4fd4-a48b-0c61f68d6178", "x-merge-expands-to": "Company" }, "first_name": { "type": "string", "nullable": true, "description": "The employee's first name.", "example": "Greg" }, "last_name": { "type": "string", "nullable": true, "description": "The employee's last name.", "example": "Hirsch" }, "preferred_name": { "type": "string", "nullable": true, "description": "The employee's preferred first name.", "example": "Greg the egg" }, "display_full_name": { "type": "string", "nullable": true, "description": "The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.", "example": "Cousin Greg Hirsch" }, "username": { "type": "string", "nullable": true, "description": "The employee's username that appears in the remote UI.", "example": "cousingreg" }, "groups": { "type": "array", "items": { "type": "string", "format": "uuid", "nullable": true }, "example": [ "21a54124-397f-494d-985e-3c5b330b8a68" ], "x-merge-expands-to": "Group" }, "work_email": { "type": "string", "format": "email", "nullable": true, "description": "The employee's work email.", "maxLength": 254, "example": "greg@merge.dev" }, "personal_email": { "type": "string", "format": "email", "nullable": true, "description": "The employee's personal email.", "maxLength": 254, "example": "greg@gmail.com" }, "mobile_phone_number": { "type": "string", "nullable": true, "description": "The employee's mobile phone number.", "example": "+1234567890" }, "employments": { "type": "array", "items": { "type": "string", "format": "uuid", "nullable": true }, "example": [ "17a54124-287f-494d-965e-3c5b330c9a68" ], "description": "Array of `Employment` IDs for this Employee.", "x-merge-expands-to": "Employment" }, "home_location": { "type": "string", "format": "uuid", "description": "The employee's home address.", "nullable": true, "example": "d2f972d0-2526-434b-9409-4c3b468e08f0", "x-merge-expands-to": "Location" }, "work_location": { "type": "string", "format": "uuid", "description": "The employee's work address.", "nullable": true, "example": "9efbc633-3387-4306-aa55-e2c635e6bb4f", "x-merge-expands-to": "Location" }, "manager": { "type": "string", "format": "uuid", "description": "The employee ID of the employee's manager.", "nullable": true, "example": "0048ea5b-911e-4dff-9364-92070dea62ff", "x-merge-expands-to": "Employee" }, "team": { "type": "string", "format": "uuid", "description": "The employee's team.", "nullable": true, "deprecated": true, "x-merge-expands-to": "Team" }, "pay_group": { "type": "string", "format": "uuid", "description": "The employee's pay group", "nullable": true, "example": "ad1264e2-39be-4787-b749-f1aade9e3405", "x-merge-expands-to": "PayGroup" }, "ssn": { "type": "string", "nullable": true, "description": "The employee's social security number.", "maxLength": 100, "example": "1234567890" }, "gender": { "allOf": [ { "$ref": "#/components/schemas/GenderEnum" } ], "nullable": true, "description": "The employee's gender.", "example": "MALE" }, "ethnicity": { "allOf": [ { "$ref": "#/components/schemas/EthnicityEnum" } ], "nullable": true, "description": "The employee's ethnicity.", "example": "WHITE" }, "marital_status": { "allOf": [ { "$ref": "#/components/schemas/MaritalStatusEnum" } ], "nullable": true, "description": "The employee's filing status as related to marital status.", "example": "SINGLE" }, "date_of_birth": { "type": "string", "format": "date-time", "nullable": true, "description": "The employee's date of birth.", "example": "1990-11-10T00:00:00Z" }, "hire_date": { "type": "string", "format": "date-time", "nullable": true, "description": "The date that the employee was hired, usually the day that an offer letter is signed. If an employee has multiple hire dates from previous employments, this represents the most recent hire date. Note: If you're looking for the employee's start date, refer to the start_date field.", "deprecated": true, "example": "2020-10-10T00:00:00Z" }, "start_date": { "type": "string", "format": "date-time", "nullable": true, "description": "The date that the employee started working. If an employee was rehired, the most recent start date will be returned.", "example": "2020-10-11T00:00:00Z" }, "employment_status": { "allOf": [ { "$ref": "#/components/schemas/EmploymentStatusEnum" } ], "nullable": true, "description": "The employment status of the employee.", "example": "INACTIVE" }, "termination_date": { "type": "string", "format": "date-time", "nullable": true, "description": "The employee's termination date.", "example": "2021-10-12T00:00:00Z" }, "avatar": { "type": "string", "format": "uri", "nullable": true, "maxLength": 2000, "example": "http://alturl.com/h2h8m", "description": "The URL of the employee's avatar image." }, "employee_url": { "type": "string", "format": "uri", "nullable": true, "description": "The 3rd party URL of the employee.", "maxLength": 2000, "example": "https://www.workday.com/wday/v2/employee/19202938" }, "integration_params": { "type": "object", "additionalProperties": {}, "writeOnly": true, "nullable": true, "example": { "unique_integration_field": "unique_integration_field_value" } }, "linked_account_params": { "type": "object", "additionalProperties": {}, "writeOnly": true, "nullable": true, "example": { "unique_linked_account_field": "unique_linked_account_field_value" } }, "employment_status_native": { "type": "string", "writeOnly": true, "nullable": true, "minLength": 1, "description": "The third-party value for `employment_status`, sent to the integration without enum normalization. Cannot be combined with `employment_status`." }, "ethnicity_native": { "type": "string", "writeOnly": true, "nullable": true, "minLength": 1, "description": "The third-party value for `ethnicity`, sent to the integration without enum normalization. Cannot be combined with `ethnicity`." }, "gender_native": { "type": "string", "writeOnly": true, "nullable": true, "minLength": 1, "description": "The third-party value for `gender`, sent to the integration without enum normalization. Cannot be combined with `gender`." }, "marital_status_native": { "type": "string", "writeOnly": true, "nullable": true, "minLength": 1, "description": "The third-party value for `marital_status`, sent to the integration without enum normalization. Cannot be combined with `marital_status`." } }, "x-merge-expands": "{\"company\": \"Company\", \"employments\": \"Employment\", \"groups\": \"Group\", \"home_location\": \"Location\", \"manager\": \"Employee\", \"pay_group\": \"PayGroup\", \"team\": \"Team\", \"work_location\": \"Location\"}", "x-merge-category": "hris" }, "EmployeeResponse": { "type": "object", "properties": { "model": { "$ref": "#/components/schemas/Employee" }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/WarningValidationProblem" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorValidationProblem" } }, "logs": { "type": "array", "items": { "$ref": "#/components/schemas/DebugModeLog" } } }, "required": [ "errors", "model", "warnings" ], "x-merge-category": "hris" }, "EmployerBenefit": { "type": "object", "description": "# The EmployerBenefit Object\n### Description\nThe `Employer Benefit` object is used to represent a benefit plan offered by a company.\n\n### Usage Example\nFetch from the `LIST EmployerBenefits` endpoint and filter by `ID` to show all EmployerBenefits.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "example": "025fjlc6-6000-430a-848e-aafacbadf4fele" }, "remote_id": { "type": "string", "nullable": true, "description": "The third-party API ID of the matching object.", "example": "19202939" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was created by Merge.", "example": "2021-09-15T00:00:00Z" }, "modified_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was modified by Merge.", "example": "2021-10-16T00:00:00Z" }, "benefit_plan_type": { "allOf": [ { "$ref": "#/components/schemas/BenefitPlanTypeEnum" } ], "nullable": true, "description": "The type of benefit plan.", "example": "MEDICAL" }, "name": { "type": "string", "nullable": true, "description": "The employer benefit's name - typically the carrier or network name.", "maxLength": 200, "example": "Kaiser Permanente Medical Plan" }, "description": { "type": "string", "nullable": true, "description": "The employer benefit's description.", "maxLength": 2000, "example": "HDHP Silver Plan" }, "deduction_code": { "type": "string", "nullable": true, "description": "The employer benefit's deduction code.", "maxLength": 60, "example": "COL" }, "remote_was_deleted": { "type": "boolean", "readOnly": true, "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)." }, "field_mappings": { "type": "object", "nullable": true, "properties": { "organization_defined_targets": { "type": "object", "additionalProperties": true }, "linked_account_defined_targets": { "type": "object", "additionalProperties": true } }, "readOnly": true, "example": { "organization_defined_targets": { "custom_key": "custom_value" }, "linked_account_defined_targets": { "custom_key": "custom_value" } } }, "remote_data": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteData" }, "readOnly": true, "nullable": true } }, "x-merge-category": "hris" }, "Employment": { "type": "object", "description": "# The Employment Object\n### Description\nThe `Employment` object is used to represent a job position at a company.\n\nIf an integration supports historical tracking of employments, it will be reflected in the data. If not, a new `Employment` object will be created whenever there is a change in job title or pay. The `effective_date` field should be used to order `Employment` objects, with the most recent date corresponding to the latest employment record for an employee.\n\n### Usage Example\nFetch from the `LIST Employments` endpoint and filter by `ID` to show all employees.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "example": "65d8ffd0-211b-4ba4-b85a-fbe2ce220982" }, "remote_id": { "type": "string", "nullable": true, "description": "The third-party API ID of the matching object.", "example": "19202938" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was created by Merge.", "example": "2021-09-15T00:00:00Z" }, "modified_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was modified by Merge.", "example": "2021-10-16T00:00:00Z" }, "employee": { "type": "string", "format": "uuid", "description": "The employee holding this position.", "nullable": true, "example": "0958cbc6-6040-430a-848e-aafacbadf4ae", "x-merge-expands-to": "Employee" }, "job_title": { "type": "string", "nullable": true, "description": "The position's title.", "example": "Executive Assistant to Tom Wambsgans" }, "pay_rate": { "type": "number", "format": "double", "nullable": true, "description": "The position's pay rate.", "example": "50000.00" }, "pay_period": { "allOf": [ { "$ref": "#/components/schemas/PayPeriodEnum" } ], "nullable": true, "description": "The time period this pay rate encompasses.", "example": "YEAR" }, "pay_frequency": { "allOf": [ { "$ref": "#/components/schemas/PayFrequencyEnum" } ], "nullable": true, "description": "The position's pay frequency.", "example": "BIWEEKLY" }, "pay_currency": { "allOf": [ { "$ref": "#/components/schemas/PayCurrencyEnum" } ], "nullable": true, "description": "The position's currency code. The currency code in ISO 4217 format.", "example": "USD" }, "pay_group": { "type": "string", "format": "uuid", "description": "The employment's pay group", "nullable": true, "example": "d4e4837f-9900-484c-ac40-528365bb08ef", "x-merge-expands-to": "PayGroup" }, "flsa_status": { "allOf": [ { "$ref": "#/components/schemas/FlsaStatusEnum" } ], "nullable": true, "description": "The position's FLSA status.", "example": "EXEMPT" }, "effective_date": { "type": "string", "format": "date-time", "nullable": true, "description": "The position's effective date.", "example": "2023-10-06T18:42:34Z" }, "employment_type": { "allOf": [ { "$ref": "#/components/schemas/EmploymentTypeEnum" } ], "nullable": true, "description": "The position's type of employment.", "example": "FULL TIME" }, "remote_was_deleted": { "type": "boolean", "readOnly": true, "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)." }, "field_mappings": { "type": "object", "nullable": true, "properties": { "organization_defined_targets": { "type": "object", "additionalProperties": true }, "linked_account_defined_targets": { "type": "object", "additionalProperties": true } }, "readOnly": true, "example": { "organization_defined_targets": { "custom_key": "custom_value" }, "linked_account_defined_targets": { "custom_key": "custom_value" } } }, "remote_data": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteData" }, "readOnly": true, "nullable": true, "example": [ { "path": "/jobs", "data": [ "Varies by platform" ] } ] }, "employment_type_native": { "type": "string", "readOnly": true, "nullable": true, "description": "The third-party value for `employment_type` before Merge normalized it. Returned only when `show_native_enum_values=true`." }, "flsa_status_native": { "type": "string", "readOnly": true, "nullable": true, "description": "The third-party value for `flsa_status` before Merge normalized it. Returned only when `show_native_enum_values=true`." }, "pay_frequency_native": { "type": "string", "readOnly": true, "nullable": true, "description": "The third-party value for `pay_frequency` before Merge normalized it. Returned only when `show_native_enum_values=true`." }, "pay_period_native": { "type": "string", "readOnly": true, "nullable": true, "description": "The third-party value for `pay_period` before Merge normalized it. Returned only when `show_native_enum_values=true`." } }, "x-merge-nested-write-allowed": true, "x-merge-expands": "{\"employee\": \"Employee\", \"pay_group\": \"PayGroup\"}", "x-merge-category": "hris" }, "EmploymentStatusEnum": { "enum": [ "ACTIVE", "PENDING", "INACTIVE" ], "type": "string", "x-merge-category": "hris" }, "EmploymentTypeEnum": { "enum": [ "FULL_TIME", "PART_TIME", "INTERN", "CONTRACTOR", "FREELANCE" ], "type": "string", "x-merge-category": "hris" }, "EnabledActionsEnum": { "enum": [ "READ", "WRITE" ], "type": "string", "x-merge-category": "hris" }, "EncodingEnum": { "enum": [ "RAW", "BASE64", "GZIP_BASE64" ], "type": "string", "x-merge-category": "hris" }, "EndUserDetailsRequest": { "type": "object", "properties": { "end_user_email_address": { "type": "string", "minLength": 1, "description": "Your end user's email address. This is purely for identification purposes - setting this value will not cause any emails to be sent.", "maxLength": 100, "example": "example@gmail.com" }, "end_user_organization_name": { "type": "string", "minLength": 1, "description": "Your end user's organization.", "maxLength": 100, "example": "Test Organization" }, "end_user_origin_id": { "type": "string", "minLength": 1, "description": "This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers.", "maxLength": 100, "example": "12345" }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CategoriesEnum" }, "description": "The integration categories to show in Merge Link.", "example": [ "hris", "ats" ] }, "integration": { "type": "string", "nullable": true, "minLength": 1, "description": "The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/.", "example": "bamboohr" }, "link_expiry_mins": { "type": "integer", "maximum": 10080, "minimum": 30, "default": 30, "description": "An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30." }, "should_create_magic_link_url": { "type": "boolean", "nullable": true, "default": false, "description": "Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link." }, "hide_admin_magic_link": { "type": "boolean", "nullable": true, "default": false, "description": "Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link." }, "common_models": { "type": "array", "items": { "$ref": "#/components/schemas/CommonModelScopesBodyRequest" }, "nullable": true, "description": "An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account." }, "category_common_model_scopes": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/IndividualCommonModelScopeDeserializerRequest" } }, "nullable": true, "description": "When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings.", "example": { "hris": [ { "model_name": "Employee", "model_permissions": { "READ": { "is_enabled": true }, "WRITE": { "is_enabled": true } }, "field_permissions": { "enabled_fields": [ "first_name", "last_name", "personal_email" ], "disabled_fields": [ "preferred_name" ] } }, { "model_name": "Employment", "model_permissions": { "READ": { "is_enabled": false }, "WRITE": { "is_enabled": false } }, "field_permissions": { "enabled_fields": [ "effective_date" ] } } ], "ats": [ { "model_name": "Job", "model_permissions": { "READ": { "is_enabled": true }, "WRITE": { "is_enabled": true } }, "field_permissions": { "enabled_fields": [ "name" ], "disabled_fields": [ "description" ] } }, { "model_name": "Department", "model_permissions": { "READ": { "is_enabled": true }, "WRITE": { "is_enabled": true } } } ] } }, "language": { "allOf": [ { "$ref": "#/components/schemas/LanguageEnum" } ], "nullable": true, "description": "The following subset of IETF language tags can be used to configure localization.", "example": "en" }, "are_syncs_disabled": { "type": "boolean", "nullable": true, "default": false, "description": "The boolean that indicates whether initial, periodic, and force syncs will be disabled." }, "integration_specific_config": { "type": "object", "additionalProperties": {}, "nullable": true, "description": "A JSON object containing integration-specific configuration options.", "example": { "rippling": { "oauth_code": "3h1jj8ssdf31dfji3o1jjdfjasd" } } }, "completed_account_initial_screen": { "allOf": [ { "$ref": "#/components/schemas/CompletedAccountInitialScreenEnum" } ], "nullable": true, "description": "When creating a Link token, you can specifiy the initial screen of Linking Flow for a completed Linked Account." }, "linked_destination_id": { "type": "string", "format": "uuid", "nullable": true, "description": "The UUID of the linked destination that you want this Linked Account to be tied to." }, "credential_id": { "type": "string", "format": "uuid", "nullable": true, "description": "The id of the credential that you want this Linked Account to be tied to." }, "ekm_enabled": { "type": "boolean", "default": false, "description": "Whether to enable EKM (External Key Management) for this Linked Account." } }, "required": [ "categories", "end_user_email_address", "end_user_organization_name", "end_user_origin_id" ], "x-merge-category": "hris" }, "ErrorValidationProblem": { "type": "object", "properties": { "source": { "$ref": "#/components/schemas/ValidationProblemSource", "example": { "pointer": "/model/custom_fields" } }, "title": { "type": "string", "example": "Missing Required Field" }, "detail": { "type": "string", "example": "custom_fields is a required field on model." }, "problem_type": { "type": "string", "example": "MISSING_REQUIRED_FIELD" }, "block_merge_link": { "type": "boolean" }, "raw_error": { "type": "string" }, "error_code": { "type": "integer" } }, "required": [ "detail", "problem_type", "title" ], "x-merge-category": "hris" }, "EthnicityEnum": { "enum": [ "AMERICAN_INDIAN_OR_ALASKA_NATIVE", "ASIAN_OR_INDIAN_SUBCONTINENT", "BLACK_OR_AFRICAN_AMERICAN", "HISPANIC_OR_LATINO", "NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER", "TWO_OR_MORE_RACES", "WHITE", "PREFER_NOT_TO_DISCLOSE" ], "type": "string", "x-merge-category": "hris" }, "EventTypeEnum": { "enum": [ "CREATED_REMOTE_PRODUCTION_API_KEY", "DELETED_REMOTE_PRODUCTION_API_KEY", "CREATED_TEST_API_KEY", "DELETED_TEST_API_KEY", "REGENERATED_PRODUCTION_API_KEY", "REGENERATED_WEBHOOK_SIGNATURE", "INVITED_USER", "TWO_FACTOR_AUTH_ENABLED", "TWO_FACTOR_AUTH_DISABLED", "DELETED_LINKED_ACCOUNT", "DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT", "CREATED_DESTINATION", "DELETED_DESTINATION", "CHANGED_DESTINATION", "CHANGED_SCOPES", "CHANGED_PERSONAL_INFORMATION", "CHANGED_ORGANIZATION_SETTINGS", "ENABLED_INTEGRATION", "DISABLED_INTEGRATION", "ENABLED_CATEGORY", "DISABLED_CATEGORY", "CHANGED_PASSWORD", "RESET_PASSWORD", "ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION", "ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT", "DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION", "DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT", "CREATED_INTEGRATION_WIDE_FIELD_MAPPING", "CREATED_LINKED_ACCOUNT_FIELD_MAPPING", "CHANGED_INTEGRATION_WIDE_FIELD_MAPPING", "CHANGED_LINKED_ACCOUNT_FIELD_MAPPING", "DELETED_INTEGRATION_WIDE_FIELD_MAPPING", "DELETED_LINKED_ACCOUNT_FIELD_MAPPING", "CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE", "CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE", "DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE", "FORCED_LINKED_ACCOUNT_RESYNC", "MUTED_ISSUE", "GENERATED_MAGIC_LINK", "ENABLED_MERGE_WEBHOOK", "DISABLED_MERGE_WEBHOOK", "MERGE_WEBHOOK_TARGET_CHANGED", "END_USER_CREDENTIALS_ACCESSED", "CHANGED_SELECTIVE_SYNC_FILTERS", "ADDED_PARTNER_CREDENTIALS", "UPDATED_PARTNER_CREDENTIALS", "REMOVED_PARTNER_CREDENTIALS", "CHANGED_PARTNER_CREDENTIAL_SOURCE" ], "type": "string", "x-merge-category": "hris" }, "ExternalTargetFieldAPI": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "readOnly": true, "example": "example_target_field_name" }, "description": { "type": "string", "nullable": true, "readOnly": true, "example": "this is a example description of a target field" }, "is_mapped": { "type": "string", "nullable": true, "readOnly": true, "example": true } }, "x-merge-category": "hris" }, "ExternalTargetFieldAPIResponse": { "type": "object", "properties": { "Benefit": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalTargetFieldAPI" } }, "EmployerBenefit": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalTargetFieldAPI" } }, "Company": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalTargetFieldAPI" } }, "EmployeePayrollRun": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalTargetFieldAPI" } }, "Employee": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalTargetFieldAPI" } }, "Employment": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalTargetFieldAPI" } }, "Location": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalTargetFieldAPI" } }, "PayrollRun": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalTargetFieldAPI" } }, "Team": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalTargetFieldAPI" } }, "TimeOff": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalTargetFieldAPI" } }, "TimeOffBalance": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalTargetFieldAPI" } }, "BankInfo": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalTargetFieldAPI" } }, "PayGroup": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalTargetFieldAPI" } }, "Group": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalTargetFieldAPI" } }, "Dependent": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalTargetFieldAPI" } }, "TimesheetEntry": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalTargetFieldAPI" } } }, "x-merge-category": "hris" }, "FieldMappingApiInstance": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "is_integration_wide": { "type": "boolean", "readOnly": true }, "target_field": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "is_organization_wide": { "type": "boolean" } }, "required": [ "description", "is_organization_wide", "name" ], "nullable": true, "readOnly": true, "example": { "name": "example_target_field_name", "description": "this is a example description of a target field", "is_organization_wide": true } }, "remote_field": { "type": "object", "properties": { "remote_key_name": { "type": "string", "nullable": true }, "schema": { "type": "object", "additionalProperties": {}, "nullable": true }, "remote_endpoint_info": { "type": "object", "properties": { "method": { "type": "string", "nullable": true }, "url_path": { "type": "string", "nullable": true }, "field_traversal_path": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "required": [ "field_traversal_path", "method", "url_path" ] } }, "required": [ "remote_endpoint_info", "remote_key_name", "schema" ], "nullable": true, "readOnly": true, "example": { "remote_key_name": "example_remote_field_key", "schema": { "type": "string" }, "remote_endpoint_info": { "method": "GET", "url_path": "/example-url-path", "field_traversal_path": [ "example_remote_field_key" ] } } }, "jmes_path": { "type": "string", "nullable": true, "readOnly": true, "example": "[0].example_jmes_path" }, "advanced_mapping_expression": { "type": "string", "nullable": true, "readOnly": true, "example": "$[0].example_jsonata" } }, "x-merge-category": "hris" }, "FieldMappingApiInstanceResponse": { "type": "object", "properties": { "Benefit": { "type": "array", "items": { "$ref": "#/components/schemas/FieldMappingApiInstance" } }, "EmployerBenefit": { "type": "array", "items": { "$ref": "#/components/schemas/FieldMappingApiInstance" } }, "Company": { "type": "array", "items": { "$ref": "#/components/schemas/FieldMappingApiInstance" } }, "EmployeePayrollRun": { "type": "array", "items": { "$ref": "#/components/schemas/FieldMappingApiInstance" } }, "Employee": { "type": "array", "items": { "$ref": "#/components/schemas/FieldMappingApiInstance" } }, "Employment": { "type": "array", "items": { "$ref": "#/components/schemas/FieldMappingApiInstance" } }, "Location": { "type": "array", "items": { "$ref": "#/components/schemas/FieldMappingApiInstance" } }, "PayrollRun": { "type": "array", "items": { "$ref": "#/components/schemas/FieldMappingApiInstance" } }, "Team": { "type": "array", "items": { "$ref": "#/components/schemas/FieldMappingApiInstance" } }, "TimeOff": { "type": "array", "items": { "$ref": "#/components/schemas/FieldMappingApiInstance" } }, "TimeOffBalance": { "type": "array", "items": { "$ref": "#/components/schemas/FieldMappingApiInstance" } }, "BankInfo": { "type": "array", "items": { "$ref": "#/components/schemas/FieldMappingApiInstance" } }, "PayGroup": { "type": "array", "items": { "$ref": "#/components/schemas/FieldMappingApiInstance" } }, "Group": { "type": "array", "items": { "$ref": "#/components/schemas/FieldMappingApiInstance" } }, "Dependent": { "type": "array", "items": { "$ref": "#/components/schemas/FieldMappingApiInstance" } }, "TimesheetEntry": { "type": "array", "items": { "$ref": "#/components/schemas/FieldMappingApiInstance" } } }, "x-merge-category": "hris" }, "FieldMappingInstanceResponse": { "type": "object", "properties": { "model": { "$ref": "#/components/schemas/FieldMappingApiInstance" }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/WarningValidationProblem" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorValidationProblem" } }, "logs": { "type": "array", "items": { "$ref": "#/components/schemas/DebugModeLog" } } }, "required": [ "errors", "model", "warnings" ], "x-merge-category": "hris" }, "FieldPermissionDeserializer": { "type": "object", "properties": { "enabled_fields": { "type": "array", "items": {} }, "disabled_fields": { "type": "array", "items": {} } }, "x-merge-category": "hris" }, "FieldPermissionDeserializerRequest": { "type": "object", "properties": { "enabled_fields": { "type": "array", "items": {} }, "disabled_fields": { "type": "array", "items": {} } }, "x-merge-category": "hris" }, "FlsaStatusEnum": { "enum": [ "EXEMPT", "SALARIED_NONEXEMPT", "NONEXEMPT", "OWNER" ], "type": "string", "x-merge-category": "hris" }, "GenderEnum": { "enum": [ "MALE", "FEMALE", "NON-BINARY", "OTHER", "PREFER_NOT_TO_DISCLOSE" ], "type": "string", "x-merge-category": "hris" }, "GenerateRemoteKeyRequest": { "type": "object", "description": "# The GenerateRemoteKey Object\n### Description\nThe `GenerateRemoteKey` object is used to represent a request for a new remote key.\n\n### Usage Example\nPost a `GenerateRemoteKey` to create a new remote key.", "properties": { "name": { "type": "string", "minLength": 1, "description": "The name of the remote key", "example": "Remote Deployment Key 1" } }, "required": [ "name" ], "x-merge-category": "hris" }, "Group": { "type": "object", "description": "# The Group Object\n### Description\nThe `Group` object is used to represent any subset of employees across, for example, `DEPARTMENT` or `TEAM`. Employees can be in multiple Groups.\n\n### Usage Example\nFetch from the `LIST Employee` endpoint and expand groups to view an employee's groups.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "example": "134e0111-0f67-44f6-98f0-597000290bb3" }, "remote_id": { "type": "string", "nullable": true, "description": "The third-party API ID of the matching object.", "example": "800293" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was created by Merge.", "example": "2021-09-15T00:00:00Z" }, "modified_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was modified by Merge.", "example": "2021-10-16T00:00:00Z" }, "parent_group": { "type": "string", "format": "uuid", "description": "The parent group for this group.", "nullable": true, "example": "2ef51b11-2c4e-4b02-8d1d-50592d9e96ef", "x-merge-expands-to": "Group" }, "name": { "type": "string", "nullable": true, "description": "The group name.", "example": "COST_CENTER_US" }, "type": { "allOf": [ { "$ref": "#/components/schemas/GroupTypeEnum" } ], "nullable": true, "description": "The Group type returned directly from the third-party.", "example": "COST_CENTER" }, "is_commonly_used_as_team": { "type": "boolean", "nullable": true, "description": "Indicates whether the Group refers to a team in the third party platform. Note that this is an opinionated view based on how Merge observes most organizations representing teams in each third party platform. If your customer uses a platform different from most, there is a chance this will not be correct.", "example": true }, "group_url": { "type": "string", "format": "uri", "nullable": true, "description": "The 3rd party URL of the group.", "maxLength": 2000, "example": "https://www.workday.com/wday/v2/cost-center/800293" }, "remote_was_deleted": { "type": "boolean", "readOnly": true, "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)." }, "field_mappings": { "type": "object", "nullable": true, "properties": { "organization_defined_targets": { "type": "object", "additionalProperties": true }, "linked_account_defined_targets": { "type": "object", "additionalProperties": true } }, "readOnly": true, "example": { "organization_defined_targets": { "custom_key": "custom_value" }, "linked_account_defined_targets": { "custom_key": "custom_value" } } }, "remote_data": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteData" }, "readOnly": true, "nullable": true, "example": [ { "path": "/group", "data": [ "Varies by platform" ] } ] }, "type_native": { "type": "string", "readOnly": true, "nullable": true, "description": "The third-party value for `type` before Merge normalized it. Returned only when `show_native_enum_values=true`." } }, "x-merge-expands": "{\"parent_group\": \"Group\"}", "x-merge-category": "hris" }, "GroupTypeEnum": { "enum": [ "TEAM", "DEPARTMENT", "COST_CENTER", "BUSINESS_UNIT", "GROUP" ], "type": "string", "x-merge-category": "hris" }, "IgnoreCommonModelRequest": { "type": "object", "properties": { "reason": { "allOf": [ { "$ref": "#/components/schemas/ReasonEnum" } ], "example": "GENERAL_CUSTOMER_REQUEST" }, "message": { "type": "string", "minLength": 1, "maxLength": 256, "example": "deletion request by user id 51903790-7dfe-4053-8d63-5a10cc4ffd39" } }, "required": [ "reason" ], "x-merge-category": "hris" }, "IndividualCommonModelScopeDeserializer": { "type": "object", "properties": { "model_name": { "type": "string" }, "model_permissions": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelPermissionDeserializer" } }, "field_permissions": { "$ref": "#/components/schemas/FieldPermissionDeserializer" } }, "required": [ "model_name" ], "x-merge-category": "hris" }, "IndividualCommonModelScopeDeserializerRequest": { "type": "object", "properties": { "model_name": { "type": "string", "minLength": 1 }, "model_permissions": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ModelPermissionDeserializerRequest" } }, "field_permissions": { "$ref": "#/components/schemas/FieldPermissionDeserializerRequest" } }, "required": [ "model_name" ], "x-merge-category": "hris" }, "Issue": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "status": { "allOf": [ { "$ref": "#/components/schemas/IssueStatusEnum" } ], "description": "Status of the issue.", "example": "ONGOING" }, "error_description": { "type": "string", "example": "Missing Permissions" }, "end_user": { "type": "object", "additionalProperties": {}, "readOnly": true, "example": "b82302de-852e-4e60-b050-edf9da3b7c02" }, "first_incident_time": { "type": "string", "format": "date-time", "nullable": true, "example": "2022-12-05T16:19:15.161Z" }, "last_incident_time": { "type": "string", "format": "date-time", "nullable": true, "example": "2022-12-05T16:19:15.161Z" }, "is_muted": { "type": "boolean", "readOnly": true, "example": true }, "error_details": { "type": "array", "items": { "type": "string" }, "readOnly": true, "example": [ "Missing employee permissions.", "Missing time off permissions." ] } }, "required": [ "error_description" ], "x-merge-category": "hris" }, "IssueStatusEnum": { "enum": [ "ONGOING", "RESOLVED" ], "type": "string", "x-merge-category": "hris" }, "LanguageEnum": { "enum": [ "en", "de" ], "type": "string", "x-merge-category": "hris" }, "LastSyncResultEnum": { "enum": [ "SYNCING", "DONE", "FAILED", "DISABLED", "PAUSED", "PARTIALLY_SYNCED" ], "type": "string", "x-merge-category": "hris" }, "LinkToken": { "type": "object", "properties": { "link_token": { "type": "string", "example": "necdP7FtdASl1fQwm62be2_dM4wBG8_GactqoUV0" }, "integration_name": { "type": "string", "example": "Lever" }, "magic_link_url": { "type": "string", "example": "https://link.merge.dev/asdfjkl12345jsndfgi2i83n" } }, "required": [ "link_token" ], "x-merge-category": "hris" }, "LinkedAccountCommonModelScopeDeserializerRequest": { "type": "object", "properties": { "common_models": { "type": "array", "items": { "$ref": "#/components/schemas/IndividualCommonModelScopeDeserializerRequest" }, "description": "The common models you want to update the scopes for", "example": [ { "model_name": "Employee", "model_permissions": { "READ": { "is_enabled": true }, "WRITE": { "is_enabled": false } }, "field_permissions": { "enabled_fields": [ "avatar", "home_location" ], "disabled_fields": [ "work_location" ] } }, { "model_name": "Benefit", "model_permissions": { "WRITE": { "is_enabled": false } } } ] } }, "required": [ "common_models" ], "x-merge-category": "hris" }, "LinkedAccountPatchResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "ekm_enabled": { "type": "boolean" } }, "required": [ "ekm_enabled", "id" ], "x-merge-category": "hris" }, "LinkedAccountStatus": { "type": "object", "properties": { "linked_account_status": { "type": "string" }, "can_make_request": { "type": "boolean" } }, "required": [ "can_make_request", "linked_account_status" ], "x-merge-category": "hris" }, "Location": { "type": "object", "description": "# The Location Object\n### Description\nThe `Location` object is used to represent an address that can be associated with an employee.\n\n### Usage Example\nFetch from the `LIST Locations` endpoint and filter by `ID` to show all office locations.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "example": "f5e6a151-f44e-449a-afb1-8fd781905958" }, "remote_id": { "type": "string", "nullable": true, "description": "The third-party API ID of the matching object.", "example": "93018402" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was created by Merge.", "example": "2021-09-15T00:00:00Z" }, "modified_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was modified by Merge.", "example": "2021-10-16T00:00:00Z" }, "name": { "type": "string", "nullable": true, "description": "The location's name.", "example": "NYC Office" }, "phone_number": { "type": "string", "nullable": true, "description": "The location's phone number.", "example": "+1111111111" }, "street_1": { "type": "string", "nullable": true, "description": "Line 1 of the location's street address.", "example": "2920 Broadway" }, "street_2": { "type": "string", "nullable": true, "description": "Line 2 of the location's street address.", "example": "2nd Floor" }, "city": { "type": "string", "nullable": true, "description": "The location's city.", "example": "New York " }, "state": { "type": "string", "nullable": true, "description": "The location's state. Represents a region if outside of the US.", "example": "NY" }, "zip_code": { "type": "string", "nullable": true, "description": "The location's zip code or postal code.", "example": "10027" }, "country": { "allOf": [ { "$ref": "#/components/schemas/CountryEnum" } ], "nullable": true, "description": "The location's country. The country code in ISO 3166-1 alpha-2 format.", "example": "US" }, "location_type": { "allOf": [ { "$ref": "#/components/schemas/LocationTypeEnum" } ], "nullable": true, "description": "The location's type. Can be either WORK or HOME", "example": "WORK" }, "remote_was_deleted": { "type": "boolean", "readOnly": true, "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)." }, "field_mappings": { "type": "object", "nullable": true, "properties": { "organization_defined_targets": { "type": "object", "additionalProperties": true }, "linked_account_defined_targets": { "type": "object", "additionalProperties": true } }, "readOnly": true, "example": { "organization_defined_targets": { "custom_key": "custom_value" }, "linked_account_defined_targets": { "custom_key": "custom_value" } } }, "remote_data": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteData" }, "readOnly": true, "nullable": true, "example": [ { "path": "/locations", "data": [ "Varies by platform" ] } ] }, "country_native": { "type": "string", "readOnly": true, "nullable": true, "description": "The third-party value for `country` before Merge normalized it. Returned only when `show_native_enum_values=true`." }, "location_type_native": { "type": "string", "readOnly": true, "nullable": true, "description": "The third-party value for `location_type` before Merge normalized it. Returned only when `show_native_enum_values=true`." } }, "x-merge-category": "hris" }, "LocationTypeEnum": { "enum": [ "HOME", "WORK" ], "type": "string", "x-merge-category": "hris" }, "MaritalStatusEnum": { "enum": [ "SINGLE", "MARRIED_FILING_JOINTLY", "MARRIED_FILING_SEPARATELY", "HEAD_OF_HOUSEHOLD", "QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD" ], "type": "string", "x-merge-category": "hris" }, "MetaResponse": { "type": "object", "properties": { "request_schema": { "type": "object", "additionalProperties": {}, "example": { "type": "object", "properties": { "model": { "type": "object", "required": [ "last_name", "first_name", "merge_categories", "new_york_city_neighborhood", "favorite_tv_shows", "favorite_watch" ], "properties": { "email_addresses": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "title": "value" }, "email_address_type": { "type": "string", "title": "email_address_type" }, "integration_params": { "type": "object", "title": "integration_params", "properties": {} }, "linked_account_params": { "type": "object", "title": "linked_account_params", "properties": {} } } }, "title": "email_addresses", "description": "Array of email_addresses objects" }, "urls": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "title": "value" }, "url_type": { "type": "string", "title": "url_type" }, "integration_params": { "type": "object", "title": "integration_params", "properties": {} }, "linked_account_params": { "type": "object", "title": "linked_account_params", "properties": {} } } }, "title": "urls", "description": "Array of urls objects" }, "first_name": { "type": "string", "title": "first_name", "description": "The first name." }, "last_name": { "type": "string", "title": "last_name", "description": "The last name." }, "phone_numbers": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "title": "value" }, "phone_number_type": { "type": "string", "title": "phone_number_type" }, "integration_params": { "type": "object", "title": "integration_params", "properties": {} }, "linked_account_params": { "type": "object", "title": "linked_account_params", "properties": {} } } }, "title": "phone_numbers", "description": "Array of phone_numbers objects" }, "tags": { "type": "array", "items": { "type": "string", "format": "uuid" }, "title": "tags", "description": "Array of tags names" }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "title": "id" }, "file_url": { "type": "string", "title": "file_url" }, "file_name": { "type": "string", "title": "file_name" }, "attachment_type": { "type": "string", "title": "attachment_type" }, "integration_params": { "type": "object", "title": "integration_params", "properties": {} }, "linked_account_params": { "type": "object", "title": "linked_account_params", "properties": {} } } }, "title": "attachments", "description": "Array of attachments objects " }, "merge_categories": { "type": "array", "categories": { "type": "string", "enum": [ "HRIS", "ATS", "Accounting", "Ticketing", "File Storage", "CRM", "Marketing Automation" ], "enum_information": [ { "value": "HRIS", "description": "Merge HRIS Category" }, { "value": "ATS", "description": "Merge ATS Category" }, { "value": "Accounting", "description": "Merge Accounting Category" }, { "value": "Ticketing", "description": "Merge Ticketing Category" }, { "value": "File Storage", "description": "Merge File Storage Category" }, { "value": "CRM", "description": "Merge CRM Category" }, { "value": "Marketing Automation", "description": "Merge Marketing Automation Category" } ] }, "title": "Merge Categories", "description": "Array of Merge's Unified API Categories" }, "new_york_city_neighborhood": { "type": "string", "title": "Borough", "description": "One of the 5 Boroughs of New York City" }, "favorite_tv_shows": { "type": "array", "items": { "type": "string", "format": "uuid" }, "title": "Favorite TV Shows", "description": "Array of TV Show objects on merge.tv_shows" }, "favorite_watch": { "type": "string", "title": "Favorite Watch", "description": "Favorite watch of all time" } } } } } }, "status": { "$ref": "#/components/schemas/LinkedAccountStatus", "example": { "linked_account_status": "COMPLETE", "can_make_request": true } }, "has_conditional_params": { "type": "boolean" }, "has_required_linked_account_params": { "type": "boolean" }, "remote_fields": { "type": "array", "items": { "type": "string", "format": "uuid" }, "title": "remote_fields", "description": "Remote field values to populate", "enum": [], "enum_information": [] } }, "required": [ "has_conditional_params", "has_required_linked_account_params", "request_schema" ], "x-merge-category": "hris" }, "MethodEnum": { "enum": [ "GET", "OPTIONS", "HEAD", "POST", "PUT", "PATCH", "DELETE" ], "type": "string", "x-merge-category": "hris" }, "ModelOperation": { "type": "object", "description": "# The ModelOperation Object\n### Description\nThe `ModelOperation` object is used to represent the operations that are currently supported for a given model.\n\n### Usage Example\nView what operations are supported for the `Candidate` endpoint.", "properties": { "model_name": { "type": "string", "example": "Candidate" }, "available_operations": { "type": "array", "items": { "type": "string" }, "example": [ "FETCH", "CREATE" ] }, "required_post_parameters": { "type": "array", "items": { "type": "string" }, "example": [ "remote_user_id" ] }, "supported_fields": { "type": "array", "items": { "type": "string" }, "example": [ "first_name", "last_name", "company", "title" ] } }, "required": [ "available_operations", "model_name", "required_post_parameters", "supported_fields" ], "x-merge-category": "hris" }, "ModelPermissionDeserializer": { "type": "object", "properties": { "is_enabled": { "type": "boolean" } }, "x-merge-category": "hris" }, "ModelPermissionDeserializerRequest": { "type": "object", "properties": { "is_enabled": { "type": "boolean" } }, "x-merge-category": "hris" }, "MultipartFormFieldRequest": { "type": "object", "description": "# The MultipartFormField Object\n### Description\nThe `MultipartFormField` object is used to represent fields in an HTTP request using `multipart/form-data`.\n\n### Usage Example\nCreate a `MultipartFormField` to define a multipart form entry.", "properties": { "name": { "type": "string", "minLength": 1, "description": "The name of the form field", "example": "resume" }, "data": { "type": "string", "minLength": 1, "description": "The data for the form field.", "example": "SW50ZWdyYXRlIGZhc3QKSW50ZWdyYXRlIG9uY2U=" }, "encoding": { "allOf": [ { "$ref": "#/components/schemas/EncodingEnum" } ], "nullable": true, "default": "RAW", "description": "The encoding of the value of `data`. Defaults to `RAW` if not defined.", "example": "BASE64" }, "file_name": { "type": "string", "nullable": true, "minLength": 1, "description": "The file name of the form field, if the field is for a file.", "example": "resume.pdf" }, "content_type": { "type": "string", "nullable": true, "minLength": 1, "description": "The MIME type of the file, if the field is for a file.", "example": "application/pdf" } }, "required": [ "data", "name" ], "x-merge-category": "hris" }, "OperatorEnum": { "enum": [ "CONTAINS", "EQUALS", "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO", "HAS_ALL_OF", "HAS_NONE_OF", "IS_ONE_OF", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "NOT_EQUALS", "WITHIN" ], "type": "string", "x-merge-category": "hris" }, "PaginatedAccountDetailsAndActionsList": { "type": "object", "properties": { "next": { "type": "string", "nullable": true, "example": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw" }, "previous": { "type": "string", "nullable": true, "example": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/AccountDetailsAndActions" } } }, "x-merge-category": "hris" }, "PaginatedAuditLogEventList": { "type": "object", "properties": { "next": { "type": "string", "nullable": true, "example": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw" }, "previous": { "type": "string", "nullable": true, "example": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/AuditLogEvent" } } }, "x-merge-category": "hris" }, "PaginatedBankInfoList": { "type": "object", "properties": { "next": { "type": "string", "nullable": true, "example": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw" }, "previous": { "type": "string", "nullable": true, "example": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/BankInfo" } } }, "x-merge-category": "hris" }, "PaginatedBenefitList": { "type": "object", "properties": { "next": { "type": "string", "nullable": true, "example": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw" }, "previous": { "type": "string", "nullable": true, "example": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Benefit" } } }, "x-merge-category": "hris" }, "PaginatedCompanyList": { "type": "object", "properties": { "next": { "type": "string", "nullable": true, "example": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw" }, "previous": { "type": "string", "nullable": true, "example": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Company" } } }, "x-merge-category": "hris" }, "PaginatedDependentList": { "type": "object", "properties": { "next": { "type": "string", "nullable": true, "example": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw" }, "previous": { "type": "string", "nullable": true, "example": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Dependent" } } }, "x-merge-category": "hris" }, "PaginatedEmployeeList": { "type": "object", "properties": { "next": { "type": "string", "nullable": true, "example": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw" }, "previous": { "type": "string", "nullable": true, "example": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Employee" } } }, "x-merge-category": "hris" }, "PaginatedEmployeePayrollRunList": { "type": "object", "properties": { "next": { "type": "string", "nullable": true, "example": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw" }, "previous": { "type": "string", "nullable": true, "example": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/EmployeePayrollRun" } } }, "x-merge-category": "hris" }, "PaginatedEmployerBenefitList": { "type": "object", "properties": { "next": { "type": "string", "nullable": true, "example": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw" }, "previous": { "type": "string", "nullable": true, "example": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/EmployerBenefit" } } }, "x-merge-category": "hris" }, "PaginatedEmploymentList": { "type": "object", "properties": { "next": { "type": "string", "nullable": true, "example": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw" }, "previous": { "type": "string", "nullable": true, "example": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Employment" } } }, "x-merge-category": "hris" }, "PaginatedGroupList": { "type": "object", "properties": { "next": { "type": "string", "nullable": true, "example": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw" }, "previous": { "type": "string", "nullable": true, "example": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Group" } } }, "x-merge-category": "hris" }, "PaginatedIssueList": { "type": "object", "properties": { "next": { "type": "string", "nullable": true, "example": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw" }, "previous": { "type": "string", "nullable": true, "example": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Issue" } } }, "x-merge-category": "hris" }, "PaginatedLocationList": { "type": "object", "properties": { "next": { "type": "string", "nullable": true, "example": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw" }, "previous": { "type": "string", "nullable": true, "example": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Location" } } }, "x-merge-category": "hris" }, "PaginatedPayGroupList": { "type": "object", "properties": { "next": { "type": "string", "nullable": true, "example": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw" }, "previous": { "type": "string", "nullable": true, "example": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/PayGroup" } } }, "x-merge-category": "hris" }, "PaginatedPayrollRunList": { "type": "object", "properties": { "next": { "type": "string", "nullable": true, "example": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw" }, "previous": { "type": "string", "nullable": true, "example": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/PayrollRun" } } }, "x-merge-category": "hris" }, "PaginatedSyncStatusList": { "type": "object", "properties": { "next": { "type": "string", "nullable": true, "example": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw" }, "previous": { "type": "string", "nullable": true, "example": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/SyncStatus" } } }, "x-merge-category": "hris" }, "PaginatedTeamList": { "type": "object", "properties": { "next": { "type": "string", "nullable": true, "example": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw" }, "previous": { "type": "string", "nullable": true, "example": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Team" } } }, "x-merge-category": "hris" }, "PaginatedTimeOffBalanceList": { "type": "object", "properties": { "next": { "type": "string", "nullable": true, "example": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw" }, "previous": { "type": "string", "nullable": true, "example": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TimeOffBalance" } } }, "x-merge-category": "hris" }, "PaginatedTimeOffList": { "type": "object", "properties": { "next": { "type": "string", "nullable": true, "example": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw" }, "previous": { "type": "string", "nullable": true, "example": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TimeOff" } } }, "x-merge-category": "hris" }, "PaginatedTimesheetEntryList": { "type": "object", "properties": { "next": { "type": "string", "nullable": true, "example": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw" }, "previous": { "type": "string", "nullable": true, "example": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TimesheetEntry" } } }, "x-merge-category": "hris" }, "PatchedEditFieldMappingRequest": { "type": "object", "properties": { "remote_field_traversal_path": { "type": "array", "items": {}, "description": "The field traversal path of the remote field listed when you hit the GET /remote-fields endpoint.", "example": [ "example_remote_field_name" ] }, "remote_method": { "type": "string", "minLength": 1, "description": "The method of the remote endpoint where the remote field is coming from.", "example": "GET" }, "remote_url_path": { "type": "string", "minLength": 1, "description": "The path of the remote endpoint where the remote field is coming from.", "example": "/example-url-path" }, "jmes_path": { "type": "string", "minLength": 1, "description": "DEPRECATED: Use 'advanced_mapping_expression' instead." }, "advanced_mapping_expression": { "type": "string", "minLength": 1, "description": "A JSONata expression used to transform the remote field data.", "example": "$[0].example_jsonata" } }, "x-merge-category": "hris" }, "PatchedLinkedAccountPatchDeserializerRequest": { "type": "object", "properties": { "ekm_enabled": { "type": "boolean" } }, "x-merge-category": "hris" }, "PayCurrencyEnum": { "enum": [ "XUA", "AFN", "AFA", "ALL", "ALK", "DZD", "ADP", "AOA", "AOK", "AON", "AOR", "ARA", "ARS", "ARM", "ARP", "ARL", "AMD", "AWG", "AUD", "ATS", "AZN", "AZM", "BSD", "BHD", "BDT", "BBD", "BYN", "BYB", "BYR", "BEF", "BEC", "BEL", "BZD", "BMD", "BTN", "BOB", "BOL", "BOV", "BOP", "BAM", "BAD", "BAN", "BWP", "BRC", "BRZ", "BRE", "BRR", "BRN", "BRB", "BRL", "GBP", "BND", "BGL", "BGN", "BGO", "BGM", "BUK", "BIF", "XPF", "KHR", "CAD", "CVE", "KYD", "XAF", "CLE", "CLP", "CLF", "CNX", "CNY", "CNH", "COP", "COU", "KMF", "CDF", "CRC", "HRD", "HRK", "CUC", "CUP", "CYP", "CZK", "CSK", "DKK", "DJF", "DOP", "NLG", "XCD", "DDM", "ECS", "ECV", "EGP", "GQE", "ERN", "EEK", "ETB", "EUR", "XBA", "XEU", "XBB", "XBC", "XBD", "FKP", "FJD", "FIM", "FRF", "XFO", "XFU", "GMD", "GEK", "GEL", "DEM", "GHS", "GHC", "GIP", "XAU", "GRD", "GTQ", "GWP", "GNF", "GNS", "GYD", "HTG", "HNL", "HKD", "HUF", "IMP", "ISK", "ISJ", "INR", "IDR", "IRR", "IQD", "IEP", "ILS", "ILP", "ILR", "ITL", "JMD", "JPY", "JOD", "KZT", "KES", "KWD", "KGS", "LAK", "LVL", "LVR", "LBP", "LSL", "LRD", "LYD", "LTL", "LTT", "LUL", "LUC", "LUF", "MOP", "MKD", "MKN", "MGA", "MGF", "MWK", "MYR", "MVR", "MVP", "MLF", "MTL", "MTP", "MRU", "MRO", "MUR", "MXV", "MXN", "MXP", "MDC", "MDL", "MCF", "MNT", "MAD", "MAF", "MZE", "MZN", "MZM", "MMK", "NAD", "NPR", "ANG", "TWD", "NZD", "NIO", "NIC", "NGN", "KPW", "NOK", "OMR", "PKR", "XPD", "PAB", "PGK", "PYG", "PEI", "PEN", "PES", "PHP", "XPT", "PLN", "PLZ", "PTE", "GWE", "QAR", "XRE", "RHD", "RON", "ROL", "RUB", "RUR", "RWF", "SVC", "WST", "SAR", "RSD", "CSD", "SCR", "SLL", "XAG", "SGD", "SKK", "SIT", "SBD", "SOS", "ZAR", "ZAL", "KRH", "KRW", "KRO", "SSP", "SUR", "ESP", "ESA", "ESB", "XDR", "LKR", "SHP", "XSU", "SDD", "SDG", "SDP", "SRD", "SRG", "SZL", "SEK", "CHF", "SYP", "STN", "STD", "TVD", "TJR", "TJS", "TZS", "XTS", "THB", "XXX", "TPE", "TOP", "TTD", "TND", "TRY", "TRL", "TMT", "TMM", "USD", "USN", "USS", "UGX", "UGS", "UAH", "UAK", "AED", "UYW", "UYU", "UYP", "UYI", "UZS", "VUV", "VES", "VEB", "VEF", "VND", "VNN", "CHE", "CHW", "XOF", "YDD", "YER", "YUN", "YUD", "YUM", "YUR", "ZWN", "ZRN", "ZRZ", "ZMW", "ZMK", "ZWD", "ZWR", "ZWL" ], "type": "string", "description": "The currency code in ISO 4217 format.", "x-merge-category": "hris" }, "PayFrequencyEnum": { "enum": [ "WEEKLY", "BIWEEKLY", "MONTHLY", "QUARTERLY", "SEMIANNUALLY", "ANNUALLY", "THIRTEEN-MONTHLY", "PRO_RATA", "SEMIMONTHLY" ], "type": "string", "x-merge-category": "hris" }, "PayGroup": { "type": "object", "description": "# The PayGroup Object\n### Description\nThe `PayGroup` object is used to represent a subset of employees that are put together for payroll processing purposes.\n\n### Usage Example\nFetch from the `LIST PayGroup` endpoint and filter by `ID` to show all pay group information.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "example": "fd1e0fb5-8f92-4ec9-9f32-179cf732867d" }, "remote_id": { "type": "string", "nullable": true, "description": "The third-party API ID of the matching object.", "example": "800293" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was created by Merge.", "example": "2021-09-15T00:00:00Z" }, "modified_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was modified by Merge.", "example": "2021-10-16T00:00:00Z" }, "pay_group_name": { "type": "string", "nullable": true, "description": "The pay group name.", "example": "contractor" }, "remote_was_deleted": { "type": "boolean", "readOnly": true, "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)." }, "field_mappings": { "type": "object", "nullable": true, "properties": { "organization_defined_targets": { "type": "object", "additionalProperties": true }, "linked_account_defined_targets": { "type": "object", "additionalProperties": true } }, "readOnly": true, "example": { "organization_defined_targets": { "custom_key": "custom_value" }, "linked_account_defined_targets": { "custom_key": "custom_value" } } }, "remote_data": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteData" }, "readOnly": true, "nullable": true, "example": [ { "path": "/pay-group", "data": [ "Varies by platform" ] } ] } }, "x-merge-category": "hris" }, "PayPeriodEnum": { "enum": [ "HOUR", "DAY", "WEEK", "EVERY_TWO_WEEKS", "SEMIMONTHLY", "MONTH", "QUARTER", "EVERY_SIX_MONTHS", "YEAR" ], "type": "string", "x-merge-category": "hris" }, "PayrollRun": { "type": "object", "description": "# The PayrollRun Object\n### Description\nThe `PayrollRun` object is used to represent a group of pay statements for a specific pay schedule.\n\n### Usage Example\nFetch from the `LIST PayrollRuns` endpoint and filter by `ID` to show all payroll runs.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "example": "37336947-b3d4-4a4c-a310-ab6ab510e079" }, "remote_id": { "type": "string", "nullable": true, "description": "The third-party API ID of the matching object.", "example": "19202938" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was created by Merge.", "example": "2021-09-15T00:00:00Z" }, "modified_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was modified by Merge.", "example": "2021-10-16T00:00:00Z" }, "run_state": { "allOf": [ { "$ref": "#/components/schemas/RunStateEnum" } ], "nullable": true, "description": "The state of the payroll run", "example": "PAID" }, "run_type": { "allOf": [ { "$ref": "#/components/schemas/RunTypeEnum" } ], "nullable": true, "description": "The type of the payroll run", "example": "REGULAR" }, "start_date": { "type": "string", "format": "date-time", "nullable": true, "description": "The day and time the payroll run started.", "example": "2020-11-08T00:00:00Z" }, "end_date": { "type": "string", "format": "date-time", "nullable": true, "description": "The day and time the payroll run ended.", "example": "2020-11-15T00:00:00Z" }, "check_date": { "type": "string", "format": "date-time", "nullable": true, "description": "The day and time the payroll run was checked.", "example": "2020-11-15T00:00:00Z" }, "remote_was_deleted": { "type": "boolean", "readOnly": true, "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)." }, "field_mappings": { "type": "object", "nullable": true, "properties": { "organization_defined_targets": { "type": "object", "additionalProperties": true }, "linked_account_defined_targets": { "type": "object", "additionalProperties": true } }, "readOnly": true, "example": { "organization_defined_targets": { "custom_key": "custom_value" }, "linked_account_defined_targets": { "custom_key": "custom_value" } } }, "remote_data": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteData" }, "readOnly": true, "nullable": true, "example": [ { "path": "/payroll", "data": [ "Varies by platform" ] } ] }, "run_state_native": { "type": "string", "readOnly": true, "nullable": true, "description": "The third-party value for `run_state` before Merge normalized it. Returned only when `show_native_enum_values=true`." }, "run_type_native": { "type": "string", "readOnly": true, "nullable": true, "description": "The third-party value for `run_type` before Merge normalized it. Returned only when `show_native_enum_values=true`." } }, "x-merge-category": "hris" }, "PolicyTypeEnum": { "enum": [ "VACATION", "SICK", "PERSONAL", "JURY_DUTY", "VOLUNTEER", "BEREAVEMENT" ], "type": "string", "x-merge-category": "hris" }, "ReasonEnum": { "enum": [ "GENERAL_CUSTOMER_REQUEST", "GDPR", "OTHER" ], "type": "string", "x-merge-category": "hris" }, "RegenerateAccountToken": { "type": "object", "description": "# The RegenerateAccountToken Object\n### Description\nThe `RegenerateAccountToken` object is used to exchange an old account token for a new one.\n\n### Usage Example\nPost to receive a new `RegenerateAccountToken`.", "properties": { "linked_account_id": { "type": "string", "example": "e59b1821-f85c-4e28-a6b3-1804156f3563" }, "account_token": { "type": "string", "example": "hXY57W0g0WkdRHjCaPvwijK63fwfN-o_Wh7f30SLTq_uPCOLo-WFcA" } }, "required": [ "account_token", "linked_account_id" ], "x-merge-category": "hris" }, "RelationshipEnum": { "enum": [ "CHILD", "SPOUSE", "DOMESTIC_PARTNER" ], "type": "string", "x-merge-category": "hris" }, "RemoteData": { "type": "object", "description": "# The RemoteData Object\n### Description\nThe `RemoteData` object is used to represent the full data pulled from the third-party API for an object.\n\n### Usage Example\nTODO", "properties": { "path": { "type": "string", "description": "The third-party API path that is being called.", "example": "/platform-endpoint" }, "data": { "readOnly": true, "description": "The data returned from the third-party for this object in its original, unnormalized format.", "example": [ "Varies by platform" ] } }, "required": [ "path" ], "x-merge-category": "hris" }, "RemoteEndpointInfo": { "type": "object", "properties": { "method": { "type": "string", "example": "GET" }, "url_path": { "type": "string", "example": "/example-url-path" }, "field_traversal_path": { "type": "array", "items": {}, "example": [ "example_key_name" ] } }, "required": [ "field_traversal_path", "method", "url_path" ], "x-merge-category": "hris" }, "RemoteFieldAPI": { "type": "object", "properties": { "schema": { "type": "object", "additionalProperties": {}, "example": { "type": "string" } }, "remote_key_name": { "type": "string", "example": "example_remote_key_name" }, "remote_endpoint_info": { "$ref": "#/components/schemas/RemoteEndpointInfo", "example": { "method": "GET", "url_path": "/example-url-path", "field_traversal_path": [ "example_key_name" ] } }, "example_values": { "type": "array", "items": {}, "nullable": true, "example": [ "example" ] }, "advanced_metadata": { "allOf": [ { "$ref": "#/components/schemas/AdvancedMetadata" } ], "nullable": true }, "coverage": { "oneOf": [ { "type": "integer" }, { "type": "number", "format": "double" } ], "nullable": true, "readOnly": true, "example": 0.33 } }, "required": [ "advanced_metadata", "remote_endpoint_info", "remote_key_name", "schema" ], "x-merge-category": "hris" }, "RemoteFieldAPIResponse": { "type": "object", "properties": { "Benefit": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteFieldAPI" } }, "EmployerBenefit": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteFieldAPI" } }, "Company": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteFieldAPI" } }, "EmployeePayrollRun": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteFieldAPI" } }, "Employee": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteFieldAPI" } }, "Employment": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteFieldAPI" } }, "Location": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteFieldAPI" } }, "PayrollRun": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteFieldAPI" } }, "Team": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteFieldAPI" } }, "TimeOff": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteFieldAPI" } }, "TimeOffBalance": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteFieldAPI" } }, "BankInfo": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteFieldAPI" } }, "PayGroup": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteFieldAPI" } }, "Group": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteFieldAPI" } }, "Dependent": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteFieldAPI" } }, "TimesheetEntry": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteFieldAPI" } } }, "x-merge-category": "hris" }, "RemoteKey": { "type": "object", "description": "# The RemoteKey Object\n### Description\nThe `RemoteKey` object is used to represent a request for a new remote key.\n\n### Usage Example\nPost a `GenerateRemoteKey` to receive a new `RemoteKey`.", "properties": { "name": { "type": "string", "example": "Remote Deployment Key 1" }, "key": { "type": "string", "example": "hXY57W0g0WkdRHjCaPvwijK63fwfN-o_Wh7f30SLTq_uPCOLo-WFcA" } }, "required": [ "key", "name" ], "x-merge-category": "hris" }, "RemoteKeyForRegenerationRequest": { "type": "object", "description": "# The RemoteKeyForRegeneration Object\n### Description\nThe `RemoteKeyForRegeneration` object is used to exchange an old remote key for a new one\n\n### Usage Example\nPost a `RemoteKeyForRegeneration` to swap out an old remote key for a new one", "properties": { "name": { "type": "string", "minLength": 1, "description": "The name of the remote key", "example": "Remote Deployment Key 1" } }, "required": [ "name" ], "x-merge-category": "hris" }, "RemoteResponse": { "type": "object", "description": "# The RemoteResponse Object\n### Description\nThe `RemoteResponse` object is used to represent information returned from a third-party endpoint.\n\n### Usage Example\nView the `RemoteResponse` returned from your `DataPassthrough`.", "properties": { "method": { "type": "string", "example": "GET" }, "path": { "type": "string", "example": "/scooters" }, "status": { "type": "integer", "example": 200 }, "response": { "example": { "scooters": [ { "company": "Lime", "model": "Gen 2.5" }, { "company": "Bird", "model": "Bird Zero" } ] } }, "response_headers": { "type": "object", "additionalProperties": {}, "example": { "X-Page-Token": "value" } }, "response_type": { "allOf": [ { "$ref": "#/components/schemas/ResponseTypeEnum" } ], "example": "JSON" }, "headers": { "type": "object", "additionalProperties": {}, "example": { "EXTRA-HEADER": "value", "Authorization": "" } } }, "required": [ "method", "path", "response", "status" ], "x-merge-category": "hris" }, "RequestFormatEnum": { "enum": [ "JSON", "XML", "MULTIPART" ], "type": "string", "x-merge-category": "hris" }, "RequestTypeEnum": { "enum": [ "VACATION", "SICK", "PERSONAL", "JURY_DUTY", "VOLUNTEER", "BEREAVEMENT", "LEAVE" ], "type": "string", "x-merge-category": "hris" }, "ResponseTypeEnum": { "enum": [ "JSON", "BASE64_GZIP" ], "type": "string", "x-merge-category": "hris" }, "RoleEnum": { "enum": [ "ADMIN", "DEVELOPER", "MEMBER", "API", "SYSTEM", "MERGE_TEAM", "SUPPORT", "END_USER" ], "type": "string", "x-merge-category": "hris" }, "RunStateEnum": { "enum": [ "PAID", "DRAFT", "APPROVED", "FAILED", "CLOSED" ], "type": "string", "x-merge-category": "hris" }, "RunTypeEnum": { "enum": [ "REGULAR", "OFF_CYCLE", "CORRECTION", "TERMINATION", "SIGN_ON_BONUS" ], "type": "string", "x-merge-category": "hris" }, "SelectiveSyncCondition": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The Merge ID of the filter." }, "common_model": { "type": "string", "description": "The common model the filter applies to." }, "normalized_key_name": { "type": "string", "description": "The Merge field the filter applies to." }, "remote_key_name": { "type": "string", "nullable": true, "description": "The third-party API's name for the filtered field." }, "operator": { "allOf": [ { "$ref": "#/components/schemas/OperatorEnum" } ], "description": "How the value is compared." }, "value": { "type": "object", "additionalProperties": {}, "description": "The value the field is compared against." } }, "required": [ "common_model", "id", "normalized_key_name", "operator", "remote_key_name", "value" ], "x-merge-category": "hris" }, "SelectiveSyncConditionList": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/SelectiveSyncCondition" } } }, "required": [ "results" ], "x-merge-category": "hris" }, "SelectiveSyncConfigurationsUsageEnum": { "enum": [ "IN_NEXT_SYNC", "IN_LAST_SYNC" ], "type": "string", "x-merge-category": "hris" }, "StatusFd5Enum": { "enum": [ "SYNCING", "DONE", "FAILED", "DISABLED", "PAUSED", "PARTIALLY_SYNCED" ], "type": "string", "x-merge-category": "hris" }, "SyncStatus": { "type": "object", "description": "# The SyncStatus Object\n### Description\nThe `SyncStatus` object is used to represent the syncing state of an account\n\n### Usage Example\nView the `SyncStatus` for an account to see how recently its models were synced.", "properties": { "model_name": { "type": "string", "example": "Employee" }, "model_id": { "type": "string", "example": "hris.Employee" }, "last_sync_start": { "type": "string", "format": "date-time", "example": "2021-03-30T19:44:18.695973Z" }, "next_sync_start": { "type": "string", "format": "date-time", "example": "2021-03-30T20:44:18.662942Z" }, "last_sync_result": { "allOf": [ { "$ref": "#/components/schemas/LastSyncResultEnum" } ], "example": "DONE" }, "last_sync_finished": { "type": "string", "format": "date-time", "example": "2021-03-30T19:55:18.695973Z" }, "data_fresh_as_of": { "type": "string", "format": "date-time", "nullable": true, "description": "The point in time that this model's data is complete through. This is the start time of the most recent sync that completed successfully for the model. The data is current at least through this time and may be fresher. Null until the first sync completes.", "example": "2021-03-30T19:44:18.695973Z" }, "historical_data_since": { "type": "string", "format": "date-time", "nullable": true, "description": "The earliest point this model has complete historical data for, based on each record's modified date in the third-party platform. Records modified before this time have not been fully synced. A model synced over its full history reaches back to 1900-01-01, unless there's a selective sync filter. Null until the first sync completes.", "example": "1900-01-01T00:00:00Z" }, "status": { "allOf": [ { "$ref": "#/components/schemas/StatusFd5Enum" } ], "example": "SYNCING" }, "sync_status_reason": { "allOf": [ { "$ref": "#/components/schemas/SyncStatusReasonEnum" } ], "nullable": true, "description": "Why a model is healthy but not actively progressing while its `status` stays `SYNCING`. Null when the model is progressing normally. `RATE_LIMITED` means the model is paused behind the data provider's rate limits. `WAITING_ON_OTHER_MODELS` means the model is on hold until other models finish syncing.", "example": "WAITING_ON_OTHER_MODELS" }, "is_initial_sync": { "type": "boolean", "example": true }, "selective_sync_configurations_usage": { "$ref": "#/components/schemas/SelectiveSyncConfigurationsUsageEnum" } }, "required": [ "is_initial_sync", "model_id", "model_name", "status", "sync_status_reason" ], "x-merge-sample-json": "{\"model_name\": \"Candidate\", \"model_id\": \"ats.Candidate\", \"last_sync_start\": \"2021-03-30T19:44:18.695973Z\", \"next_sync_start\": \"2021-03-30T20:44:18.662942Z\", \"status\": \"SYNCING\", \"sync_status_reason\": \"WAITING_ON_OTHER_MODELS\", \"is_initial_sync\": true}", "x-merge-category": "hris" }, "SyncStatusReasonEnum": { "enum": [ "RATE_LIMITED", "WAITING_ON_OTHER_MODELS" ], "type": "string", "x-merge-category": "hris" }, "Tax": { "type": "object", "description": "# The Tax Object\n### Description\nThe `Tax` object is used to represent an array of the tax deductions for a given employee's payroll run.\n\n### Usage Example\nFetch from the `LIST Taxes` endpoint and filter by `ID` to show all taxes.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "example": "e3a825fd-c38d-4095-a717-df98c4cb9ebc" }, "remote_id": { "type": "string", "nullable": true, "description": "The third-party API ID of the matching object.", "example": "26806834" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was created by Merge.", "example": "2021-09-15T00:00:00Z" }, "modified_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was modified by Merge.", "example": "2021-10-16T00:00:00Z" }, "employee_payroll_run": { "type": "string", "format": "uuid", "nullable": true, "example": "35347df1-95e7-46e2-93cc-66f1191edca5" }, "name": { "type": "string", "nullable": true, "description": "The tax's name.", "example": "California State Income Tax" }, "amount": { "type": "number", "format": "double", "nullable": true, "description": "The tax amount.", "example": 100.25 }, "employer_tax": { "type": "boolean", "nullable": true, "description": "Whether or not the employer is responsible for paying the tax.", "example": "False" }, "remote_was_deleted": { "type": "boolean", "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)." }, "field_mappings": { "type": "object", "nullable": true, "properties": { "organization_defined_targets": { "type": "object", "additionalProperties": true }, "linked_account_defined_targets": { "type": "object", "additionalProperties": true } }, "readOnly": true, "example": { "organization_defined_targets": { "custom_key": "custom_value" }, "linked_account_defined_targets": { "custom_key": "custom_value" } } }, "remote_data": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteData" }, "readOnly": true, "nullable": true } }, "x-merge-nested-write-allowed": true, "x-merge-category": "hris" }, "Team": { "type": "object", "description": "# The Team Object\n### Description\nThe `Team` object is used to represent a subdivision of the company, usually a department. Each employee will be grouped into one specific Team.\n\n### Usage Example\nIf you're building a way to filter by `Team`, you'd hit the `GET Teams` endpoint to fetch the `Teams`, and then use the `ID` of the team your user selects to filter the `GET Employees` endpoint.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "example": "13a72919-9fae-4f54-81ca-ddfd8712a1ba" }, "remote_id": { "type": "string", "nullable": true, "description": "The third-party API ID of the matching object.", "example": "19202938" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was created by Merge.", "example": "2021-09-15T00:00:00Z" }, "modified_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was modified by Merge.", "example": "2021-10-16T00:00:00Z" }, "name": { "type": "string", "nullable": true, "description": "The team's name.", "example": "Engineering" }, "parent_team": { "type": "string", "format": "uuid", "description": "The team's parent team.", "nullable": true, "example": "1b998423-db0a-4037-a4cf-f79c60cb67b3", "x-merge-expands-to": "Team" }, "remote_was_deleted": { "type": "boolean", "readOnly": true, "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)." }, "field_mappings": { "type": "object", "nullable": true, "properties": { "organization_defined_targets": { "type": "object", "additionalProperties": true }, "linked_account_defined_targets": { "type": "object", "additionalProperties": true } }, "readOnly": true, "example": { "organization_defined_targets": { "custom_key": "custom_value" }, "linked_account_defined_targets": { "custom_key": "custom_value" } } }, "remote_data": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteData" }, "readOnly": true, "nullable": true, "example": [ { "path": "/teams", "data": [ "Varies by platform" ] } ] } }, "x-merge-expands": "{\"parent_team\": \"Team\"}", "x-merge-category": "hris" }, "TimeOff": { "type": "object", "description": "# The TimeOff Object\n### Description\nThe `TimeOff` object is used to represent all employees' Time Off entries.\n\n### Usage Example\nFetch from the `LIST TimeOffs` endpoint and filter by `ID` to show all time off requests.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "example": "91b2b905-e866-40c8-8be2-efe53827a0aa" }, "remote_id": { "type": "string", "nullable": true, "description": "The third-party API ID of the matching object.", "example": "19202938" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was created by Merge.", "example": "2021-09-15T00:00:00Z" }, "modified_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was modified by Merge.", "example": "2021-10-16T00:00:00Z" }, "employee": { "type": "string", "format": "uuid", "description": "The employee requesting time off.", "nullable": true, "example": "d2f972d0-2526-434b-9409-4c3b468e08f0", "x-merge-expands-to": "Employee" }, "approver": { "type": "string", "format": "uuid", "description": "The Merge ID of the employee with the ability to approve the time off request.", "nullable": true, "example": "9efbc633-3387-4306-aa55-e2c635e6bb4f", "x-merge-expands-to": "Employee" }, "status": { "allOf": [ { "$ref": "#/components/schemas/TimeOffStatusEnum" } ], "nullable": true, "description": "The status of this time off request.", "example": "APPROVED" }, "employee_note": { "type": "string", "nullable": true, "description": "The employee note for this time off request.", "example": "Moving into the new apartment Kendall Roy gave me!" }, "units": { "allOf": [ { "$ref": "#/components/schemas/UnitsEnum" } ], "nullable": true, "description": "The measurement that the third-party integration uses to count time requested.", "example": "DAYS" }, "amount": { "type": "number", "format": "double", "nullable": true, "description": "The time off quantity measured by the prescribed “units”.", "example": 3 }, "request_type": { "allOf": [ { "$ref": "#/components/schemas/RequestTypeEnum" } ], "nullable": true, "description": "The type of time off request.", "example": "VACATION" }, "start_time": { "type": "string", "format": "date-time", "nullable": true, "description": "The day and time of the start of the time requested off.", "example": "2020-11-10T00:00:00Z" }, "end_time": { "type": "string", "format": "date-time", "nullable": true, "description": "The day and time of the end of the time requested off.", "example": "2020-11-17T00:00:00Z" }, "remote_was_deleted": { "type": "boolean", "readOnly": true, "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)." }, "field_mappings": { "type": "object", "nullable": true, "properties": { "organization_defined_targets": { "type": "object", "additionalProperties": true }, "linked_account_defined_targets": { "type": "object", "additionalProperties": true } }, "readOnly": true, "example": { "organization_defined_targets": { "custom_key": "custom_value" }, "linked_account_defined_targets": { "custom_key": "custom_value" } } }, "remote_data": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteData" }, "readOnly": true, "nullable": true, "example": [ { "path": "/leave", "data": [ "Varies by platform" ] } ] }, "request_type_native": { "type": "string", "readOnly": true, "nullable": true, "description": "The third-party value for `request_type` before Merge normalized it. Returned only when `show_native_enum_values=true`." }, "status_native": { "type": "string", "readOnly": true, "nullable": true, "description": "The third-party value for `status` before Merge normalized it. Returned only when `show_native_enum_values=true`." }, "units_native": { "type": "string", "readOnly": true, "nullable": true, "description": "The third-party value for `units` before Merge normalized it. Returned only when `show_native_enum_values=true`." } }, "x-merge-expands": "{\"approver\": \"Employee\", \"employee\": \"Employee\"}", "x-merge-category": "hris" }, "TimeOffBalance": { "type": "object", "description": "# The TimeOffBalance Object\n### Description\nThe `TimeOffBalance` object is used to represent current balances for an employee's Time Off plan.\n\n### Usage Example\nFetch from the `LIST TimeOffBalances` endpoint and filter by `ID` to show all time off balances.", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "example": "91b2b905-e866-40c8-8be2-efe53827a0aa" }, "remote_id": { "type": "string", "nullable": true, "description": "The third-party API ID of the matching object.", "example": "19202938" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was created by Merge.", "example": "2021-09-15T00:00:00Z" }, "modified_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was modified by Merge.", "example": "2021-10-16T00:00:00Z" }, "employee": { "type": "string", "format": "uuid", "description": "The employee the balance belongs to.", "nullable": true, "example": "d2f972d0-2526-434b-9409-4c3b468e08f0", "x-merge-expands-to": "Employee" }, "balance": { "type": "number", "format": "double", "nullable": true, "description": "The current remaining PTO balance, measured in hours. For integrations that return this value in days, Merge multiplies by 8 to calculate hours.", "example": "60.0" }, "used": { "type": "number", "format": "double", "nullable": true, "description": "The amount of PTO used in terms of hours. For integrations that return this value in days, Merge multiplies by 8 to calculate hours.", "example": "45.0" }, "policy_type": { "allOf": [ { "$ref": "#/components/schemas/PolicyTypeEnum" } ], "nullable": true, "description": "The policy type of this time off balance.", "example": "VACATION" }, "remote_was_deleted": { "type": "boolean", "readOnly": true, "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)." }, "field_mappings": { "type": "object", "nullable": true, "properties": { "organization_defined_targets": { "type": "object", "additionalProperties": true }, "linked_account_defined_targets": { "type": "object", "additionalProperties": true } }, "readOnly": true, "example": { "organization_defined_targets": { "custom_key": "custom_value" }, "linked_account_defined_targets": { "custom_key": "custom_value" } } }, "remote_data": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteData" }, "readOnly": true, "nullable": true, "example": [ { "path": "/leave", "data": [ "Varies by platform" ] } ] }, "policy_type_native": { "type": "string", "readOnly": true, "nullable": true, "description": "The third-party value for `policy_type` before Merge normalized it. Returned only when `show_native_enum_values=true`." } }, "x-merge-expands": "{\"employee\": \"Employee\"}", "x-merge-category": "hris" }, "TimeOffEndpointRequest": { "type": "object", "properties": { "model": { "$ref": "#/components/schemas/TimeOffRequest" } }, "required": [ "model" ], "x-merge-category": "hris" }, "TimeOffRequest": { "type": "object", "description": "# The TimeOff Object\n### Description\nThe `TimeOff` object is used to represent all employees' Time Off entries.\n\n### Usage Example\nFetch from the `LIST TimeOffs` endpoint and filter by `ID` to show all time off requests.", "properties": { "employee": { "type": "string", "format": "uuid", "description": "The employee requesting time off.", "nullable": true, "example": "d2f972d0-2526-434b-9409-4c3b468e08f0", "x-merge-expands-to": "Employee" }, "approver": { "type": "string", "format": "uuid", "description": "The Merge ID of the employee with the ability to approve the time off request.", "nullable": true, "example": "9efbc633-3387-4306-aa55-e2c635e6bb4f", "x-merge-expands-to": "Employee" }, "status": { "allOf": [ { "$ref": "#/components/schemas/TimeOffStatusEnum" } ], "nullable": true, "description": "The status of this time off request.", "example": "APPROVED" }, "employee_note": { "type": "string", "nullable": true, "description": "The employee note for this time off request.", "example": "Moving into the new apartment Kendall Roy gave me!" }, "units": { "allOf": [ { "$ref": "#/components/schemas/UnitsEnum" } ], "nullable": true, "description": "The measurement that the third-party integration uses to count time requested.", "example": "DAYS" }, "amount": { "type": "number", "format": "double", "nullable": true, "description": "The time off quantity measured by the prescribed “units”.", "example": 3 }, "request_type": { "allOf": [ { "$ref": "#/components/schemas/RequestTypeEnum" } ], "nullable": true, "description": "The type of time off request.", "example": "VACATION" }, "start_time": { "type": "string", "format": "date-time", "nullable": true, "description": "The day and time of the start of the time requested off.", "example": "2020-11-10T00:00:00Z" }, "end_time": { "type": "string", "format": "date-time", "nullable": true, "description": "The day and time of the end of the time requested off.", "example": "2020-11-17T00:00:00Z" }, "integration_params": { "type": "object", "additionalProperties": {}, "writeOnly": true, "nullable": true, "example": { "unique_integration_field": "unique_integration_field_value" } }, "linked_account_params": { "type": "object", "additionalProperties": {}, "writeOnly": true, "nullable": true, "example": { "unique_linked_account_field": "unique_linked_account_field_value" } }, "request_type_native": { "type": "string", "writeOnly": true, "nullable": true, "minLength": 1, "description": "The third-party value for `request_type`, sent to the integration without enum normalization. Cannot be combined with `request_type`." }, "status_native": { "type": "string", "writeOnly": true, "nullable": true, "minLength": 1, "description": "The third-party value for `status`, sent to the integration without enum normalization. Cannot be combined with `status`." }, "units_native": { "type": "string", "writeOnly": true, "nullable": true, "minLength": 1, "description": "The third-party value for `units`, sent to the integration without enum normalization. Cannot be combined with `units`." } }, "x-merge-expands": "{\"approver\": \"Employee\", \"employee\": \"Employee\"}", "x-merge-category": "hris" }, "TimeOffResponse": { "type": "object", "properties": { "model": { "$ref": "#/components/schemas/TimeOff" }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/WarningValidationProblem" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorValidationProblem" } }, "logs": { "type": "array", "items": { "$ref": "#/components/schemas/DebugModeLog" } } }, "required": [ "errors", "model", "warnings" ], "x-merge-category": "hris" }, "TimeOffStatusEnum": { "enum": [ "REQUESTED", "APPROVED", "DECLINED", "CANCELLED", "DELETED" ], "type": "string", "x-merge-category": "hris" }, "TimesheetEntry": { "type": "object", "description": "# The Timesheet Entry Object\n### Description\nThe `Timesheet Entry` object is used to track coverage for hours worked by an 'Employee'.\n\n\n### Usage Example\nGET and POST Timesheet Entries", "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true, "example": "91b2b905-e866-40c8-8be2-efe53827a0aa" }, "remote_id": { "type": "string", "nullable": true, "description": "The third-party API ID of the matching object.", "example": "19202938" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was created by Merge.", "example": "2021-09-15T00:00:00Z" }, "modified_at": { "type": "string", "format": "date-time", "readOnly": true, "description": "The datetime that this object was modified by Merge.", "example": "2021-10-16T00:00:00Z" }, "employee": { "type": "string", "format": "uuid", "description": "The employee the timesheet entry is for.", "nullable": true, "example": "d2f972d0-2526-434b-9409-4c3b468e08f0", "x-merge-expands-to": "Employee" }, "hours_worked": { "type": "number", "format": "double", "nullable": true, "description": "The number of hours logged by the employee.", "example": 10.0 }, "start_time": { "type": "string", "format": "date-time", "nullable": true, "description": "The time at which the employee started work.", "example": "2020-11-10T00:00:00Z" }, "end_time": { "type": "string", "format": "date-time", "nullable": true, "description": "The time at which the employee ended work.", "example": "2020-11-10T00:10:00Z" }, "remote_was_deleted": { "type": "boolean", "readOnly": true, "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)." }, "field_mappings": { "type": "object", "nullable": true, "properties": { "organization_defined_targets": { "type": "object", "additionalProperties": true }, "linked_account_defined_targets": { "type": "object", "additionalProperties": true } }, "readOnly": true, "example": { "organization_defined_targets": { "custom_key": "custom_value" }, "linked_account_defined_targets": { "custom_key": "custom_value" } } }, "remote_data": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteData" }, "readOnly": true, "nullable": true, "example": [ { "path": "/dependent", "data": [ "Varies by platform" ] } ] } }, "x-merge-expands": "{\"employee\": \"Employee\"}", "x-merge-category": "hris" }, "TimesheetEntryEndpointRequest": { "type": "object", "properties": { "model": { "$ref": "#/components/schemas/TimesheetEntryRequest" } }, "required": [ "model" ], "x-merge-category": "hris" }, "TimesheetEntryRequest": { "type": "object", "description": "# The Timesheet Entry Object\n### Description\nThe `Timesheet Entry` object is used to track coverage for hours worked by an 'Employee'.\n\n\n### Usage Example\nGET and POST Timesheet Entries", "properties": { "employee": { "type": "string", "format": "uuid", "description": "The employee the timesheet entry is for.", "nullable": true, "example": "d2f972d0-2526-434b-9409-4c3b468e08f0", "x-merge-expands-to": "Employee" }, "hours_worked": { "type": "number", "format": "double", "nullable": true, "description": "The number of hours logged by the employee.", "example": 10.0 }, "start_time": { "type": "string", "format": "date-time", "nullable": true, "description": "The time at which the employee started work.", "example": "2020-11-10T00:00:00Z" }, "end_time": { "type": "string", "format": "date-time", "nullable": true, "description": "The time at which the employee ended work.", "example": "2020-11-10T00:10:00Z" }, "integration_params": { "type": "object", "additionalProperties": {}, "writeOnly": true, "nullable": true, "example": { "unique_integration_field": "unique_integration_field_value" } }, "linked_account_params": { "type": "object", "additionalProperties": {}, "writeOnly": true, "nullable": true, "example": { "unique_linked_account_field": "unique_linked_account_field_value" } } }, "x-merge-expands": "{\"employee\": \"Employee\"}", "x-merge-category": "hris" }, "TimesheetEntryResponse": { "type": "object", "properties": { "model": { "$ref": "#/components/schemas/TimesheetEntry" }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/WarningValidationProblem" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorValidationProblem" } }, "logs": { "type": "array", "items": { "$ref": "#/components/schemas/DebugModeLog" } } }, "required": [ "errors", "model", "warnings" ], "x-merge-category": "hris" }, "UnitsEnum": { "enum": [ "HOURS", "DAYS" ], "type": "string", "x-merge-category": "hris" }, "ValidationProblemSource": { "type": "object", "properties": { "pointer": { "type": "string" } }, "required": [ "pointer" ], "x-merge-category": "hris" }, "WarningValidationProblem": { "type": "object", "properties": { "source": { "$ref": "#/components/schemas/ValidationProblemSource", "example": { "pointer": "/age" } }, "title": { "type": "string", "example": "Unrecognized Field" }, "detail": { "type": "string", "example": "An unrecognized field, age, was passed in with request data." }, "problem_type": { "type": "string", "example": "UNRECOGNIZED_FIELD" }, "block_merge_link": { "type": "boolean" }, "raw_error": { "type": "string" }, "error_code": { "type": "integer" } }, "required": [ "detail", "problem_type", "title" ], "x-merge-category": "hris" }, "WebhookReceiver": { "type": "object", "properties": { "event": { "type": "string" }, "is_active": { "type": "boolean" }, "key": { "type": "string" } }, "required": [ "event", "is_active" ], "x-merge-category": "hris" }, "WebhookReceiverRequest": { "type": "object", "properties": { "event": { "type": "string", "minLength": 1 }, "is_active": { "type": "boolean" }, "key": { "type": "string", "minLength": 1 } }, "required": [ "event", "is_active" ], "x-merge-category": "hris" } }, "securitySchemes": { "tokenAuth": { "type": "http", "scheme": "bearer", "description": "Token-based authentication with required prefix \"Bearer\"", "x-fern-token-variable-name": "api_key" } } }, "servers": [ { "url": "https://api.merge.dev/api/hris/v1", "description": "Production", "x-fern-server-name": "Production" }, { "url": "https://api-sandbox.merge.dev/api/hris/v1", "description": "Sandbox", "x-fern-server-name": "Sandbox" }, { "url": "https://api-eu.merge.dev/api/hris/v1", "description": "Production EU", "x-fern-server-name": "ProductionEU" }, { "url": "https://api-ap.merge.dev/api/hris/v1", "description": "Production APSE1", "x-fern-server-name": "ProductionAPSE1" } ] }