Invoice

Structure

FieldTypeRequiredDescription
idIntegertrueUnique identifier for the InvoiceProduct.
sequenceIntegertrue
invoiceSerieStringtrueSerie of the Invoice
invoiceNumberIntegertrueNumber of the Invoice
invoiceSourceInvoicefalse
invoiceDateLocalDatetrueDate of the Invoice
companyCompanyfalseCompany of this Invoice
customerCustomerfalseCustomer of this Invoice
travelAgentTravelAgentfalseTravelAgent of this Invoice
holderNameStringtrueName of the holder
taxIdStringfalse
addressStringfalse
cityStringfalse
stateProvNameStringfalse
stateProvCodeStringfalseISO 3166-2
municipalityNameStringfalseMunicipality name.
municipalityCodeStringfalseMunicipality code.
postalCodeStringfalse
countryCodeStringfalseISO 3166-1 alpha-2
remarkStringfalse

invoiceType

InvoiceType

false

billingType

BillingType

false
totalAmountAfterTaxBigDecimaltrue
totalAmountBeforeTaxBigDecimaltrue
totalAmountTaxBigDecimaltrue
totalAmountTaxExemptBigDecimaltrueTotal amount exempt of tax in a given invoice
totalAmountDiscountBigDecimaltrue
totalAmountCommissionBigDecimaltrue
productListArray of InvoiceProduct elementstrueInvoiceProduct list related to this Invoice
invoiceTaxSummaryListArray of InvoiceTaxSummaryfalse
reservationSummaryReservationSummary

reservationRoomStaySummaryReservationRoomStaySummary

reservationGroupReservationGroup

depositDeposit

minimumTicketNumberStringfalse
maximumTicketNumberStringfalse


invoiceDescriptionString
Free text description of the invoice.

JSON representation

{
	"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",
	"municipalityName": "Agurain/Salvatierra",
    "municipalityCode": "051",
	"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,
	"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,
	"reservationSummary":null,
	"reservationRoomStaySummary":null,
	"reservationGroup":null,
	"deposit":null,
	"minimumTicketNumber":null,
	"maximumTicketNumber":null,
	"invoiceDescription": "Hoteleria y Restauración"
}