--- updatedAt: 2025-09-09T21:11:35.000Z agentTools: projectIndex: https://docs.ciiruspartners.com/v2023.07.31/llms.txt --- # Retrieve all rental extras # OpenAPI definition ```json { "openapi": "3.0.0", "security": [ { "basicAuth": [] } ], "info": { "title": "CiiRUS Partner API", "version": "2023.07.31" }, "paths": { "/rates/extras": { "get": { "summary": "Retrieve all rental extras", "description": "", "responses": { "200": { "description": "Inventory extras response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveRatesExtrasInventoryResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/lastUpdateDate" }, { "$ref": "#/components/parameters/mcUserId" }, { "$ref": "#/components/parameters/mcUserIds" }, { "$ref": "#/components/parameters/unitIdQuery" }, { "$ref": "#/components/parameters/unitIdQueries" }, { "$ref": "#/components/parameters/retrieveAllExtras" }, { "$ref": "#/components/parameters/deleted" } ], "tags": [ "Rates (Extras)" ] } } }, "servers": [ { "url": "https://api.ciiruspartners.com/v2023.07.31" } ], "components": { "parameters": { "unitIdQuery": { "name": "unitId", "in": "query", "description": "Unique Identifier for inventory.", "schema": { "type": "integer", "format": "int32", "minimum": 0 } }, "unitIdQueries": { "name": "unitIds", "in": "query", "description": "Unique Identifiers for inventory.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int32", "minimum": 0 } } }, "pageSize": { "name": "pageSize", "in": "query", "description": "Limits the number of returned results.", "required": false, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 1000, "default": 25 } }, "page": { "name": "page", "in": "query", "description": "The page to be shown.", "required": false, "schema": { "type": "integer", "format": "int32", "minimum": 1, "default": 1 } }, "lastUpdateDate": { "name": "lastUpdateDate", "in": "query", "description": "Only return objects which have been modified after a certain date.", "required": false, "schema": { "type": "string", "format": "date-time" } }, "retrieveAllExtras": { "name": "retrieveAllExtras", "in": "query", "description": "Return all extras.", "required": false, "schema": { "type": "boolean" } }, "deleted": { "name": "deleted", "in": "query", "description": "Only show properties which are deleted or not deleted.", "required": false, "schema": { "type": "boolean" } }, "mcUserId": { "name": "mcUserId", "in": "query", "description": "Unique Identifier for supplier.", "required": false, "schema": { "type": "integer", "format": "int32", "minimum": 0 } }, "mcUserIds": { "name": "mcUserIds", "in": "query", "description": "Unique Identifiers for suppliers.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int32", "minimum": 0 } } } }, "responses": { "BadRequest": { "description": "Bad Request response", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "Unauthorized": { "description": "Unauthorized response", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "Forbidden": { "description": "Forbidden response", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "NotFound": { "description": "Not Found response", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } }, "schemas": { "Error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "PagedLambdaResponseObject": { "properties": { "next_page_url": { "type": "string", "format": "uri", "description": "URL to the next page (not present on last page)" }, "previous_page_url": { "type": "string", "format": "uri", "description": "URL to the previous page (not present on first page)" }, "total_page_count": { "type": "integer", "format": "int32", "minimum": 0, "description": "Total number of pages available" } }, "required": [ "total_page_count" ] }, "applicable_taxes": { "properties": { "applicable_taxes": { "type": "array", "items": { "$ref": "#/components/schemas/applicable_tax" } } } }, "applicable_tax": { "required": [ "tax_type" ], "allOf": [ { "$ref": "#/components/schemas/tax_type" } ] }, "rate_decimal_places": { "properties": { "rate_decimal_places": { "type": "integer" } } }, "percent": { "properties": { "percent": { "type": "integer" } } }, "amount": { "properties": { "amount": { "type": "integer" } } }, "amount_to_vendor": { "properties": { "amount_to_vendor": { "type": "integer" } } }, "amount_to_supplier": { "properties": { "amount_to_supplier": { "type": "integer" } } }, "per_guest": { "properties": { "per_guest": { "type": "boolean" } } }, "item_code": { "properties": { "item_code": { "type": "string" } } }, "item_description": { "properties": { "item_description": { "type": "string" } } }, "extra_id": { "properties": { "extra_id": { "type": "integer" } } }, "property_id": { "properties": { "property_id": { "type": "integer", "format": "int32", "description": "Unique identifier for inventory" } } }, "airbnb_fee_type": { "properties": { "airbnb_fee_type": { "type": "string", "enum": [ "PASS_THROUGH_RESORT_FEE,", "PASS_THROUGH_MANAGEMENT_FEE,", "PASS_THROUGH_COMMUNITY_FEE,", "PASS_THROUGH_LINEN_FEE,", "PASS_THROUGH_ELECTRICITY_FEE,", "PASS_THROUGH_WATER_FEE,", "PASS_THROUGH_HEATING_FEE,", "PASS_THROUGH_AIR_CONDITIONING_FEE,", "PASS_THROUGH_UTILITY_FEE,", "PASS_THROUGH_PET_FEE,", "PASS_THROUGH_CLEANING_FEE,", "PASS_THROUGH_SHORT_TERM_CLEANING_FEE,", "PASS_THROUGH_SECURITY_DEPOSIT" ] } } }, "fee_type": { "properties": { "fee_type": { "type": "string", "enum": [ "CLEANING_FEE,", "BOOKING_FEE,", "STANDARD_DISCOUNT", "OPTIONAL_EXTRA", "MANDATORY_EXTRA", "POOL_HEAT_FEE", "ON_ARRIVAL_EXTRA", "SECURITY_DEPOSIT" ] } } }, "mc_user_id": { "properties": { "mc_user_id": { "type": "integer", "format": "int32", "description": "Unique Identifier for supplier" } } }, "RetrieveRatesExtrasInventoryResponse": { "properties": { "properties": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveRatesExtrasResponseObject" } } }, "required": [ "properties" ], "allOf": [ { "$ref": "#/components/schemas/PagedLambdaResponseObject" }, { "type": "object" } ] }, "RetrieveRatesExtrasResponseObject": { "allOf": [ { "$ref": "#/components/schemas/property_id" }, { "$ref": "#/components/schemas/extras" }, { "$ref": "#/components/schemas/mc_user_id" } ], "required": [ "property_id", "extras", "mc_user_id" ] }, "extras": { "properties": { "extras": { "type": "array", "items": { "$ref": "#/components/schemas/extra" } } } }, "extra": { "allOf": [ { "$ref": "#/components/schemas/extra_id" }, { "$ref": "#/components/schemas/per_guest" }, { "$ref": "#/components/schemas/fee_type" }, { "$ref": "#/components/schemas/amount" }, { "$ref": "#/components/schemas/amount_to_vendor" }, { "$ref": "#/components/schemas/amount_to_supplier" }, { "$ref": "#/components/schemas/rate_decimal_places" }, { "$ref": "#/components/schemas/applicable_taxes" }, { "$ref": "#/components/schemas/airbnb_fee_type" }, { "$ref": "#/components/schemas/item_code" }, { "$ref": "#/components/schemas/item_description" }, { "$ref": "#/components/schemas/percent" } ], "required": [ "fee_type", "applicable_taxes" ] }, "tax_type": { "properties": { "tax_type": { "type": "string", "enum": [ "TAX_ONE,", "TAX_TWO,", "TAX_THREE" ] } } } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true } } ```