Versions Compared

Key

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

Operation

Get a list of Proforma from 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/api/{version}/chain/{chainId}/property/{propertyId}/reservation/{reservationId}/proforma



Request

PropertyTypeRequiredDefault valueDescription
chainIdStringtrue
Unique identificator of the chain.
propertyIdIntegertrue
Unique identificator of the property.
reservartionIdIntegertrue
Unique identificator of the reservartion.


Example request

Code Block
languagepowershell
themeDJango
GET https://prod.ulysescloud.com/api/v1/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",
	"sequencestateProvName": null,
	"stateProv": null,
	"postalCode": "75710",
	"country": {
		"id": 18,
		"code": "BGD",
		"propertyRegisteredCompany"name": "BANGLADESH"
	},
	"remark": null,
	"channel": {
		"id": 77,
		"code": "WEBM",
		"name": "Booking Engine Mobile"
	},
	"source": {
		"id": 62,
		"code": "EMA",
	"profile	"name": "Email"
	},
	"segment": {
		"id": 167,
		"code": "FAM",
		"name": "Family"
	},
	"businessDate": 347null,
	"proformaProductList": [{
			"createdDatepostingDate": "2019-07-22T09:56:50.177Z",
		"modifiedDate": "2019-07-22T09:03:57.677Z",
		"createdUser06-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,
			"modifiedUser"offerPercentDiscount": 10,
			"promotion": 13null,
			"chainpromotionAmountDiscount": null,
			"profileTypepromotionPercentDiscount": null,
			"channel": {
				"id": 77,
				"code": "WEBM",
				"name": "Booking Engine Mobile"
			},
			"source": {
				"id": "Travelbook.ph",
		"taxId": "01fb2376-97a3-428b-84a0-cecfdd2899ab",
		"remark": "Company Agency",
		"primaryPhoneNumber": "1-(510)423-2328",
		"primaryEmail": "dadams9x@umn.edu",
		"profileDocumentList": [],
		"profileAddressList": [{
			"id": 347,
			"createdDate": "2019-07-22T09:56:50.177Z",
			"createdUser": 0,
			"primary": true,
			"communicationLocationType": null,
			"street": "21 Main Point",
			"city": "Oakland",
			"stateProvName": "California",
			"postalCode": "94627",
			"country": null,
			"remark": "Address Remark"
		}],
		"profileEmailList": null,
		"profilePhoneList": null,
		"profileCommentList": null,
		"profileCompanyList": null,
		"profileCustomerList": null,
		"profileTaxAddressList": null,
		"profileCustomerCustomFieldValueSet": null,
		"profileCompanyCustomFieldValueSet": null,
		"profileChainCustomerPreferenceSet": null,
		"profilePropertyCustomerPreferenceSet": null,
		"profileTagList": null,
		"rateProfileSet": null,
		"profileAccountReceivableSet": null,
		"propertyProfileCommissionSet62,
				"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,
		"propertyProfileDiscountSet	"rate": {
				"id": null2,
				"propertyIntegrationAccountingProfileMapSetcode": null"BB",
				"iataname": "I01fb2376-97a3-428b-84a0-cecfdd2899abBed And Breakfast"
			},
			"nameoffer": "Travelbook.ph",
	"taxId{
				"id": 1,
				"code": "01fb2376-97a3-428b-84a0-cecfdd2899abNR",
				"streetname": "21 Main Point"Non Refundable"
			},
			"offerAmountDiscount": 0,
			"cityofferPercentDiscount": "Oakland"10,
			"promotion": null,
			"stateProvNamepromotionAmountDiscount": null,
			"stateProvpromotionPercentDiscount": null,
			"postalCodechannel": {
				"94627id": 77,
				"countrycode": null"WEBM",
				"remarkname": null "Booking Engine Mobile"
			},
			"propertyChannelsource": {
				"id": 62,
				"code": "EMA",
				"name": "Email"
			},
			"createdDatesegment": {
				"id": 167,
"2019-07-22T09:56:43.077Z"				"code": "FAM",
				"name": "Family"
			},
			"createdUserremark": 0null,
			"propertyproformaProductTaxList": null,
			"chainChannelproformaProductCommissionList": {null,
			"idproformaProductDiscountList": 5null
		},
		{
			"createdDatepostingDate": "2019-07-22T09:56:43.077Z",
			"createdUser": 006-28",
			"quantity": 1,
			"product": {
				"id": 392,
				"name": "Television",
				"productType": {
					"id": 2,
					"code": "SER",
					"name": "WEB"Service"
				}
			},
			"name": "Television",
			"amountAfterTax": 10,
			"amountBeforeTax": null,
			"currency": {
"Booking Engine				"id": 1,
				"code": "EUR",
				"nameI18nIdname": 2546"Euro"
			},
			"nameI18namountTax": null,
"Booking Engine"			"amountDiscount": null,
			"amountCommission": null,
			"descriptionI18nIdrate": 2547null,
			"colorCodeoffer": null,
			"#FDD835offerAmountDiscount": null,
			"propertyChannelSetofferPercentDiscount": null,
		}	"promotion": null,
			"reservationRoomStayDailySetpromotionAmountDiscount": null,
			"propertyPreferenceSetpromotionPercentDiscount": null,
			"channel": {
				"id": 77,
				"code": "WEBM",
				"activename": true
	"Booking Engine Mobile"
			},
			"propertySourcesource": {
				"id": 62,
				"code": "EMA",
				"name": 17"Email"
			},
			"createdDatesegment": {
"2019-07-22T09:56:42.327Z				"id": 167,
				"code": "FAM",
				"createdUsername": 0 "Family"
			},
			"propertyremark": null,
			"chainSourceproformaProductTaxList": [{
				"idquantity": 21,
				"createdDateproduct": "2019-07-22T09:56:42.327Z",
			"createdUser": 0{
					"id": 797,
					"name": "Tax 21%",
					"productType": {
						"id": 8,
						"code": "COM"TAX",
						"name": "Tax"
					}
				},
				"name": "CompanyTax 21%",
				"nameI18nIdprice": 24941.735537,
				"nameI18ncurrency": {
					"Companyid": 1,
					"descriptionI18nIdcode": 2495"EUR",
					"colorCodename": "#000000"Euro"
				},
				"propertySourceSetamount": null,
				"percentage": 21
			}],
			"activeproformaProductCommissionList": truenull,
			"reservationRoomStayDailySetproformaProductDiscountList": null
		},
		{
			"postingDate": "2019-06-28",
			"quantity": 1,
			"product": {
				"id": 362,
				"name": "Hostess",
				"productType": {
					"id": 2,
		"propertyPreferenceSet": null
	},
	"propertySegment			"code": "SER",
					"name": "Service"
				}
			},
			"name": "Hostess",
			"amountAfterTax": 10,
			"amountBeforeTax": null,
			"currency": {
				"id": 1,
				"code": "EUR",
				"name": 47"Euro"
			},
			"createdDateamountTax": null,
