api.reason

Synopsis The reason that the admin account is not supported by the Payroll Integration API.
Where used

/accounts response

A readable English explanation for an admin account not being supported by the Payroll Integration API. The explanations that can be returned are:

  • “This account is not currently supported through the Payroll Integration API as it uses Contractual Enrolment.”
  • “This account is not currently supported through the Payroll Integration API as it has either an Employee Accident Cover or Employee Life Cover component.”
  • “This account is not currently supported through the Payroll Integration API as it is using Assessment.”
  • “This account is not currently supported through the Payroll Integration API as it is an EasyBuild product.”

Your software must not depend on these specific values being returned though. You should use the flags that are provided in the /accounts response instead; these are listed below.

This field will only be present if isSupported is false.

Data type

String
Constraints/format

maxLength: 250

The reason will be an English sentence, including trailing full stop.
Example

"api": {
"isSupported": false,
"reason": "This account is not currently supported through the Payroll Integration API as it uses Contractual Enrolment."
},
See also

api.isSupported

hasContractualEnrolment

hasEmployeeAccidentOrLifeCover

isUsingAssessment