Skip to main content
POST
Take Over Absence Calculation

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Path Parameters

organization_id
string
required
employee_id
string
required
absence_id
string
required

Response

Successful Response

One edition, as stored. created_at is the edition's transaction time.

absence_id
string
required
content
GBMaternityAbsence · object
required

GB maternity content payload. ewc anchors the qualifying-week and MPP derivations, so it must be the SUNDAY the expected week of childbirth starts on (HMRC weeks run Sunday to Saturday); rejecting anything else is correct-by-policy rather than silently normalising a caller bug.

created_at
string<date-time>
required
employee_id
string
required
end_date
string<date>
required

Last day of leave (inclusive); return to work is the next day

start_date
string<date>
required

First day of leave (inclusive)

valuation
enum<string>
required

Who calculates the absence's pay. ENGINE: this service pays the statutory, keeping-in-touch and occupational top-up lines. CALLER: the partner pays it, and the engine writes nothing more for it. Every absence starts ENGINE and becomes CALLER for good after the take-over action, or once an approved positive-pay payslip covers a day of it; the next write to the absence then stores CALLER. A read reports the effective value; the history reports what each edition stored.

Available options:
ENGINE,
CALLER
country_code
string
default:GB
Allowed value: "GB"
external_ref
string | null

AMS correlation reference

is_cancelled
boolean
default:false