Invoice By Id [GET]

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.

GET

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

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.
invoiceId	Integer	true	path parameter		Unique identificator of the invoice.
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/1

Response

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

{
	"id": 1,
	"sequence": 21312,
	"invoiceSerie": "A15",
	"invoiceNumber": 100000,
	"invoiceDate": "2019-01-21",
	"invoiceDueDate": null,
	"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",
	"stateProvName": "Barcelona",
	"stateProvCode": "ES-B",
	"postalCode": "48604",
	"countryCode": "ES",
	"remark": null,
	"invoiceType": {
		"id": 6,
		"code": "FO",
		"name": "Factura Ordinaria",
		"description": null,
		"active": true,
		"inactiveReason": null
	},
	"billingType": {
		"id": 1,
		"code": "RES",
		"name": "Reservation",
		"nameI18n": "Reservation",
		"colorCode": "#43A047"
	},
	"invoiceSource": null,
	"totalAmountAfterTax": 1330.000000,
	"totalAmountBeforeTax": 1211.000007,
	"totalAmountTax": 118.999993,
	"totalAmountTaxExempt": 0.000000,
	"totalAmountDiscount": 0.000000,
	"totalAmountCommission": 0.000000,
	"minimumTicketNumber": null,
    "maximumTicketNumber": 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": []
		}
	],
	"invoiceTaxSummaryList": null,
	"folioInvoiceOwner": {
		"reservation": null,
		"reservationRoomStay": null,
		"reservationGroup": null,
		"deposit": null,
		"customer": null,
		"company": {
			"id": 22,
			"name": "Tesipro MAD",
			"code": "TESMA",
			"taxId": "ABCDE",
			"companyEmailList": null,
			"companyAddressList": [{
				"id": 22,
				"primary": true,
				"communicationLocationType": {
					"id": 1,
					"code": "1",
					"name": "Home",
					"nameI18n": "Home"
				},
				"street": "9 Weeping Birch Crossing",
				"city": "Orange",
				"stateProvName": "Soria",
				"stateProvCode": "ES-SO",
				"postalCode": "92862",
				"countryCode": "ES",
				"remark": "Address Remark"
			}],
			"companyPhoneList": null,
			"companyTaxAddress": {
				"id": 3,
				"communicationLocationType": null,
				"street": "9 Weeping Birch Crossing",
				"city": "Orange",
				"stateProvName": "Cáceres",
				"stateProvCode": "ES-CC",
				"postalCode": "92862",
				"countryCode": "ES",
				"remark": "Address Remark"
			},
			"remark": "Company Remarks",
			"assignedUser": null,
			"profileType": null
		},
		"travelAgent": null

	}
}

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.