Module: AvaTax::Client::JurisdictionOverrides

Included in:

AvaTax::Client

Defined in:

lib/avatax/client/jurisdictionoverrides.rb

Instance Method Summary

• #create_jurisdiction_overrides(accountId, model) ⇒ JurisdictionOverrideModel[]

  Create one or more overrides.

• #delete_jurisdiction_override(accountId, id) ⇒ ErrorDetail[]

  Delete a single override.

• #get_jurisdiction_override(accountId, id) ⇒ Object

  Retrieve a single override.

• #list_jurisdiction_overrides_by_account(accountId, options = {}) ⇒ FetchResult

  Retrieve overrides for this account.

• #query_jurisdiction_overrides(options = {}) ⇒ FetchResult

  Retrieve all overrides.

• #update_jurisdiction_override(accountId, id, model) ⇒ Object

  Update a single jurisdictionoverride.

Instance Method Details

#create_jurisdiction_overrides(accountId, model) ⇒ JurisdictionOverrideModel[]

Create one or more overrides

Creates one or more jurisdiction override objects for this account.

A Jurisdiction Override is a configuration setting that allows you to select the taxing jurisdiction for a specific address. If you encounter an address that is on the boundary between two different jurisdictions, you can choose to set up a jurisdiction override to switch this address to use different taxing jurisdictions.

Security Policies

• This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

• accountId (Integer) —

  The ID of the account that owns this override

• model (JurisdictionOverrideModel[]) —

  The jurisdiction override objects to create

Returns:

• (JurisdictionOverrideModel[])

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

def create_jurisdiction_overrides(accountId, model)        path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides"
post(path, model, {}, AvaTax::VERSION)      end

#delete_jurisdiction_override(accountId, id) ⇒ ErrorDetail[]

Delete a single override

Marks the item object at this URL as deleted.

Security Policies

• This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

• accountId (Integer) —

  The ID of the account that owns this override

• id (Integer) —

  The ID of the override you wish to delete

Returns:

• (ErrorDetail[])

# File 'lib/avatax/client/jurisdictionoverrides.rb', line 36

def delete_jurisdiction_override(accountId, id)        path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
delete(path, {}, AvaTax::VERSION)      end

#get_jurisdiction_override(accountId, id) ⇒ Object

Retrieve a single override

Get the item object identified by this URL.

A Jurisdiction Override is a configuration setting that allows you to select the taxing jurisdiction for a specific address. If you encounter an address that is on the boundary between two different jurisdictions, you can choose to set up a jurisdiction override to switch this address to use different taxing jurisdictions.

Security Policies

• This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

• accountId (Integer) —

  The ID of the account that owns this override

• id (Integer) —

  The primary key of this override

Returns:

• (Object)

# File 'lib/avatax/client/jurisdictionoverrides.rb', line 55

def get_jurisdiction_override(accountId, id)        path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
get(path, {}, AvaTax::VERSION)      end

#list_jurisdiction_overrides_by_account(accountId, options = {}) ⇒ FetchResult

Retrieve overrides for this account

List all jurisdiction override objects defined for this account.

A Jurisdiction Override is a configuration setting that allows you to select the taxing jurisdiction for a specific address. If you encounter an address that is on the boundary between two different jurisdictions, you can choose to set up a jurisdiction override to switch this address to use different taxing jurisdictions.

Search for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST . Paginate your results using the $top, $skip, and $orderby parameters.

Security Policies

• This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. Swagger Name: AvaTaxClient

Parameters:

• accountId (Integer) —

  The ID of the account that owns this override

• filter (String) —

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

• include (String) —

  A comma separated list of additional data to retrieve.

• 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)

# File 'lib/avatax/client/jurisdictionoverrides.rb', line 81

def list_jurisdiction_overrides_by_account(accountId, options={})        path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides"
get(path, options, AvaTax::VERSION)      end

#query_jurisdiction_overrides(options = {}) ⇒ FetchResult

Retrieve all overrides

Get multiple jurisdiction override objects across all companies.

A Jurisdiction Override is a configuration setting that allows you to select the taxing jurisdiction for a specific address. If you encounter an address that is on the boundary between two different jurisdictions, you can choose to set up a jurisdiction override to switch this address to use different taxing jurisdictions.

Search for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST . Paginate your results using the $top, $skip, and $orderby parameters.

Security Policies

• This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser. 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: country, Jurisdictions

• include (String) —

  A comma separated list of additional data to retrieve.

• 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)

# File 'lib/avatax/client/jurisdictionoverrides.rb', line 106

def query_jurisdiction_overrides(options={})        path = "/api/v2/jurisdictionoverrides"
get(path, options, AvaTax::VERSION)      end

#update_jurisdiction_override(accountId, id, model) ⇒ Object

Update a single jurisdictionoverride

Replace the existing jurisdictionoverride object at this URL with an updated object.

Security Policies

• This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

• accountId (Integer) —

  The ID of the account that this jurisdictionoverride belongs to.

• id (Integer) —

  The ID of the jurisdictionoverride you wish to update

• model (Object) —

  The jurisdictionoverride object you wish to update.

Returns:

• (Object)

# File 'lib/avatax/client/jurisdictionoverrides.rb', line 121

def update_jurisdiction_override(accountId, id, model)        path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
put(path, model, {}, AvaTax::VERSION)      end