Boolean
Boolean The Boolean scalar type represents true or false.
Date
Date Scalar that represents a date string compliant with the RFC 3339 profile of the ISO 8601 standard.
IdSource
Enum Source of a given ID.
Name Description EXPEDIAExpedia is the source of the ID.
SUPPLIERConnectivity provider or lodging partner is the source of the ID. This value is not supported for use in promotions.
VRBOUnsupported.
Int
Int The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
JurisdictionAttribute
Object Details about the tax rule's attribute and how its validated.
Field Description attributeFieldsNot nullable. One or more fields that constitute the attribute.
Type: Array of non nullable JurisdictionAttributeField typeNot nullable. Purpose of attribute.
Type: String valueTypeNot nullable. Type of the attribute's value, such as BOOLEAN or TEXT.
Type: String
JurisdictionAttributeField
Object Field that constitutes the tax rule attribute.
Field Description defaultValueDefault value of the attribute field.
Type: String enumValuesNot nullable. List of allowed values for the attribute field for enumeration attribute
fields. Empty when type is numeric or does not have an enumerated list of
possible values.
Type: Array of non nullable String pathNot nullable. Path for setting data in this attribute. 'data' for a simple type, or 'data.fieldName' for complex objects.
Type: String requiredNot nullable. Whether this attribute field is required.
Type: Boolean validationValidation applied to this attribute field.
Type: JurisdictionAttributeValidation
JurisdictionAttributeValidation
Object Validation applied to the attribute field.
Field Description expressionValueNot nullable. Value for checking against the attribute to determine if the condition is met,
such as a regex pattern or a maximum number.
Type: String validationTypeNot nullable. Type of check applied to this condition, such as REGEX, MIN, or MAX.
Type: String
JurisdictionComplianceRequirement
Object Compliance requirement for the tax rule.
Field Description expiresNot nullable. Whether the compliance requirement expires.
Type: Boolean jurisdictionAttributeNot nullable. Details about the tax rule's attribute and how its validated.
Type: JurisdictionAttribute nameNot nullable. Name of the compliance requirement. If legal_room_count is returned and
required : true, you can use the
setUnitLegalNumberOfNewYorkRoomsRegulatoryAttributes mutation
provided by the product management capability to set the number of units for
properties in New York City.
Type: String referenceIdNot nullable. Reference ID of the attribute for use in ruleCondition.
Type: String requiredNot nullable. Whether the compliance requirement is required (mandatory).
Type: Boolean ruleConditionDetails about the tax rule's condition and how its validated.
Type: JurisdictionCondition
JurisdictionCondition
Object Details about the tax rule's condition and how its validated.
Field Description dependsOnNot nullable. Property attribute that the tax rule depends on, such as property_type.
Type: Array of non nullable String validationNot nullable. Validation applied to this condition.
Type: JurisdictionValidation
JurisdictionRule
Object Jurisdiction's tax rule.
Field Description complianceRequirementsNot nullable. Compliance requirements for the tax rule.
Type: Array of non nullable JurisdictionComplianceRequirement effectiveDateNot nullable. Date when the jurisdiction rule goes into effect.
Type: Date enforcementDateNot nullable. Date when the jurisdiction rule will begin to be enforced.
Type: Date expiryDateDate when the jurisdiction rule will expire.
Type: Date gracePeriodInDaysNot nullable. Number of days after effectiveDate when the rule will not be enforced (grace period).
Type: Int idNot nullable. ID of the regulatory rule.
Type: String
JurisdictionValidation
Object Validation criteria.
Field Description conditionsNot nullable. Conditions of the validation.
Type: Array of non nullable JurisdictionValidationCondition expressionNot nullable. Combination of one or more validation condition IDs used to determine if the
overall validation is met. Conditions can be joined with logical operators of
AND or OR, and they can be grouped by parentheses to clarify order of operations.
Type: String
JurisdictionValidationCondition
Object Conditions of the validation.
Field Description attributePathNot nullable. Path for the attribute field being referenced.
Type: String attributeReferenceIdNot nullable. Reference ID for the data attribute to be validated.
Type: String idNot nullable. ID used to reference this validation condition.
Type: String validationNot nullable. Validation applied to the attribute field.
Type: JurisdictionAttributeValidation
LocalTaxJurisdiction
Object Tax rules for a property's jurisdiction.
Field Description nameName of the jurisdiction.
Type: String rulesNot nullable. Jurisdiction's tax rules.
Type: Array of non nullable JurisdictionRule
Property
Object Representation of a physical property, including its units, reservations, and promotions.
Field Description localTaxJurisdictionTax rules for the local jurisdiction (especially useful for properties in New York City).
Type: LocalTaxJurisdiction
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.