Payments are all standing payments attributed to an employee. This includes the payment heading type, effective dates and values
Create payment
Create payment
SecuritybearerAuth
Request
Request Body schema: application/vnd.api+json
Create employee payment
One of:
object |
Responses
200
Employee payment
default
General Error
post/Payments
Request samples
- Payload
- curl
- C#
- Java
- PHP
application/vnd.api+json
{- "data": {
- "type": "employeePaymentStanding",
- "attributes": {
- "effectiveFromDate": "2021-11-17",
- "effectiveToDate": "2022-11-17",
- "periodicity": "Monthly",
- "amount": 25000.21
}, - "relationships": {
- "paymentHeading": {
- "data": {
- "id": "e6eca788-01ec-41b1-a7ca-65e9bac13ca3",
- "type": "paymentHeadings"
}
}, - "employment": {
- "data": {
- "id": "9ee83f76-67b6-47f8-b6e8-94f0a14ab840",
- "type": "employments"
}
}
}
}
}Response samples
- 200
- default
application/vnd.api+json
{- "links": {
- "self": "string"
}, - "data": {
- "id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03",
- "type": "employeePaymentStanding",
- "attributes": {
- "effectiveFromDate": "2021-11-17",
- "effectiveToDate": "2022-11-17",
- "periodicity": "Monthly",
- "amount": 25000.21
}, - "relationships": {
- "paymentHeading": {
- "links": {
- "data": {
- "type": "paymentHeadings",
- "id": "69049d80-0887-fd71-2197-75605a257ce6"
}
}
}, - "reasonForChangeRate": {
- "links": {
- "data": {
- "type": "reasonForChangeRates",
- "id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
}
}
}
}
}Get payment by ID
Get payment by ID
SecuritybearerAuth
Request
Responses
200
Employee payment
default
General Error
get/Payments/{id}
Request samples
- curl
- C#
- Java
- PHP
Response samples
- 200
- default
application/vnd.api+json
{- "links": {
- "self": "string"
}, - "data": {
- "id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03",
- "type": "employeePaymentStanding",
- "attributes": {
- "effectiveFromDate": "2021-11-17",
- "effectiveToDate": "2022-11-17",
- "periodicity": "Monthly",
- "amount": 25000.21
}, - "relationships": {
- "paymentHeading": {
- "links": {
- "data": {
- "type": "paymentHeadings",
- "id": "69049d80-0887-fd71-2197-75605a257ce6"
}
}
}, - "reasonForChangeRate": {
- "links": {
- "data": {
- "type": "reasonForChangeRates",
- "id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
}
}
}
}
}delete/Payments/{id}
Request samples
- curl
- C#
- Java
- PHP
Response samples
- default
application/vnd.api+json
{- "links": {
- "self": "string"
}, - "errors": [
- {
- "id": "de4e1bd5-9223-435a-b56d-1b0190a12313",
- "status": 401,
- "title": "Unable authenticate client",
- "detail": "No further detail is available"
}
]
}Update an existing payment
Update an existing payment by ID (partial update)
SecuritybearerAuth
Request
Responses
200
Employee payment
default
General Error
patch/Payments/{id}
Request samples
- Payload
- curl
- C#
- Java
- PHP
application/vnd.api+json
{- "data": {
- "type": "employeePaymentStanding",
- "attributes": {
- "effectiveFromDate": "2021-11-17",
- "effectiveToDate": "2022-11-17",
- "periodicity": "Monthly",
- "amount": 25000.21
}, - "relationships": {
- "paymentHeading": {
- "data": {
- "id": "e6eca788-01ec-41b1-a7ca-65e9bac13ca3",
- "type": "paymentHeadings"
}
}, - "employment": {
- "data": {
- "id": "9ee83f76-67b6-47f8-b6e8-94f0a14ab840",
- "type": "employments"
}
}
}, - "id": "906264f1-2dff-4f72-a10b-59918cf738d7"
}
}Response samples
- 200
- default
application/vnd.api+json
{- "links": {
- "self": "string"
}, - "data": {
- "id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03",
- "type": "employeePaymentStanding",
- "attributes": {
- "effectiveFromDate": "2021-11-17",
- "effectiveToDate": "2022-11-17",
- "periodicity": "Monthly",
- "amount": 25000.21
}, - "relationships": {
- "paymentHeading": {
- "links": {
- "data": {
- "type": "paymentHeadings",
- "id": "69049d80-0887-fd71-2197-75605a257ce6"
}
}
}, - "reasonForChangeRate": {
- "links": {
- "data": {
- "type": "reasonForChangeRates",
- "id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
}
}
}
}
}Get all payments for employee
Get all payments for employee
SecuritybearerAuth
Request
Responses
200
Employee payments array
default
General Error
get/Payments/employee/{employeeId}
Request samples
- curl
- C#
- Java
- PHP
Response samples
- 200
- default
application/vnd.api+json
{- "links": {
- "self": "string"
}, - "data": [
- {
- "type": "employeePaymentStanding",
- "attributes": {
- "effectiveFromDate": "2021-11-17",
- "periodicity": "Monthly",
- "amount": 25000
}, - "id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03",
- "relationships": {
- "type": "object",
- "properties": {
- "paymentHeading": {
- "allOf": [
- {
- "$ref": "../shared/RelationGetIncludedDataModel.yaml"
}
], - "example": {
- "links": {
- "data": {
- "type": "paymentHeadings",
- "id": "69049d80-0887-fd71-2197-75605a257ce6"
}
}
}
}, - "reasonForChangeRate": {
- "allOf": [
- {
- "$ref": "../shared/RelationGetIncludedDataModel.yaml"
}
], - "example": {
- "links": {
- "data": {
- "type": "reasonForChangeRates",
- "id": "69049d80-0887-fd71-2197-75605a257ce6"
}
}
}
}
}
}
}, - {
- "type": "employeePaymentStanding",
- "attributes": {
- "effectiveFromDate": "2021-11-17",
- "units": 1,
- "rate": 50
}, - "id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03",
- "relationships": {
- "type": "object",
- "properties": {
- "paymentHeading": {
- "allOf": [
- {
- "$ref": "../shared/RelationGetIncludedDataModel.yaml"
}
], - "example": {
- "links": {
- "data": {
- "type": "paymentHeadings",
- "id": "69049d80-0887-fd71-2197-75605a257ce6"
}
}
}
}, - "reasonForChangeRate": {
- "allOf": [
- {
- "$ref": "../shared/RelationGetIncludedDataModel.yaml"
}
], - "example": {
- "links": {
- "data": {
- "type": "reasonForChangeRates",
- "id": "69049d80-0887-fd71-2197-75605a257ce6"
}
}
}
}
}
}
}
]
}