Module: AvaTax::Client::Filings

Included in:
AvaTax::Client
Defined in:
lib/avatax/client/filings.rb

Instance Method Summary collapse

Instance Method Details

#get_accrual_filings(companyId, filingReturnId) ⇒ FetchResult

Retrieve a filing containing the return and all its accrual returns.

Security Policies

  • This API requires openId bearer token for authentication
  • This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. Swagger Name: AvaTaxClient

Parameters:

  • companyId (Integer) —

    The ID of the company that owns these returns

  • filingReturnId (Integer) —

    The ID of the filing return

Returns:

  • (FetchResult) 


16
17
 
# File 'lib/avatax/client/filings.rb', line 16

def get_accrual_filings(companyId, filingReturnId)        path = "/api/v2/companies/#{companyId}/filings/accrual/#{filingReturnId}"
get(path, {}, "22.3.0")      end

#get_filed_returns(companyId, options = {}) ⇒ FetchResult

Retrieve a list of filed returns for the specified company in the year and month of a given filing period.

Security Policies

  • This API requires openId bearer token for authentication
  • This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
  • This API is available by invitation only.Exempt security roles: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser, CompanyUser, AccountUser, CompanyAdmin, AccountAdmin.
  • 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:

  • companyId (Integer) —

    The ID of the company that owns these batches

  • endPeriodMonth (Integer) —

    The month of the period you are trying to retrieve

  • endPeriodYear (Integer) —

    The year of the period you are trying to retrieve

  • frequency (String) —

    The frequency of the return you are trying to retrieve (See FilingFrequencyId::* for a list of allowable values)

  • status (String) —

    The status of the return(s) you are trying to retrieve (See FilingStatusId::* for a list of allowable values)

  • country (String) —

    The country of the return(s) you are trying to retrieve

  • region (String) —

    The region of the return(s) you are trying to retrieve

  • filingCalendarId (Integer) —

    The filing calendar id of the return you are trying to retrieve

  • taxformCode (String) —

    The unique tax form code of the form.

Returns:

  • (FetchResult) 


38
39
 
# File 'lib/avatax/client/filings.rb', line 38

def get_filed_returns(companyId, options={})        path = "/api/v2/companies/#{companyId}/filings/returns/filed"
get(path, options, "22.3.0")      end