Versions Compared

Key

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

Operation

This operation gives as a result the total daily amount produced by one or more products (payment methods) throughout an specific period

Rw ui textbox macro
typewarning

Only accessible with permission of pms.integration.revenue


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}/revenue/payment



Request

PropertyTypeRequiredType parameterDefault valueDescription
chainIdIntegertruepath parameter
Unique identificator of the chain.
propertyIdIntegertruepath parameter
Unique identificator of the property.
productIdIntegerfalsepath parameter
Filter by productId
fromLocalDatetruerequest parameter
Start of date range
toLocalDatetruerequest parameter
End of date range
offsetIntegerfalserequest parameter0Offset of the array of results.
limitIntegerfalserequest parameter10Limit of results.


Example request

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



Response

PropertyTypeRequiredDescription
PagePagetrue

Entity


Insert excerpt
Revenue
Revenue
nopaneltrue

Example response

Code Block
themeDJango
{
	"count": 93,
	"offset": 0,
	"limit": 2,
	"list": [{
			"date": "2020-03-30",
			"product": {
				"id": 48,
				"code":"CS",
				"name": "Cash",
				"productType": {
					"id": 3,
					"code": "PAY",
					"name": "Payment"
				}
			},
			"quantity": 1,
			"adults": 0,
			"juniors": 0,
			"children": 0,
			"infants": 0,
			"amountAfterTax": 910.800000,
			"amountBeforeTax": 910.800000,
			"amountDiscount": 0.000000,
			"amountTax": 0.000000,
			"amountCommission": 0.000000,
			"segment": null,
			"source": null,
			"channel": null,
			"rate": null,
			"offer": null,
			"promotion": null,
			"booker": null,
			"billTo": null,
			"central": null,
			"company": null,
			"countryCode": null
		},
		{
			"date": "2020-03-30",
			"product": {
				"id": 49,
				"code":"AE",
				"name": "American Express",
				"productType": {
					"id": 3,
					"code": "PAY",
					"name": "Payment"
				}
			},
			"quantity": 2,
			"adults": 0,
			"juniors": 0,
			"children": 0,
			"infants": 0,
			"amountAfterTax": 329.200000,
			"amountBeforeTax": 329.200000,
			"amountDiscount": 0.000000,
			"amountTax": 0.000000,
			"amountCommission": 0.000000,
			"segment": null,
			"source": null,
			"channel": null,
			"rate": null,
			"offer": null,
			"promotion": null,
			"booker": null,
			"billTo": null,
			"central": null,
			"company": null,
			"countryCode": null
		}
	]
}