> This page is for Unified. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.merge.dev/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.merge.dev/_mcp/server. The `Employment` object is used to represent a job position at a company. If 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. ### The Employment Object ```json { "id": "string", "remote_id": "string", "created_at": "2023-01-01T00:00:00Z", "modified_at": "2023-01-01T00:00:00Z", "employee": "string", "job_title": "string", "pay_rate": 1, "pay_period": "HOUR", "pay_frequency": "WEEKLY", "pay_currency": "XUA", "pay_group": "string", "flsa_status": "EXEMPT", "effective_date": "2023-01-01T00:00:00Z", "employment_type": "FULL_TIME", "remote_was_deleted": true, "field_mappings": { "organization_defined_targets": { "string": {} }, "linked_account_defined_targets": { "string": {} } }, "remote_data": [ { "path": "string", "data": {} } ] } ``` ### Schema (`Employment`) ```yaml components: schemas: PayPeriodEnum: type: string enum: - HOUR - DAY - WEEK - EVERY_TWO_WEEKS - SEMIMONTHLY - MONTH - QUARTER - EVERY_SIX_MONTHS - YEAR title: PayPeriodEnum PayFrequencyEnum: type: string enum: - WEEKLY - BIWEEKLY - MONTHLY - QUARTERLY - SEMIANNUALLY - ANNUALLY - THIRTEEN-MONTHLY - PRO_RATA - SEMIMONTHLY title: PayFrequencyEnum PayCurrencyEnum: type: string 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 description: The currency code in ISO 4217 format. title: PayCurrencyEnum FlsaStatusEnum: type: string enum: - EXEMPT - SALARIED_NONEXEMPT - NONEXEMPT - OWNER title: FlsaStatusEnum EmploymentTypeEnum: type: string enum: - FULL_TIME - PART_TIME - INTERN - CONTRACTOR - FREELANCE title: EmploymentTypeEnum EmploymentFieldMappings: type: object properties: organization_defined_targets: type: object additionalProperties: description: Any type linked_account_defined_targets: type: object additionalProperties: description: Any type title: EmploymentFieldMappings RemoteData: type: object properties: path: type: string description: The third-party API path that is being called. data: description: >- The data returned from the third-party for this object in its original, unnormalized format. required: - path description: >- # The RemoteData Object ### Description The `RemoteData` object is used to represent the full data pulled from the third-party API for an object. ### Usage Example TODO title: RemoteData Employment: type: object properties: id: type: string format: uuid remote_id: type: - string - 'null' description: The third-party API ID of the matching object. created_at: type: string format: date-time description: The datetime that this object was created by Merge. modified_at: type: string format: date-time description: The datetime that this object was modified by Merge. employee: type: - string - 'null' format: uuid description: The employee holding this position. job_title: type: - string - 'null' description: The position's title. pay_rate: type: - number - 'null' format: double description: The position's pay rate. pay_period: oneOf: - $ref: '#/components/schemas/PayPeriodEnum' - type: 'null' description: >- The time period this pay rate encompasses. This field is an open enum: Merge can return a value outside this list when an integration provides one it does not map. Pass `show_enum_origins=pay_period` to receive the integration's own value instead. pay_frequency: oneOf: - $ref: '#/components/schemas/PayFrequencyEnum' - type: 'null' description: >- The position's pay frequency. This field is an open enum: Merge can return a value outside this list when an integration provides one it does not map. Pass `show_enum_origins=pay_frequency` to receive the integration's own value instead. pay_currency: oneOf: - $ref: '#/components/schemas/PayCurrencyEnum' - type: 'null' description: The position's currency code. The currency code in ISO 4217 format. pay_group: type: - string - 'null' format: uuid description: The employment's pay group flsa_status: oneOf: - $ref: '#/components/schemas/FlsaStatusEnum' - type: 'null' description: >- The position's FLSA status. This field is an open enum: Merge can return a value outside this list when an integration provides one it does not map. Pass `show_enum_origins=flsa_status` to receive the integration's own value instead. effective_date: type: - string - 'null' format: date-time description: The position's effective date. employment_type: oneOf: - $ref: '#/components/schemas/EmploymentTypeEnum' - type: 'null' description: >- The position's type of employment. This field is an open enum: Merge can return a value outside this list when an integration provides one it does not map. Pass `show_enum_origins=employment_type` to receive the integration's own value instead. 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: oneOf: - $ref: '#/components/schemas/EmploymentFieldMappings' - type: 'null' remote_data: type: - array - 'null' items: $ref: '#/components/schemas/RemoteData' title: Employment ```