Field Names

First Name(Given Name)

text

The employee's first name as it appears on their official government ID.

personalInfo.firstName

Middle Name

text

The employee's middle name as it appears on their official government ID.

personalInfo.middleName

Surname (Last Name)

text

The employee's last name as it appears on their official government ID.

personalInfo.lastName

Date of Birth

date

The employee's date of birth.

personalInfo.birthday

Gender

enum

The employee's gender.

"Male", "Female", “Non-Binary“, “Prefer not to say“

personalInfo.genderCode

Marital Status

enum

The employee's marital status.
Single" or "Married", “Common Law“, “Domestic Partnership“, “Separated“, “Widowed”

personalInfo.maritalStatusCode

Nationality

text

The employee's nationality.

personalInfo.citizenship[].countryCode

National ID Number

text

The employee's national ID number.

personalInfo.citizenship[].nationalId_1

Personal Address

text

The employee's personal address.

personalInfo.homeAddress.addressLine1

Phone Number

text

The employee's phone number.

personalInfo.contactDetails.mobilePhone.number

Work Country Code

text

The country where the employee works. ISO code with 2 letters

workLocation.countryCode

Work State Province / Canton

text

The state, province, or canton where the employee works.

workLocation.stateCode

Work Address

text

The address where the employee works.

workLocation.addressLine1

Work Permit Required

boolean

Indicates if a work permit is required for the employee.

personalInfo.isLegallyAuthorized

Personal Email

email

The employee's email address to be used within atlas.

personalInfo.contactDetails.primaryContactEmail

Atlas Client Work Email

email

The employee work email address,

personalInfo.contactDetails.loginId

Hire date with Client )

date

The hire date with the client, before joining atlas

employmentInfo.seniorityDate

Atlas Contract Start Date

date

The start date of the employee's contract with Atlas.
Note: If this field is set to null you may face unexpected issues on GET endpoints.

employmentInfo.atlasStartDate

Target Start Date

date

The target start date for the employee.

employmentInfo.targetStartDate

Job Title

text

The employee's job title.

employmentInfo.jobTitle

Job Description

text

A description of the employee's job.

employmentInfo.jobDescription

Manager Email Address

email

The email address of the line manager.

employmentInfo.managerEmail

Currency Code

text

The local currency used for the employee's salary.

https://en.wikipedia.org/wiki/ISO_4217

compensationDetails.currencyCode

Gross Salary Frequency

enum

The frequency of the employee's gross salary payments.

• SemiMonthly

• Monthly

• Yearly

• Daily

• Hourly

• Weekly

compensationDetails.paymentScheduleCode

Gross Salary Amount

number

The amount of the employee's gross salary.

compensationDetails.compensationAmount

Full Time or Part Time

enum

Indicates if the employee is full-time or part-time.

• FullTime

• PartTime

employmentInfo.employmentTypeCode

Overtime

bool

Indicates if overtime is applicable for the employee.

compensationDetails.isOvertimeApplicableIndicator

Indefinite or Fixed Term employment (subject to Atlas approval)

enum

Indicates if the employment is indefinite or fixed term, subject to Atlas approval.

• Fixed

• Indefinite

employmentInfo.employmentTermCode

In case of Fixed Term Employment, state expected end date

date

The expected end date for fixed term employment.

employmentInfo.termEndDate

Probation Period in Months: following the local law or negotiated with employee?

number

The probation period in months, following local law or negotiated with the employee.

employmentInfo.probationPeriodQuantity

Probation Period

bool

is probation period applicable?

EmploymentInfo.IsProbationApplicableIndicator

Notice Period of Termination: following the local law or negotiated with employee?

number

The notice period of termination, following local law or negotiated with the employee.

offboardingInfo.employerNoticePeriodQuantity

If you want link your third party system employeeID with atlas employeeID

text

employee id.

externalEmployeeId

CustomerId header

header text

customerid header is required but there is no actual validation on the current value of this field for now.

CustomerId

Owner Id

text

Can Be (employee id, customer id, user id)

document.ownerId

Document Id

text

represent a document unique identifier

document.id

Locker ID

text

Represent a unique identifier for a logical group where documents are stored

lockerId

Category

text

Enumeration value meaning the category document was classified:

• All

• Personal

• Employment

• Benefits

• TaxDocuments

• PaySlips

category