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 ElementData TypeWhat is itMandatory
IdIntegerThe unique id of the recordNo
EmployeeIdIntegerThe unique id of the employee linked to this employee agreementYes
PayPointIntegerThe pay center which is associated with the employee agreement (eg Weekly, Monday to Friday, Monthly)Yes
EmpTypeIntegerThe type of employee in terms of employment.

1 = Employee
2 = Contractor.
CompanyNameVarCharThe location the agreement is linked to. This is only available in EnterpriseNo
ActiveBoolean True/FalseWhether the agreement is currently activeNo
StartDateDateTimeThe start date of the agreementYes
ContractIntegerThe unique id record of the employment term/pay rate which is linked to this agreementNo
SalaryPayRuleIntegerOnly used when the contract is salary basedNo
PayrollIdVarCharThe payroll id of the employee associated with the agreementNo
PayPeriodIntegerThe pay period associated with the agreement (monthly, weekly etc). Important for EnterpriseNo
HistoryIdIntegerThis unique id is used to track changes to the agreementNo
CreatorIntegerThe unique id of the user who created the recordNo
CreatedDateTimeWhen the record was first createdNo
ModifiedDateTimeWhen the record was last modifiedNo

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