Proforma Expenses List from ReservationRoomStay [GET]

Operation

Get a list of E xpenses from folios and from settlement of the ReservationRoomStay.

GET

https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property/{propertyId}/reservationRoomStay/{reservationRoomStayId}/proforma/expenses

Request

Property	Type	Required	Type parameter	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/expenses

Response

The response is a list of Expenses objects.

Entity

Field	Type	Required	Description
customer	Customer	true	Customer related to this Expenses.
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 of the customer.
municipalityCode	String	false	Municipality code of the customer.
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 Expenses.
source	Source	true	Source related to this Expenses.
segment	Segment	true	Segment related to this Expenses.
businessDate	LocalDate	false
expensesProductList	List of ExpensesProduct.	false	The products associated to this Expenses.
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": 1,
		"name": "Gerald Lèi Simpson"
	},
	"company": null,
	"name": "Gerald Lèi Simpson",
	"taxId": null,
	"street": "003 Merrick Junction",
	"city": "El Paso",
	"stateProvName": null,
	"stateProvCode": null,
	"postalCode": "79950",
	"countryCode": "ES",
	"remark": null,
	"channel": {
		"id": 32,
		"code": "IDS",
		"name": "IDS"
	},
	"source": {
		"id": 47,
		"code": "FAX",
		"name": "Fax"
	},
	"segment": {
		"id": 227,
		"code": "TOU",
		"name": "Tourism"
	},
	"businessDate": null,
	"expensesProductList": [{
		"postingDate": "2019-08-02",
		"quantity": 1,
		"product": {
			"id": 32,
			"code":"DBL",
			"name": "Double",
			"productType": {
				"id": 1,
				"code": "ACC",
				"name": "Accommodation"
			}
		},
		"name": "Double",
		"amountAfterTax": 10.000000,
		"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": 32,
			"code": "IDS",
			"name": "IDS"
		},
		"source": {
			"id": 47,
			"code": "FAX",
			"name": "Fax"
		},
		"segment": {
			"id": 227,
			"code": "TOU",
			"name": "Tourism"
		},
		"remark": null,
		"expensesProductTaxList": [{
			"quantity": 1,
			"product": {
				"id": 782,
	 			"code":"TX10",
				"name": "Tax 10%",
				"productType": {
					"id": 8,
					"code": "TAX",
					"name": "Tax"
				}
			},
			"name": "Tax 10%",
			"price": 0.909091,
			"currency": {
				"id": 1,
				"code": "EUR",
				"name": "Euro"
			},
			"amount": null,
			"percentage": 10.000000
		}],
		"expensesProductCommissionList": null,
		"expensesProductDiscountList": null
	}, {
		"postingDate": "2019-08-02",
		"quantity": 1,
		"product": {
			"id": 227,
 			"code":"BR",
			"name": "Breakfast",
			"productType": {
				"id": 2,
				"code": "SER",
				"name": "Service"
			}
		},
		"name": "Breakfast",
		"amountAfterTax": 41.000000,
		"amountBeforeTax": 33.884298,
		"currency": {
			"id": 1,
			"code": "EUR",
			"name": "Euro"
		},
		"amountTax": 7.115702,
		"amountDiscount": 0.000000,
		"amountCommission": 0.000000,
		"rate": null,
		"offer": null,
		"offerAmountDiscount": null,
		"offerPercentDiscount": null,
		"promotion": null,
		"promotionAmountDiscount": null,
		"promotionPercentDiscount": null,
		"channel": {
			"id": 32,
			"code": "IDS",
			"name": "IDS"
		},
		"source": {
			"id": 47,
			"code": "FAX",
			"name": "Fax"
		},
		"segment": {
			"id": 227,
			"code": "TOU",
			"name": "Tourism"
		},
		"remark": null,
		"expensesProductTaxList": [{
			"quantity": 1,
			"product": {
				"id": 797,
	 			"code":"TX21",
				"name": "Tax 21%",
				"productType": {
					"id": 8,
					"code": "TAX",
					"name": "Tax"
				}
			},
			"name": "Tax 21%",
			"price": 7.115702,
			"currency": {
				"id": 1,
				"code": "EUR",
				"name": "Euro"
			},
			"amount": null,
			"percentage": 21.000000
		}],
		"expensesProductCommissionList": null,
		"expensesProductDiscountList": null
	}],
	"totalAmountAfterTax": null,
	"totalAmountBeforeTax": null,
	"totalAmountTax": null,
	"totalAmountDiscount": null,
	"totalAmountCommission": null,
	"nonTaxable": null,
	"total": 51.000000,
	"paid": 0,
	"balance": 51.000000
}]