Module: AvaTax::Client::ErrorTransactions

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

Instance Method Summary collapse

Instance Method Details

#delete_error_transactions(companyId, model) ⇒ Object

Delete a batch of error transactions

Delete a batch of error transactions attached to a company.

If any of the provided error transaction isn't found then it'll be treated as a success.

Security Policies

  • This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
  • This API depends on the following active services
    Required (all): AvaTaxPro, BasicReturns.

Parameters:

  • companyId (Integer) —

    ID number of the company to delete error transactions from.

  • model (Object) —

    The request that contains error transactions to be deleted

Returns:

  • (Object) 


19
20
 
# File 'lib/avatax/client/errortransactions.rb', line 19

def delete_error_transactions(companyId, model)        path = "/api/v2/companies/#{companyId}/errortransactions"
delete(path, model)      end

#list_error_codes(companyId, options = {}) ⇒ CappedFetchResult

Get a list of error transactions' error codes and its counts

Get a list of error transactions' error codes and their counts When you try to create or adjust a transaction with a datasource for a company and for any reason that call fails with an error, those errors with their count can be retrieved by this API.

Security Policies

  • This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
  • This API depends on the following active services
    Required (all): AvaTaxPro, BasicReturns.

Parameters:

  • companyId (Integer) —

    ID number of the company to query from.

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

Returns:

  • (CappedFetchResult) 


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

def list_error_codes(companyId, options={})        path = "/api/v2/companies/#{companyId}/errortransactions/errorcodes"
get(path, options)      end

#list_error_transactions(companyId, options = {}) ⇒ CappedFetchResult

Retrieve list of error transactions

List error transactions attached to this company. Results are dependent on $filter if provided.

This endpoint is limited to returning 1000 error transactions at a time maximum.

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, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
  • This API depends on the following active services
    Required (all): AvaTaxPro, BasicReturns.

Parameters:

  • companyId (Integer) —

    The company ID to filter error transactions on.

  • filter (String) —

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

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

  • (CappedFetchResult) 


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

def list_error_transactions(companyId, options={})        path = "/api/v2/companies/#{companyId}/errortransactions"
get(path, options)      end