Availability and rates APIs
Booking APIs
Property mgmt APIs
Developer Tools
Product management
ReferenceProduct management

setUnitLegalNumberOfNewYorkRoomsRegulatoryAttributes mutation

This mutation is offered as part of the product management capability, which is available to pilot partners only. If you are interested in adopting this capability, contact your Technical Account Manager.

Submits the legal number of rooms per unit for properties in New York City, for tax calculation purposes.

New York City has a room occupancy tax that must be charged based on the number of rooms inside of a unit. Use the property query to determine whether the property is in New York City. If so, this mutation can be used to provide the legal number of rooms in the unit, and Expedia will then use this information to calculate the tax amount that needs to be applied.

Syntax

1mutation {
2  setUnitLegalNumberOfNewYorkRoomsRegulatoryAttributes(
3    input: SetUnitLegalNumberOfNewYorkRoomsRegulatoryAttributesInput!
4): SetUnitLegalNumberOfNewYorkRoomsRegulatoryAttributesPayload
5}

Examples

1mutation {
2  setUnitLegalNumberOfNewYorkRoomsRegulatoryAttributes(
3    input: {
4      propertyType: "HOTEL",
5      legalNumberOfNewYorkRooms: 5,
6      unitId: "220341729"
7    }
8  ) {
9    propertyType
10    legalNumberOfNewYorkRooms
11    unitId
12  }
13}

Arguments

NameDescription

input

Required.
Type: SetUnitLegalNumberOfNewYorkRoomsRegulatoryAttributesInput

Types


Name
Type
ID
ID

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
Int

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

SetUnitLegalNumberOfNewYorkRoomsRegulatoryAttributesInput
InputObject

Input parameters for the setUnitLegalNumberOfNewYorkRoomsRegulatoryAttributes mutation.

FieldDescription
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
legalNumberOfNewYorkRoomsNot nullable.

Legal number of rooms per unit for New York tax calculation purposes. Must be greater than 0.

Type: Int
propertyTypeNot nullable.

The type of the property. Supported values are HOTEL or MOTEL.

Type: String
unitIdNot nullable.

Unit ID of the unit to which the legal number of rooms applies.

Type: ID
SetUnitLegalNumberOfNewYorkRoomsRegulatoryAttributesPayload
Object

Response payload for the setUnitLegalNumberOfNewYorkRoomsRegulatoryAttributes mutation.

FieldDescription
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
legalNumberOfNewYorkRoomsNot nullable.

Legal number of rooms per unit for New York tax calculation purposes.

Type: Int
propertyTypeNot nullable.

Type of the property.

Type: String
unitIdNot nullable.

Unit ID of the unit to which the legal number of rooms applies.

Type: ID
String
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.