EmployeeAgreement

An employee agreement is a record linked to an employee profile that defines their employment within a business. It covers items such as what type of employee are they (full time etc), when they started work, whether they are paid a salary or not and their payroll id (important for payroll application integrations).

Data Element

Data Type

What is it

Mandatory

Id

Integer

The unique id of the record

No

EmployeeId

Integer

The unique id of the employee linked to this employee agreement

Yes

PayPoint

Integer

The unique id of the pay center which is associated with the employee agreement (eg Location/Company). May not be the same as main location in enterprise.

Yes

EmpType

Integer

The type of employee in terms of employment.

1 = Employee
2 = Contractor.

Yes

CompanyName

VarChar

The location the agreement is linked to. This is only available in Enterprise

No

Active

Boolean True/False

Whether the agreement is currently active

No

StartDate

DateTime

The start date of the agreement

Yes

Contract

Integer

The unique id record of the employment term/pay rate which is linked to this agreement

No

SalaryPayRule

Integer

Only used when the contract is salary based

No

PayrollId

VarChar

The payroll id of the employee associated with the agreement

No

PayPeriod

Integer

The pay period associated with the agreement (monthly, weekly etc). Important for Enterprise

No

HistoryId

Integer

This unique id is used to track changes to the agreement

No

Creator

Integer

The unique id of the user who created the record

No

Created

DateTime

When the record was first created

No

Modified

DateTime

When the record was last modified

No

Foreign Objects which can be linked with the Resource API

Employee - Employee
Pay Point - PayPointObject
Contract - ContractObject
Salary Pay Rule - SalaryPayRuleObject
PayPeriod - PayPeriodObject

Associated Objects

EmployeeSalaryOpUnits - Operational Unit