Folio

Structure

ReservationRoomStaySummary

FieldTypeRequiredDescription
idinttrueUnique identifier for the Product.
codestringfalseCode of the folio
sequenceinttrueSequence of the folio
serieinttrueNumbered serie of the Folio.
namestringtrueName of the Folio.
folioTypestringtrueType of the Folio.
roomRoomfalseRoom where the Folio is linked to.
reservationRoomStaySummaryReservationRoomStaySummaryfalseReservationRoomStay where the Folio is linked to.
reservationSummaryReservationSummaryfalse
reservationGroupReservationGroupfalse
companyCompanyfalse
customerCustomerfalse
travelAgentTravelAgentfalse
depositDepositfalse
paidAmountBigDecimalfalse
balanceAmountBigDecimalfalse
totalAmountBigDecimalfalse

JSON representation

 {
	"id": 155,
	"code": "105",
	"serie": 1,
	"name": "Skinder",
	"folioType": {
		"id": 1,
		"code": "M",
		"name": "Main",
		"nameI18n": "Main"
	},
	"room": {
		"id": 5,
		"code": "105",
		"name": "105",
		"roomSpaceStatusType": {
			"id": 2,
			"code": "DI",
			"name": "Dirty",
			"nameI18n": "Dirty"
		},
		"reservationRoomStay": null,
		"roomSituationType": {
			"id": 2,
			"code": "OC",
			"name": "Occupied",
			"nameI18n": "Occupied"
		}
	},
	"reservationRoomStaySummary": {
		"id": 70,
		"reservationRoomStay": null,
		"reservationRoomStayId": 70,
		"reservation": null,
		"reservationId": 48,
		"pmsLocator": "ALI00000048/70",
		"crsLocator": null,
		"otaLocator": null,
		"cmLocator": null,
		"holder": "Salomé Olson, Phyllis",
		"arrival": "2020-10-31",
		"departure": "2020-11-15",
		"nights": 15,
		"productAccommodation": {
			"id": 767,
			"name": "Suite",
			"roomType": {
				"id": 77,
				"name": "Suite",
				"nameI18n": "Suite",
				"mainImage": "1/2/propertyroomtypeimages/07aabe64-2724-42ac-8161-29d612d6e17c.jpg"
			}
		},
		"productAccommodationUpgrade": null,
		"roomType": {
			"id": 77,
			"name": "Suite",
			"nameI18n": "Suite",
			"mainImage": "1/2/propertyroomtypeimages/07aabe64-2724-42ac-8161-29d612d6e17c.jpg"
		},
		"adult": 2,
		"junior": 0,
		"child": 0,
		"infant": 0,
		"extraBed": 0,
		"extraCot": 0,
		"board": {
			"id": 8,
			"code": "FB",
			"name": "FullBoard",
			"serviceList": [{
					"id": 63,
					"code": "BRK",
					"name": "Breakfast"
				},
				{
					"id": 67,
					"code": "LUNCH",
					"name": "Lunch"
				},
				{
					"id": 68,
					"code": "DINNER",
					"name": "Dinner"
				}
			]
		},
		"guest": "MÃ¥ns Woods, James",
		"allotment": null,
		"rate": {
			"id": 2,
			"code": "BAR",
			"name": "Best Available Rate"
		},
		"offer": null,
		"promotion": null,
		"accommodationAmount": 4620.000000,
		"boardAmount": 2730.000000,
		"serviceAmount": 0.000000,
		"totalAmount": 7350.000000,
		"totalPaid": 7250.000000,
		"balance": 100.000000,
		"currency": {
			"id": 1,
			"code": "EUR",
			"name": "Euro",
			"nameI18n": "Euro"
		},
		"booker": {
			"id": 860,
			"name": "Tagchat",
			"code": "TAGCH",
			"taxId": "49510847",
			"companyEmailList": [{
				"id": 860,
				"primary": true,
				"emailAddressType": {
					"id": 1,
					"code": "1",
					"name": "Personal",
					"nameI18n": "Personal"
				},
				"email": "rpattersonni@state.gov",
				"remark": null
			}],
			"companyAddressList": [{
				"id": 860,
				"primary": true,
				"communicationLocationType": {
					"id": 1,
					"code": "1",
					"name": "Home",
					"nameI18n": "Home"
				},
				"street": "4796 Iowa Crossing",
				"city": "Grand Rapids",
				"stateProvName": "Huesca",
				"stateProvCode": "ES-HU",
				"postalCode": "49510",
				"countryCode": "ES",
				"remark": "Address Remark"
			}],
			"companyPhoneList": [{
				"id": 860,
				"primary": true,
				"phoneLocationType": {
					"id": 6,
					"code": "6",
					"name": "Home",
					"nameI18n": "Home"
				},
				"phoneTechType": {
					"id": 1,
					"code": "1",
					"name": "Voice",
					"nameI18n": "Voice"
				},
				"countryAccessCode": "+34",
				"areaCityCode": "B",
				"phoneNumber": "1-(616)551-2913",
				"extension": "1",
				"remark": "Phone Remark"
			}],
			"companyTaxAddress": {
				"id": 850,
				"communicationLocationType": null,
				"street": "4796 Iowa Crossing",
				"city": "Grand Rapids",
				"stateProvName": "Madrid",
				"stateProvCode": "ES-M",
				"postalCode": "49510",
				"countryCode": "ES",
				"remark": "Address Remark"
			},
			"remark": "Company Remarks",
			"assignedUser": null
		},
		"billTo": {
			"id": 789,
			"name": "Skinder",
			"code": "SKIND1",
			"taxId": "28215776",
			"companyEmailList": [{
				"id": 789,
				"primary": true,
				"emailAddressType": {
					"id": 1,
					"code": "1",
					"name": "Personal",
					"nameI18n": "Personal"
				},
				"email": "sjacksonlj@rakuten.co.jp",
				"remark": null
			}],
			"companyAddressList": [{
				"id": 789,
				"primary": true,
				"communicationLocationType": {
					"id": 1,
					"code": "1",
					"name": "Home",
					"nameI18n": "Home"
				},
				"street": "231 Oneill Way",
				"city": "Charlotte",
				"stateProvName": "North Carolina",
				"stateProvCode": null,
				"postalCode": "28215",
				"countryCode": "MT",
				"remark": "Address Remark"
			}],
			"companyPhoneList": [{
				"id": 789,
				"primary": true,
				"phoneLocationType": {
					"id": 6,
					"code": "6",
					"name": "Home",
					"nameI18n": "Home"
				},
				"phoneTechType": {
					"id": 1,
					"code": "1",
					"name": "Voice",
					"nameI18n": "Voice"
				},
				"countryAccessCode": "+34",
				"areaCityCode": "B",
				"phoneNumber": "1-(704)134-5395",
				"extension": "1",
				"remark": "Phone Remark"
			}],
			"companyTaxAddress": {
				"id": 779,
				"communicationLocationType": null,
				"street": "231 Oneill Way",
				"city": "Charlotte",
				"stateProvName": "North Carolina",
				"stateProvCode": null,
				"postalCode": "28215",
				"countryCode": "KE",
				"remark": "Address Remark"
			},
			"remark": "Company Remarks",
			"assignedUser": null
		},
		"central": {
			"id": 443,
			"name": "Dynava",
			"code": "DYNAV5",
			"taxId": "93386430",
			"companyEmailList": [{
				"id": 443,
				"primary": true,
				"emailAddressType": {
					"id": 1,
					"code": "1",
					"name": "Personal",
					"nameI18n": "Personal"
				},
				"email": "blewisbx@lulu.com",
				"remark": null
			}],
			"companyAddressList": [{
				"id": 443,
				"primary": true,
				"communicationLocationType": {
					"id": 1,
					"code": "1",
					"name": "Home",
					"nameI18n": "Home"
				},
				"street": "69 Morningstar Drive",
				"city": "Bakersfield",
				"stateProvName": "California",
				"stateProvCode": null,
				"postalCode": "93386",
				"countryCode": "SZ",
				"remark": "Address Remark"
			}],
			"companyPhoneList": [{
				"id": 443,
				"primary": true,
				"phoneLocationType": {
					"id": 6,
					"code": "6",
					"name": "Home",
					"nameI18n": "Home"
				},
				"phoneTechType": {
					"id": 1,
					"code": "1",
					"name": "Voice",
					"nameI18n": "Voice"
				},
				"countryAccessCode": "+34",
				"areaCityCode": "B",
				"phoneNumber": "1-(661)147-6366",
				"extension": "1",
				"remark": "Phone Remark"
			}],
			"companyTaxAddress": {
				"id": 433,
				"communicationLocationType": null,
				"street": "69 Morningstar Drive",
				"city": "Bakersfield",
				"stateProvName": "California",
				"stateProvCode": null,
				"postalCode": "93386",
				"countryCode": "TM",
				"remark": "Address Remark"
			},
			"remark": "Company Remarks",
			"assignedUser": null
		},
		"company": {
			"id": 1151,
			"name": "Jumia Travel",
			"code": "JUMTR",
			"taxId": "475b6dca-bffc-42c2-8c55-4d47bb5d7c1d",
			"companyEmailList": [{
				"id": 1151,
				"primary": true,
				"emailAddressType": {
					"id": 1,
					"code": "1",
					"name": "Personal",
					"nameI18n": "Personal"
				},
				"email": "cfoxit@apple.com",
				"remark": null
			}],
			"companyAddressList": [{
				"id": 1151,
				"primary": true,
				"communicationLocationType": {
					"id": 1,
					"code": "1",
					"name": "Home",
					"nameI18n": "Home"
				},
				"street": "02 Hayes Pass",
				"city": "Charlotte",
				"stateProvName": "North Carolina",
				"stateProvCode": null,
				"postalCode": "28220",
				"countryCode": "TJ",
				"remark": "Address Remark"
			}],
			"companyPhoneList": [{
				"id": 1151,
				"primary": true,
				"phoneLocationType": {
					"id": 6,
					"code": "6",
					"name": "Home",
					"nameI18n": "Home"
				},
				"phoneTechType": {
					"id": 1,
					"code": "1",
					"name": "Voice",
					"nameI18n": "Voice"
				},
				"countryAccessCode": "+34",
				"areaCityCode": "B",
				"phoneNumber": "1-(704)295-6820",
				"extension": "1",
				"remark": "Phone Remark"
			}],
			"companyTaxAddress": null,
			"remark": "Company Agency",
			"assignedUser": null
		},
		"room": {
			"id": 5,
			"code": "105",
			"name": "105",
			"roomSpaceStatusType": {
				"id": 2,
				"code": "DI",
				"name": "Dirty",
				"nameI18n": "Dirty"
			},
			"reservationRoomStay": null,
			"roomSituationType": {
				"id": 2,
				"code": "OC",
				"name": "Occupied",
				"nameI18n": "Occupied"
			}
		},
		"paymentType": {
			"id": 4,
			"code": "AA",
			"name": "Pay Agency Agency",
			"nameI18n": "Pay Agency Agency"
		},
		"propertyPolicy": {
			"id": 12,
			"code": "24H",
			"name": "24 Hours 1 Night"
		},
		"propertySource": {
			"id": 9,
			"code": "COM",
			"name": "Company"
		},
		"propertyChannel": {
			"id": 9,
			"code": "IDS",
			"name": "Internet Distribution System"
		},
		"propertySegment": {
			"id": 21,
			"code": "CONV",
			"name": "Conventions"
		},
		"reservationStatusType": {
			"id": 4,
			"code": "IH",
			"name": "InHouse",
			"nameI18n": "InHouse",
			"colorCode": "#64b5f6"
		},
		"expiredDate": null,
		"hasCredit": true,
		"creditAvailable": null
	},
	"reservationSummary":null,
	"reservationGroup": null,
	"company": {
		"id": 789,
		"name": "Skinder",
		"code": "SKIND1",
		"taxId": "28215776",
		"companyEmailList": [{
			"id": 789,
			"primary": true,
			"emailAddressType": {
				"id": 1,
				"code": "1",
				"name": "Personal",
				"nameI18n": "Personal"
			},
			"email": "sjacksonlj@rakuten.co.jp",
			"remark": null
		}],
		"companyAddressList": [{
			"id": 789,
			"primary": true,
			"communicationLocationType": {
				"id": 1,
				"code": "1",
				"name": "Home",
				"nameI18n": "Home"
			},
			"street": "231 Oneill Way",
			"city": "Charlotte",
			"stateProvName": "North Carolina",
			"stateProvCode": null,
			"postalCode": "28215",
			"countryCode": "MT",
			"remark": "Address Remark"
		}],
		"companyPhoneList": [{
			"id": 789,
			"primary": true,
			"phoneLocationType": {
				"id": 6,
				"code": "6",
				"name": "Home",
				"nameI18n": "Home"
			},
			"phoneTechType": {
				"id": 1,
				"code": "1",
				"name": "Voice",
				"nameI18n": "Voice"
			},
			"countryAccessCode": "+34",
			"areaCityCode": "B",
			"phoneNumber": "1-(704)134-5395",
			"extension": "1",
			"remark": "Phone Remark"
		}],
		"companyTaxAddress": {
			"id": 779,
			"communicationLocationType": null,
			"street": "231 Oneill Way",
			"city": "Charlotte",
			"stateProvName": "North Carolina",
			"stateProvCode": null,
			"postalCode": "28215",
			"countryCode": "KE",
			"remark": "Address Remark"
		},
		"remark": "Company Remarks",
		"assignedUser": null
	},
	"customer": null,
	"travelAgent": null,
	"deposit": null,
	"paidAmmount":null,
	"balanceAmount":null, 
	"totalAmount":null
}