Invoice List [GET]

Operation

Information of the operation

GET

https://{environment}.ulysescloud.com/api/{version}/chain/{chainId}/property/{propertyId}/invoice

Request

Property	Type	Required	Default value	Description
chainId	Integer	true		Unique identificator of the chain.
propertyId	Integer	true		Unique identificator of the property.
invoiceNumber	String	false
invoiceSerie	String	false
from	Date	false		Date from
to	Date	false		Date to
offset	Integer	false	0	Offset of the array of results.
limit	Integer	false	10	Limit of results.
sort	String	false	id	Property of the entity to sort by.
sortMode	String	false	Asc	Mode of sorting.

Example request

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

Response

Property	Type	Required	Description
Page	Page	true	Description of the response of the success operation

Entity

Field	Type	Required	Description
id	Integer	true	Unique identifier for the InvoiceProduct.
sequence	Integer	true
invoiceSerie	String	true	Serie of the Invoice
invoiceNumber	Integer	true	Number of the Invoice
invoiceSource	Invoice	false
invoiceDate	LocalDate	true	Date of the Invoice
company	Company	false	Company of this Invoice
customer	Customer	false	Customer of this Invoice
travelAgent	TravelAgent	false	TravelAgent of this Invoice
holderName	String	true	Name of the holder
taxId	String	false
address	String	false
city	String	false
stateProvName	String	false
stateProvCode	String	false	ISO 3166-2
municipalityName	String	false	Municipality name.
municipalityCode	String	false	Municipality code.
postalCode	String	false
countryCode	String	false	ISO 3166-1 alpha-2
remark	String	false
invoiceType	InvoiceType	false
billingType	BillingType	false
totalAmountAfterTax	BigDecimal	true
totalAmountBeforeTax	BigDecimal	true
totalAmountTax	BigDecimal	true
totalAmountTaxExempt	BigDecimal	true	Total amount exempt of tax in a given invoice
totalAmountDiscount	BigDecimal	true
totalAmountCommission	BigDecimal	true
productList	Array of InvoiceProduct elements	true	InvoiceProduct list related to this Invoice
invoiceTaxSummaryList	Array of InvoiceTaxSummary	false
reservationSummary	ReservationSummary
reservationRoomStaySummary	ReservationRoomStaySummary
reservationGroup	ReservationGroup
deposit	Deposit
minimumTicketNumber	String	false
maximumTicketNumber	String	false
invoiceDescription	String		Free text description of the invoice.

Example response

{
	"count": 2,
	"offset": 0,
	"limit": 10,
	"list": [{
			"id": 1,
			"invoiceSerie": "A15",
			"invoiceNumber": 100000,
			"invoiceDate": "2019-01-21",
			"company": null,
			"customer": {
				"id": 8,
				"name": "Denise Naéva Schmidt"
			},
			"travelAgent": null,
			"holderName": "Denise Naéva Schmidt",
			"taxId": null,
			"address": "75865 Emmet Crossing",
			"city": "Saginaw",
			"stateProv": "Michigan",
			"postalCode": "48604",
			"country": {
				"code": "ESP",
				"name": "SPAIN"
			},
			"remark": null,
			"productList": [{
					"id": 1,
					"productionDate": "2019-01-30",
					"postingDate": "2019-01-30",
					"product": {
						"id": 431,
						"name": "Cash"
					},
					"productType": {
						"code": "PAY",
						"name": "Payment"
					},
					"productName": "Cash",
					"quantity": 1,
					"amountAfterTax": 142,
					"amountBeforeTax": 142,
					"amountDiscount": 0,
					"amountTax": 0,
					"amountCommission": 0,
					"currency": {
						"code": "EUR",
						"name": "Euro"
					},
					"channel": null,
					"source": null,
					"segment": null,
					"invoiceProductTaxList": [],
					"invoiceProductCommissionList": [],
					"invoiceProductDiscountList": []
				},
				{
					"id": 2,
					"productionDate": "2019-01-30",
					"postingDate": "2019-01-30",
					"product": {
						"id": 530,
						"name": "Deposit 21"
					},
					"productType": {
						"code": "DEP",
						"name": "Deposit"
					},
					"productName": "Deposit 21",
					"quantity": 1,
					"amountAfterTax": 142,
					"amountBeforeTax": 142,
					"amountDiscount": 0,
					"amountTax": 0,
					"amountCommission": 0,
					"currency": {
						"code": "EUR",
						"name": "Euro"
					},
					"channel": null,
					"source": null,
					"segment": null,
					"invoiceProductTaxList": [],
					"invoiceProductCommissionList": [],
					"invoiceProductDiscountList": []
				}
			]
		},
		{
			"id": 2,
			"invoiceSerie": "A15",
			"invoiceNumber": 100001,
			"invoiceDate": "2019-01-22",
			"company": null,
			"customer": null,
			"travelAgent": {
				"id": 153,
				"name": "Skipstorm"
			},
			"holderName": "Skipstorm",
			"taxId": null,
			"address": "1695 Meadow Ridge Parkway",
			"city": "Lake Worth",
			"stateProv": "Florida",
			"postalCode": "33462",
			"country": {
				"code": "ESP",
				"name": "SPAIN"
			},
			"remark": null,
			"productList": [{
					"id": 3,
					"productionDate": "2019-01-30",
					"postingDate": "2019-01-30",
					"product": {
						"id": 464,
						"name": "Diners"
					},
					"productType": {
						"code": "PAY",
						"name": "Payment"
					},
					"productName": "Diners",
					"quantity": 1,
					"amountAfterTax": 25,
					"amountBeforeTax": 25,
					"amountDiscount": 0,
					"amountTax": 0,
					"amountCommission": 0,
					"currency": {
						"code": "EUR",
						"name": "Euro"
					},
					"channel": null,
					"source": null,
					"segment": null,
					"invoiceProductTaxList": [],
					"invoiceProductCommissionList": [],
					"invoiceProductDiscountList": []
				},
				{
					"id": 4,
					"productionDate": "2019-01-30",
					"postingDate": "2019-01-30",
					"product": {
						"id": 530,
						"name": "Deposit 21"
					},
					"productType": {
						"code": "DEP",
						"name": "Deposit"
					},
					"productName": "Deposit 21",
					"quantity": 1,
					"amountAfterTax": 25,
					"amountBeforeTax": 25,
					"amountDiscount": 0,
					"amountTax": 0,
					"amountCommission": 0,
					"currency": {
						"code": "EUR",
						"name": "Euro"
					},
					"channel": null,
					"source": null,
					"segment": null,
					"invoiceProductTaxList": [],
					"invoiceProductCommissionList": [],
					"invoiceProductDiscountList": []
				}
			]
		}
	]
}