Billing Payment list by date range [GET]

Operation

This endpoint returns a combined list of payments from folios and invoices filtered by a date range.

GET

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

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.
from	LocalDate	true	request parameter	Start of date range
to	LocalDate	true	request parameter	End of date range

Example request

GET https://prod.ulysescloud.com/api/v1/chain/1/property/1/billingPayment

Response

Property	Type	Required	Description
Page	Page	true

Entity

Field	Type	Required	Description
id	Integer	true	Identificator of the BillingPayment
sequence	Integer	true	Sequence of the folioProduct/invoiceProduct
productionDate	Integer	true	Date when the payment enters in production
postingDate	String	true	Date when the payment is posted.
payment	Payment	true	The product of type payment associated to this billingPayment.
quantity	Integer	true
amount	BigDecimal	true
currency	Currency	true
invoice	Invoice	false	The Invoice related to this payment
folio	Folio	false	The Folio related to this payment
paymentReceipt	PaymentReceipt	false	Payment receipt related to this billing payment

Example response

[{
	"id": 8,
	"productionDate": "2019-04-30",
	"postingDate": "2019-04-30",
	"payment": {
		"id": 453,
		"name": "Visa"
	},
	"quantity": 1,
	"amount": 357,
	"currency": {
		"id": 1,
		"code": "EUR",
		"name": "Euro"
	},
	"invoice": {
		"id": 3,
		"invoiceSerie": "A15",
		"invoiceNumber": 100002,
		"invoiceDate": "2019-04-23",
		"company": null,
		"customer": {
			"id": 213,
			"name": "Emily Maëlann Andrews"
		},
		"travelAgent": null,
		"holderName": "Emily Maëlann Andrews",
		"taxId": null,
		"address": null,
		"city": null,
	    "stateProvName": null,
		"stateProvCode": null,
		"postalCode": null,
		"countryCode": null,
		"remark": null,
		"productList": [{
				"id": 8,
				"productionDate": "2019-04-30",
				"postingDate": "2019-04-30",
				"product": {
					"id": 453,
		  			"code":"V",
					"name": "Visa",
					"productType": {
						"id": 8,
						"code": "PAY",
						"name": "Payment"
					}
				},
				"quantity": 1,
				"amountAfterTax": 357,
				"amountBeforeTax": 357,
				"amountDiscount": 0,
				"amountTax": 0,
				"amountCommission": 0,
				"currency": {
					"id": 1,
					"code": "EUR",
					"name": "Euro"
				},
				"channel": null,
				"source": null,
				"segment": null,
				"invoiceProductTaxList": [],
				"invoiceProductCommissionList": [],
				"invoiceProductDiscountList": []
			},
			{
				"id": 9,
				"productionDate": "2019-04-30",
				"postingDate": "2019-04-30",
				"product": {
					"id": 519,
		  			"code":"DEP10",
					"name": "Deposit 10",
					"productType": {
						"id": 9,
						"code": "DEP",
						"name": "Deposit"
					}
				},
				"quantity": 1,
				"amountAfterTax": 357,
				"amountBeforeTax": 357,
				"amountDiscount": 0,
				"amountTax": 0,
				"amountCommission": 0,
				"currency": {
					"id": 1,
					"code": "EUR",
					"name": "Euro"
				},
				"channel": null,
				"source": null,
				"segment": null,
				"invoiceProductTaxList": [],
				"invoiceProductCommissionList": [],
				"invoiceProductDiscountList": []
			}
		]
	}
}
]