Versions Compared

Key

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

Operation

Returns a single invoice with the specified ID. Also adds the owner of the entity, the invoice due date and the receipts if they exist in the product list.

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/{invoiceId}



Request

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


Example request

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



Response

Insert excerpt
Invoice
Invoice
nopaneltrue

Example response

Code Block
themeDJango
{
	"id": 33841,
	"invoiceSeriesequence": "IN",
	"invoiceNumber": 82,
	"invoiceSource": {
		"id": 102,
	21312,
	"invoiceSerie": "INA15",
		"invoiceNumber": 80,
		"invoiceSource": null100000,
		"invoiceDate": "20212019-01-2521",
		"companyinvoiceDueDate": null,
		"customercompany": {
			"id": 1461null,
			"name": "Marie-ève Bailey, Mary",
			"customerDocumentList": [{
		customer": {
		"id": 186,
				"primary": true,
				"documentType": {
					"id": 2,
					"code": "P"8,
					"name": "Passport",
					"nameI18n": "Passport"
				},
				"number": "QIhvzJUU",
				"givenName": "Mary",
				"surName": "Marie-ève",
				"secondSurName": "Bailey",
				"genderType": {
					"id": 2,
					"code": "F",
					"name": "Female",
					"nameI18n": "Female"
				},
				"birthDate": "2003-01-26",
				"birthCountryCode": "CK",
				"birthPlace": "Memphis",
				"effectiveDate": "2020-01-26",
				"expireDate": "2023-01-26",
				"street": "6 Pine View Avenue",
				"city": "Memphis",
				"stateProvName": "Tennessee",
				"stateProvCode": null,
				"countryCode": "CK",
				"postalCode": "38143",
				"nationalityCountryCode": "CK",
				"countryOfIssuanceCode": "CK",
				"ocr": null,
				"remark": null
			}],
			"customerEmailList": null,
			"customerAddressList": null,
			"customerPhoneList": null,
			"remark": null,
			"profileType": {
				"code": "1",
				"name": "Customer",
				"nameI18n": "Customer",
				"colorCode": "#757575"
			}
		},
	Denise Naéva Schmidt"
	},
	"travelAgent": null,
		"holderName": "Marie-ève Bailey, MaryDenise Naéva Schmidt",
		"taxId": "QIhvzJUU"null,
		"address": "675865 PineEmmet View AvenueCrossing",
		"city": "MemphisSaginaw",
		"stateProvName": "TennesseeBarcelona",
		"stateProvCode": null"ES-B",
		"postalCode": "3814348604",
		"countryCode": "CKES",
		"remark": null,
		"invoiceType": {
			"id": 6,
			"code": "INFO",
			"name": "InvoiceFactura Ordinaria",
			"description": null,
			"active": true,
			"inactiveReason": null
		},
		"billingType": {
			"id": 31,
			"code": "RERES",
			"name": "ReservationRoomStayReservation",
			"nameI18n": "ReservationRoomStayReservation",
			"colorCode": "#1E88E5#43A047"
		},
	"invoiceSource": null,
	"totalAmountAfterTax": 1761330.000000,
		"totalAmountBeforeTax": 1601211.272727000007,
		"totalAmountTax": 15118.727273999993,
		"totalAmountTaxExempt": 30.000000,
		"totalAmountDiscount": 0.000000,
		"totalAmountCommission": 0.000000,
		"productList": [],{
			"invoiceTaxSummaryListid": null1,
		},
	"invoiceDateproductionDate": "20212019-01-2630",
	"company": null,
	"customer": {
		"idpostingDate": 1461,
		"name": "Marie-ève Bailey, Mary"2019-01-30",
		"customerDocumentList": [{
			"id": 186,
			"primary": true,
			"documentType"	"product": {
				"id": 2431,
				"code": "P",
				"name": "Passport",
				"nameI18n": "Passport"
Cash"
			},
			"numberproductType": "QIhvzJUU",
			"givenName": "Mary",
			"surName": "Marie-ève",
			"secondSurName": "Bailey",
			"genderType": {
				"id":
2,
				"code": "FPAY",
				"name": "FemalePayment",
				"nameI18n": "Female"
			},
			"birthDateproductName": "2003-01-26Cash",
			"birthCountryCodequantity": "CK"1,
			"birthPlaceamountAfterTax": "Memphis"142,
			"effectiveDateamountBeforeTax": "2020-01-26"142,
			"expireDateamountDiscount": "2023-01-26"0,
			"streetamountTax": "6 Pine View Avenue"0,
			"cityamountCommission": "Memphis"0,
			"stateProvNamecurrency": "Tennessee",{
			"stateProvCode": null,
			"countryCodecode": "CKEUR",
				"postalCodename": "38143Euro",
			"nationalityCountryCode": "CK"},
			"countryOfIssuanceCodechannel": "CK"null,
			"ocrsource": null,
			"remarksegment": null,
		}],
		"customerEmailListinvoiceProductTaxList": [{
			"id": 1461],
			"primaryinvoiceProductCommissionList": true[],
			"emailAddressTypeinvoiceProductDiscountList": {[]
				"id": 1},
				"code": "1",{
				"nameid": "Personal"2,
				"nameI18nproductionDate": "Personal"
			}2019-01-30",
			"emailpostingDate": "mrichardsn1@spiegel.de2019-01-30",
			"remark": null
		}],
		"customerAddressList": [{
			"id": 1461,
			"primary": true,
			"communicationLocationType": product": {
				"id": 1530,
				"code": "1",
				"name": "Home",
				"nameI18n": "HomeDeposit 21"
			},
			"streetproductType": "6 Pine View Avenue",
{
			"city": "Memphis",
			"stateProvNamecode": "TennesseeDEP",
			"stateProvCode": null,
			"postalCodename": "38143Deposit",
			"countryCode": "CK"},
			"remarkproductName": null
		}], 		"customerPhoneList": [{
			"id": 1461Deposit 21",
			"primaryquantity": true1,
			"phoneLocationTypeamountAfterTax": {142,
				"idamountBeforeTax": 6142,
				"codeamountDiscount": "6"0,
				"nameamountTax": "Home"0,
				"nameI18namountCommission": "Home"
			}0,
			"phoneTechTypecurrency": {
				"id": 1,
				"code": "1EUR",
				"name": "VoiceEuro",
				"nameI18n": "Voice"
			},
			"countryAccessCodechannel": null,
			"areaCityCodesource": null,
			"phoneNumber": "1-(901)824-6880",
			"extension"segment": null,
			"remarkinvoiceProductTaxList": null
		}[],
		"remark": null,
		"profileTypeinvoiceProductCommissionList": {
			"code": "1"[],
			"nameinvoiceProductDiscountList": "Customer",
			"nameI18n": "Customer",
			"colorCode": "#757575"
		[]
		}
	}],
	"travelAgentinvoiceTaxSummaryList": null,
	"holderNamefolioInvoiceOwner": "Marie-ève Bailey, Mary",
	"taxId": "QIhvzJUU",
	"address": "6 Pine View Avenue",
	"city": "Memphis",
	"stateProvName": "Tennessee",
	"stateProvCode": null,
	"postalCode": "38143",
	"countryCode": "CK",
	"remark{
		"reservation": null,
		"reservationRoomStay": null,
		"reservationGroup": null,
	"invoiceType": {
		"iddeposit": 6null,
		"code": "IN",
		"name": "Invoice",
		"description"customer": null,
		"activecompany": true,{
		"inactiveReason": null
	},
	"billingType": {
		"id": 322,
		"code": "RE",
		"name": "ReservationRoomStay",
		"nameI18n": "ReservationRoomStay"Tesipro MAD",
		"colorCode": "#1E88E5"
	},
	"totalAmountAfterTaxcode": 176.000000,
	"totalAmountBeforeTax": 160.272727"TESMA",
	"totalAmountTax": 15.727273,
	"totalAmountTaxExempt": 3.000000,
	"totalAmountDiscounttaxId": 0.000000,
	"totalAmountCommission": 0.000000"ABCDE",
	"productList": [{
		"idcompanyEmailList": 51197null,
		"productionDate": "2021-01-26",
		"postingDatecompanyAddressList": "2021-01-26",[{
		"product": {
			"id": 67722,
				"codeprimary": "DBL"true,
			"name": "Double",
			"productTypecommunicationLocationType": {
					"id": 1,
					"code": "ACC1",
					"name": "AccommodationHome",
					"nameI18n": "AccommodationHome"
			}
		},
		"quantity": 1,
		"amountAfterTaxstreet": 120.000000, 		"amountBeforeTax": 109.090909,
		"amountDiscount": 0.000000,
		"amountTax": 10.9090919 Weeping Birch Crossing",
		"amountCommission": 0.000000,
		"currencycity": { 			"idOrange": 1,
				"codestateProvName": "EURSoria",
				"namestateProvCode": "EuroES-SO",
				"nameI18npostalCode": "Euro92862",
				"symbolcountryCode": "ES",
				"decimalPlacesremark": 2
		},
		"channel": {
			"id": 8"Address Remark"
			}],
			"codecompanyPhoneList": "GDS"null,
			"namecompanyTaxAddress": "Global Distribution System"
{
		},
		"sourceid": {3,
				"idcommunicationLocationType": 13null,
				"codestreet": "PHO",
			"name": "Phone"9 Weeping Birch Crossing",
		},
		"segmentcity": { 			"idOrange": 22,
				"codestateProvName": "CRUCáceres",
				"namestateProvCode": "CruiseES-CC",
		},
		"invoiceProductTaxListpostalCode": [{ 			"id92862": 40409,
				"taxcountryCode": { 				"idES": 46,
				"nameremark": "TaxAddress 10%Remark"
			},
			"nameremark": "TaxCompany 10%Remarks",
			"amountassignedUser": 0.000000null,
			"percentageOfTaxprofileType": 10.000000,null
			"amountOfTax": 0.000000
		}],
		"invoiceProductCommissionListtravelAgent": [],
		"invoiceProductDiscountList": []null

	}],
	"invoiceTaxSummaryList": null
}