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

localTaxJurisdiction query

This query 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.

Retrieves a property's tax rules according to its jurisdiction. This is especially important for properties in New York City.

Syntax

1query {  
2  property( 
3    id: String!,  
4    idSource: IdSource 
5  ) {  
6    localTaxJurisdiction: LocalTaxJurisdiction
7  }  
8}

Example

1query {
2  property(id:"6092805") {
3    localTaxJurisdiction {
4      name
5      rules {
6        id
7        effectiveDate
8        enforcementDate
9        expiryDate
10        gracePeriodInDays
11        complianceRequirements {
12          required
13          referenceId
14          jurisdictionAttribute {
15            type
16            valueType
17            attributeFields {
18              required
19              path
20              enumValues
21              defaultValue
22              validation{
23                validationType
24                expressionValue
25              }
26            }
27          }
28          name
29          ruleCondition {
30            dependsOn
31            validation {
32              expression
33              conditions {
34                id
35                attributePath
36                attributeReferenceId
37                validation {
38                  validationType
39                  expressionValue
40                }
41              }
42            }
43          }
44          expires
45        }
46      }
47    }
48  }
49}

Arguments

NameDescription

id

Required.

Expedia ID (EID) or supplier ID (external ID in the partner's system) of the property..

Type: String

idSource

Source system of the ID. EXPEDIA is the default value.

Type: IdSource

Types


Name
Type
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.

NameDescription
EXPEDIA

Expedia is the source of the ID.

SUPPLIER

Connectivity provider or lodging partner is the source of the ID. This value is not supported for use in promotions.

VRBO

Unsupported.

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.

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

FieldDescription
defaultValue

Default 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
validation

Validation applied to this attribute field.

Type: JurisdictionAttributeValidation
JurisdictionAttributeValidation
Object

Validation applied to the attribute field.

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

FieldDescription
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
ruleCondition

Details 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.

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

FieldDescription
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
expiryDate

Date 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.

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

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

FieldDescription
name

Name 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.

FieldDescription
localTaxJurisdiction

Tax 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.