Documentation

ReferenceProduct management

replaceFeeSet mutation

Updates a fee set.

Note: When updating a fee set, all parameters (full payload) must be specified; this mutation is a full overlay.

Syntax

1mutation {
2  replaceFeeSet(input: ReplaceFeeSetInput!): ReplaceFeeSetPayload
3}

Examples

Request
Response

1mutation {
2  replaceFeeSet(
3    input: {
4      clientMutationId: "client-id"
5      id: "450013352"
6      name:"feeset_p1234_ssf_03"
7      propertyId: "1234"
8      fees: [
9          {
10          name: "SSF_01"
11          type: "SERVICE"
12          charges: [
13            {
14              duration: NIGHT
15              type: FLAT_AMOUNT
16              flatAmount: { currencyCode: "USD", amount: "41" }
17            }
18            {
19              duration: STAY
20              type: FLAT_AMOUNT
21              flatAmount: { currencyCode: "USD", amount: "51" }
22            }
23            { duration: STAY, type: PERCENTAGE, percentage: "11.0" }
24          ]
25          taxable: false
26          ageCategory: null
27          restrictions: null
28          variesByLengthOfStay: false
29        }
30      ]
31    }
32  ) {
33    clientMutationId
34    feeSet {
35      id
36      name
37      businessModel
38      fees {
39        name
40        type
41        charges {
42          duration
43          percentage
44          flatAmount {
45            amount
46            currencyCode
47          }
48        }
49        ageCategory
50        restrictions {
51          dateRange {
52            from
53            to
54          }
55          extraGuestRange {
56            min
57            max
58          }
59          rangeOfNight {
60            min
61            max
62          }
63        }
64        taxable
65        variesByLengthOfStay
66      }
67    }
68  }
69}

Arguments

Name	Description
`input`	Required. Type: ReplaceFeeSetInput

Types

Name

Type

Boolean

The Boolean scalar type represents true or false.

CurrencyCode

Scalar that represents the three-letter currency code defined by the ISO 4217 standard.

Date

Scalar that represents a date string compliant with the RFC 3339 profile of the ISO 8601 standard.

Decimal

Scalar representing an arbitrary-precision and scale decimal number, serialized as a string.

Fee

Object

Details about a fee.

Field	Description
`ageCategory`	Age category to which the fee applies. Type: FeeAgeCategory
`category`	Not nullable. Fee category. Type: String
`charges`	Not nullable. Amount, type, and duration of the fee. Type: Array of non nullable FeeCharge
`restrictions`	Restrictions applied to the fee (dates or extra guests). Type: FeeRestrictions
`taxable`	Whether the fee is taxable. Type: Boolean
`variesByLengthOfStay`	Whether the fee changes based on length of stay. Type: Boolean

FeeAgeCategory

Enum

Age category values.

Name	Description
`ADULT`
`CHILD_A`
`CHILD_B`
`CHILD_C`
`CHILD_D`
`INFANT`

FeeBusinessModel

Enum

Values for the property's business model.

Name	Description
`AGENCY`
`MERCHANT`

FeeCharge

Object

Amount, type, and duration of the fee.

Field	Description
`duration`	Not nullable. Duration of time to which the fee is applied. Type: FeeChargeDuration
`flatAmount`	Amount of the fee if applied as a flat amount. Type: Money
`percentage`	Percentage of the rental amount if the fee is applied as a percentage. Type: Decimal
`type`	Not nullable. How the fee is applied (flat amount or percentage). Type: FeeChargeType

FeeChargeDuration

Enum

Duration of time to which the fee is applied.

Name	Description
`NIGHT`
`STAY`

FeeChargeInput

InputObject

Amount, type, and duration of the fee.

Field	Description
`duration`	Not nullable. Duration of time to which the fee is applied. Type: FeeChargeDuration
`flatAmount`	Amount of the fee if applied as a flat amount. Type: MoneyInput
`percentage`	Percentage of the rental amount if the fee is applied as a percentage. Type: Decimal
`type`	Not nullable. How the fee is applied (flat amount or percentage). Type: FeeChargeType

FeeChargeType

Enum

How the fee is applied (flat amount or percentage).

Name	Description
`FLAT_AMOUNT`
`PERCENTAGE`

FeeDateRange

Object

Date range when the fee is applied.

