Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Operation

Get a list of Proforma of all the ReservationRoomStay in a Reservation.

Rw ui textbox macro
typewarning

Only accessible with permission of pms.integration.reservation


Style
table {
width: 100%;
}
body.page-gadget {
padding-top: 20px;
}
.separator{
margin: 5px 0;
}



Div
style background-color: green; color: white; display: inline-block; padding: 5px; border-radius: 3px;

GET



Div
stylebackground-color: #0a2b1d; padding: 10px 1em; display: inline-block; color: white; border-radius: 3px;

https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property/{propertyId}/reservation/{reservationId}/proforma



Request

PropertyTypeRequiredType parameterDefault valueDescription
chainIdIntegertruepath parameter
Unique identificator of the chain.
propertyIdIntegertruepath parameter
Unique identificator of the property.
reservartionIdIntegertruepath parameter
Unique identificator of the reservation.


Example request

Code Block
languagepowershell
themeDJango
GET https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/property/1/reservation/1/proforma



Response

The response is a list of Proforma objects or an error if it's not found.

Entity

Insert excerpt
Proforma
Proforma
nopaneltrue


Example response

Code Block
themeDJango
[{
	"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,
	 			"code":"JS",
				"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,
	 	 			"code":"TAX10",
					"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,
	 	 			"code":"CM",
					"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,
	 	 			"code":"DS",
					"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,
 	 			"code":"CTB",
				"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,
 	 			"code":"TV",
				"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,
	 	 			"code":"TAX21",
					"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,
 	 			"code":"HST",
				"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,
 	 			"code":"TAX21",
					"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
}]