"2019-07-22T09:56:42.627Z"			"amountDiscount": null,
			"amountCommission": null,
			"rate": null,
			"modifiedDateoffer": null,
"2019-07-22T07:56:42.630Z",
		"createdUser": 0,
		"property			"offerAmountDiscount": null,
			"offerPercentDiscount": null,
			"promotion": null,
			"promotionAmountDiscount": null,
			"promotionPercentDiscount": null,
			"chainSegmentchannel": {
				"id": 77,
				"code": "WEBM": 4,
,
				"name": "Booking Engine Mobile"
			},
			"source": {
				"createdDateid": "2019-07-22T09:56:42.610Z"62,
				"code": "EMA",
				"name": "Email"
			},
			"createdUser"segment": {
				"id": 0167,
				"code": "CONGFAM",
				"name": "Family"
			},
			"remark": "Congress",
null,
			"proformaProductTaxList": [{
				"quantity": 1,
				"nameI18nIdproduct": {
					"id": 2512797,
					"nameI18nname": "CongressTax 21%",
					"productType": {
						"descriptionI18nIdid": 25138,
						"colorCodecode": "#1E88E5TAX",
						"propertySegmentSetname": null
 "Tax"
					}
				},
		"reservationRoomStayDailySet": null		"name": "Tax 21%",
				"price": 1.735537,
				"currency": {
					"id": 1,
					"code": "EUR",
					"name": "Euro"
				},
				"propertyPreferenceSetamount": null,
				"activepercentage": true21
			}],
			"businessDateproformaProductCommissionList": null,
			"proformaProductSetproformaProductDiscountList": null
		}
	],
	"totalAmountAfterTax": null,
	"totalAmountBeforeTax": null,
	"totalAmountTax": null,
	"totalAmountDiscount": null,
	"totalAmountCommission": null,
	"nonTaxable": null,
	"total": 0331.31,
	"paid": 0,
	"balance": 0331.31
}]