Planned Payment is used to describe an expected payment for a reservation.
| Resource | Description |
|---|---|
| GET /v1/PlannedPayments/{reservationId} | Get an associated planned payments with reservationId. |
| POST /v1/PlannedPayment | Adding a planned payment to a reservation. |
| PUT /v1/PlannedPayment | Update a planned payment. |
| DELETE /v1/PlannedPayment/{id} | Removing a planned payment from a reservation. |
Get an associated planned payments with reservationId.
Request parameters
| Name | Value |
|---|---|
| reservationId | The id of the reservation |
Response
The result is a list of planned payments.
Example Response
[
{
"id": 6,
"plannedDate": "2020-05-01T00:00:00",
"reservationId": 12731,
"amount": 100.00,
"currencyCode": "EUR",
"paymentDescriptionId": 1,
"description": "test",
"isPaid": 0
}
]
Adding a planned payment to a reservation.
Request parameters
| Name | Value |
|---|---|
| Amount | The amount of a planned payment |
| CurrencyCode | The currency of a planned payment. |
| PaymentDescriptionId | The ID of a payment description |
| PlannedDate | The date of a payment description |
| ReservationId | The ID of an associated reservation |
Response
The ID of a planned payment.
Example Request
{
"Amount": 130,
"CurrencyCode": "EUR",
"PaymentDescriptionId": 1,
"PlannedDate": "2020-05-31",
"ReservationId": 12731
}
Update a reservation contract for a reservation.
Request parameters
| Name | Value |
|---|---|
| Id | The id of a planned payment |
| Amount | The amount of a planned payment |
| CurrencyCode | The currency of a planned payment. |
| PaymentDescriptionId | The ID of a payment description |
| PlannedDate | The date of a payment description |
| ReservationId | The ID of an associated reservation |
Example Request
{
"Id": 8,
"Amount": 130,
"CurrencyCode": "EUR",
"PaymentDescriptionId": 1,
"PlannedDate": "2020-05-31",
"ReservationId": 12731
}
Removing a planned payment from a reservatio.
| Name | Value |
|---|---|
| Id | The ID of a planned payment |