Versions Compared

Key

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

Operation

Information of the operation

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/api/{version}/chain/{chainId}/property/{propertyId}/invoice



Request

PropertyTypeRequiredDefault valueDescription
chainIdIntegertrue
Unique identificator of the chain.
propertyIdIntegertrue
Unique identificator of the property.
invoiceNumberStringfalse

invoiceSerieStringfalse

fromDatefalse
Date from
toDatefalse
Date to
offsetIntegerfalse0Offset of the array of results.
limitIntegerfalse10Limit of results.
sortStringfalseidProperty of the entity to sort by.
sortModeStringfalseAscMode of sorting.


Example request

Code Block
languagepowershell
themeDJango
GET https://prod.ulysescloud.com/api/v1/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": 216,
	  "offset": 0,
	  "limit": 102,
	  "list": [
    {
			
      "id": 1,
			      "invoiceSerie": "A15",
			
      "invoiceNumber": 1000001,
			      "invoiceDate": "20192020-01-2115",
			
      "company": null,
			"customer": {
				{
        "id": 8,
				172,
        "name": "Denise Naéva Schmidt"
			},
			"travelAgent"Tagfeed",
        "code": null,
			"holderName        "taxId": "Denise Naéva Schmidt",
			"taxId"75310161",
        "iataId": null,
 			"address": "75865 Emmet Crossing",
			"city": "Saginaw",
			"stateProv": "Michigan",
			"postalCode": "48604",
			"country": {
				"code": "ESP",
				"name": "SPAIN"
			},
			"remark": null,
			"productList": [{
					     "companyEmailList": [
          {
            "id": 172,
            "primary": true,
            "emailAddressType": {
              "id": 1,
					"productionDate
              "code": "2019-01-301",
					"postingDate
              "name": "2019-01-30",
					"product": {
						"id": 431,
						"name": "CashPersonal"
            },
            "email": "rsnyder4g@quantcast.com",
            "remark": null
          }
 "productType": { 						    "code": "PAY",
						 ],
        "namecompanyAddressList": [
"Payment"
					          {
          } 					}, 					"quantityid": 1,
					"amountAfterTax172,
            "primary": 142true,
					"amountBeforeTax": 142,
					"amountDiscount": 0,
					"amountTax": 0,
					"amountCommission": 0,
					"currency": {
						
            "communicationLocationType": {
              "id": 1,
              "code": "EUR1",
						              "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",Home"
            },
            "street": "09914 Lunder Point",
            "city": "Dallas",
            "stateProvName": "Texas",
            "stateProvCode": null,
            "postalCode": "75310",
            "countryCode": "HT",
            "remark": "Address Remark"
          }
        ],
        "productTypecompanyPhoneList": [
          {
						
            "codeid": "DEP"172,
						    "name": "Deposit" 					    } 					}, 					"quantityprimary": 1,
					"amountAfterTax": 142,
					"amountBeforeTax": 142,
					"amountDiscount": 0,
					"amountTax": 0,
					"amountCommission": 0,
					"currency": {
						true,
            "phoneLocationType": {
              "id": 6,
              "code": "EUR6",
						
              "name": "EuroHome"
					},
					"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"
						}
					},
					"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"
						}
					},
					"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": []
				}
			]
		}
	
            },
            "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"
      },
      "customer": null,
      "travelAgent": null,
      "holderName": "Tagfeed",
      "taxId": "75310161",
      "address": "09914 Lunder Point",
      "city": "Dallas",
      "stateProvName": "Texas",
      "stateProvCode": null,
      "postalCode": "75310",
      "countryCode": "HT",
      "remark": null,
      "productList": [
        {
          "id": 1,
          "productionDate": "2020-01-14",
          "postingDate": "2020-01-14",
          "product": {
            "id": 632,
            "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,
            "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,
            "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,
            "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,
            "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,
            "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",
            "middleName": "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
          }
        ],
        "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
      },
      "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,
            "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,
            "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,
            "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,
            "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,
            "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,
            "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,
            "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": []
        }
      ]
    }
  ]
}