Get Role Assumed Pensionable Pay

Get

/employers/{employerId}/employees/{employeeId}/leave/{id}/role/{roleId}/assumedpensionablepay

Calculates the assumed pensionable pay for a specific employee role during a leave period.
For existing leaves (when id is provided), uses the leave's existing configuration.
For new leaves (when id is empty), calculates based on the provided leave type, pay type, and period parameters.
Only supports roles associated with LGPS schemes that allow automatic APP calculation.

Store values

Parameters

employerId string

The unique identifier of the employer

employeeId string

The unique identifier of the employee

id string

The unique identifier of the leave record (empty GUID for new leaves)

roleId string

The unique identifier of the employee role for which to calculate assumed pensionable pay

payPeriod string

The pay period (required for new leaves, ignored for existing leaves) (optional)

leaveType string

The type of leave (required for new leaves, ignored for existing leaves) (optional)

leavePayType string

The leave payment type (required for new leaves, ignored for existing leaves) (optional)

from string

The leave start date (required for new leaves, ignored for existing leaves) (optional)

Try it

OAuth Token

Api Key

Response Code

Response Body

Response Headers

The API Key you provided may not be valid.
Please check it or use the OAuth Token.

Possible Responses

200	Success	`number`	application/json
404	Not Found
400	Bad Request