Creating your 1st employee

All requests related to this API is around employee data. To get started, first you will need one employee on the database. Method is POST and the path of url is:

community/api/v1/employee

Mandatory objects:

PersonalInfo, WorkLocation, EmploymentInfo, ExternalUserInfo

Optional Objects

emergencyContact, bankInfo, offboardingInfo, compensationDetails, payItems

So one good start for initial employee data might be

{
  "externalEmployeeId": "0000005",
  "resellerEmployerId": "ABCDEF-reseller",
  "personalInfo": {
    "firstName": "my first user",
    "lastName": "Atlas Connect",
    "preferredName": "AtlasConnect",
    "clientId": "f0fc3e97-afbf-4441-bfaf-377ad3580cdf",
    "titleCode": 1,
    "genderCode": 1,
    "birthday": "2005-04-03",
    "maritalStatusCode": 1,
    "homeAddress": {
      "addressLine1": "Av naro of flemming 456",
      "cityName": "Flamingo",
      "stateCode": "RS",
      "countryCode": "US",
      "postalCode": "1234657"
    },
    "isMultipleCitizenIndicator": false,
    "citizenship": [
      {
        "countryCode": "US",
        "nationalId_1": "98435465455"
      }
    ],
    "personalPronounCode": 1,
    "contactDetails": {
      "mobilePhone": {
        "countryCallingCode": "US",
        "number": "55519957810215"
      },
      "linkedinUrl": "https://linkedin.coim/hellow",
      "loginId": "employeemail@company.com"
    }
  },
  "workLocation": {
    "workLocationCode": 1,
    "addressLine1": "Central Perk",
    "cityName": "NY",
    "stateCode": "NY",
    "countryCode": "US",
    "postalCode": "151654",
    "isWorkSameAsHomeAddressIndicator": true
  },
  "employmentInfo": {
    "targetStartDate": "2025-01-01",
    "atlasStartDate": "2025-01-01",
    "seniorityDate": "2025-01-01",
    "jobTitle": "Sr of nothing",
    "divisionName": "IT",
    "employmentTypeCode": 1,
    "workingHrsPerWeek": 44,
    "employmentTermCode": 2,
    "termEndDate": "2026-04-03",
    "contractEndDate": "2026-04-03",
    "departmentName": "STW",
    "jobDescription": "Save the wordl",
    "isProbationApplicableIndicator": true,
    "probationPeriodTypeCode": 2,
    "probationPeriodQuantity": 12,
    "managerEmail": "manager@atlashxm.com"
  },
   "externalUserInfo": {
    "externalCreatedOn": "2025-01-01",
    "externalCreatedBy": "StarLord",
    "externalUpdatedOn": "2025-01-01",
    "externalUpdatedBy": "StarLord"
  }
}

follows a list with descriptions for every field