Versions Compared

Key

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

Operation


This endpoint returns a list of invoices detailed with all its products.
Rw ui textbox macro
typewarning

Only accessible with permission of pms.integration.invoice


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}/invoice



Request

PropertyTypeRequiredType parameterDefault valueDescription
chainIdIntegertruepath parameter
Unique identificator of the chain.
propertyIdIntegertruepath parameter
Unique identificator of the property.
invoiceNumberStringfalserequest parameter

invoiceSerieStringfalserequest parameter

billingTypeIdListList<Integer>falserequest parameter

invoiceTypeIdListList<Integer>falserequest parameter

fromDatefalserequest parameter
Date from
toDatefalserequest parameter
Date to
offsetIntegerfalserequest parameter0Offset of the array of results.
limitIntegerfalserequest parameter10Limit of results.
sortStringfalserequest parameteridProperty of the entity to sort by.
sortModeStringfalserequest parameterAscMode of sorting.
showProductAccommodationBooleanfalserequest parameterfalseShow accommodation rows associated with this invoice
showProductServiceBooleanfalserequest parameterfalseShow service rows associated with this invoice
showProductPaymentBooleanfalserequest parameterfalseShow payment rows associated with this invoice
showProductDepositBooleanfalserequest parameterfalseShow deposit rows associated with this invoice
showProductFeeBooleanfalserequest parameterfalseShow fee rows associated with this invoice
showProductCancellationFeeBooleanfalserequest parameterfalseShow cancellation fee rows associated with this invoice
showDetailedTaxBooleanfalserequest parameterfalseShow tax for each product included in invoice
showDetailedDiscountBooleanfalserequest parameterfalseShow discount for each product included in invoice
showDetailedCommissionBooleanfalserequest parameterfalseShow commission for each product included in invoice
showSummarizedTaxBooleanfalserequest parameterfalseShow tax summarized by percentage


Example request

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



Response

PropertyTypeRequiredDescription
PagePagetrueDescription of the response of the success operation

Entity


Insert excerpt
Invoice
Invoice
nopaneltrue

Example response

Code Block
themeDJango
{
  "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": []
        }
      ]
    }
  ]
}