Module: AvaTax::Client::APConfigSetting

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

Instance Method Summary collapse

Instance Method Details

#create_a_p_config_setting(companyid, model) ⇒ Object

Create new rule

Swagger Name: AvaTaxClient

Parameters:

  • companyid (Integer) —

    The ID of the company that owns this AP Config Setting object

  • model (Object) —

    The AP Config Setting you wish to create.

Returns:

  • (Object) 


13
14
 
# File 'lib/avatax/client/apconfigsetting.rb', line 13

def create_a_p_config_setting(companyid, model)        path = "/api/v2/companies/#{companyid}/apconfigsetting"
post(path, model, {}, AvaTax::VERSION)      end

#get_a_p_config_setting_by_company(companyid, options = {}) ⇒ FetchResult

Retrieve rule for this company

Swagger Name: AvaTaxClient

Parameters:

  • companyid (Integer) —

    The ID of the company that defined this rule

  • filter (String) —

    A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
    Not filterable: meta, amount, varianceForIgnore, varianceForAccrue, variancePercent

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


27
28
 
# File 'lib/avatax/client/apconfigsetting.rb', line 27

def get_a_p_config_setting_by_company(companyid, options={})        path = "/api/v2/companies/#{companyid}/apconfigsetting"
get(path, options, AvaTax::VERSION)      end

#query_a_p_config_setting(options = {}) ⇒ FetchResult

Retrieve all rules

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: meta, amount, varianceForIgnore, varianceForAccrue, variancePercent

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


40
41
 
# File 'lib/avatax/client/apconfigsetting.rb', line 40

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

#update_a_p_config_setting(companyid, model) ⇒ Object

Update a AP config setting

Swagger Name: AvaTaxClient

Parameters:

  • companyid (Integer) —

    The ID of the company that owns this AP config setting object

  • model (Object) —

    The AP config setting object you wish to update.

Returns:

  • (Object) 


50
51
 
# File 'lib/avatax/client/apconfigsetting.rb', line 50

def update_a_p_config_setting(companyid, model)        path = "/api/v2/companies/#{companyid}/apconfigsetting"
put(path, model, {}, AvaTax::VERSION)      end