--- title: Occupancy Based Rates slug: _ONN-occupancy-based-rates createdAt: 2025-09-10T11:52:05.061Z --- :::ApiMethodV2 ```json { "name": "Occupancy Based Rates Update", "method": "POST", "url": "https://api.bakuun.com/ratedockAPI/agent/v2/updateoccuraterq", "description": "", "tab": "examples", "examples": { "languages": [ { "id": "F6DFMY8yp37HbzLk13k1v", "language": "json", "code": "{\n \"password\": \"XXXXX\",\n \"username\": \"XXXXX\",\n \"hotelId\": \"string\",\n \"startDateYmd\": \"YYYY-MM-DD\",\n \"endDateYmd\": \"YYYY-MM-DD\",\n \"action\": \"occPriceUpdate\",\n \"dailyRates\": [\n {\n \"roomCode\": \"string\",\n \"condCode\": \"string\",\n \"rateDiscount\": \"10.5\",\n \"rateModel\": \"OBP\",\n \"cancelPolicy\": \"Not Refundable\",\n \"currencyCode\": \"USD\",\n \"priceDetails\": [\n {\n \"rateType\": \"NET\",\n \"amountAfterTax\": \"7876.00\",\n \"amountBeforeTax\": \"7876.00\",\n \"occupancy\": {\n \"adultCount\": 22,\n \"childCount\": [\n {\n \"count\": 1,\n \"minAge\": \"0\",\n \"maxAge\": \"0\",\n \"costDetails\": {\n \"unit\": \"currency\",\n \"amountBeforeTax\": \"10.00\",\n \"amountAfterTax\": \"10.00\",\n \"taxDetails\": {\n \"Before\": {\n \"taxType\": \"VAT\",\n \"taxValue\": \"10.00\",\n \"included\": \"0\"\n },\n \"After\": {\n \"taxType\": \"VAT\",\n \"taxValue\": \"10.00\",\n \"included\": \"0\"\n }\n }\n }\n }\n ],\n \"infantCount\": []\n },\n \"taxFeeDetails\": {\n \"Before\": {\n \"tax\": {\n \"taxType\": \"VAT\",\n \"taxValue\": \"10.00\",\n \"included\": \"0\"\n },\n \"fees\": {\n \"feeType\": \"per night\",\n \"feeValue\": \"200.00\",\n \"included\": \"0\"\n },\n \"offers\": {\n \"offerType\": \"no offer\",\n \"offerValue\": \"\"\n }\n },\n \"After\": {\n \"tax\": {\n \"taxType\": \"VAT\",\n \"taxValue\": \"10.00\",\n \"included\": \"0\"\n },\n \"fees\": {\n \"feeType\": \"per night\",\n \"feeValue\": \"200.00\",\n \"included\": \"0\"\n },\n \"offers\": {\n \"offerType\": \"no offer\",\n \"offerValue\": \"\"\n }\n }\n }\n }\n ]\n }\n ]\n}", "customLabel": "" }, { "id": "TRTEEAXWvdQwSMMlA-2mg", "language": "curl", "code": "curl --location 'https://api.bakuun.com/ratedockAPI/agent/v2/updateoccuraterq' \\\n--header 'Accept: application/json' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"username\": \"String\",\n \"password\": \"String\",\n \"hotelId\": \"String\",\n \"startDateYmd\": \"String\",\n \"endDateYmd\": \"String\",\n \"action\": \"String\",\n \"dailyRates\": {\n \"roomCode\": \"\",\n \"condCode\": \"\",\n \"currencyCode\": \"\",\n \"priceDetails\": {\n \"amountBeforeTax\": \"\",\n \"amountAfterTax\": \"\",\n \"occupancy\": {\n \"adultCount\": \"\",\n \"childCount\": {\n \"count\": \"\",\n \"minAge\": \"\",\n \"maxAge\": \"\",\n \"costDetails\": {\n \"unit\": \"\",\n \"amountBeforeTax\": \"\",\n \"amountAfterTax\": \"\",\n \"taxDetails\": {\n \"Before\": {\n \"taxType\": \"\",\n \"taxValue\": \"\",\n \"included\": \"\"\n },\n \"After\": {\n \"taxType\": \"\",\n \"taxValue\": \"\",\n \"included\": \"\"\n }\n }\n }\n },\n \"infantCount\": {\n \"count\": \"\",\n \"minAge\": \"\",\n \"maxAge\": \"\",\n \"costDetails\": {\n \"unit\": \"\",\n \"amountBeforeTax\": \"\",\n \"amountAfterTax\": \"\",\n \"taxDetails\": {\n \"Before\": {\n \"taxType\": \"\",\n \"taxValue\": \"\",\n \"included\": \"\"\n },\n \"After\": {\n \"taxType\": \"\",\n \"taxValue\": \"\",\n \"included\": \"\"\n }\n }\n }\n }\n },\n \"rateType\": \"\",\n \"taxFeeDetails\": {\n \"Before\": {\n \"tax\": {\n \"taxType\": \"\",\n \"taxValue\": \"\",\n \"included\": \"\"\n },\n \"fees\": {\n \"feeType\": \"\",\n \"feeValue\": \"\",\n \"included\": \"\"\n },\n \"offers\": {\n \"offerType\": \"\",\n \"offerValue\": \"\"\n }\n },\n \"After\": {\n \"tax\": {\n \"taxType\": \"\",\n \"taxValue\": \"\",\n \"included\": \"\"\n },\n \"fees\": {\n \"feeType\": \"\",\n \"feeValue\": \"\",\n \"included\": \"\"\n },\n \"offers\": {\n \"offerType\": \"\",\n \"offerValue\": \"\"\n }\n }\n }\n },\n \"rateDiscount\": \"\",\n \"rateModel\": \"\",\n \"cancelPolicy\": \"\"\n }\n}'", "customLabel": "" }, { "id": "dcMV3mEXoiY-d-CnD2c6i", "language": "nodejs", "code": "var request = require('request');\nvar options = {\n 'method': 'POST',\n 'url': 'https://api.bakuun.com/ratedockAPI/agent/v2/updateoccuraterq',\n 'headers': {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({\n \"username\": \"String\",\n \"password\": \"String\",\n \"hotelId\": \"String\",\n \"startDateYmd\": \"String\",\n \"endDateYmd\": \"String\",\n \"action\": \"String\",\n \"dailyRates\": {\n \"roomCode\": \"\",\n \"condCode\": \"\",\n \"currencyCode\": \"\",\n \"priceDetails\": {\n \"amountBeforeTax\": \"\",\n \"amountAfterTax\": \"\",\n \"occupancy\": {\n \"adultCount\": \"\",\n \"childCount\": {\n \"count\": \"\",\n \"minAge\": \"\",\n \"maxAge\": \"\",\n \"costDetails\": {\n \"unit\": \"\",\n \"amountBeforeTax\": \"\",\n \"amountAfterTax\": \"\",\n \"taxDetails\": {\n \"Before\": {\n \"taxType\": \"\",\n \"taxValue\": \"\",\n \"included\": \"\"\n },\n \"After\": {\n \"taxType\": \"\",\n \"taxValue\": \"\",\n \"included\": \"\"\n }\n }\n }\n },\n \"infantCount\": {\n \"count\": \"\",\n \"minAge\": \"\",\n \"maxAge\": \"\",\n \"costDetails\": {\n \"unit\": \"\",\n \"amountBeforeTax\": \"\",\n \"amountAfterTax\": \"\",\n \"taxDetails\": {\n \"Before\": {\n \"taxType\": \"\",\n \"taxValue\": \"\",\n \"included\": \"\"\n },\n \"After\": {\n \"taxType\": \"\",\n \"taxValue\": \"\",\n \"included\": \"\"\n }\n }\n }\n }\n },\n \"rateType\": \"\",\n \"taxFeeDetails\": {\n \"Before\": {\n \"tax\": {\n \"taxType\": \"\",\n \"taxValue\": \"\",\n \"included\": \"\"\n },\n \"fees\": {\n \"feeType\": \"\",\n \"feeValue\": \"\",\n \"included\": \"\"\n },\n \"offers\": {\n \"offerType\": \"\",\n \"offerValue\": \"\"\n }\n },\n \"After\": {\n \"tax\": {\n \"taxType\": \"\",\n \"taxValue\": \"\",\n \"included\": \"\"\n },\n \"fees\": {\n \"feeType\": \"\",\n \"feeValue\": \"\",\n \"included\": \"\"\n },\n \"offers\": {\n \"offerType\": \"\",\n \"offerValue\": \"\"\n }\n }\n }\n },\n \"rateDiscount\": \"\",\n \"rateModel\": \"\",\n \"cancelPolicy\": \"\"\n }\n })\n\n};\nrequest(options, function (error, response) {\n if (error) throw new Error(error);\n console.log(response.body);\n});\n", "customLabel": "" }, { "id": "xIXyu4_FlAL18qk1xY_yb", "language": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"Accept\", \"application/json\");\nmyHeaders.append(\"Content-Type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"username\": \"String\",\n \"password\": \"String\",\n \"hotelId\": \"String\",\n \"startDateYmd\": \"String\",\n \"endDateYmd\": \"String\",\n \"action\": \"String\",\n \"dailyRates\": {\n \"roomCode\": \"\",\n \"condCode\": \"\",\n \"currencyCode\": \"\",\n \"priceDetails\": {\n \"amountBeforeTax\": \"\",\n \"amountAfterTax\": \"\",\n \"occupancy\": {\n \"adultCount\": \"\",\n \"childCount\": {\n \"count\": \"\",\n \"minAge\": \"\",\n \"maxAge\": \"\",\n \"costDetails\": {\n \"unit\": \"\",\n \"amountBeforeTax\": \"\",\n \"amountAfterTax\": \"\",\n \"taxDetails\": {\n \"Before\": {\n \"taxType\": \"\",\n \"taxValue\": \"\",\n \"included\": \"\"\n },\n \"After\": {\n \"taxType\": \"\",\n \"taxValue\": \"\",\n \"included\": \"\"\n }\n }\n }\n },\n \"infantCount\": {\n \"count\": \"\",\n \"minAge\": \"\",\n \"maxAge\": \"\",\n \"costDetails\": {\n \"unit\": \"\",\n \"amountBeforeTax\": \"\",\n \"amountAfterTax\": \"\",\n \"taxDetails\": {\n \"Before\": {\n \"taxType\": \"\",\n \"taxValue\": \"\",\n \"included\": \"\"\n },\n \"After\": {\n \"taxType\": \"\",\n \"taxValue\": \"\",\n \"included\": \"\"\n }\n }\n }\n }\n },\n \"rateType\": \"\",\n \"taxFeeDetails\": {\n \"Before\": {\n \"tax\": {\n \"taxType\": \"\",\n \"taxValue\": \"\",\n \"included\": \"\"\n },\n \"fees\": {\n \"feeType\": \"\",\n \"feeValue\": \"\",\n \"included\": \"\"\n },\n \"offers\": {\n \"offerType\": \"\",\n \"offerValue\": \"\"\n }\n },\n \"After\": {\n \"tax\": {\n \"taxType\": \"\",\n \"taxValue\": \"\",\n \"included\": \"\"\n },\n \"fees\": {\n \"feeType\": \"\",\n \"feeValue\": \"\",\n \"included\": \"\"\n },\n \"offers\": {\n \"offerType\": \"\",\n \"offerValue\": \"\"\n }\n }\n }\n },\n \"rateDiscount\": \"\",\n \"rateModel\": \"\",\n \"cancelPolicy\": \"\"\n }\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.bakuun.com/ratedockAPI/agent/v2/updateoccuraterq\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));", "customLabel": "" }, { "id": "WVEF2sdFv8nSy0WFTbpXh", "language": "python", "code": "import requests\nimport json\n\nurl = \"https://api.bakuun.com/ratedockAPI/agent/v2/updateoccuraterq\"\n\npayload = json.dumps({\n \"username\": \"String\",\n \"password\": \"String\",\n \"hotelId\": \"String\",\n \"startDateYmd\": \"String\",\n \"endDateYmd\": \"String\",\n \"action\": \"String\",\n \"dailyRates\": {\n \"roomCode\": \"\",\n \"condCode\": \"\",\n \"currencyCode\": \"\",\n \"priceDetails\": {\n \"amountBeforeTax\": \"\",\n \"amountAfterTax\": \"\",\n \"occupancy\": {\n \"adultCount\": \"\",\n \"childCount\": {\n \"count\": \"\",\n \"minAge\": \"\",\n \"maxAge\": \"\",\n \"costDetails\": {\n \"unit\": \"\",\n \"amountBeforeTax\": \"\",\n \"amountAfterTax\": \"\",\n \"taxDetails\": {\n \"Before\": {\n \"taxType\": \"\",\n \"taxValue\": \"\",\n \"included\": \"\"\n },\n \"After\": {\n \"taxType\": \"\",\n \"taxValue\": \"\",\n \"included\": \"\"\n }\n }\n }\n },\n \"infantCount\": {\n \"count\": \"\",\n \"minAge\": \"\",\n \"maxAge\": \"\",\n \"costDetails\": {\n \"unit\": \"\",\n \"amountBeforeTax\": \"\",\n \"amountAfterTax\": \"\",\n \"taxDetails\": {\n \"Before\": {\n \"taxType\": \"\",\n \"taxValue\": \"\",\n \"included\": \"\"\n },\n \"After\": {\n \"taxType\": \"\",\n \"taxValue\": \"\",\n \"included\": \"\"\n }\n }\n }\n }\n },\n \"rateType\": \"\",\n \"taxFeeDetails\": {\n \"Before\": {\n \"tax\": {\n \"taxType\": \"\",\n \"taxValue\": \"\",\n \"included\": \"\"\n },\n \"fees\": {\n \"feeType\": \"\",\n \"feeValue\": \"\",\n \"included\": \"\"\n },\n \"offers\": {\n \"offerType\": \"\",\n \"offerValue\": \"\"\n }\n },\n \"After\": {\n \"tax\": {\n \"taxType\": \"\",\n \"taxValue\": \"\",\n \"included\": \"\"\n },\n \"fees\": {\n \"feeType\": \"\",\n \"feeValue\": \"\",\n \"included\": \"\"\n },\n \"offers\": {\n \"offerType\": \"\",\n \"offerValue\": \"\"\n }\n }\n }\n },\n \"rateDiscount\": \"\",\n \"rateModel\": \"\",\n \"cancelPolicy\": \"\"\n }\n})\nheaders = {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n", "customLabel": "" }, { "id": "2rNshu6nXDDMLFKNFotZz", "language": "ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.bakuun.com/ratedockAPI/agent/v2/updateoccuraterq\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"Accept\"] = \"application/json\"\nrequest[\"Content-Type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"username\": \"String\",\n \"password\": \"String\",\n \"hotelId\": \"String\",\n \"startDateYmd\": \"String\",\n \"endDateYmd\": \"String\",\n \"action\": \"String\",\n \"dailyRates\": {\n \"roomCode\": \"\",\n \"condCode\": \"\",\n \"currencyCode\": \"\",\n \"priceDetails\": {\n \"amountBeforeTax\": \"\",\n \"amountAfterTax\": \"\",\n \"occupancy\": {\n \"adultCount\": \"\",\n \"childCount\": {\n \"count\": \"\",\n \"minAge\": \"\",\n \"maxAge\": \"\",\n \"costDetails\": {\n \"unit\": \"\",\n \"amountBeforeTax\": \"\",\n \"amountAfterTax\": \"\",\n \"taxDetails\": {\n \"Before\": {\n \"taxType\": \"\",\n \"taxValue\": \"\",\n \"included\": \"\"\n },\n \"After\": {\n \"taxType\": \"\",\n \"taxValue\": \"\",\n \"included\": \"\"\n }\n }\n }\n },\n \"infantCount\": {\n \"count\": \"\",\n \"minAge\": \"\",\n \"maxAge\": \"\",\n \"costDetails\": {\n \"unit\": \"\",\n \"amountBeforeTax\": \"\",\n \"amountAfterTax\": \"\",\n \"taxDetails\": {\n \"Before\": {\n \"taxType\": \"\",\n \"taxValue\": \"\",\n \"included\": \"\"\n },\n \"After\": {\n \"taxType\": \"\",\n \"taxValue\": \"\",\n \"included\": \"\"\n }\n }\n }\n }\n },\n \"rateType\": \"\",\n \"taxFeeDetails\": {\n \"Before\": {\n \"tax\": {\n \"taxType\": \"\",\n \"taxValue\": \"\",\n \"included\": \"\"\n },\n \"fees\": {\n \"feeType\": \"\",\n \"feeValue\": \"\",\n \"included\": \"\"\n },\n \"offers\": {\n \"offerType\": \"\",\n \"offerValue\": \"\"\n }\n },\n \"After\": {\n \"tax\": {\n \"taxType\": \"\",\n \"taxValue\": \"\",\n \"included\": \"\"\n },\n \"fees\": {\n \"feeType\": \"\",\n \"feeValue\": \"\",\n \"included\": \"\"\n },\n \"offers\": {\n \"offerType\": \"\",\n \"offerValue\": \"\"\n }\n }\n }\n },\n \"rateDiscount\": \"\",\n \"rateModel\": \"\",\n \"cancelPolicy\": \"\"\n }\n})\n\nresponse = https.request(request)\nputs response.read_body\n", "customLabel": "" } ], "selectedLanguageId": "F6DFMY8yp37HbzLk13k1v" }, "results": { "languages": [ { "id": "Nk06oAPM-SJCHzGv2ZylY", "language": "200", "code": "{ \n\"success\": true \n}", "customLabel": "" }, { "id": "zcwpkCoaI2Gcs_LMjv5yy", "language": "500", "code": "{\n \"success\": false,\n \"errors\": [\n {\n \"code\": 500,\n \"message\": \"Internal server error\"\n }\n ]\n}", "customLabel": "" }, { "id": "em_Kpv2oZfn8MCO7_f1SV", "language": "502", "code": "{\n \"success\": false,\n \"errors\": [\n {\n \"code\": 502,\n \"message\": \"Bad gateway\"\n }\n ]\n}", "customLabel": "" }, { "id": "zzzE2J6Y7YZDula_qc4OD", "language": "503", "code": "{\n \"success\": false,\n \"errors\": [\n {\n \"code\": 503,\n \"message\": \"Service unavailable\"\n }\n ]\n}", "customLabel": "" }, { "id": "B4wRfM8K9w0KuyctvGtOu", "language": "504", "code": "{\n \"success\": false,\n \"errors\": [\n {\n \"code\": 504,\n \"message\": \"Endpoint request timed-out\"\n }\n ]\n}", "customLabel": "" } ], "selectedLanguageId": "Nk06oAPM-SJCHzGv2ZylY" }, "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [ { "name": "username", "kind": "required", "type": "string", "description": "API username provided by the partner to authenticate incoming pushes from Bakuun.", "": "API username provided by the partner to authenticate incoming pushes from Bakuun." }, { "name": "password", "kind": "required", "type": "string", "description": "API password provided by the partner to authenticate incoming requests from Bakuun.", "": "API password provided by the partner to authenticate incoming requests from Bakuun." }, { "name": "hotelId", "kind": "required", "type": "string", "description": "Unique property identifier (shared mapping between Bakuun and the partner).", "": "Unique property identifier (shared mapping between Bakuun and the partner)." }, { "name": "startDateYmd", "kind": "required", "type": "string", "description": "Start date of the update range, formatted as YYYY-MM-DD.", "": "Start date of the update range, formatted as YYYY-MM-DD." }, { "name": "endDateYmd", "kind": "required", "type": "string", "description": "End date of the update range, formatted as YYYY-MM-DD.", "": "End date of the update range, formatted as YYYY-MM-DD." }, { "name": "action", "kind": "required", "type": "string", "description": "Always set as occPriceUpdate", "": "Always set as occPriceUpdate" }, { "name": "dailyRates", "kind": "required", "type": "object", "description": "", "": "dailyRates", "children": [ { "name": "roomCode", "kind": "required", "type": "string", "description": "Code identifying the room code as per mapping." }, { "name": "condCode", "kind": "required", "type": "string", "description": "Code identifying the rate plan code as per mapping." }, { "name": "currencyCode", "kind": "required", "type": "string", "description": "3-letter ISO currency code (e.g. EUR, USD, SGD)." }, { "name": "priceDetails", "kind": "required", "type": "object", "description": "", "children": [ { "name": "amountBeforeTax", "kind": "required", "type": "string", "description": "Room amount before taxes/fees. Decimal as string, e.g. \"100.00\" N/A to clear the value." }, { "name": "amountAfterTax", "kind": "required", "type": "string", "description": "Room amount after taxes/fees (total sell price). Decimal as string. N/A to clear the value." }, { "name": "occupancy", "kind": "required", "type": "object", "description": "Occupancy breakdown", "children": [ { "name": "adultCount", "kind": "required", "type": "integer", "description": "Number of adults" }, { "name": "childCount", "kind": "required", "type": "object", "description": "Children details", "children": [ { "name": "count", "kind": "required", "type": "integer", "description": "Number of children" }, { "name": "minAge", "kind": "required", "type": "string", "description": "minAge is conditionally required. When count is greater than zero, minAge must be provided and must be a value between 0 and 17 (inclusive). When count equals zero, minAge must be empty." }, { "name": "maxAge", "kind": "required", "type": "string", "description": "maxAge is conditionally required. When count is greater than zero, maxAge must be provided, must be a value between 0 and 17 (inclusive), and must be greater than or equal to minAge. When count equals zero, maxAge must be empty." }, { "name": "costDetails", "kind": "required", "type": "object", "description": "", "children": [ { "name": "unit", "kind": "required", "type": "string", "description": "unit defines the cost calculation method. Supported values are \ncurrency → Cost is a fixed monetary amount in the specified currency\npercentage → Cost is calculated as a percentage of the base rate\nfree → No cost applies (amount is always zero)" }, { "name": "amountBeforeTax", "kind": "required", "type": "string", "description": "Child amount before taxes/fees. Decimal as string, e.g. \"100.00\"" }, { "name": "amountAfterTax", "kind": "required", "type": "string", "description": "Child amount after taxes/fees. Decimal as string, e.g. \"100.00\"" }, { "name": "taxDetails", "kind": "required", "type": "object", "description": "", "children": [ { "name": "Before", "kind": "required", "type": "object", "description": "", "children": [ { "name": "taxType", "kind": "required", "type": "string", "description": "Used to identify the tax label , the available options are VAT and FEES" }, { "name": "taxValue", "kind": "required", "type": "string", "description": "Tax value as a percentage." }, { "name": "included", "kind": "required", "type": "string", "description": "0 = Included in amountBeforeTax \n1= Not included (to be added on top)." } ] }, { "name": "After", "kind": "required", "type": "object", "description": "", "children": [ { "name": "taxType", "kind": "required", "type": "string", "description": "Used to identify the tax label , the available options are VAT and FEES" }, { "name": "taxValue", "kind": "required", "type": "string", "description": "Tax value as a percentage." }, { "name": "included", "kind": "required", "type": "string", "description": "0 = Included in amountAfterTax \n1= Not included (to be added on top)." } ] } ] } ] } ] }, { "name": "infantCount", "kind": "required", "type": "object", "description": "Infant details", "children": [ { "name": "count", "kind": "required", "type": "string", "description": "Number of infant" }, { "name": "minAge", "kind": "required", "type": "string", "description": "minAge is conditionally required. When count is greater than zero, minAge must be provided and must be a value between 0 and 17 (inclusive). When count equals zero, minAge must be empty." }, { "name": "maxAge", "kind": "required", "type": "string", "description": "maxAge is conditionally required. When count is greater than zero, maxAge must be provided, must be a value between 0 and 17 (inclusive), and must be greater than or equal to minAge. When count equals zero, maxAge must be empty." }, { "name": "costDetails", "kind": "required", "type": "object", "description": "", "children": [ { "name": "unit", "kind": "required", "type": "string", "description": "unit defines the cost calculation method. Supported values are \ncurrency → Cost is a fixed monetary amount in the specified currency\npercentage → Cost is calculated as a percentage of the base rate\nfree → No cost applies (amount is always zero)" }, { "name": "amountBeforeTax", "kind": "required", "type": "string", "description": "Infant amount before taxes/fees. Decimal as string, e.g. \"100.00\"" }, { "name": "amountAfterTax", "kind": "required", "type": "string", "description": "Infant amount after taxes/fees. Decimal as string, e.g. \"100.00\"" }, { "name": "taxDetails", "kind": "required", "type": "object", "description": "", "children": [ { "name": "Before", "kind": "required", "type": "object", "description": "", "children": [ { "name": "taxType", "kind": "required", "type": "string", "description": "Used to identify the tax label , the available options are VAT and FEES" }, { "name": "taxValue", "kind": "required", "type": "string", "description": "Tax value as a percentage " }, { "name": "included", "kind": "required", "type": "string", "description": "0 = Included in amountBeforeTax \n1= Not included (to be added on top)." } ] }, { "name": "After", "kind": "required", "type": "object", "description": "", "children": [ { "name": "taxType", "kind": "required", "type": "string", "description": "Used to identify the tax label , the available options are VAT and FEES" }, { "name": "taxValue", "kind": "required", "type": "string", "description": "Tax value as a percentage." }, { "name": "included", "kind": "required", "type": "string", "description": "0 = Included in amountAfterTax \n1= Not included (to be added on top)." } ] } ] } ] } ] } ] }, { "name": "rateType", "kind": "required", "type": "string", "description": "Used to identify the rate type , the allowed value would be BAR or NET" }, { "name": "taxFeeDetails", "kind": "required", "type": "object", "description": "Detailed breakdown of taxes, fees, offers Before/After. Recommended if you want transparency/calculation consistency.", "children": [ { "name": "Before", "kind": "required", "type": "object", "description": "", "children": [ { "name": "tax", "kind": "required", "type": "object", "description": "", "children": [ { "name": "taxType", "kind": "required", "type": "string", "description": "Used to identify the tax label , the available options are VAT and FEES" }, { "name": "taxValue", "kind": "required", "type": "string", "description": "Tax value as a percentage" }, { "name": "included", "kind": "required", "type": "string", "description": "0 = Included in amountBeforeTax \n1= Not included (to be added on top)." } ] }, { "name": "fees", "kind": "required", "type": "object", "description": "", "children": [ { "name": "feeType", "kind": "required", "type": "string", "description": "Used to identify the Fee type, the available options are \n- percentage\n- incalculable\n- per night" }, { "name": "feeValue", "kind": "required", "type": "string", "description": "Percentage use positive value between 0.01 to 99.99 \nPer night use positive value between 0.01 to 99,999,999,999.99\nIncalculable use 0.00" }, { "name": "included", "kind": "required", "type": "string", "description": "0 = Included in amountBeforeTax \n1= Not included (to be added on top)." } ] }, { "name": "offers", "kind": "required", "type": "object", "description": "Represents a promotional discount applied to the rate.\nThe discount value is fixed and determined solely by offerType.", "children": [ { "name": "offerType", "kind": "required", "type": "string", "description": "Defines the type of promotion and its fixed discount:\n- sales \n- last \n- easy \n- free percentage " }, { "name": "offerValue", "kind": "required", "type": "string", "description": "Defines the offerValue based on offerType selected \nsales → 50% discount\nlast → 40% discount\neasy → 30% discount\nfree percentage 1%→ up to 99%discount other than sales, last and easy discount" } ] } ] }, { "name": "After", "kind": "required", "type": "object", "description": "", "children": [ { "name": "tax", "kind": "required", "type": "object", "description": "", "children": [ { "name": "taxType", "kind": "required", "type": "string", "description": "Used to identify the tax label , the available options are VAT and FEES" }, { "name": "taxValue", "kind": "required", "type": "string", "description": "Tax value as a percentage." }, { "name": "included", "kind": "required", "type": "string", "description": "0 = Included in amountAfterTax \n1= Not included (to be added on top)." } ] }, { "name": "fees", "kind": "required", "type": "object", "description": "", "children": [ { "name": "feeType", "kind": "required", "type": "string", "description": "Used to identify the Fee type, the available options are \n- percentage\n- incalculable\n- per night" }, { "name": "feeValue", "kind": "required", "type": "string", "description": "Percentage use positive value between 0.01 to 99.99 \nPer night use positive value between 0.01 to 99,999,999,999.99\nIncalculable use 0.00" }, { "name": "included", "kind": "required", "type": "string", "description": "0 = Included in amountAfterTax \n1= Not included (to be added on top)." } ] }, { "name": "offers", "kind": "required", "type": "object", "description": "Represents a promotional discount applied to the rate.\nThe discount value is fixed and determined solely by offerType.", "children": [ { "name": "offerType", "kind": "required", "type": "string", "description": "Defines the type of promotion and its fixed discount:\n- sales \n- last \n- easy \n- free percentage " }, { "name": "offerValue", "kind": "required", "type": "string", "description": "Defines the offerValue based on offerType selected \nsales → 50% discount\nlast → 40% discount\neasy → 30% discount\nfree percentage 1%→ up to 99%discount other than sales, last and easy discount" } ] } ] } ] } ] }, { "name": "rateDiscount", "kind": "required", "type": "string", "description": "Discount applied vs base rate (percentage)." }, { "name": "rateModel", "kind": "required", "type": "string", "description": "Used to identify the rate model , the allowed value would be OPB" }, { "name": "cancelPolicy", "kind": "required", "type": "string", "description": "Cancellation policy automatically generated from the rate plan’s configured cancellation rules." } ], "schema": [ { "name": "roomCode", "kind": "required", "type": "string", "description": "Code identifying the room code as per mapping." }, { "name": "condCode", "kind": "required", "type": "string", "description": "Code identifying the rate plan code as per mapping." }, { "name": "currencyCode", "kind": "required", "type": "string", "description": "3-letter ISO currency code (e.g. EUR, USD, SGD)." }, { "name": "priceDetails", "kind": "required", "type": "object", "description": "", "children": [ { "name": "amountBeforeTax", "kind": "required", "type": "string", "description": "Room amount before taxes/fees. Decimal as string, e.g. \"100.00\" N/A to clear the value." }, { "name": "amountAfterTax", "kind": "required", "type": "string", "description": "Room amount after taxes/fees (total sell price). Decimal as string. N/A to clear the value." }, { "name": "occupancy", "kind": "required", "type": "object", "description": "Occupancy breakdown", "children": [ { "name": "adultCount", "kind": "required", "type": "integer", "description": "Number of adults" }, { "name": "childCount", "kind": "required", "type": "object", "description": "Children details", "children": [ { "name": "count", "kind": "required", "type": "integer", "description": "Number of children" }, { "name": "minAge", "kind": "required", "type": "string", "description": "minAge is conditionally required. When count is greater than zero, minAge must be provided and must be a value between 0 and 17 (inclusive). When count equals zero, minAge must be empty." }, { "name": "maxAge", "kind": "required", "type": "string", "description": "maxAge is conditionally required. When count is greater than zero, maxAge must be provided, must be a value between 0 and 17 (inclusive), and must be greater than or equal to minAge. When count equals zero, maxAge must be empty." }, { "name": "costDetails", "kind": "required", "type": "object", "description": "", "children": [ { "name": "unit", "kind": "required", "type": "string", "description": "unit defines the cost calculation method. Supported values are \ncurrency → Cost is a fixed monetary amount in the specified currency\npercentage → Cost is calculated as a percentage of the base rate\nfree → No cost applies (amount is always zero)" }, { "name": "amountBeforeTax", "kind": "required", "type": "string", "description": "Child amount before taxes/fees. Decimal as string, e.g. \"100.00\"" }, { "name": "amountAfterTax", "kind": "required", "type": "string", "description": "Child amount after taxes/fees. Decimal as string, e.g. \"100.00\"" }, { "name": "taxDetails", "kind": "required", "type": "object", "description": "", "children": [ { "name": "Before", "kind": "required", "type": "object", "description": "", "children": [ { "name": "taxType", "kind": "required", "type": "string", "description": "Used to identify the tax label , the available options are VAT and FEES" }, { "name": "taxValue", "kind": "required", "type": "string", "description": "Tax value as a percentage." }, { "name": "included", "kind": "required", "type": "string", "description": "0 = Included in amountBeforeTax \n1= Not included (to be added on top)." } ] }, { "name": "After", "kind": "required", "type": "object", "description": "", "children": [ { "name": "taxType", "kind": "required", "type": "string", "description": "Used to identify the tax label , the available options are VAT and FEES" }, { "name": "taxValue", "kind": "required", "type": "string", "description": "Tax value as a percentage." }, { "name": "included", "kind": "required", "type": "string", "description": "0 = Included in amountAfterTax \n1= Not included (to be added on top)." } ] } ] } ] } ] }, { "name": "infantCount", "kind": "required", "type": "object", "description": "Infant details", "children": [ { "name": "count", "kind": "required", "type": "string", "description": "Number of infant" }, { "name": "minAge", "kind": "required", "type": "string", "description": "minAge is conditionally required. When count is greater than zero, minAge must be provided and must be a value between 0 and 17 (inclusive). When count equals zero, minAge must be empty." }, { "name": "maxAge", "kind": "required", "type": "string", "description": "maxAge is conditionally required. When count is greater than zero, maxAge must be provided, must be a value between 0 and 17 (inclusive), and must be greater than or equal to minAge. When count equals zero, maxAge must be empty." }, { "name": "costDetails", "kind": "required", "type": "object", "description": "", "children": [ { "name": "unit", "kind": "required", "type": "string", "description": "unit defines the cost calculation method. Supported values are \ncurrency → Cost is a fixed monetary amount in the specified currency\npercentage → Cost is calculated as a percentage of the base rate\nfree → No cost applies (amount is always zero)" }, { "name": "amountBeforeTax", "kind": "required", "type": "string", "description": "Infant amount before taxes/fees. Decimal as string, e.g. \"100.00\"" }, { "name": "amountAfterTax", "kind": "required", "type": "string", "description": "Infant amount after taxes/fees. Decimal as string, e.g. \"100.00\"" }, { "name": "taxDetails", "kind": "required", "type": "object", "description": "", "children": [ { "name": "Before", "kind": "required", "type": "object", "description": "", "children": [ { "name": "taxType", "kind": "required", "type": "string", "description": "Used to identify the tax label , the available options are VAT and FEES" }, { "name": "taxValue", "kind": "required", "type": "string", "description": "Tax value as a percentage " }, { "name": "included", "kind": "required", "type": "string", "description": "0 = Included in amountBeforeTax \n1= Not included (to be added on top)." } ] }, { "name": "After", "kind": "required", "type": "object", "description": "", "children": [ { "name": "taxType", "kind": "required", "type": "string", "description": "Used to identify the tax label , the available options are VAT and FEES" }, { "name": "taxValue", "kind": "required", "type": "string", "description": "Tax value as a percentage." }, { "name": "included", "kind": "required", "type": "string", "description": "0 = Included in amountAfterTax \n1= Not included (to be added on top)." } ] } ] } ] } ] } ] }, { "name": "rateType", "kind": "required", "type": "string", "description": "Used to identify the rate type , the allowed value would be BAR or NET" }, { "name": "taxFeeDetails", "kind": "required", "type": "object", "description": "Detailed breakdown of taxes, fees, offers Before/After. Recommended if you want transparency/calculation consistency.", "children": [ { "name": "Before", "kind": "required", "type": "object", "description": "", "children": [ { "name": "tax", "kind": "required", "type": "object", "description": "", "children": [ { "name": "taxType", "kind": "required", "type": "string", "description": "Used to identify the tax label , the available options are VAT and FEES" }, { "name": "taxValue", "kind": "required", "type": "string", "description": "Tax value as a percentage" }, { "name": "included", "kind": "required", "type": "string", "description": "0 = Included in amountBeforeTax \n1= Not included (to be added on top)." } ] }, { "name": "fees", "kind": "required", "type": "object", "description": "", "children": [ { "name": "feeType", "kind": "required", "type": "string", "description": "Used to identify the Fee type, the available options are \n- percentage\n- incalculable\n- per night" }, { "name": "feeValue", "kind": "required", "type": "string", "description": "Percentage use positive value between 0.01 to 99.99 \nPer night use positive value between 0.01 to 99,999,999,999.99\nIncalculable use 0.00" }, { "name": "included", "kind": "required", "type": "string", "description": "0 = Included in amountBeforeTax \n1= Not included (to be added on top)." } ] }, { "name": "offers", "kind": "required", "type": "object", "description": "Represents a promotional discount applied to the rate.\nThe discount value is fixed and determined solely by offerType.", "children": [ { "name": "offerType", "kind": "required", "type": "string", "description": "Defines the type of promotion and its fixed discount:\n- sales \n- last \n- easy \n- free percentage " }, { "name": "offerValue", "kind": "required", "type": "string", "description": "Defines the offerValue based on offerType selected \nsales → 50% discount\nlast → 40% discount\neasy → 30% discount\nfree percentage 1%→ up to 99%discount other than sales, last and easy discount" } ] } ] }, { "name": "After", "kind": "required", "type": "object", "description": "", "children": [ { "name": "tax", "kind": "required", "type": "object", "description": "", "children": [ { "name": "taxType", "kind": "required", "type": "string", "description": "Used to identify the tax label , the available options are VAT and FEES" }, { "name": "taxValue", "kind": "required", "type": "string", "description": "Tax value as a percentage." }, { "name": "included", "kind": "required", "type": "string", "description": "0 = Included in amountAfterTax \n1= Not included (to be added on top)." } ] }, { "name": "fees", "kind": "required", "type": "object", "description": "", "children": [ { "name": "feeType", "kind": "required", "type": "string", "description": "Used to identify the Fee type, the available options are \n- percentage\n- incalculable\n- per night" }, { "name": "feeValue", "kind": "required", "type": "string", "description": "Percentage use positive value between 0.01 to 99.99 \nPer night use positive value between 0.01 to 99,999,999,999.99\nIncalculable use 0.00" }, { "name": "included", "kind": "required", "type": "string", "description": "0 = Included in amountAfterTax \n1= Not included (to be added on top)." } ] }, { "name": "offers", "kind": "required", "type": "object", "description": "Represents a promotional discount applied to the rate.\nThe discount value is fixed and determined solely by offerType.", "children": [ { "name": "offerType", "kind": "required", "type": "string", "description": "Defines the type of promotion and its fixed discount:\n- sales \n- last \n- easy \n- free percentage " }, { "name": "offerValue", "kind": "required", "type": "string", "description": "Defines the offerValue based on offerType selected \nsales → 50% discount\nlast → 40% discount\neasy → 30% discount\nfree percentage 1%→ up to 99%discount other than sales, last and easy discount" } ] } ] } ] } ] }, { "name": "rateDiscount", "kind": "required", "type": "string", "description": "Discount applied vs base rate (percentage)." }, { "name": "rateModel", "kind": "required", "type": "string", "description": "Used to identify the rate model , the allowed value would be OPB" }, { "name": "cancelPolicy", "kind": "required", "type": "string", "description": "Cancellation policy automatically generated from the rate plan’s configured cancellation rules." } ] } ], "formDataParameters": [] }, "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "hasTryItOut": false, "response": [ { "name": "success", "kind": "optional", "type": "boolean", "description": "" } ], "autoGeneratedAnchorSlug": "occupancy-based-rates-update", "legacyHash": "vzhSUehopTtLCuG25WWeH" } ``` ::: :::Paragraph{indent="1"} :::