Proforma List from ReservationRoomStay [GET]
- David Garcerán
- Jordi Artal
- Javier Sanchez
Owned by David Garcerán
GET
https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property/{propertyId}/reservationRoomStay/{reservationRoomStayId}/proforma
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/proforma
Response
The response is a list of Proforma objects or an error if it's not found.
Entity
Field Type Required Description customer Customer true Customer related to this Proforma. name String true Name of the customer. taxId String false TaxId if the customer is a company. street String true Street from the address of the customer. city String true City of the customer. stateProvName String false Name of the State/Province of the customer. stateProvCode String false State/Province of the customer. ISO 3166-2 municipalityName String false Municipality name. municipalityCode String false Municipality code. postalCode String true Postal code of the customer. countryCode String true Country of the customer. ISO 3166-1 alpha-2 remark String false channel Channel true Channel related to this Proforma. source Source true Source related to this Proforma. segment Segment true Segment related to this Proforma. businessDate LocalDate false proformaProductList List of ProformaProduct. false The products associated to this Proforma. nonTaxable Boolean true If is nonTaxable, taxes can not be applied. total BigDecimal false Total amount. paid BigDecimal false Paid amount. balance BigDecimal false Total minus paid.
Example response
[{
"customer": {
"id": 416,
"name": "Anne Lóng Alvarez"
},
"name": "Anne Lóng Alvarez",
"taxId": null,
"street": "296 Ridge Oak Alley",
"city": "Tyler",
"stateProvName": null,
"stateProvCode": null,
"postalCode": "75710",
"countryCode": "ES",
"remark": null,
"channel": {
"id": 77,
"code": "WEBM",
"name": "Booking Engine Mobile"
},
"source": {
"id": 62,
"code": "EMA",
"name": "Email"
},
"segment": {
"id": 167,
"code": "FAM",
"name": "Family"
},
"businessDate": null,
"proformaProductList": [{
"postingDate": "2019-06-28",
"quantity": 1,
"product": {
"id": 107,
"name": "Junior Suite",
"productType": {
"id": 1,
"code": "ACC",
"name": "Accommodation"
}
},
"name": "Junior Suite",
"amountAfterTax": 308.61,
"amountBeforeTax": null,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro"
},
"amountTax": null,
"amountDiscount": null,
"amountCommission": null,
"rate": {
"id": 2,
"code": "BB",
"name": "Bed And Breakfast"
},
"offer": {
"id": 1,
"code": "NR",
"name": "Non Refundable"
},
"offerAmountDiscount": 0,
"offerPercentDiscount": 10,
"promotion": null,
"promotionAmountDiscount": null,
"promotionPercentDiscount": null,
"channel": {
"id": 77,
"code": "WEBM",
"name": "Booking Engine Mobile"
},
"source": {
"id": 62,
"code": "EMA",
"name": "Email"
},
"segment": {
"id": 167,
"code": "FAM",
"name": "Family"
},
"remark": null,
"proformaProductTaxList": [{
"quantity": 1,
"product": {
"id": 782,
"name": "Tax 10%",
"productType": {
"id": 8,
"code": "TAX",
"name": "Tax"
}
},
"name": "Tax 10%",
"price": 28.055455,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro"
},
"amount": null,
"percentage": 10
}],
"proformaProductCommissionList": [{
"company": {
"id": 159,
"name": "Ctrip"
},
"quantity": 1,
"product": {
"id": 812,
"name": "Commission",
"productType": {
"id": 6,
"code": "COM",
"name": "Commission"
}
},
"name": "Commission",
"price": 64.8081,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro"
},
"amount": null,
"percentage": 21
}],
"proformaProductDiscountList": [{
"company": {
"id": 107,
"name": "96Dabfeed"
},
"quantity": 1,
"product": {
"id": 827,
"name": "Discount",
"productType": {
"id": 7,
"code": "DIS",
"name": "Discount"
}
},
"name": "Discount",
"price": 30.861,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro"
},
"amount": null,
"percentage": 10
}]
},
{
"postingDate": "2019-06-28",
"quantity": 2,
"product": {
"id": 737,
"name": "City Tax Barcelona",
"productType": {
"id": 9,
"code": "FEE",
"name": "Fee"
}
},
"name": "City Tax Barcelona",
"amountAfterTax": 2.7,
"amountBeforeTax": null,
"currency": null,
"amountTax": null,
"amountDiscount": null,
"amountCommission": null,
"rate": {
"id": 2,
"code": "BB",
"name": "Bed And Breakfast"
},
"offer": {
"id": 1,
"code": "NR",
"name": "Non Refundable"
},
"offerAmountDiscount": 0,
"offerPercentDiscount": 10,
"promotion": null,
"promotionAmountDiscount": null,
"promotionPercentDiscount": null,
"channel": {
"id": 77,
"code": "WEBM",
"name": "Booking Engine Mobile"
},
"source": {
"id": 62,
"code": "EMA",
"name": "Email"
},
"segment": {
"id": 167,
"code": "FAM",
"name": "Family"
},
"remark": null,
"proformaProductTaxList": null,
"proformaProductCommissionList": null,
"proformaProductDiscountList": null
},
{
"postingDate": "2019-06-28",
"quantity": 1,
"product": {
"id": 392,
"name": "Television",
"productType": {
"id": 2,
"code": "SER",
"name": "Service"
}
},
"name": "Television",
"amountAfterTax": 10,
"amountBeforeTax": null,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro"
},
"amountTax": null,
"amountDiscount": null,
"amountCommission": null,
"rate": null,
"offer": null,
"offerAmountDiscount": null,
"offerPercentDiscount": null,
"promotion": null,
"promotionAmountDiscount": null,
"promotionPercentDiscount": null,
"channel": {
"id": 77,
"code": "WEBM",
"name": "Booking Engine Mobile"
},
"source": {
"id": 62,
"code": "EMA",
"name": "Email"
},
"segment": {
"id": 167,
"code": "FAM",
"name": "Family"
},
"remark": null,
"proformaProductTaxList": [{
"quantity": 1,
"product": {
"id": 797,
"name": "Tax 21%",
"productType": {
"id": 8,
"code": "TAX",
"name": "Tax"
}
},
"name": "Tax 21%",
"price": 1.735537,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro"
},
"amount": null,
"percentage": 21
}],
"proformaProductCommissionList": null,
"proformaProductDiscountList": null
},
{
"postingDate": "2019-06-28",
"quantity": 1,
"product": {
"id": 362,
"name": "Hostess",
"productType": {
"id": 2,
"code": "SER",
"name": "Service"
}
},
"name": "Hostess",
"amountAfterTax": 10,
"amountBeforeTax": null,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro"
},
"amountTax": null,
"amountDiscount": null,
"amountCommission": null,
"rate": null,
"offer": null,
"offerAmountDiscount": null,
"offerPercentDiscount": null,
"promotion": null,
"promotionAmountDiscount": null,
"promotionPercentDiscount": null,
"channel": {
"id": 77,
"code": "WEBM",
"name": "Booking Engine Mobile"
},
"source": {
"id": 62,
"code": "EMA",
"name": "Email"
},
"segment": {
"id": 167,
"code": "FAM",
"name": "Family"
},
"remark": null,
"proformaProductTaxList": [{
"quantity": 1,
"product": {
"id": 797,
"name": "Tax 21%",
"productType": {
"id": 8,
"code": "TAX",
"name": "Tax"
}
},
"name": "Tax 21%",
"price": 1.735537,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro"
},
"amount": null,
"percentage": 21
}],
"proformaProductCommissionList": null,
"proformaProductDiscountList": null
}
],
"totalAmountAfterTax": null,
"totalAmountBeforeTax": null,
"totalAmountTax": null,
"totalAmountDiscount": null,
"totalAmountCommission": null,
"nonTaxable": null,
"total": 331.31,
"paid": 0,
"balance": 331.31
}]