Deposit List from ReservationRoomStay [GET]
- Jordi Artal
Owned by Jordi Artal
GET
https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property/{propertyId}/reservationRoomStay/{reservationRoomStayId}/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. | |
| reservartionRoomStayId | Integer | true | path parameter | Unique identificator of the reservationRoomStay. |
Example request
GET https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/property/1/reservationRoomStay/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": 1,
"name": "SEP00000001/1",
"company": null,
"customer": null,
"travelAgent": null,
"productCONModel": {
"id": 61,
"chainProductId": 15,
"code": "DEP10",
"name": "Deposit 10",
"nameI18n": "Deposit 10",
"productType": {
"id": 4,
"code": "DEP",
"name": "Deposit",
"nameI18n": "Deposit"
}
},
"consumptionDate": "2023-10-29",
"price": 233.000000,
"spent": 233.000000,
"refund": 0.000000,
"remaining": 0.000000,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro",
"nameI18n": "Euro",
"symbol": "€",
"decimalPlaces": 2
},
"depositStatusType": {
"id": 4,
"name": "Consumed",
"nameI18n": "Consumed",
"code": "CONSU"
},
"reservationRoomStaySummary": {
"id": 1,
"reservationRoomStay": {
"id": 1,
"reservationStatusType": {
"id": 5,
"code": "CO",
"name": "CheckedOut",
"nameI18n": "CheckedOut",
"colorCode": "#757575"
},
"reservationSituationType": null,
"arrival": "2023-10-29",
"departure": "2023-10-30",
"arrivalTime": null,
"departureTime": null,
"quantity": 1,
"accommodation": {
"id": 692,
"name": "Single",
"code": null,
"roomType": {
"id": 2,
"chainRoomTypeId": 1,
"name": "Single",
"nameI18n": "Single",
"mainImage": "1/2/propertyroomtypeimages/87b82195-e3a6-42c5-9021-c5b3f36a3fcd.jpg",
"active": true
}
},
"room": {
"id": 1,
"code": "101",
"name": "101",
"startDate": null,
"endDate": null,
"roomSpaceStatusType": null,
"reservationRoomStay": null,
"roomSituationType": null,
"roomType": null
},
"adult": 1,
"junior": 0,
"child": 0,
"infant": 0,
"accommodationAmount": 106.000000,
"boardAmount": 97.000000,
"serviceAmount": 30.000000,
"totalAmount": 233.000000,
"productFee": {
"id": 842,
"name": "City Tax Mallorca"
},
"pmsLocator": "SEP00000001/1",
"crsLocator": null,
"otaLocator": null,
"cmLocator": null,
"remark": null,
"reservationRoomStayGuests": [
{
"id": 1,
"profileId": 1295,
"documentType": {
"id": 5,
"code": "D",
"name": "National identity document",
"nameI18n": "National identity document"
},
"documentNumber": "avvoXdSY",
"givenName": "Jose",
"surName": "Noémie",
"secondSurName": "Rice",
"genderType": {
"id": 2,
"code": "F",
"name": "Female",
"nameI18n": "Female"
},
"birthDate": "2005-11-28",
"birthCountryCode": "ES",
"birthPlace": "Toledo",
"effectiveDate": "2022-11-28",
"expireDate": "2025-11-28",
"street": "5364 Towne Circle",
"city": "Toledo",
"stateProvName": null,
"stateProvCode": "ES-CO",
"countryCode": "ES",
"postalCode": "43699",
"nationalityCountryCode": "ES",
"countryOfIssuanceCode": "ES",
"ocr": null,
"email": "dcoxfu@ovh.net",
"phoneNumber": "1-(419)445-4885",
"allowMarketing": null,
"allowThirdParty": null,
"language": null,
"registrationNumber": 1,
"reservationRoomStayGuestCustomFieldValueSet": null
}
],
"mainBoard": {
"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"
}
]
},
"reservationRoomStayDaily": [
{
"id": 1,
"date": "2023-10-29",
"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
},
"allotment": null,
"rate": {
"id": 77,
"code": "GROUPL",
"name": "Group Leisure Rate",
"rateType": {
"id": 12,
"code": "REG",
"name": "Regular/Rack"
}
},
"amountBeforeTax": 184.545454,
"amountAfterTax": 203.000000,
"amountNetAfterTax": 203.000000,
"amountNetBeforeTax": 184.545454,
"amountInvoiceAfterTax": 203.000000,
"amountInvoiceBeforeTax": 184.545454,
"accommodationAmount": 106.000000,
"accommodationAmountAfterDiscount": 106.000000,
"accommodationAmountAfterTax": 106.000000,
"accommodationAmountBeforeTax": 96.363636,
"accommodationAmountNetAfterTax": 106.000000,
"accommodationAmountNetBeforeTax": 96.363636,
"accommodationAmountInvoiceAfterTax": 106.000000,
"accommodationAmountInvoiceBeforeTax": 96.363636,
"centralAccommodationPercentageCommission": null,
"centralAccommodationAmountCommission": null,
"centralBoardPercentageCommission": null,
"centralBoardAmountCommission": null,
"companyAccommodationPercentageCommission": null,
"companyAccommodationAmountCommission": null,
"companyBoardPercentageCommission": null,
"companyBoardAmountCommission": null,
"bookerAccommodationPercentageCommission": null,
"bookerAccommodationAmountCommission": null,
"bookerBoardPercentageCommission": null,
"bookerBoardAmountCommission": null,
"billToAccommodationPercentageCommission": null,
"billToAccommodationAmountCommission": null,
"billToBoardPercentageCommission": null,
"billToBoardAmountCommission": null,
"billToAccommodationPercentageDiscount": null,
"billToAccommodationAmountDiscount": null,
"billToBoardPercentageDiscount": null,
"billToBoardAmountDiscount": null,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro",
"nameI18n": "Euro",
"symbol": "€",
"decimalPlaces": 2
},
"offer": null,
"offerAmountDiscount": null,
"offerPercentDiscount": null,
"promotion": null,
"promotionAmountDiscount": null,
"promotionPercentDiscount": 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"
}
]
},
"boardAmountAfterDiscountAdult": 97.000000,
"boardAmountAdult": 97.000000,
"boardAmountAfterTaxAdult": 97.000000,
"boardAmountBeforeTaxAdult": 88.181818,
"boardAmountNetAfterTaxAdult": 97.000000,
"boardAmountNetBeforeTaxAdult": 88.181818,
"boardAmountInvoiceAfterTaxAdult": 97.000000,
"boardAmountInvoiceBeforeTaxAdult": 88.181818,
"boardAmountAfterDiscountJunior": 66.000000,
"boardAmountJunior": 66.000000,
"boardAmountAfterTaxJunior": 66.000000,
"boardAmountBeforeTaxJunior": 60.000000,
"boardAmountNetAfterTaxJunior": 66.000000,
"boardAmountNetBeforeTaxJunior": 60.000000,
"boardAmountInvoiceAfterTaxJunior": 66.000000,
"boardAmountInvoiceBeforeTaxJunior": 60.000000,
"boardAmountAfterDiscountChild": 0.000000,
"boardAmountChild": 0.000000,
"boardAmountAfterTaxChild": 0.000000,
"boardAmountBeforeTaxChild": 0.000000,
"boardAmountNetAfterTaxChild": 0.000000,
"boardAmountNetBeforeTaxChild": 0.000000,
"boardAmountInvoiceAfterTaxChild": 0.000000,
"boardAmountInvoiceBeforeTaxChild": 0.000000,
"boardAmountAfterDiscountInfant": 0.000000,
"boardAmountInfant": 0.000000,
"boardAmountAfterTaxInfant": 0.000000,
"boardAmountBeforeTaxInfant": 0.000000,
"boardAmountNetAfterTaxInfant": 0.000000,
"boardAmountNetBeforeTaxInfant": 0.000000,
"boardAmountInvoiceAfterTaxInfant": 0.000000,
"boardAmountInvoiceBeforeTaxInfant": 0.000000,
"paymentType": {
"id": 1,
"code": "G",
"name": "Pay Guest",
"nameI18n": "Pay Guest"
},
"propertyPolicy": {
"id": 12,
"code": "24H",
"name": "24 Hours 1 Night"
},
"propertySource": {
"id": 11,
"code": "FAX",
"name": "Fax"
},
"propertySegment": {
"id": 17,
"code": "TAGE",
"name": "Travel Agent"
},
"propertyChannel": {
"id": 12,
"code": "WEBM",
"name": "Booking Engine Mobile"
},
"booker": null,
"billTo": null,
"central": null,
"company": null,
"reservationGroup": null
}
],
"reservationRoomStayServiceList": [
{
"reservationRoomStay": null,
"service": {
"id": 78,
"code": "TV",
"name": "Television"
},
"startDate": "2023-10-29",
"endDate": "2023-10-30",
"quantity": 1,
"totalAmountAfterTax": 10.000000,
"totalAmountBeforeTax": 20.000000,
"reservationRoomStayServiceDailyList": [
{
"id": 1,
"date": "2023-10-29",
"rate": null,
"amount": 10.000000,
"amountAfterDiscount": 10.000000,
"amountAfterTax": 10.000000,
"amountBeforeTax": 9.090909,
"amountNetAfterTax": 10.000000,
"amountNetBeforeTax": 9.090909,
"amountInvoiceAfterTax": 10.000000,
"amountInvoiceBeforeTax": 9.090909,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro",
"nameI18n": "Euro",
"symbol": "€",
"decimalPlaces": 2
},
"offer": null,
"offerAmountDiscount": null,
"offerPercentDiscount": null,
"promotion": null,
"promotionAmountDiscount": null,
"promotionPercentDiscount": null,
"bookerPercentageCommission": null,
"bookerAmountCommission": null,
"billToPercentageCommission": null,
"billToAmountCommission": null,
"billToPercentageDiscount": null,
"billToAmountDiscount": null,
"centralPercentageCommission": null,
"centralAmountCommission": null,
"companyPercentageCommission": null,
"companyAmountCommission": null,
"postingDate": "2023-11-28"
}
]
},
{
"reservationRoomStay": null,
"service": {
"id": 76,
"code": "AZA",
"name": "Hostess"
},
"startDate": "2023-10-29",
"endDate": "2023-10-30",
"quantity": 1,
"totalAmountAfterTax": 10.000000,
"totalAmountBeforeTax": 20.000000,
"reservationRoomStayServiceDailyList": [
{
"id": 2,
"date": "2023-10-29",
"rate": null,
"amount": 10.000000,
"amountAfterDiscount": 10.000000,
"amountAfterTax": 10.000000,
"amountBeforeTax": 9.090909,
"amountNetAfterTax": 10.000000,
"amountNetBeforeTax": 9.090909,
"amountInvoiceAfterTax": 10.000000,
"amountInvoiceBeforeTax": 9.090909,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro",
"nameI18n": "Euro",
"symbol": "€",
"decimalPlaces": 2
},
"offer": null,
"offerAmountDiscount": null,
"offerPercentDiscount": null,
"promotion": null,
"promotionAmountDiscount": null,
"promotionPercentDiscount": null,
"bookerPercentageCommission": null,
"bookerAmountCommission": null,
"billToPercentageCommission": null,
"billToAmountCommission": null,
"billToPercentageDiscount": null,
"billToAmountDiscount": null,
"centralPercentageCommission": null,
"centralAmountCommission": null,
"companyPercentageCommission": null,
"companyAmountCommission": null,
"postingDate": "2023-11-28"
}
]
},
{
"reservationRoomStay": null,
"service": {
"id": 76,
"code": "AZA",
"name": "Hostess"
},
"startDate": "2023-10-29",
"endDate": "2023-10-30",
"quantity": 1,
"totalAmountAfterTax": 10.000000,
"totalAmountBeforeTax": 20.000000,
"reservationRoomStayServiceDailyList": [
{
"id": 3,
"date": "2023-10-29",
"rate": null,
"amount": 10.000000,
"amountAfterDiscount": 10.000000,
"amountAfterTax": 10.000000,
"amountBeforeTax": 9.090909,
"amountNetAfterTax": 10.000000,
"amountNetBeforeTax": 9.090909,
"amountInvoiceAfterTax": 10.000000,
"amountInvoiceBeforeTax": 9.090909,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro",
"nameI18n": "Euro",
"symbol": "€",
"decimalPlaces": 2
},
"offer": null,
"offerAmountDiscount": null,
"offerPercentDiscount": null,
"promotion": null,
"promotionAmountDiscount": null,
"promotionPercentDiscount": null,
"bookerPercentageCommission": null,
"bookerAmountCommission": null,
"billToPercentageCommission": null,
"billToAmountCommission": null,
"billToPercentageDiscount": null,
"billToAmountDiscount": null,
"centralPercentageCommission": null,
"centralAmountCommission": null,
"companyPercentageCommission": null,
"companyAmountCommission": null,
"postingDate": "2023-11-28"
}
]
}
],
"createdDate": "2023-11-28T07:46:38.707Z",
"modifiedDate": "2023-11-28T07:48:36.882Z",
"mainBooker": null,
"mainBillTo": null,
"mainCentral": null,
"mainCompany": null,
"mainRate": null,
"mainOffer": null,
"mainPromotion": null,
"deposit": null,
"reservationType": null,
"reservationRoomStayCustomFieldValueSet": null
},
"reservationRoomStayId": 1,
"reservation": {
"id": 1,
"reservationHolder": {
"id": 1,
"profileId": null,
"documentNumber": null,
"givenName": "Frances",
"surName": "Illustrée",
"secondSurName": "Sims",
"street": null,
"city": null,
"stateProvName": null,
"stateProvCode": null,
"postalCode": null,
"countryCode": "SM",
"email": "fsimsq3@wordpress.com",
"phoneNumber": "1-(561)354-4710",
"membershipId": null,
"allowMarketing": null,
"allowThirdParty": null,
"language": null,
"documentType": null
},
"pmsLocator": "SEP00000001",
"crsLocator": null,
"otaLocator": null,
"cmLocator": null,
"accommodationAmount": null,
"boardAmount": null,
"serviceAmount": null,
"totalAmount": null,
"remark": "ReservationRoomStay remarks",
"deposit": null,
"reservationGuaranteeCardList": null,
"createdDate": "2023-11-28T07:46:38.680Z",
"modifiedDate": null,
"reservationRoomStayList": null
},
"reservationId": 1,
"reservationGroup": null,
"pmsLocator": "SEP00000001/1",
"crsLocator": null,
"otaLocator": null,
"cmLocator": null,
"holder": "Illustrée Sims, Frances",
"arrival": "2023-10-29",
"departure": "2023-10-30",
"nights": 1,
"productAccommodation": {
"id": 692,
"name": "Single",
"code": null,
"roomType": {
"id": 2,
"chainRoomTypeId": 1,
"name": "Single",
"nameI18n": "Single",
"mainImage": "1/2/propertyroomtypeimages/87b82195-e3a6-42c5-9021-c5b3f36a3fcd.jpg",
"active": true
}
},
"productAccommodationUpgrade": null,
"roomType": {
"id": 2,
"chainRoomTypeId": 1,
"name": "Single",
"nameI18n": "Single",
"mainImage": "1/2/propertyroomtypeimages/87b82195-e3a6-42c5-9021-c5b3f36a3fcd.jpg",
"active": true
},
"adult": 1,
"junior": 0,
"child": 0,
"infant": 0,
"extraBed": 0,
"extraCot": 0,
"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"
}
]
},
"guest": "Noémie Rice, Jose",
"allotment": null,
"rate": {
"id": 77,
"code": "GROUPL",
"name": "Group Leisure Rate",
"rateType": {
"id": 12,
"code": "REG",
"name": "Regular/Rack"
}
},
"offer": null,
"promotion": null,
"accommodationAmount": 106.000000,
"boardAmount": 97.000000,
"serviceAmount": 30.000000,
"totalAmount": 233.000000,
"totalPaid": 233.000000,
"balance": 0.000000,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro",
"nameI18n": "Euro",
"symbol": "€",
"decimalPlaces": 2
},
"booker": null,
"billTo": null,
"central": null,
"company": null,
"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
},
"paymentType": {
"id": 1,
"code": "G",
"name": "Pay Guest",
"nameI18n": "Pay Guest"
},
"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"
},
"reservationStatusType": {
"id": 5,
"code": "CO",
"name": "CheckedOut",
"nameI18n": "CheckedOut",
"colorCode": "#757575"
},
"reservationType": null,
"expiredDate": null,
"hasCredit": true,
"creditAvailable": null,
"customerPreference": "Balcony, Slippers, Pets, Cava"
},
"reservationSummary": null,
"reservationGroup": null
}
]