openapi: 3.2.0 info: title: Hostfully Fees API license: name: Apache 2.0 url: https://www.hostfully.com/ version: v3.0.1 servers: - url: https://sandbox-api.hostfully.com security: - JWT-Authentication: [] - Agency-API-key: [] tags: - name: Fees paths: /api/v3.3/fees/{uid}: get: tags: - Fees summary: Get fee by UID description: Retrieve details of a fee identified by its UIDwith all fee configuration fields. operationId: findByUid_3 parameters: - name: uid in: path required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/FeeApi3_3ResponseWrapper' put: tags: - Fees summary: Update an existing fee description: Update the fee identified by UID with the given fee data. operationId: updateFee parameters: - name: uid in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FeeSavingApi3_3Dto' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/FeeApi3_3ResponseWrapper' delete: tags: - Fees summary: Delete a fee description: Delete the fee identified by the given UID. operationId: deleteFee parameters: - name: uid in: path required: true schema: type: string responses: '200': description: OK /api/v3.3/fees: get: tags: - Fees summary: Get all property fees description: Retrieve all fees associated with the specified property UID with all fee configuration fields. operationId: findAll_8 parameters: - name: propertyUid in: query required: true schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/FeeApi3_3ResponseListWrapper' post: tags: - Fees summary: Create a new fee description: Create a fee for a property using the provided fee data. operationId: createFee requestBody: content: application/json: schema: $ref: '#/components/schemas/FeeSavingApi3_3Dto' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/FeeApi3_3ResponseWrapper' components: schemas: FeeApi3_3Dto: type: object properties: feeId: type: integer format: int32 uid: type: string propertyUid: type: string amount: type: number amountType: type: string enum: - AMOUNT - TAX attestation: type: boolean longTermStayExemption: type: integer format: int32 name: type: string optional: type: boolean scope: type: string enum: - PER_NIGHT - PER_STAY - PER_GUEST_PER_NIGHT - PER_GUEST - PER_PET - PER_PET_PER_NIGHT - PERCENTAGE_OF_TOTAL - PERCENTAGE_OF_RENT condition: $ref: '#/components/schemas/FeeConditionsApi3ResponseDto' taxationRate: type: number type: type: string enum: - CLEANING - EARLY_ARRIVAL - LATE_DEPARTURE - PET - TAX - CUSTOM airbnbType: 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 - PASS_THROUGH_HOTEL_TAX - PASS_THROUGH_LODGING_TAX - PASS_THROUGH_ROOM_TAX - PASS_THROUGH_TOURIST_TAX - PASS_THROUGH_TRANSIENT_OCCUPANCY_TAX - PASS_THROUGH_SALES_TAX - PASS_THROUGH_VAT_TAX - PASS_THROUGH_TOURISM_ASSESSMENT_FEE - AIRBNB_COLLECTED_TAX airbnbUnitType: type: string enum: - PER_KILOWATT_HOUR - PER_LITER - PER_CUBIC_METER offline: type: boolean bookingDotComType: type: string enum: - AIRPORT_SHUTTLE_FEE - AIR_CONDITIONING_FEE - CITY_TAX - CLUB_CARD_FEE - CONSERVATION_FEE - CREDIT_CARD_FEE - DESTINATION_FEE - ELECTRICITY_FEE - ENVIRONMENT_FEE - FINAL_CLEANING_FEE - GAS_FEE - GOODS_AND_SERVICES_TAX - GOVERNMENT_TAX - HEATING_FEE - HERITAGE_FEE - HOT_SPRING_TAX - HOUSEKEEPING_FEE - KITCHEN_LINEN_FEE - LINEN_FEE - LINEN_PACKAGE_FEE - LOCAL_COUNCIL_TAX - MUNICIPALITY_FEE - OIL_FEE - PETS_FEE - RESIDENTIAL_TAX - RESORT_FEE - SAUNA_FITNESS_FACILITIES_TAX - SEA_PLANE_FEE - SERVICE_CHARGE_FEE - SHUTTLE_BOAT_FEE - SKI_PASS_FEE - SPA_TAX - TOWEL_FEE - TRANSFER_FEE - TRANSIT_FEE - VAT - VISA_SUPPORT_FEE - WATER_FEE - WATER_PARK_FEE - WOOD_FEE - WRISTBAND_FEE - DESTINATION_CHARGE - DESTINATION_TAX - GALA_DINNER_FEE - GOODS_SERVICES_FLOOD_TAX - GOVERNMENT_CHARGE - HOT_SPRING_BATH - INSURANCE_FEE - INTERNET_FEE - LOCALITY_CONSERVATION_FEE - LOUNGE - PARKING_FEE - POOL - SERVICE_CHARGE_ASIA - SPA - SUSTAINABILITY_FEE - TOURISM_FEE hostfullyType: type: string enum: - DEFAULT hvmiType: type: string enum: - ADMINISTRATIVE_FEE - BOOKING_FEE - CLEANING_FEE - DOCK_FEE - GUEST_REGISTRATION - HOA_FEE - HOTEL_TAX - HOT_TUB_FEE - MANAGEMENT_FEE - MISCELLANEOUS_FEE - OCCUPANCY_TAX - PARKING_FEE - PER_EXTRA_PERSON_FEE - POOL_FEE - POOL_HEATING_FEE - RESORT_FEE - SECURITY_DEPOSIT_FEE - SERVICE_FEE - UTILITY_FEE - VAT_TAX - WAIVER_DAMAGE_FEE - PET_FEE - CITY_TAX - COUNTY_TAX - STATE_TAX vrboType: type: string enum: - ADDITIONAL_BED - ADMINISTRATIVE - AIR_CONDITIONING - ARRIVAL_EARLY - ARRIVAL_LATE - ASSOCIATION_PROPERTY - BABY_BED - BOOKING_EARLY - BOOKING_LATE - CLASS - CLUB - CONCIERGE - DEPARTURE_EARLY - DEPARTURE_LATE - ELECTRICITY - EQUIPMENT - FOOD - GARDENING - GAS - HEATING - HIGH_CHAIR - HOT_TUB - INTERNET - LABOR - LAUNDRY - LINENS - LINENS_BATH - LINENS_BED - MANAGEMENT - OIL - ON_SITE_PAYMENT_METHOD - PARKING - PET - PHONE - POOL - POOL_HEATING - RENT - RESORT - SPA - TAX - TOILETRIES - TOUR - TRANSPORTATION - UTENSILS_CLEANING - UTENSILS_FOOD - VEHICLE - WAIVER_DAMAGE - WATER - WATER_CRAFT - WATER_CRAFT_MOORING - WATER_DRINKING - WOOD rollsIntoRent: type: boolean metadata: $ref: '#/components/schemas/FeeMetadataApi3Dto' FeeConditionsApi3ResponseDto: type: object properties: condition: type: string enum: - NONE - EXEMPT_LONG_STAY - EXCLUSIVE_LONG_STAY - BY_NIGHT conditionsLOSDays: type: integer format: int32 longTermStayExemption: type: integer format: int32 firstNightsApplying: type: integer format: int32 Api3ResponseMetadata: type: object properties: count: type: integer format: int32 totalCount: type: integer format: int32 FeeSavingApi3_3Dto: required: - amount - amountType - name - propertyUid - taxationRate type: object properties: propertyUid: type: string amount: type: number amountType: type: string enum: - AMOUNT - TAX attestation: type: boolean name: maxLength: 255 minLength: 1 type: string optional: type: boolean scope: type: string enum: - PER_NIGHT - PER_STAY - PER_GUEST_PER_NIGHT - PER_GUEST - PER_PET - PER_PET_PER_NIGHT - PERCENTAGE_OF_TOTAL - PERCENTAGE_OF_RENT taxationRate: type: number type: type: string enum: - CLEANING - EARLY_ARRIVAL - LATE_DEPARTURE - PET - TAX - CUSTOM offline: type: boolean airbnbType: 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 - PASS_THROUGH_HOTEL_TAX - PASS_THROUGH_LODGING_TAX - PASS_THROUGH_ROOM_TAX - PASS_THROUGH_TOURIST_TAX - PASS_THROUGH_TRANSIENT_OCCUPANCY_TAX - PASS_THROUGH_SALES_TAX - PASS_THROUGH_VAT_TAX - PASS_THROUGH_TOURISM_ASSESSMENT_FEE - AIRBNB_COLLECTED_TAX airbnbUnitType: type: string enum: - PER_KILOWATT_HOUR - PER_LITER - PER_CUBIC_METER conditions: $ref: '#/components/schemas/FeeConditionsApi3RequestDto' bookingDotComType: type: string enum: - AIRPORT_SHUTTLE_FEE - AIR_CONDITIONING_FEE - CITY_TAX - CLUB_CARD_FEE - CONSERVATION_FEE - CREDIT_CARD_FEE - DESTINATION_FEE - ELECTRICITY_FEE - ENVIRONMENT_FEE - FINAL_CLEANING_FEE - GAS_FEE - GOODS_AND_SERVICES_TAX - GOVERNMENT_TAX - HEATING_FEE - HERITAGE_FEE - HOT_SPRING_TAX - HOUSEKEEPING_FEE - KITCHEN_LINEN_FEE - LINEN_FEE - LINEN_PACKAGE_FEE - LOCAL_COUNCIL_TAX - MUNICIPALITY_FEE - OIL_FEE - PETS_FEE - RESIDENTIAL_TAX - RESORT_FEE - SAUNA_FITNESS_FACILITIES_TAX - SEA_PLANE_FEE - SERVICE_CHARGE_FEE - SHUTTLE_BOAT_FEE - SKI_PASS_FEE - SPA_TAX - TOWEL_FEE - TRANSFER_FEE - TRANSIT_FEE - VAT - VISA_SUPPORT_FEE - WATER_FEE - WATER_PARK_FEE - WOOD_FEE - WRISTBAND_FEE - DESTINATION_CHARGE - DESTINATION_TAX - GALA_DINNER_FEE - GOODS_SERVICES_FLOOD_TAX - GOVERNMENT_CHARGE - HOT_SPRING_BATH - INSURANCE_FEE - INTERNET_FEE - LOCALITY_CONSERVATION_FEE - LOUNGE - PARKING_FEE - POOL - SERVICE_CHARGE_ASIA - SPA - SUSTAINABILITY_FEE - TOURISM_FEE hostfullyType: type: string enum: - DEFAULT hvmiType: type: string enum: - ADMINISTRATIVE_FEE - BOOKING_FEE - CLEANING_FEE - DOCK_FEE - GUEST_REGISTRATION - HOA_FEE - HOTEL_TAX - HOT_TUB_FEE - MANAGEMENT_FEE - MISCELLANEOUS_FEE - OCCUPANCY_TAX - PARKING_FEE - PER_EXTRA_PERSON_FEE - POOL_FEE - POOL_HEATING_FEE - RESORT_FEE - SECURITY_DEPOSIT_FEE - SERVICE_FEE - UTILITY_FEE - VAT_TAX - WAIVER_DAMAGE_FEE - PET_FEE - CITY_TAX - COUNTY_TAX - STATE_TAX vrboType: type: string enum: - ADDITIONAL_BED - ADMINISTRATIVE - AIR_CONDITIONING - ARRIVAL_EARLY - ARRIVAL_LATE - ASSOCIATION_PROPERTY - BABY_BED - BOOKING_EARLY - BOOKING_LATE - CLASS - CLUB - CONCIERGE - DEPARTURE_EARLY - DEPARTURE_LATE - ELECTRICITY - EQUIPMENT - FOOD - GARDENING - GAS - HEATING - HIGH_CHAIR - HOT_TUB - INTERNET - LABOR - LAUNDRY - LINENS - LINENS_BATH - LINENS_BED - MANAGEMENT - OIL - ON_SITE_PAYMENT_METHOD - PARKING - PET - PHONE - POOL - POOL_HEATING - RENT - RESORT - SPA - TAX - TOILETRIES - TOUR - TRANSPORTATION - UTENSILS_CLEANING - UTENSILS_FOOD - VEHICLE - WAIVER_DAMAGE - WATER - WATER_CRAFT - WATER_CRAFT_MOORING - WATER_DRINKING - WOOD rollsIntoRent: type: boolean FeeApi3_3ResponseListWrapper: type: object properties: fees: type: array items: $ref: '#/components/schemas/FeeApi3_3Dto' _metadata: $ref: '#/components/schemas/Api3ResponseMetadata' TupleStringString: type: object properties: left: type: string right: type: string FeeApi3_3ResponseWrapper: type: object properties: fee: $ref: '#/components/schemas/FeeApi3_3Dto' FeeMetadataApi3Dto: type: object properties: appliesToAllProperties: type: boolean propertiesThatShareFee: type: array items: $ref: '#/components/schemas/TupleStringString' FeeConditionsApi3RequestDto: type: object properties: condition: type: string enum: - NONE - EXEMPT_LONG_STAY - EXCLUSIVE_LONG_STAY - BY_NIGHT conditionsLOSDays: type: integer format: int32 firstNightsApplying: type: integer format: int32 longTermStayExemption: type: integer format: int32 securitySchemes: JWT-Authentication: type: apiKey description: OAuth Access Token name: Authorization in: header Agency-API-key: type: apiKey description: API Key name: X-HOSTFULLY-APIKEY in: header externalDocs: description: Hostfully Documentation url: https://dev.hostfully.com/v3.0/reference x-readme: explorer-enabled: true proxy-enabled: true