Field	Description
`from`	Not nullable. Start date of the date range. Type: Date
`to`	End date of the date range. Type: Date

FeeDateRangeInput

InputObject

Date range when the fee is applied.

Field	Description
`from`	Not nullable. Start date of the date range. Type: Date
`to`	End date of the date range. Type: Date

FeeInput

InputObject

Details about a fee.

Field	Description
`ageCategory`	Age category to which the fee applies. Type: FeeAgeCategory
`category`	Not nullable. Fee category (Guest or Service). Type: String
`charges`	Not nullable. Amount, type, and duration of the fee. Type: Array of non nullable FeeChargeInput
`restrictions`	Restrictions applied to the fee (dates or extra guests). Type: FeeRestrictionsInput
`taxable`	Whether the fee is taxable. Type: Boolean
`variesByLengthOfStay`	Whether the fee changes based on length of stay. Type: Boolean

FeeRestrictions

Object

Restrictions applied to the fee (dates or extra guests).

Field	Description
`dateRange`	Date range restriction Type: FeeDateRange
`extraGuestRange`	Number of guests (minimum and maximum) that are restricted. Type: IntRange

FeeRestrictionsInput

InputObject

Restrictions applied to the fee (dates or extra guests).

Field	Description
`dateRange`	Start and end dates that define the date range that is restricted. Type: FeeDateRangeInput
`extraGuestRange`	Number of guests (minimum and maximum) that are restricted. Type: IntRangeInput

FeeSet

Object

Details and fees that make up the fee set.

Field	Description
`businessModel`	Not nullable. Business model used by the property. Type: FeeBusinessModel
`fees`	Not nullable. One or more fees included in the fee set. Type: Array of non nullable Fee
`id`	Not nullable. Fee set ID. Type: ID
`name`	Not nullable. Fee set name. Type: String

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Int

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

IntRange

Object

Range of integers.

Field	Description
`max`	Not nullable. Maximum integer value. Type: Int
`min`	Not nullable. Minimum integer value. Type: Int

IntRangeInput

InputObject

Range of integers.

Field	Description
`max`	Not nullable. Maximum integer value. Type: Int
`min`	Not nullable. Minimum integer value. Type: Int

Money

Object

Monetary amount value and its currency code.

Field	Description
`amount`	Not nullable. Monetary amount value. The scale of the amount varies according to the currency or any rate conversion that may have been applied. Type: Decimal
`currencyCode`	Not nullable. Currency code. Type: CurrencyCode

MoneyInput

InputObject

A monetary amount value along with its currency.

Field	Description
`amount`	Not nullable. Monetary amount value. The scale of the amount varies according to the currency or any rate conversion that may have been applied. Type: Decimal
`currencyCode`	Not nullable. Code of the currency of the amount. Type: CurrencyCode

ReplaceFeeSetInput

InputObject

Details to update a fee set.

Field	Description
`businessModel`	Not nullable. Business model used by the property. Type: FeeBusinessModel
`clientMutationId`	Partner's transaction ID that uniquely identifies the request, which can be used to associate requests and responses for troubleshooting purposes. This ID must be unique across requests and cannot be reused. However, if a request needs to be retried, such as because it failed or timed out, the ID provided in the original request should be used. The ID can be in any format as long as it uniquely identifies the request. Type: String
`fees`	Not nullable. One or more fees to include in the fee set. Type: Array of non nullable FeeInput
`id`	Not nullable. Fee set ID to update. Type: ID
`name`	Not nullable. Fee set name. Type: String
`propertyId`	Not nullable. ID of the property to which the fee set belongs. Type: ID

ReplaceFeeSetPayload

Object

Details about the fee set after it is updated.

Field	Description
`clientMutationId`	Partner's transaction ID that identifies the request, which can be used to correlate with partner's transaction logs. This ID must be unique across requests and cannot be reused. Type: String
`feeSet`	Not nullable. Details about the fee set. Type: FeeSet

String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Availability and Rates APIs

Booking APIs

Property Mgmt APIs

Product management

replaceFeeSet mutation

Syntax

Examples

Arguments

Types

Availability and Rates APIs

Booking APIs

Property Mgmt APIs

Product management

replaceFeeSet mutationCopy link

Syntax

Examples

Arguments

Types

replaceFeeSet mutation