Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Operation

Get a list of Proforma from a Reservation.

GET
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

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



Example response

[{
	"sequence": null,
	"propertyRegisteredCompany": null,
	"profile": {
		"id": 347,
		"createdDate": "2019-07-22T09:56:50.177Z",
		"modifiedDate": "2019-07-22T09:03:57.677Z",
		"createdUser": 0,
		"modifiedUser": 13,
		"chain": null,
		"profileType": null,
		"name": "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,
		"propertyProfileCommissionSet": null,
		"propertyProfileDiscountSet": null,
		"propertyIntegrationAccountingProfileMapSet": null,
		"iata": "I01fb2376-97a3-428b-84a0-cecfdd2899ab"
	},
	"name": "Travelbook.ph",
	"taxId": "01fb2376-97a3-428b-84a0-cecfdd2899ab",
	"street": "21 Main Point",
	"city": "Oakland",
	"stateProvName": null,
	"stateProv": null,
	"postalCode": "94627",
	"country": null,
	"remark": null,
	"propertyChannel": {
		"id": 62,
		"createdDate": "2019-07-22T09:56:43.077Z",
		"createdUser": 0,
		"property": null,
		"chainChannel": {
			"id": 5,
			"createdDate": "2019-07-22T09:56:43.077Z",
			"createdUser": 0,
			"code": "WEB",
			"name": "Booking Engine",
			"nameI18nId": 2546,
			"nameI18n": "Booking Engine",
			"descriptionI18nId": 2547,
			"colorCode": "#FDD835",
			"propertyChannelSet": null
		},
		"reservationRoomStayDailySet": null,
		"propertyPreferenceSet": null,
		"active": true
	},
	"propertySource": {
		"id": 17,
		"createdDate": "2019-07-22T09:56:42.327Z",
		"createdUser": 0,
		"property": null,
		"chainSource": {
			"id": 2,
			"createdDate": "2019-07-22T09:56:42.327Z",
			"createdUser": 0,
			"code": "COM",
			"name": "Company",
			"nameI18nId": 2494,
			"nameI18n": "Company",
			"descriptionI18nId": 2495,
			"colorCode": "#000000",
			"propertySourceSet": null
		},
		"active": true,
		"reservationRoomStayDailySet": null,
		"propertyPreferenceSet": null
	},
	"propertySegment": {
		"id": 47,
		"createdDate": "2019-07-22T09:56:42.627Z",
		"modifiedDate": "2019-07-22T07:56:42.630Z",
		"createdUser": 0,
		"property": null,
		"chainSegment": {
			"id": 4,
			"createdDate": "2019-07-22T09:56:42.610Z",
			"createdUser": 0,
			"code": "CONG",
			"name": "Congress",
			"nameI18nId": 2512,
			"nameI18n": "Congress",
			"descriptionI18nId": 2513,
			"colorCode": "#1E88E5",
			"propertySegmentSet": null
		},
		"reservationRoomStayDailySet": null,
		"propertyPreferenceSet": null,
		"active": true
	},
	"businessDate": null,
	"proformaProductSet": null,
	"totalAmountAfterTax": null,
	"totalAmountBeforeTax": null,
	"totalAmountTax": null,
	"totalAmountDiscount": null,
	"totalAmountCommission": null,
	"nonTaxable": null,
	"total": 0,
	"paid": 0,
	"balance": 0
}]
  • No labels