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 10 Next »

Operation

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

GET
https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property{propertyId}/revenue/payment


Request

PropertyTypeRequiredDefault valueDescription
chainIdIntegertrue
Unique identificator of the chain.
propertyIdIntegertrue
Unique identificator of the property.
productIdIntegerfalse
Filter by productId
fromLocalDatetrue
Start of date range
toLocalDatetrue
End of date range
offsetIntegerfalse0Offset of the array of results.
limitIntegerfalse10Limit of results.

Example request

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


Response

PropertyTypeRequiredDescription
PagePagetrue

Entity



FieldTypeRequiredDescription
dateLocalDatetrueDate of the revenue calculus
productProducttrueProduct that groups the values
quantityIntegertrue
adultsIntegertrue
juniorsIntegertrue
childrenIntegertrue
infantsIntegertrue
amountAfterTaxBigDecimaltrue
amountBeforeTaxBigDecimaltrue
amountDiscountBigDecimaltrue
amountTaxBigDecimaltrue
amountCommissionBigDecimaltrue
amountCommissionAppliedBigDecimaltrue

amountFoodBreakdownAfterTax

BigDecimal

amountFoodBreakdownBeforeTax

BigDecimal

amountBeverageBreakdownAfterTax

BigDecimal

amountBeverageBreakdownBeforeTax

BigDecimal

amountOtherBreakdownAfterTax

BigDecimal



amountOtherBreakdownBeforeTax

BigDecimal



amountNetAfterTaxBigDecimaltrue
amountNetBeforeTaxBigDecimaltrue
amountFoodBreakdownNetAfterTaxBigDecimal

amountFoodBreakdownNetBeforeTaxBigDecimal

amountBeverageBreakdownNetAfterTaxBigDecimal

amountBeverageBreakdownNetBeforeTaxBigDecimal

amountOtherBreakdownNetAfterTaxBigDecimal

amountOtherBreakdownNetBeforeTaxBigDecimal

amountInvoiceAfterTaxBigDecimal

amountInvoiceBeforeTaxBigDecimal

segment

Segment



source

Source



channel

Channel



rate

Rate



offer

Offer



promotion

Promotion



booker

Company



billTo

Company



central

Company



company

Company



countryCode

String



Example response

{
	"count": 93,
	"offset": 0,
	"limit": 2,
	"list": [{
			"date": "2020-03-30",
			"product": {
				"id": 48,
				"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,
				"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
		}
	]
}
  • No labels