Skip to main content
GET
Get Awe

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Path Parameters

organization_id
string
required
employee_id
string
required

Query Parameters

relevant_period_end
string<date>
required

Regime-derived relevant-period-end anchor (e.g. Saturday of the qualifying week)

Response

Successful Response

Output of the AWE computation. Full precision; regimes apply 90%, prescribed caps, and HMRC rounding. NO_EARNINGS carries awe=None: a starter with no elapsed pay day, never a data defect (that raises).

outcome
enum<string>
required
Available options:
COMPUTED,
NO_EARNINGS
awe
string | null
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
method
enum<string> | null
required
Available options:
WEEKLY,
MONTHLY,
OTHER,
PATTERN_CHANGE
divisor
string | null
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
total_niable
string
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
relevant_period_start
string<date> | null
required
relevant_period_end
string<date> | null
required
included_pay_dates
IncludedPayment · object[]
required
insufficient_history
boolean
required
employed_from
string<date> | null