Payroll - Run transfer to payroll

API Url

Use it to run Transfer for Payroll webpart

POST
http://localhost:16010/ProMarkREST/web/Payroll/transfer

Permissions: user

Request headers

FieldTypeDescription
Accept-LanguageoptionalString

=en-GB Language use for localization.

X-ClientoptionalString

=Client type.

Allowed values:"Portal""Mobile""Admin"
X-RoleoptionalNumber

ProMark role (1: Employee, 2: User).

Allowed values:{12}
X-WebPart-IdoptionalNumber

Unique web-part identifier.

Parameter

FieldTypeDescription
requestObject

Main object containing the request data.

  dataObject

Object containg data to be uploaded.

    transferObject
      periodIdString

Id for the period profile that the transfer is running for

Request example:

{
"request": {
"data": {
"transfer": [
{
"periodId": "PER1"
},
{
"periodId": "PER2"
}
]
}
}
}

Error 4xx

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data (empty).

  errorCodeNumber

Error code.

  errorMessageString

Error description.