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

« Previous Version 5 Next »

Operation

Get a list of Expenses of the ReservationRoomStay.

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


Request

PropertyTypeRequiredDefault valueDescription
chainIdIntegertrue
Unique identificator of the chain.
propertyIdIntegertrue
Unique identificator of the property.
reservartionRoomStayIdIntegertrue
Unique identificator of the reservationRoomStay.

Example request

GET https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/property/1/reservationRoomStay/1/expenses


Response

The response is a list of Expenses objects.

Entity


FieldTypeRequiredDescription
customerCustomertrueCustomer related to this Expenses.
nameStringtrueName of the customer.
taxIdStringfalseTaxId if the customer is a company.
streetStringtrueStreet from the address of the customer.
cityStringtrueCity of the customer.
stateProvNameStringfalseName of the State/Province of the customer.
stateProvCodeStringfalseState/Province of the customer. ISO 3166-2
municipalityNameStringfalseMunicipality name of the customer.
municipalityCodeStringfalseMunicipality code of the customer.
postalCodeStringtruePostal code of the customer.
countryCodeStringtrueCountry of the customer. ISO 3166-1 alpha-2
remarkStringfalse
channelChanneltrueChannel related to this Expenses.
sourceSourcetrueSource related to this Expenses.
segmentSegmenttrueSegment related to this Expenses.
businessDateLocalDatefalse
expensesProductListList of ExpensesProduct.falseThe products associated to this Expenses.
nonTaxableBooleantrueIf is nonTaxable, taxes can not be applied.
totalBigDecimalfalseTotal amount.
paidBigDecimalfalsePaid amount.
balanceBigDecimalfalseTotal 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
}]
  • No labels