Invoice List [GET]
- David Garcerán
- Jordi Artal
- Ricardo Vargas (Unlicensed)
Owned by David Garcerán
Operation
GET
https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property/{propertyId}/invoice
Request
| Property | Type | Required | Type parameter | Default value | Description |
|---|---|---|---|---|---|
| chainId | Integer | true | path parameter | Unique identificator of the chain. | |
| propertyId | Integer | true | path parameter | Unique identificator of the property. | |
| invoiceNumber | String | false | request parameter | ||
| invoiceSerie | String | false | request parameter | ||
| billingTypeIdList | List<Integer> | false | request parameter | ||
| invoiceTypeIdList | List<Integer> | false | request parameter | ||
| from | Date | false | request parameter | Date from | |
| to | Date | false | request parameter | Date to | |
| offset | Integer | false | request parameter | 0 | Offset of the array of results. |
| limit | Integer | false | request parameter | 10 | Limit of results. |
| sort | String | false | request parameter | id | Property of the entity to sort by. |
| sortMode | String | false | request parameter | Asc | Mode of sorting. |
| showProductAccommodation | Boolean | false | request parameter | false | Show accommodation rows associated with this invoice |
| showProductService | Boolean | false | request parameter | false | Show service rows associated with this invoice |
| showProductPayment | Boolean | false | request parameter | false | Show payment rows associated with this invoice |
| showProductDeposit | Boolean | false | request parameter | false | Show deposit rows associated with this invoice |
| showProductFee | Boolean | false | request parameter | false | Show fee rows associated with this invoice |
| showProductCancellationFee | Boolean | false | request parameter | false | Show cancellation fee rows associated with this invoice |
| showDetailedTax | Boolean | false | request parameter | false | Show tax for each product included in invoice |
| showDetailedDiscount | Boolean | false | request parameter | false | Show discount for each product included in invoice |
| showDetailedCommission | Boolean | false | request parameter | false | Show commission for each product included in invoice |
| showSummarizedTax | Boolean | false | request parameter | false | Show tax summarized by percentage |
| addRebate | Boolean | false | request parameter | false | Show Rebate posts of this invoice.. |
Example request
GET https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/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 | false | ||
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": 16,
"offset": 0,
"limit": 2,
"list": [
{
"id": 1,
"invoiceSerie": "",
"invoiceNumber": 1,
"invoiceDate": "2020-01-15",
"company": {
"id": 172,
"name": "Tagfeed",
"code": null,
"taxId": "75310161",
"iataId": null,
"companyEmailList": [
{
"id": 172,
"primary": true,
"emailAddressType": {
"id": 1,
"code": "1",
"name": "Personal"
},
"email": "rsnyder4g@quantcast.com",
"remark": null
}
],
"companyAddressList": [
{
"id": 172,
"primary": true,
"communicationLocationType": {
"id": 1,
"code": "1",
"name": "Home"
},
"street": "09914 Lunder Point",
"city": "Dallas",
"stateProvName": "Texas",
"stateProvCode": null,
"postalCode": "75310",
"countryCode": "HT",
"remark": "Address Remark"
}
],
"companyPhoneList": [
{
"id": 172,
"primary": true,
"phoneLocationType": {
"id": 6,
"code": "6",
"name": "Home"
},
"phoneTechType": {
"id": 1,
"code": "1",
"name": "Voice"
},
"countryAccessCode": "+34",
"areaCityCode": "B",
"phoneNumber": "1-(214)166-4006",
"extension": "1",
"remark": "Phone Remark"
}
],
"companyTaxAddress": {
"id": 162,
"communicationLocationType": null,
"street": "09914 Lunder Point",
"city": "Dallas",
"stateProvName": "Texas",
"stateProvCode": null,
"postalCode": "75310",
"countryCode": "NZ",
"remark": "Address Remark"
},
"remark": "Company Remarks",
"profileType": {
"code": "2",
"name": "Company",
"nameI18n": "Company",
"colorCode": "#00ACC1"
}
},
"customer": null,
"travelAgent": null,
"holderName": "Tagfeed",
"taxId": "75310161",
"address": "09914 Lunder Point",
"city": "Dallas",
"stateProvName": "Texas",
"stateProvCode": null,
"postalCode": "75310",
"countryCode": "HT",
"remark": null,
"totalAmountAfterTax": 1330.000000,
"totalAmountBeforeTax": 1211.000007,
"totalAmountTax": 118.999993,
"totalAmountDiscount": 0.000000,
"totalAmountCommission": 0.000000,
"minimumTicketNumber": null,
"maximumTicketNumber": null,
"productList": [
{
"id": 1,
"productionDate": "2020-01-14",
"postingDate": "2020-01-14",
"product": {
"id": 632,
"code":"S",
"name": "Single",
"productType": {
"id": 1,
"code": "ACC",
"name": "Accommodation"
}
},
"quantity": 1,
"amountAfterTax": 102.200000,
"amountBeforeTax": 92.909091,
"amountDiscount": 0.000000,
"amountTax": 9.290909,
"amountCommission": 0.000000,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro"
},
"channel": {
"id": 11,
"code": "WEB",
"name": "Booking Engine"
},
"source": {
"id": 8,
"code": "AGE",
"name": "Agency"
},
"segment": {
"id": 31,
"code": "CREWS",
"name": "Crews"
},
"invoiceProductTaxList": [
{
"id": 1,
"tax": {
"id": 45,
"name": "Tax 10%"
},
"name": "Tax 10%",
"amount": 0.000000,
"percentageOfTax": 10.000000,
"amountOfTax": 0.000000
}
],
"invoiceProductCommissionList": [],
"invoiceProductDiscountList": []
},
{
"id": 2,
"productionDate": "2020-01-14",
"postingDate": "2020-01-14",
"product": {
"id": 767,
"code":"CTB",
"name": "City Tax Barcelona",
"productType": {
"id": 6,
"code": "FEE",
"name": "Fee"
}
},
"quantity": 1,
"amountAfterTax": 3.000000,
"amountBeforeTax": 3.000000,
"amountDiscount": 0.000000,
"amountTax": 0.000000,
"amountCommission": 0.000000,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro"
},
"channel": {
"id": 11,
"code": "WEB",
"name": "Booking Engine"
},
"source": {
"id": 8,
"code": "AGE",
"name": "Agency"
},
"segment": {
"id": 31,
"code": "CREWS",
"name": "Crews"
},
"invoiceProductTaxList": [],
"invoiceProductCommissionList": [],
"invoiceProductDiscountList": []
},
{
"id": 3,
"productionDate": "2020-01-15",
"postingDate": "2020-01-15",
"product": {
"id": 61,
"code":"BR",
"name": "Breakfast",
"productType": {
"id": 2,
"code": "SER",
"name": "Service"
}
},
"quantity": 1,
"amountAfterTax": 22.000000,
"amountBeforeTax": 20.000000,
"amountDiscount": 0.000000,
"amountTax": 2.000000,
"amountCommission": 0.000000,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro"
},
"channel": {
"id": 11,
"code": "WEB",
"name": "Booking Engine"
},
"source": {
"id": 8,
"code": "AGE",
"name": "Agency"
},
"segment": {
"id": 31,
"code": "CREWS",
"name": "Crews"
},
"invoiceProductTaxList": [
{
"id": 2,
"tax": {
"id": 45,
"name": "Tax 10%"
},
"name": "Tax 10%",
"amount": 0.000000,
"percentageOfTax": 10.000000,
"amountOfTax": 0.000000
}
],
"invoiceProductCommissionList": [],
"invoiceProductDiscountList": []
},
{
"id": 4,
"productionDate": "2020-01-15",
"postingDate": "2020-01-15",
"product": {
"id": 74,
"code":"PK",
"name": "Parking",
"productType": {
"id": 2,
"code": "SER",
"name": "Service"
}
},
"quantity": 3,
"amountAfterTax": 10.000000,
"amountBeforeTax": 9.090909,
"amountDiscount": 0.000000,
"amountTax": 0.909091,
"amountCommission": 0.000000,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro"
},
"channel": {
"id": 11,
"code": "WEB",
"name": "Booking Engine"
},
"source": {
"id": 8,
"code": "AGE",
"name": "Agency"
},
"segment": {
"id": 31,
"code": "CREWS",
"name": "Crews"
},
"invoiceProductTaxList": [
{
"id": 3,
"tax": {
"id": 45,
"name": "Tax 10%"
},
"name": "Tax 10%",
"amount": 0.000000,
"percentageOfTax": 10.000000,
"amountOfTax": 0.000000
}
],
"invoiceProductCommissionList": [],
"invoiceProductDiscountList": []
},
{
"id": 5,
"productionDate": "2020-01-15",
"postingDate": "2020-01-15",
"product": {
"id": 74,
"code":"PK",
"name": "Parking",
"productType": {
"id": 2,
"code": "SER",
"name": "Service"
}
},
"quantity": 2,
"amountAfterTax": 10.000000,
"amountBeforeTax": 9.090909,
"amountDiscount": 0.000000,
"amountTax": 0.909091,
"amountCommission": 0.000000,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro"
},
"channel": {
"id": 11,
"code": "WEB",
"name": "Booking Engine"
},
"source": {
"id": 8,
"code": "AGE",
"name": "Agency"
},
"segment": {
"id": 31,
"code": "CREWS",
"name": "Crews"
},
"invoiceProductTaxList": [
{
"id": 4,
"tax": {
"id": 45,
"name": "Tax 10%"
},
"name": "Tax 10%",
"amount": 0.000000,
"percentageOfTax": 10.000000,
"amountOfTax": 0.000000
}
],
"invoiceProductCommissionList": [],
"invoiceProductDiscountList": []
},
{
"id": 6,
"productionDate": "2020-01-15",
"postingDate": "2020-01-15",
"product": {
"id": 51,
"code":"MC",
"name": "MasterCard",
"productType": {
"id": 3,
"code": "PAY",
"name": "Payment"
}
},
"quantity": 1,
"amountAfterTax": 177.200000,
"amountBeforeTax": 177.200000,
"amountDiscount": 0.000000,
"amountTax": 0.000000,
"amountCommission": 0.000000,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro"
},
"channel": {
"id": 11,
"code": "WEB",
"name": "Booking Engine"
},
"source": {
"id": 8,
"code": "AGE",
"name": "Agency"
},
"segment": {
"id": 31,
"code": "CREWS",
"name": "Crews"
},
"invoiceProductTaxList": [],
"invoiceProductCommissionList": [],
"invoiceProductDiscountList": []
}
]
},
{
"id": 2,
"invoiceSerie": "",
"invoiceNumber": 2,
"invoiceDate": "2020-01-15",
"company": null,
"customer": {
"id": 1285,
"name": "Marie Mélodie Hunt",
"customerDocumentList": [
{
"id": 12,
"primary": true,
"documentType": {
"id": 2,
"code": "2",
"name": "Passport"
},
"number": "swgcACUU",
"givenName": "Marie",
"secondSurName": "Mélodie",
"surName": "Hunt",
"genderType": {
"id": 1,
"code": "M",
"name": "Male"
},
"birthDate": "2002-02-13",
"birthCountryCode": "VU",
"birthPlace": "Memphis",
"effectiveDate": "2019-02-13",
"expireDate": "2019-02-13",
"street": "2603 Cherokee Drive",
"city": "Memphis",
"stateProvName": null,
"stateProvCode": null,
"countryCode": "VU",
"postalCode": "38104",
"nationalityCountryCode": "VU",
"ocr": null,
"remark": null,
"profileType": {
"code": "1",
"name": "Customer",
"nameI18n": "Customer",
"colorCode": "#00ACC1"
}
}
],
"customerEmailList": [
{
"id": 1285,
"primary": true,
"emailAddressType": {
"id": 1,
"code": "1",
"name": "Personal"
},
"email": "bhernandezo@instagram.com",
"remark": null
}
],
"customerAddressList": null,
"customerPhoneList": [
{
"id": 1285,
"primary": true,
"phoneLocationType": {
"id": 6,
"code": "6",
"name": "Home"
},
"phoneTechType": {
"id": 1,
"code": "1",
"name": "Voice"
},
"countryAccessCode": null,
"areaCityCode": null,
"phoneNumber": "1-(901)206-4293",
"extension": null,
"remark": null
}
],
"remark": null,
"profileType": {
"code": "1",
"name": "Customer",
"nameI18n": "Customer",
"colorCode": "#00ACC1"
}
},
"travelAgent": null,
"holderName": "Marie Mélodie Hunt",
"taxId": "swgcACUU",
"address": "2603 Cherokee Drive",
"city": "Memphis",
"stateProvName": null,
"stateProvCode": null,
"postalCode": "38104",
"countryCode": "VU",
"remark": null,
"productList": [
{
"id": 7,
"productionDate": "2020-01-14",
"postingDate": "2020-01-14",
"product": {
"id": 72,
"code":"TV",
"name": "Television",
"productType": {
"id": 2,
"code": "SER",
"name": "Service"
}
},
"quantity": 1,
"amountAfterTax": 10.000000,
"amountBeforeTax": 9.090909,
"amountDiscount": 0.000000,
"amountTax": 0.909091,
"amountCommission": 0.000000,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro"
},
"channel": {
"id": 11,
"code": "WEB",
"name": "Booking Engine"
},
"source": {
"id": 8,
"code": "AGE",
"name": "Agency"
},
"segment": {
"id": 31,
"code": "CREWS",
"name": "Crews"
},
"invoiceProductTaxList": [
{
"id": 5,
"tax": {
"id": 45,
"name": "Tax 10%"
},
"name": "Tax 10%",
"amount": 0.000000,
"percentageOfTax": 10.000000,
"amountOfTax": 0.000000
}
],
"invoiceProductCommissionList": [],
"invoiceProductDiscountList": []
},
{
"id": 8,
"productionDate": "2020-01-14",
"postingDate": "2020-01-14",
"product": {
"id": 72,
"code":"TV",
"name": "Television",
"productType": {
"id": 2,
"code": "SER",
"name": "Service"
}
},
"quantity": 1,
"amountAfterTax": 10.000000,
"amountBeforeTax": 9.090909,
"amountDiscount": 0.000000,
"amountTax": 0.909091,
"amountCommission": 0.000000,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro"
},
"channel": {
"id": 11,
"code": "WEB",
"name": "Booking Engine"
},
"source": {
"id": 8,
"code": "AGE",
"name": "Agency"
},
"segment": {
"id": 31,
"code": "CREWS",
"name": "Crews"
},
"invoiceProductTaxList": [
{
"id": 6,
"tax": {
"id": 45,
"name": "Tax 10%"
},
"name": "Tax 10%",
"amount": 0.000000,
"percentageOfTax": 10.000000,
"amountOfTax": 0.000000
}
],
"invoiceProductCommissionList": [],
"invoiceProductDiscountList": []
},
{
"id": 9,
"productionDate": "2020-01-14",
"postingDate": "2020-01-14",
"product": {
"id": 70,
"code":"HST",
"name": "Hostess",
"productType": {
"id": 2,
"code": "SER",
"name": "Service"
}
},
"quantity": 1,
"amountAfterTax": 10.000000,
"amountBeforeTax": 9.090909,
"amountDiscount": 0.000000,
"amountTax": 0.909091,
"amountCommission": 0.000000,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro"
},
"channel": {
"id": 11,
"code": "WEB",
"name": "Booking Engine"
},
"source": {
"id": 8,
"code": "AGE",
"name": "Agency"
},
"segment": {
"id": 31,
"code": "CREWS",
"name": "Crews"
},
"invoiceProductTaxList": [
{
"id": 7,
"tax": {
"id": 45,
"name": "Tax 10%"
},
"name": "Tax 10%",
"amount": 0.000000,
"percentageOfTax": 10.000000,
"amountOfTax": 0.000000
}
],
"invoiceProductCommissionList": [],
"invoiceProductDiscountList": []
},
{
"id": 10,
"productionDate": "2020-01-14",
"postingDate": "2020-01-14",
"product": {
"id": 74,
"code":"PK",
"name": "Parking",
"productType": {
"id": 2,
"code": "SER",
"name": "Service"
}
},
"quantity": 1,
"amountAfterTax": 10.000000,
"amountBeforeTax": 9.090909,
"amountDiscount": 0.000000,
"amountTax": 0.909091,
"amountCommission": 0.000000,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro"
},
"channel": {
"id": 11,
"code": "WEB",
"name": "Booking Engine"
},
"source": {
"id": 8,
"code": "AGE",
"name": "Agency"
},
"segment": {
"id": 31,
"code": "CREWS",
"name": "Crews"
},
"invoiceProductTaxList": [
{
"id": 8,
"tax": {
"id": 45,
"name": "Tax 10%"
},
"name": "Tax 10%",
"amount": 0.000000,
"percentageOfTax": 10.000000,
"amountOfTax": 0.000000
}
],
"invoiceProductCommissionList": [],
"invoiceProductDiscountList": []
},
{
"id": 11,
"productionDate": "2020-01-15",
"postingDate": "2020-01-15",
"product": {
"id": 83,
"code":"BIC",
"name": "Bicycle",
"productType": {
"id": 2,
"code": "SER",
"name": "Service"
}
},
"quantity": 2,
"amountAfterTax": 10.000000,
"amountBeforeTax": 9.090909,
"amountDiscount": 0.000000,
"amountTax": 0.909091,
"amountCommission": 0.000000,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro"
},
"channel": {
"id": 11,
"code": "WEB",
"name": "Booking Engine"
},
"source": {
"id": 8,
"code": "AGE",
"name": "Agency"
},
"segment": {
"id": 31,
"code": "CREWS",
"name": "Crews"
},
"invoiceProductTaxList": [
{
"id": 9,
"tax": {
"id": 45,
"name": "Tax 10%"
},
"name": "Tax 10%",
"amount": 0.000000,
"percentageOfTax": 10.000000,
"amountOfTax": 0.000000
}
],
"invoiceProductCommissionList": [],
"invoiceProductDiscountList": []
},
{
"id": 12,
"productionDate": "2020-01-15",
"postingDate": "2020-01-15",
"product": {
"id": 83,
"code":"BIC",
"name": "Bicycle",
"productType": {
"id": 2,
"code": "SER",
"name": "Service"
}
},
"quantity": 2,
"amountAfterTax": 10.000000,
"amountBeforeTax": 9.090909,
"amountDiscount": 0.000000,
"amountTax": 0.909091,
"amountCommission": 0.000000,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro"
},
"channel": {
"id": 11,
"code": "WEB",
"name": "Booking Engine"
},
"source": {
"id": 8,
"code": "AGE",
"name": "Agency"
},
"segment": {
"id": 31,
"code": "CREWS",
"name": "Crews"
},
"invoiceProductTaxList": [
{
"id": 10,
"tax": {
"id": 45,
"name": "Tax 10%"
},
"name": "Tax 10%",
"amount": 0.000000,
"percentageOfTax": 10.000000,
"amountOfTax": 0.000000
}
],
"invoiceProductCommissionList": [],
"invoiceProductDiscountList": []
},
{
"id": 13,
"productionDate": "2020-01-15",
"postingDate": "2020-01-15",
"product": {
"id": 48,
"code":"AE",
"name": "American Express",
"productType": {
"id": 3,
"code": "PAY",
"name": "Payment"
}
},
"quantity": 1,
"amountAfterTax": 80.000000,
"amountBeforeTax": 80.000000,
"amountDiscount": 0.000000,
"amountTax": 0.000000,
"amountCommission": 0.000000,
"currency": {
"id": 1,
"code": "EUR",
"name": "Euro"
},
"channel": {
"id": 11,
"code": "WEB",
"name": "Booking Engine"
},
"source": {
"id": 8,
"code": "AGE",
"name": "Agency"
},
"segment": {
"id": 31,
"code": "CREWS",
"name": "Crews"
},
"invoiceProductTaxList": [],
"invoiceProductCommissionList": [],
"invoiceProductDiscountList": []
}
]
}
]
}