Human Capital Management REST API Developer Reference

newhires

Represents a New Hire REST API structure

POST

URI /services/apexrest/v1.0/newhires/*
Description Insert new hire records

Input Parameters

records New hire records that need to be inserted

Sample Code


// POST Request
{
   "records": [{
      "Workers": {
         "FirstName": "TestFirstName",
         "LastName": "TestLastName",
         "Middle": "TestMiddleName",
         "Prefix": "Mr.",
         "FormerName": "TestFormerName",
         "Nickname": "TestNickName",
         "PersonalEmail": "hcmqa+personalemail@financialforce.com",
         "WorkEmail": "hcmqa+workemail@financialforce.com",
         "EffectiveDate": "2016-05-01",
         "UserID": "00515000006AEwwAAG",
         "WorkerID": 4,
         "ExternalWorkerID": "4",
         "HireDate": "2016-01-01",
         "SeniorityDate": "2050-02-02",
         "Gender": "Male",
         "Country": "a1c15000000fHMDAA2",
         "Ethnicity": "White",
         "BirthCountry": "a1c15000000fHMDAA2",
         "DateOfBirth": "1985-01-01",
         "MaritalStatus": "Married",
         "HireReason": "a2915000001hAw3AAE",
         "BenefitProgram": "a13150000073jLfAAI",
         "BudgetOwner": "a4M15000000GwtTEAS",
         "PeopleManager": true,
         "BenefitEligible": "Yes",
         "WorkerCompCode": "a4415000000YWifAAG",
         "EligibleForEEOReporting": true,
         "I9Status": "Complete",
         "USWorkEligibility": "Yes",
         "EEOClass": "Professionals",
         "MilitaryStatus": "Active",
         "FLSAStatus": "Exempt",
         "DisabledVeteran": true,
         "VietnamVeteran": true,
         "W4Status": "Completed",
         "Phone": {
            "PhoneType": "Home",
            "PhoneNumber": "999-999-9999",
            "Extension": "999-999-9999"
         },
         "WorkAssignment": {
            "WorkerEvent": "a4615000000SFDlAAO",
            "EffectiveDate": "2016-07-07",
            "WorkerType": "Employee",
            "AssignmentIndicator": "Primary",
            "Position": "a3E15000000KXHwEAO",
            "AssignmentNumber": "1",
            "BusinessTitle": "Software Engineer",
            "PositionStartDate": "2016-07-07",
            "Job": "a2N150000006wd3EAA",
            "StandardDailyHours": 8.0,
            "ScheduledHours": 176.0,
            "FullPartTime": "Full Time",
            "RegularTemporary": "Regular",
            "SalariedHourly": "Yes",
            "FTE": 2080,
            "Shift": "a3c15000000AhFHAA0",
            "Organization": "a2r150000002BR2AAM",
            "Country": "a1c15000000fHMDAA2",
            "Division": "a1s15000003UNavAAG",
            "Department": "a1m15000000zy6fAAA",
            "Location": "a2Z15000000HuHvEAK",
            "CostCenter": "a1b150000003I4JAAU",
            "Manager": "a4I15000000H9SbEAK",
            "PayGroup": "a2v15000000IGktAAG",
            "PayrollStatus": "Active",
            "UnionCode": "a3r15000000IExGAAW"
         },
         "Compensation": {
            "CompensationEvent": "a1M1500000JHj9HEAT",
            "CompensationPlan": "a1R1500000ePpV7EAK",
            "CompensationGrade": "a1P15000003N14AEAS",
            "PayGroup": "a2v15000000IGktAAG",
            "CompensationRate": 0.9,
            "CompensationFrequency": "a1O15000004joZZEAY",
            "CostCenter": "a1b150000003I4JAAU"
         },
         "NationalID": {
            "CountryCode": "a1c15000000fHMDAA2",
            "NationalIDType": "a2d15000000HrAAAA0",
            "NationalID": "999-9999-999"
         },
         "Address": {
            "CountryCode": "a1c15000000fHMDAA2",
            "AddressType": "Home",
            "AddressLine1": "24 MARK STREET",
            "AddressLine2": "EAST TOWER",
            "CityTown": "NEW YORK",
            "StateProvinceID": "a3e1500000054bPAAQ",
            "ZipPostalCode": "99999"
         },
         "EquityPlan": {
            "GrantReason": "New Hire",
            "EquityType": "a201500000GOV15AAH",
            "GrantDate": "2015-02-02",
            "GrantPrice": 1000,
            "Amount": 2000,
            "VestingDate": "2015-02-02",
            "VestingSchedule": "2",
            "ExpirationDate": "2025-02-02"
         }
      }
   }]
}

// POST Response
["a2h15000000QoOqAAK"]
© Copyright 2009–2019 FinancialForce.com, inc. Confidential – all rights reserved. Various trademarks held by their respective owners.