entitledToRefund

Synopsis Whether the employee is entitled to a refund after they've opted out.
Where used

/accounts/.../opt-outs response

The possible values for this property are:

N – We have confirmed the employee is not entitled to a refund.
M – We are still assessing and calculating the refund entitlement.
Y – We have confirmed the employee is entitled to a refund.

 

Data type

String
Constraints/format

"N"
"M"
"Y"
Example

...
"entitledToRefund": "Y",
...
See also

employeeRefund

employerRefund

refundStatus