Deposit List from Reservation [GET]
- Jordi Artal
Owned by Jordi Artal
GET
https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property/{propertyId}/reservation/{reservationId}/deposit
Request
| Property | Type | Required | Type parameter | Default value | Description |
|---|---|---|---|---|---|
| chainId | Integer | true | path parameter | Unique identificator of the chain. | |
| propertyId | Integer | true | path parameter | Unique identificator of the property. | |
| reservartionId | Integer | true | path parameter | Unique identificator of the reservation. |
Example request
GET https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/property/1/reservation/1/deposit
Response
The response is a list of Deposit objects or an error if it's not found.
Entity
StatusType of this DepositField Type Required Description id Integer true Unique identifier for the Deposit. name String true Name of the Deposit. company Company false Company associated to this Deposit customer Customer false Customer associated to this Deposit travelAgent TravelAgent false TravelAgent associated to this Deposit product Product true Product associated to this Deposit consumptionDate LocalDate true Date when the Deposit was created price BigDecimal true Amount of this Deposit spent BigDecimal true refund BigDecimal true remaining BigDecimal true currency Currency true Currency associated to this Deposit depositStatusType DepositStatusType true reservationRoomStaySummary ReservationRoomStaySummary false reservationSummary ReservationSummary false reservationGroup ReservationGroup false
Example response
[
{
"id": 67,
"name": "SEP00000001",
"company": null,
"customer": null,
"travelAgent": null,
"productCONModel": {
"id": 60,
"chainProductId": 14,
"code": "DEPRE",
"name": "Deposit Receipt",
"nameI18n": "Deposit Receipt",
"productType": {
"id": 4,
"code": "DEP",
"name": "Deposit",
"nameI18n": "Deposit"
}
},
"consumptionDate": "2023-11-09",
"price": 155.000000,
"spent": 0.000000,
"refund": 0.000000,
"remaining": 155.000000,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro",
"nameI18n": "Euro",
"symbol": "€",
"decimalPlaces": 2
},
"depositStatusType": {
"id": 2,
"name": "Paid",
"nameI18n": "Paid",
"code": "PAID"
},
"reservationRoomStaySummary": null,
"reservationSummary": {
"id": 1,
"reservationId": 1,
"reservationGroup": null,
"reservationGroupId": null,
"pmsLocator": "SEP00000001",
"crsLocator": null,
"otaLocator": null,
"cmLocator": null,
"holder": "Illustrée Sims, Frances",
"holderEmail": "fsimsq3@wordpress.com",
"arrival": "2023-10-29",
"departure": "2023-10-30",
"roomStay": 1,
"nights": 1,
"productAccommodation": {
"id": 692,
"chainProductId": 47,
"code": "SGL",
"name": "Single",
"nameI18n": "Single",
"productType": {
"id": 1,
"code": "ACC",
"name": "Accommodation",
"nameI18n": "Accommodation"
}
},
"adult": 1,
"junior": 0,
"child": 0,
"infant": 0,
"booker": null,
"billTo": null,
"central": null,
"company": null,
"board": {
"id": 8,
"chainBoardId": 4,
"code": "FB",
"name": "FullBoard",
"nameI18n": "FullBoard",
"serviceList": [
{
"id": 67,
"code": "BRK",
"name": "Breakfast"
},
{
"id": 71,
"code": "LUNCH",
"name": "Lunch"
},
{
"id": 72,
"code": "DINNER",
"name": "Dinner"
}
]
},
"propertyPolicy": {
"id": 12,
"code": "24H",
"name": "24 Hours 1 Night"
},
"propertySource": {
"id": 11,
"code": "FAX",
"name": "Fax"
},
"propertyChannel": {
"id": 12,
"code": "WEBM",
"name": "Booking Engine Mobile"
},
"propertySegment": {
"id": 17,
"code": "TAGE",
"name": "Travel Agent"
},
"guest": "Noémie Rice, Jose",
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro",
"nameI18n": "Euro",
"symbol": "€",
"decimalPlaces": 2
},
"room": {
"id": 1,
"code": "101",
"name": "101",
"startDate": "2023-10-29",
"endDate": null,
"roomSpaceStatusType": {
"id": 2,
"code": "DI",
"name": "Dirty",
"nameI18n": "Dirty"
},
"reservationRoomStay": null,
"roomSituationType": {
"id": 1,
"code": "EM",
"name": "Empty",
"nameI18n": "Empty"
},
"roomType": null
},
"accommodationAmount": 106.000000,
"boardAmount": 97.000000,
"serviceAmount": 30.000000,
"totalAmount": 233.000000,
"totalPaid": 388.000000,
"balance": -155.000000,
"reservationStatusType": {
"id": 5,
"code": "CO",
"name": "CheckedOut",
"nameI18n": "CheckedOut",
"colorCode": "#757575"
},
"reservationType": null,
"expiredDate": null,
"limitCreditAmount": null,
"hasCredit": true,
"creditAvailable": null
},
"reservationGroup": null
}
]