payments

Payments are all standing payments attributed to an employee. This includes the payment heading type, effective dates and values

Get all payments for employee

SecuritybearerAuth

Request

path Parameters

employeeId

required

string <guid>

Employee ID

Example: 906264f1-2dff-4f72-a10b-59918cf738d7

Responses

200

Employee payments array

401

Unauthorized - Authorization Required

404

Not Found

default

General Error

get/Payments/employee/{employeeId}

Request samples

curl
C#
Java
PHP

Response samples

200
401
404
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": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/payments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/paymentHeading",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/payments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/paymentHeading",
"data": {"type": "paymentHeadings",
"id": "69049d80-0887-fd71-2197-75605a257ce6"
}
}
}
},
"reasonForChangeRate": {"allOf": [{"$ref": "../shared/RelationGetIncludedDataModel.yaml"
}
],
"example": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/payments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/reasonForChangeRate",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/payments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/reasonForChangeRate",
"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": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/payments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/paymentHeading",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/payments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/paymentHeading",
"data": {"type": "paymentHeadings",
"id": "69049d80-0887-fd71-2197-75605a257ce6"
}
}
}
},
"reasonForChangeRate": {"allOf": [{"$ref": "../shared/RelationGetIncludedDataModel.yaml"
}
],
"example": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/payments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/reasonForChangeRate",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/payments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/reasonForChangeRate",
"data": {"type": "reasonForChangeRates",
"id": "69049d80-0887-fd71-2197-75605a257ce6"
}
}
}
}
}
}
}
]
}

Create payment

SecuritybearerAuth

Request

Request Body schema: application/vnd.api+json

Create employee payment

One of:

object

Responses

200

Employee payment

400

Bad Request

401

Unauthorized - Authorization Required

422

Unprocessable Entity

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
400
401
422
default

application/vnd.api+json

{"links": {"self": "string"
},
"data": {"0": {"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
},
"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": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/payments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/paymentHeading",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/payments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/paymentHeading",
"data": {"type": "paymentHeadings",
"id": "69049d80-0887-fd71-2197-75605a257ce6"
}
}
},
"reasonForChangeRate": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/payments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/reasonForChangeRate",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/payments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/reasonForChangeRate",
"data": {"type": "reasonForChangeRates",
"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
}
}
}
}
}

Get payment by ID

SecuritybearerAuth

Request

path Parameters

required

string <guid>

payment guid

Example: 906264f1-2dff-4f72-a10b-59918cf738d7

Responses

200

Employee payment

401

Unauthorized - Authorization Required

404

Not Found

default

General Error

get/Payments/{id}

Request samples

curl
C#
Java
PHP

Response samples

200
401
404
default

application/vnd.api+json

{"links": {"self": "string"
},
"data": {"0": {"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
},
"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": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/payments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/paymentHeading",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/payments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/paymentHeading",
"data": {"type": "paymentHeadings",
"id": "69049d80-0887-fd71-2197-75605a257ce6"
}
}
},
"reasonForChangeRate": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/payments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/reasonForChangeRate",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/payments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/reasonForChangeRate",
"data": {"type": "reasonForChangeRates",
"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
}
}
}
}
}

Delete payment

SecuritybearerAuth

Request

path Parameters

required

string <guid>

payment guid

Example: 906264f1-2dff-4f72-a10b-59918cf738d7

Responses

204

400

Bad Request

401

Unauthorized - Authorization Required

404

Not Found

422

Unprocessable Entity

default

General Error

delete/Payments/{id}

Request samples

curl
C#
Java
PHP

Response samples

400
401
404
422
default

application/vnd.api+json

{"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/payments"
},
"errors": [{"id": "de4e1bd5-9223-435a-b56d-1b0190a12313",
"status": 400,
"title": "Unable authenticate client",
"detail": "No further detail is available"
}
]
}

Update an existing payment

Update an existing payment by ID (partial update)

SecuritybearerAuth

Request

path Parameters

required

string <guid>

payment guid

Example: 906264f1-2dff-4f72-a10b-59918cf738d7

Request Body schema: application/vnd.api+json

Payment object that needs to be updated

One of:

object

Responses

200

Employee payment

400

Bad Request

401

Unauthorized - Authorization Required

404

Not Found

422

Unprocessable Entity

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

application/vnd.api+json

{"links": {"self": "string"
},
"data": {"0": {"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
},
"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": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/payments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/paymentHeading",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/payments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/paymentHeading",
"data": {"type": "paymentHeadings",
"id": "69049d80-0887-fd71-2197-75605a257ce6"
}
}
},
"reasonForChangeRate": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/payments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/reasonForChangeRate",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/payments/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/reasonForChangeRate",
"data": {"type": "reasonForChangeRates",
"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
}
}
}
}
}

➔ Next to payment headings