Locations (or Pay Points) are an organisational division that can be assigned to an employee and used for reporting purposes. Historically, would be used for physical payslip distribution
Get locations
SecuritybearerAuth
Responses
200
locations - Array
400
Bad Request
401
Unauthorized - Authorization Required
422
Unprocessable Entity
default
General Error
get/locations
Request samples
- curl
- C#
- Java
- PHP
Response samples
- 200
- 400
- 401
- 422
- default
application/vnd.api+json
{- "data": [
- {
- "id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03",
- "type": "locations",
- "attributes": {
- "name": "HR",
- "addressLine1": "line 1",
- "addressLine2": "line 2",
- "addressLine3": "line 3",
- "addressLine4": "line 4",
- "country": "United Kingdom",
- "postCode": "E11 1EE"
},
}
]
}Create a new location
Create a new location
SecuritybearerAuth
Request
Request Body schema: application/vnd.api+json
new location object
object |
Responses
200
location
400
Bad Request
401
Unauthorized - Authorization Required
422
Unprocessable Entity
default
General Error
post/locations
Request samples
- Payload
- curl
- C#
- Java
- PHP
application/vnd.api+json
{- "data": {
- "type": "locations",
- "attributes": {
- "name": "HR",
- "addressLine1": "line 1",
- "addressLine2": "line 2",
- "addressLine3": "line 3",
- "addressLine4": "line 4",
- "country": "United Kingdom",
- "postCode": "E11 1EE"
}, - "relationships": [
- null
]
}
}Response samples
- 200
- 400
- 401
- 422
- default
application/vnd.api+json
{- "data": {
- "0": {
- "id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}, - "type": "locations",
- "attributes": {
- "name": "HR",
- "addressLine1": "line 1",
- "addressLine2": "line 2",
- "addressLine3": "line 3",
- "addressLine4": "line 4",
- "country": "United Kingdom",
- "postCode": "E11 1EE"
}, - "id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
}Get location by Id
SecuritybearerAuth
Request
Responses
200
location
400
Bad Request
401
Unauthorized - Authorization Required
404
Not Found
422
Unprocessable Entity
default
General Error
get/locations/{id}
Request samples
- curl
- C#
- Java
- PHP
Response samples
- 200
- 400
- 401
- 404
- 422
- default
application/vnd.api+json
{- "data": {
- "0": {
- "id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}, - "type": "locations",
- "attributes": {
- "name": "HR",
- "addressLine1": "line 1",
- "addressLine2": "line 2",
- "addressLine3": "line 3",
- "addressLine4": "line 4",
- "country": "United Kingdom",
- "postCode": "E11 1EE"
}, - "id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
}