Cintra Integrations logo
Powered by Redocly

employment one-off payments

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 Employment One-Off Payment

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-type: Provide only the amount field (e.g., bonus, allowance)
  • UnitsXRate-type: Provide 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.

Supported One-Off Payment Types

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.

SecuritybearerAuth
Request
path Parameters
employmentGuid
required
string <uuid>

Employment ID (GUID)

Example: 906264f1-2dff-4f72-a10b-59918cf738d7
Request Body schema: application/vnd.api+json

Employment One-Off Payment to be added.

Important Payment Type Constraints:

  • For Amount-type payment headings: You MUST provide the amount field (must be > 0) and MUST NOT provide units or rate fields.
  • For UnitsXRate-type payment headings: You MUST provide the units field (must be > 0), MUST NOT provide amount field. The rate field is optional.

Date Constraints:

  • If startDate and endDate are not provided, they will default to the current payslip period dates
  • If provided, endDate must not be before startDate
object
Responses
201

Employment One-Off Payment Response

post/employments/{employmentGuid}/one-off-payments
Request samples
application/vnd.api+json
{
  • "data": {
    }
}
Response samples
application/vnd.api+json
{}
➔ Next to national insurance categories