Assigns business access to a name/email.
POST https://apimy.yourpayroll.io/api/v2/business/{businessId}/access
Parameter name | Value | Description | Additional |
---|---|---|---|
businessId | string | Required |
The request body takes a complete CreateBusinessAccessModel resource, containing the following writable properties:
{
"accessType": "string",
"email": "string",
"employeeGroups": [
{
"employeeGroupId": "int32",
"permissions": "string"
}
],
"kioskAccess": {
"accessType": "string",
"kiosks": [
"int32"
],
"permissions": "string"
},
"locationAccess": [
{
"filterType": "string",
"locationIds": [
"int32"
],
"permissions": "string"
}
],
"mergeExistingAccess": "boolean",
"name": "string",
"payrollAccess": {
"approveElectronicPayrollLodgement": "boolean",
"payRunApprovalAccess": "string",
"payRunCreationAccess": "string",
"selectedPaySchedulesForPayRunApproval": [
"int32"
],
"selectedPaySchedulesForPayRunCreation": [
"int32"
],
"userBusinessRestrictionCount": "int32"
},
"reports": {
"accessType": "string",
"noReportingRestriction": "boolean",
"specificReports": "string"
},
"suppressNotificationEmails": "boolean"
}
Name | Type | Description |
---|---|---|
accessType | string |
RelatedUserType
Possible values are:
|
string | String | |
employeeGroups[] | array | |
employeeGroups[].employeeGroupId | int32 | Int32 |
employeeGroups[].permissions | string |
UserPermission
Possible values are:
|
kioskAccess | object | KioskAccessModel |
kioskAccess.accessType | string |
KioskAccessType
Possible values are:
|
kioskAccess.kiosks[] | array of int32 | |
kioskAccess.permissions | string |
UserPermission
Possible values are:
|
locationAccess[] | array | |
locationAccess[].filterType | string |
LocationRestrictionFilterTypeEnum
Possible values are:
|
locationAccess[].locationIds[] | array of int32 | |
locationAccess[].permissions | string |
UserPermission
Possible values are:
|
mergeExistingAccess | boolean | Boolean |
name | string | String |
payrollAccess | object | PayrollAccessModel |
payrollAccess.approveElectronicPayrollLodgement | boolean | Boolean |
payrollAccess.payRunApprovalAccess | string |
Nullable Possible values are:
|
payrollAccess.payRunCreationAccess | string |
Nullable Possible values are:
|
payrollAccess.selectedPaySchedulesForPayRunApproval[] | array of int32 | |
payrollAccess.selectedPaySchedulesForPayRunCreation[] | array of int32 | |
payrollAccess.userBusinessRestrictionCount | int32 | Int32 |
reports | object | ReportAccessModel |
reports.accessType | string |
ReportAccessType
Possible values are:
|
reports.noReportingRestriction | boolean | Boolean |
reports.specificReports | string |
Comma separated list of ReportEnum. Possible values are:
|
suppressNotificationEmails | boolean | Boolean |
The following HTTP status codes may be returned, optionally with a response resource.
Status code | Description | Resource |
---|---|---|
200 | OK OK |