Module: AvaTax::Client::Reports

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

Instance Method Summary collapse

Instance Method Details

#download_report(id) ⇒ Object

Download a report

This API downloads the file associated with a report.

If the report is not yet complete, you will receive a ReportNotFinished error. To check if a report is complete, use the GetReport API.

Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download for up to 30 days after completion. To run an asynchronous report, you should follow these steps:

  • Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type.
  • In the result of the Initiate API, you receive back a report's id value.
  • Check the status of a report by calling GetReport and passing in the report's id value.

  • When a report's status is Completed, call DownloadReport to retrieve the file.

  • We throttle this API. You can only call this API up to 5 times in a minute.

Security Policies

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

Parameters:

  • id (Integer) —

    The unique ID number of this report

Returns:

  • (Object) 


29
30
 
# File 'lib/avatax/client/reports.rb', line 29

def download_report(id)        path = "/api/v2/reports/#{id}/attachment"
get(path, {}, AvaTax::VERSION)      end

#get_report(id) ⇒ Object

Retrieve a single report

Retrieve a single report by its unique ID number.

Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download for up to 30 days after completion. To run an asynchronous report, you should follow these steps:

  • Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type.
  • In the result of the Initiate API, you receive back a report's id value.
  • Check the status of a report by calling GetReport and passing in the report's id value.
  • When a report's status is Completed, call DownloadReport to retrieve the file.

This API call returns information about any report type. Swagger Name: AvaTaxClient

Parameters:

  • id (Integer) —

    The unique ID number of the report to retrieve

Returns:

  • (Object) 


48
49
 
# File 'lib/avatax/client/reports.rb', line 48

def get_report(id)        path = "/api/v2/reports/#{id}"
get(path, {}, AvaTax::VERSION)      end

#initiate_export_document_line_report(companyId, model) ⇒ ReportModel[]

Initiate an ExportDocumentLine report task

Begins running an ExportDocumentLine report task and returns the identity of the report.

Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download for up to 30 days after completion. To run an asynchronous report, you should follow these steps:

  • Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type.
  • In the result of the Initiate API, you receive back a report's id value.
  • Check the status of a report by calling GetReport and passing in the report's id value.
  • When a report's status is Completed, call DownloadReport to retrieve the file.

The ExportDocumentLine report produces information about invoice lines recorded within your account.

To split large reports into multiple smaller partitions, use the numberOfPartitions and partition properties on ExportDocumentLineModel.

Example - split a report into three partitions

  • Follow the steps above with numberOfPartitions = 3 and partition = 0
  • Follow the steps above with numberOfPartitions = 3 and partition = 1
  • Follow the steps above with numberOfPartitions = 3 and partition = 2
  • Once all three reports are downloaded merge the files on the client side.

Security Policies

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

Parameters:

  • companyId (Integer) —

    The unique ID number of the company to report on.

  • model (Object) —

    Options that may be configured to customize the report.

Returns:

  • (ReportModel[]) 


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

def initiate_export_document_line_report(companyId, model)        path = "/api/v2/companies/#{companyId}/reports/exportdocumentline/initiate"
post(path, model, {}, AvaTax::VERSION)      end

#list_reports(options = {}) ⇒ FetchResult

List all report tasks for account

List all report tasks for your account.

Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download for up to 30 days after completion. To run an asynchronous report, you should follow these steps:

  • Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type.
  • In the result of the Initiate API, you receive back a report's id value.
  • Check the status of a report by calling GetReport and passing in the report's id value.
  • When a report's status is Completed, call DownloadReport to retrieve the file.

This API call returns information about all report types across your entire account.

Security Policies

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

Parameters:

  • companyId (Integer) —

    The id of the company for which to get reports.

  • pageKey (String) —

    Provide a page key to retrieve the next page of results.

  • skip (Integer) —

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

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

Returns:

  • (FetchResult) 


107
108
 
# File 'lib/avatax/client/reports.rb', line 107

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