GetPermanentPayDetails


Description:

Request employees permanent pay details for given Company Id, EmployeeId and Pay deduction type that the requester is authorized to view.


Request:

https://qa01-api-gateway.moorepay.co.uk/workers/v1/Worker/GetPermanentPayDetails/{companyId}/{employeeId}/{payDedType}[?employeeId][&hrEmployeeId]


Request parameters:

Name

In

Required

Type

Description

companyId

template

true

string

 key string[2]

payDedType

template

true

string

 key string[2]

employeeId

query

false

string

 key string[6]

hrEmployeeId

query

false

string

HR Employee Id



Request headers:

Name

Required

Type

Description

Authorization

Yes

string

access token


Response example:


Response: 200 OK

[{
 "companyId": "string",
 "employeeId": "string",
 "hrEmployeeId": "string",
"employeePayDetails": [
{
 "payDeductionCode": "string",
 "amount": "string"
}],
"employeePaymentEffectiveDates": [
{
 "payOrDeductionCode": "string",
 "startDate": "string",
 "periodAmount": "string",
 "annualSalary": "string",
 "basicHours": "string"
}],
"employeePayExtensions": [
{
 "payOrDeductionCode": "string",
 "bankSortCode": "string",
 "bankAccountNumber": "string",
 "buildingSocietyRollNumber": "string",
 "accountReference": "string",
 "bacsId": "string"
}]
}]


Response: 400 Bad Request

Bad Request


Response: 401 Unauthorized

Unauthorized


Response: 404 Not Found

Not Found


Response: 405 Method Not Allowed

Method Not Allowed


Response: 500 Internal Server Error

Internal Server Error

Created with the Personal Edition of HelpNDoc: Free iPhone documentation generator