We’ve enhanced the Employment Agreements API to allow you to retrieve the full details of an employment agreement.
To list all employment agreements in a business:
GET /api/v2/business/{businessid}/employmentagreement
This will return the names/ids of the agreements
–
To get the details of a specific agreement:
GET /api/v2/business/{businessid}/employmentagreement/{id}
This will retrieve the full details of the agreement including the pay rate templates and the rule sets. One notable property is the payRateTemplateType
property. A value of DateOfBirth indicates that the age
values in the pay rate templates are relative to the date of birth whilst a value of Anniversary indicates that the age
values are relative to the anniversary date of the employee.
Refer to KeyPay API Reference: Specifications list for further details