Merge HR, Payroll, and Directory

Employments

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.

Properties

idUUID

remote_idString

The third-party API ID of the matching object.

created_atDateTime (ISO 8601)

The datetime that this object was created by Merge.

modified_atDateTime (ISO 8601)

The datetime that this object was modified by Merge.

employeeUUID

The employee holding this position.

job_titleString

The position's title.

pay_rateNumber

The position's pay rate.

pay_periodEnum

The time period this pay rate encompasses. Possible values include: HOUR, DAY, WEEK, EVERY_TWO_WEEKS, SEMIMONTHLY, MONTH, QUARTER, EVERY_SIX_MONTHS, YEAR. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.

pay_frequencyEnum

The position's pay frequency. Possible values include: WEEKLY, BIWEEKLY, MONTHLY, QUARTERLY, SEMIANNUALLY, ANNUALLY, THIRTEEN-MONTHLY, PRO_RATA, SEMIMONTHLY. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.

pay_currencyEnum

The position's currency code. Possible values include: 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. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.

pay_groupUUID

The employment's pay group

flsa_statusEnum

The position's FLSA status. Possible values include: EXEMPT, SALARIED_NONEXEMPT, NONEXEMPT, OWNER. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.

effective_dateDateTime (ISO 8601)

The position's effective date.

employment_typeEnum

The position's type of employment. Possible values include: FULL_TIME, PART_TIME, INTERN, CONTRACTOR, FREELANCE. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.

remote_was_deletedBoolean

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.

field_mappingsObject

remote_dataRemoteData[]

The RemoteData object

The RemoteData object is used to represent the full data pulled from the third-party API for an object.

Properties

pathString

The third-party API path that is being called.

dataAny

The data returned from the third-party for this object in its original, unnormalized format.

GET

/employments

https://api.merge.dev/api/hris/v1/employments

APAC

Returns a list of Employment objects.

Query & path parameters

created_afterDateTime (ISO 8601)

Optional

If provided, will only return objects created after this datetime.

created_beforeDateTime (ISO 8601)

Optional

If provided, will only return objects created before this datetime.

cursorString

Optional

The pagination cursor value.

employee_idString

Optional

If provided, will only return employments for this employee.

expandString

Optional

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

include_deleted_dataBoolean

Optional

include_remote_dataBoolean

Optional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_shell_dataBoolean

Optional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

modified_afterDateTime (ISO 8601)

Optional

If provided, only objects synced by Merge after this date time will be returned.

modified_beforeDateTime (ISO 8601)

Optional

If provided, only objects synced by Merge before this date time will be returned.

order_byString

Optional

Overrides the default ordering for this endpoint. Possible values include: effective_date, -effective_date.

page_sizeInteger

Optional

Number of results to return per page. The maximum limit is 100.

remote_fieldsString

Optional

Deprecated. Use show_enum_origins.

remote_idString

Optional

The API provider's ID for the given object.

show_enum_originsString

Optional

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

Field support by integration

Use the /linked-accounts endpoint to pull platform support information

7shifts

ADP DECIDIUM

ADP RUN

ADP Workforce Now

AllianceHCM

Altera Payroll

BambooHR

Breathe

Cezanne HR

Charlie

ChartHop

ClayHR

CoolCare

Darwinbox

Dayforce

Deel

Employment Hero

Factorial

Folks HR

Freshteam

Generic SFTP

Gusto

Hailey HR

Hibob

HR Cloud

HR Partner

HRWorks

Humaans

Humi

Insperity Premier

IntelliHR

IRIS Cascade

ISolved

JumpCloud

Justworks

Kallidus

Keka

Kenjo

Lano

Lattice HRIS

Lucca

Namely

Nmbrs

Officient

Oracle Cloud Human Capital Management (HCM)

OysterHR

PayCaptain

Paychex

Paycom

Paycor

PayFit

Paylocity

PeopleHR

Personio

PrismHR

Proliant

Remote

Revolut People

Rippling

Sage HR

Sage People

SAP SuccessFactors

Sesame

Simployer

Square Payroll

TriNet

TriNet HR Platform

UKG Pro

UKG Pro Workforce Management

UKG Ready

Workday

Zelt

Zoho People

GET

/employments/{id}

https://api.merge.dev/api/hris/v1/employments/{id}

APAC

Returns an Employment object with the given id.

Query & path parameters

expandString

Optional

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

idUUID

Required

include_remote_dataBoolean

Optional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_shell_dataBoolean

Optional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

remote_fieldsString

Optional

Deprecated. Use show_enum_origins.

show_enum_originsString

Optional

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

Field support by integration

Use the /linked-accounts endpoint to pull platform support information

7shifts