/
Proforma

Proforma

Owned by David Garcerán
Last updated: Apr 29, 2024 by Jordi Artal

Structure

FieldTypeRequiredDescription
customerCustomertrueCustomer related to this Proforma.
nameStringtrueName of the customer.
taxIdStringfalseTaxId if the customer is a company.
streetStringtrueStreet from the address of the customer.
cityStringtrueCity of the customer.
stateProvNameStringfalseName of the State/Province of the customer.
stateProvCodeStringfalseState/Province of the customer. ISO 3166-2
municipalityNameStringfalseMunicipality name.
municipalityCodeStringfalseMunicipality code.
postalCodeStringtruePostal code of the customer.
countryCodeStringtrueCountry of the customer. ISO 3166-1 alpha-2
remarkStringfalse
channelChanneltrueChannel related to this Proforma.
sourceSourcetrueSource related to this Proforma.
segmentSegmenttrueSegment related to this Proforma.
businessDateLocalDatefalse
proformaProductListList of ProformaProduct.falseThe products associated to this Proforma.
nonTaxableBooleantrueIf is nonTaxable, taxes can not be applied.
totalBigDecimalfalseTotal amount.
paidBigDecimalfalsePaid amount.
balanceBigDecimalfalseTotal minus paid.

JSON representation

{
	"customer": {
		"id": 416,
		"name": "Anne Lóng Alvarez"
	},
	"name": "Anne Lóng Alvarez",
	"taxId": null,
	"street": "296 Ridge Oak Alley",
	"city": "Tyler",
	"stateProvName": null,
	"stateProvCode": null,
    "municipalityName": "Agurain/Salvatierra",
    "municipalityCode": "051",
	"postalCode": "75710",
	"countryCode": "ES",
	"remark": null,
	"channel": {
		"id": 77,
		"code": "WEBM",
		"name": "Booking Engine Mobile"
	},
	"source": {
		"id": 62,
		"code": "EMA",
		"name": "Email"
	},
	"segment": {
		"id": 167,
		"code": "FAM",
		"name": "Family"
	},
	"businessDate": null,
	"proformaProductList": [{
			"postingDate": "2019-06-28",
			"quantity": 1,
			"product": {
				"id": 107,
	 			"code":"JS",
				"name": "Junior Suite",
				"productType": {
					"id": 1,
					"code": "ACC",
					"name": "Accommodation"
				}
			},
			"name": "Junior Suite",
			"amountAfterTax": 308.61,
			"amountBeforeTax": null,
			"currency": {
				"id": 1,
				"code": "EUR",
				"name": "Euro"
			},
			"amountTax": null,
			"amountDiscount": null,
			"amountCommission": null,
			"rate": {
				"id": 2,
				"code": "BB",
				"name": "Bed And Breakfast"
			},
			"offer": {
				"id": 1,
				"code": "NR",
				"name": "Non Refundable"
			},
			"offerAmountDiscount": 0,
			"offerPercentDiscount": 10,
			"promotion": null,
			"promotionAmountDiscount": null,
			"promotionPercentDiscount": null,
			"channel": {
				"id": 77,
				"code": "WEBM",
				"name": "Booking Engine Mobile"
			},
			"source": {
				"id": 62,
				"code": "EMA",
				"name": "Email"
			},
			"segment": {
				"id": 167,
				"code": "FAM",
				"name": "Family"
			},
			"remark": null,
			"proformaProductTaxList": [{
				"quantity": 1,
				"product": {
					"id": 782,
	 				"code":"TAX10",
					"name": "Tax 10%",
					"productType": {
						"id": 8,
						"code": "TAX",
						"name": "Tax"
					}
				},
				"name": "Tax 10%",
				"price": 28.055455,
				"currency": {
					"id": 1,
					"code": "EUR",
					"name": "Euro"
				},
				"amount": null,
				"percentage": 10
			}],
			"proformaProductCommissionList": [{
				"company": {
					"id": 159,
					"name": "Ctrip"
				},
				"quantity": 1,
				"product": {
					"id": 812,
	 	 			"code":"CM",
					"name": "Commission",
					"productType": {
						"id": 6,
						"code": "COM",
						"name": "Commission"
					}
				},
				"name": "Commission",
				"price": 64.8081,
				"currency": {
					"id": 1,
					"code": "EUR",
					"name": "Euro"
				},
				"amount": null,
				"percentage": 21
			}],
			"proformaProductDiscountList": [{
				"company": {
					"id": 107,
					"name": "96Dabfeed"
				},
				"quantity": 1,
				"product": {
					"id": 827,
	 	 			"code":"DS",
					"name": "Discount",
					"productType": {
						"id": 7,
						"code": "DIS",
						"name": "Discount"
					}
				},
				"name": "Discount",
				"price": 30.861,
				"currency": {
					"id": 1,
					"code": "EUR",
					"name": "Euro"
				},
				"amount": null,
				"percentage": 10
			}]
		},
		{
			"postingDate": "2019-06-28",
			"quantity": 2,
			"product": {
				"id": 737,
 	 			"code":"CTB",
				"name": "City Tax Barcelona",
				"productType": {
					"id": 9,
					"code": "FEE",
					"name": "Fee"
				}
			},
			"name": "City Tax Barcelona",
			"amountAfterTax": 2.7,
			"amountBeforeTax": null,
			"currency": null,
			"amountTax": null,
			"amountDiscount": null,
			"amountCommission": null,
			"rate": {
				"id": 2,
				"code": "BB",
				"name": "Bed And Breakfast"
			},
			"offer": {
				"id": 1,
				"code": "NR",
				"name": "Non Refundable"
			},
			"offerAmountDiscount": 0,
			"offerPercentDiscount": 10,
			"promotion": null,
			"promotionAmountDiscount": null,
			"promotionPercentDiscount": null,
			"channel": {
				"id": 77,
				"code": "WEBM",
				"name": "Booking Engine Mobile"
			},
			"source": {
				"id": 62,
				"code": "EMA",
				"name": "Email"
			},
			"segment": {
				"id": 167,
				"code": "FAM",
				"name": "Family"
			},
			"remark": null,
			"proformaProductTaxList": null,
			"proformaProductCommissionList": null,
			"proformaProductDiscountList": null
		},
		{
			"postingDate": "2019-06-28",
			"quantity": 1,
			"product": {
				"id": 392,
 	 			"code":"TV",
				"name": "Television",
				"productType": {
					"id": 2,
					"code": "SER",
					"name": "Service"
				}
			},
			"name": "Television",
			"amountAfterTax": 10,
			"amountBeforeTax": null,
			"currency": {
				"id": 1,
				"code": "EUR",
				"name": "Euro"
			},
			"amountTax": null,
			"amountDiscount": null,
			"amountCommission": null,
			"rate": null,
			"offer": null,
			"offerAmountDiscount": null,
			"offerPercentDiscount": null,
			"promotion": null,
			"promotionAmountDiscount": null,
			"promotionPercentDiscount": null,
			"channel": {
				"id": 77,
				"code": "WEBM",
				"name": "Booking Engine Mobile"
			},
			"source": {
				"id": 62,
				"code": "EMA",
				"name": "Email"
			},
			"segment": {
				"id": 167,
				"code": "FAM",
				"name": "Family"
			},
			"remark": null,
			"proformaProductTaxList": [{
				"quantity": 1,
				"product": {
					"id": 797,
	 	 			"code":"TAX21",
					"name": "Tax 21%",
					"productType": {
						"id": 8,
						"code": "TAX",
						"name": "Tax"
					}
				},
				"name": "Tax 21%",
				"price": 1.735537,
				"currency": {
					"id": 1,
					"code": "EUR",
					"name": "Euro"
				},
				"amount": null,
				"percentage": 21
			}],
			"proformaProductCommissionList": null,
			"proformaProductDiscountList": null
		},
		{
			"postingDate": "2019-06-28",
			"quantity": 1,
			"product": {
				"id": 362,
 	 			"code":"HST",
				"name": "Hostess",
				"productType": {
					"id": 2,
					"code": "SER",
					"name": "Service"
				}
			},
			"name": "Hostess",
			"amountAfterTax": 10,
			"amountBeforeTax": null,
			"currency": {
				"id": 1,
				"code": "EUR",
				"name": "Euro"
			},
			"amountTax": null,
			"amountDiscount": null,
			"amountCommission": null,
			"rate": null,
			"offer": null,
			"offerAmountDiscount": null,
			"offerPercentDiscount": null,
			"promotion": null,
			"promotionAmountDiscount": null,
			"promotionPercentDiscount": null,
			"channel": {
				"id": 77,
				"code": "WEBM",
				"name": "Booking Engine Mobile"
			},
			"source": {
				"id": 62,
				"code": "EMA",
				"name": "Email"
			},
			"segment": {
				"id": 167,
				"code": "FAM",
				"name": "Family"
			},
			"remark": null,
			"proformaProductTaxList": [{
				"quantity": 1,
				"product": {
					"id": 797,
	 	 			"code":"TAX21",
					"name": "Tax 21%",
					"productType": {
						"id": 8,
						"code": "TAX",
						"name": "Tax"
					}
				},
				"name": "Tax 21%",
				"price": 1.735537,
				"currency": {
					"id": 1,
					"code": "EUR",
					"name": "Euro"
				},
				"amount": null,
				"percentage": 21
			}],
			"proformaProductCommissionList": null,
			"proformaProductDiscountList": null
		}
	],
	"totalAmountAfterTax": null,
	"totalAmountBeforeTax": null,
	"totalAmountTax": null,
	"totalAmountDiscount": null,
	"totalAmountCommission": null,
	"nonTaxable": null,
	"total": 331.31,
	"paid": 0,
	"balance": 331.31
}

Related content