One-off payments are ad-hoc payments that can be assigned to an employment for a specific period. These can be amount-based (e.g., bonuses, allowances) or units-x-rate based (e.g., overtime hours)
Add a one-off payment to an employment record. One-off payments are ad-hoc payments that apply for a specific period.
Payment Types:
amount field (e.g., bonus, allowance)units field and optionally rate field (e.g., overtime hours)Important: The payment heading must be configured as a one-off payment type in the system.
The system accepts the following one-off payment types:
| Payment Type | Description |
|---|---|
| AdhocAmount | Fixed amount payment (e.g., bonus, allowance) |
| AdhocUnitTimesRate | Units multiplied by rate (e.g., overtime hours × hourly rate) |
| UnitsAtEmployeeStandardRate | Units at the employee's standard rate |
| UnitsAtPostSpecificRate | Units at a post-specific rate |
| UnitsAtSpinePointRate | Units at a spine point rate |
Note: The response may include fields (such as units and rate) that were not explicitly provided in the request. These represent the raw values stored for the payment, which will be used when the payslip is calculated.
Employment One-Off Payment to be added.
Important Payment Type Constraints:
amount field (must be > 0) and MUST NOT provide units or rate fields.units field (must be > 0), MUST NOT provide amount field. The rate field is optional.Date Constraints:
startDate nor endDate is provided, both default to the current pay period's datesstartDate is provided, endDate is the same dayendDate must not be before startDateobject |
Employment One-Off Payment Response
The employment's payroll is locked for processing, so it can't accept new payments until the lock is released. Retry once the payroll is unlocked.
General Error
{- "data": {
- "type": "employmentOneOffPayment",
- "attributes": {
- "employmentGuid": "906264f1-2dff-4f72-a10b-59918cf738d7",
- "paymentHeadingGuid": "a1234567-89ab-cdef-0123-456789abcdef",
- "amount": 1500.5,
- "startDate": "2025-01-15",
- "endDate": "2025-01-31"
}
}
}{- "data": {
- "id": "27214",
- "type": "employmentOneOffPayment",
- "attributes": {
- "employmentGuid": "906264f1-2dff-4f72-a10b-59918cf738d7",
- "paymentHeadingGuid": "a1234567-89ab-cdef-0123-456789abcdef",
- "amount": 1500.5,
- "units": 40.5831,
- "rate": 25.5009,
- "startDate": "2025-01-15T00:00:00",
- "endDate": "2025-01-31T00:00:00"
},
}
}