GET AccommodationRateSpecification

Retrieves rate specifications for the authenticated user’s organization.

An AccommodationRateSpecification defines a pricing configuration that can be assigned to accommodations. Each specification is linked to an accommodation price component group and length-of-stay configuration, and can optionally inherit its rate values from another specification.

GETRequest

import { RecranetApiClient } from "@recranet/sdk";

const client = new RecranetApiClient({ apiKey: process.env.RECRANET_API_KEY! });

const result = await client.accommodationRateSpecifications.list();

Responses

200400

Response 200

Successful response

application/json

Example responseGenerated from schema

[
  {
    "id": 1000,
    "description": "description",
    "locale": "locale",
    "accommodationPriceComponentGroup": {
      "id": 1000
    },
    "accommodationRateLengthOfStaySpecification": {
      "id": 0,
      "description": "description",
      "locale": "locale",
      "translations": [
        {
          "id": 0,
          "locale": "locale",
          "description": "description"
        }
      ],
      "numOfDays": 1,
      "eligibleMinNumOfDays": 1
    },
    "glAccount": {
      "id": 1000
    },
    "accommodations": [
      {
        "id": 1000
      }
    ],
    "includedNumOfPersons": 0,
    "hasRatePerPersonDiscountsEnabled": false,
    "derivedAmount": "0.00",
    "derivedMethod": "percentage",
    "derivedAdjustment": "increase",
    "derivedRounding": "rounding-two-decimals",
    "type": "manual",
    "inheritanceModified": "inheritanceModified",
    "deleted": "deleted",
    "inheritedFrom": {
      "id": 1000
    },
    "campingEquipmentSpecification": {
      "id": 1000
    },
    "taxProfile": {
      "id": 1000
    }
  }
]

Response 400

Bad request

application/json

Example 1

{
  "statusCode": 400,
  "description": "Bad request",
  "errors": [
    "Bad request"
  ]
}

Query parameters

• accommodationnumberoptional
• accommodationPriceComponentGroupnumberoptional
• typestringoptional
  Allowed values: manual, inheriting-from-rate-specification, inheriting-from-group
• settingsbooleanoptional

  Returns more data in the response, required for settings

• include[]string[]optional

  Additional (relational) data groups to include in the response

Returns

Array of AccommodationRateSpecification

Schema shown for 200 · application/json

• idnumber
• descriptionstring
• includedNumOfPersonsnumberoptional
  Default: 0
• hasRatePerPersonDiscountsEnabledbooleanoptional
  Default: false
• derivedAmountstringoptional
  Default: "0.00"
• derivedMethodstringoptional
  Default: "percentage"
• derivedAdjustmentstringoptional
  Default: "increase"
• derivedRoundingstringoptional
  Default: "rounding-two-decimals"
• typestringoptional
  Default: "manual"
• inheritanceModifiedstringoptional
• deletedstringoptional
• localestring
• accommodationPriceComponentGroupobject
  Show 1 property

  • idnumberoptional
• accommodationRateLengthOfStaySpecificationAccommodationRateLengthOfStaySpecification
  Show 6 properties

  • idnumber
  • descriptionstring
  • numOfDaysnumberoptional
    Default: 1

    This property determines the length of stay. For example: a value of 3 equals to a length of stay of 3 nights.

  • eligibleMinNumOfDaysnumberoptional
    Default: 1

    This property determines the minimum numOfDays a reservations needs to have before this specification is eligible.

  • localestring
  • translationsAccommodationRateLengthOfStaySpecificationTranslation[]
    Show array — 3 properties

    • idnumber
    • descriptionstringoptional
    • localestring
• inheritedFromobjectoptional
  Show 1 property

  • idnumberoptional
• campingEquipmentSpecificationobjectoptional
  Show 1 property

  • idnumberoptional
• glAccountobject
  Show 1 property

  • idnumberoptional
• taxProfileobjectoptional
  Show 1 property

  • idnumberoptional
• accommodationsobject[]
  Show array — 1 property

  • idnumberoptional