Module: AvaTax::Client::Compliance

Defined in:
lib/avatax/client/compliance.rb

Instance Method Summary collapse

Instance Method Details

#query_juris_names(country, region, options = {}) ⇒ FetchResult

Retrieve all unique jurisnames based on filter.

Security Policies

  • This API depends on the following active services:Returns (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.Firm Managed (for accounts managed by a firm): ARA, ARAManaged. Swagger Name: AvaTaxClient

Parameters:

  • country (String) —

    The two-character ISO-3166 code for the country.

  • region (String) —

    The two or three character region code for the region.

  • effectiveDate (DateTime) —

    Used to limit the jurisnames returned.

  • endDate (DateTime) —

    Used to limit the jurisnames returned.

  • filter (String) —

    A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.

  • top (Integer) —

    If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.

  • skip (Integer) —

    If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.

  • orderBy (String) —

    A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC.

Returns:

  • (FetchResult) 


21
22
 
# File 'lib/avatax/client/compliance.rb', line 21

def query_juris_names(country, region, options={})        path = "/api/v2/compliance/jurisnames/#{country}/#{region}"
get(path, options, AvaTax::VERSION)      end

#query_rate_options(country, region, options = {}) ⇒ FetchResult

Retrieve all RateOptions.

This API is available by invitation only.

Security Policies

  • This API depends on the following active services:Returns (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.Firm Managed (for accounts managed by a firm): ARA, ARAManaged. Swagger Name: AvaTaxClient

Parameters:

  • country (String) —

    The two-character ISO-3166 code for the country.

  • region (String) —

    The two or three character region code for the region.

  • effectiveDate (DateTime) —

    Used to limit the jurisdictions or rates returned.

  • endDate (DateTime) —

    Used to limit the jurisdictions or rates returned.

  • aggregationOption (String) —

    Aggregation method used. (See StackAggregationOption::* for a list of allowable values)

  • top (Integer) —

    If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.

  • skip (Integer) —

    If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.

  • filter (String) —

    A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
    Not filterable: taxRegionId, taxTypeCodeName, taxSubTypeCode, taxSubTypeCodeName, rateTypeCodeName, componentRate, taxAuthorityId, cityName, countyName, effDate, endDate

  • orderBy (String) —

    A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC.

Returns:

  • (FetchResult) 


42
43
 
# File 'lib/avatax/client/compliance.rb', line 42

def query_rate_options(country, region, options={})        path = "/api/v2/compliance/rateOptions/#{country}/#{region}"
get(path, options, AvaTax::VERSION)      end

#query_state_config(options = {}) ⇒ FetchResult

Retrieve StateConfig information

This API is available by invitation only.

Security Policies

  • This API depends on the following active services:Returns (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.Firm Managed (for accounts managed by a firm): ARA, ARAManaged. Swagger Name: AvaTaxClient

Parameters:

  • filter (String) —

    A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
    Not filterable: effDate, endDate, hasBoundary, hasRates, isLocalAdmin, isLocalNexus, isSerState, minBoundaryLevelId, sstStatusId, state, stateFips, boundaryTableBaseName, stjCount, tsStateId, isJaasEnabled, hasSSTBoundary

  • top (Integer) —

    If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.

  • skip (Integer) —

    If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.

  • orderBy (String) —

    A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC.

Returns:

  • (FetchResult) 


58
59
 
# File 'lib/avatax/client/compliance.rb', line 58

def query_state_config(options={})        path = "/api/v2/compliance/stateconfig"
get(path, options, AvaTax::VERSION)      end

#query_state_reporting_codes(country, region, options = {}) ⇒ FetchResult

Retrieve all State Reporting Codes based on filter.

Security Policies

  • This API depends on the following active services:Returns (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.Firm Managed (for accounts managed by a firm): ARA, ARAManaged. Swagger Name: AvaTaxClient

Parameters:

  • country (String) —

    The two-character ISO-3166 code for the country.

  • region (String) —

    The two or three character region code for the region.

  • effectiveDate (DateTime) —

    Used to limit the StateReportingCodes or rates returned.

  • endDate (DateTime) —

    Used to limit the StateReportingCodes or rates returned.

  • filter (String) —

    A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
    Not filterable: label

  • top (Integer) —

    If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.

  • skip (Integer) —

    If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.

  • orderBy (String) —

    A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC.

Returns:

  • (FetchResult) 


76
77
 
# File 'lib/avatax/client/compliance.rb', line 76

def query_state_reporting_codes(country, region, options={})        path = "/api/v2/compliance/stateReportingCodes/#{country}/#{region}"
get(path, options, AvaTax::VERSION)      end

#query_tax_type_mappings(options = {}) ⇒ FetchResult

Retrieve all tax type mappings based on filter.

Security Policies

  • This API depends on the following active services:Returns (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.Firm Managed (for accounts managed by a firm): ARA, ARAManaged. Swagger Name: AvaTaxClient

Parameters:

  • filter (String) —

    A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
    Not filterable: taxTypeGroupIdSK, taxTypeIdSK, taxSubTypeIdSK, generalOrStandardRateTypeIdSK, taxTypeGroupId, taxTypeId, country, generalOrStandardRateTypeId

  • top (Integer) —

    If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.

  • skip (Integer) —

    If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.

  • orderBy (String) —

    A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC.

Returns:

  • (FetchResult) 


90
91
 
# File 'lib/avatax/client/compliance.rb', line 90

def query_tax_type_mappings(options={})        path = "/api/v2/compliance/taxtypemappings"
get(path, options, AvaTax::VERSION)      end