Module: AvaTax::Client::Notices

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

Instance Method Summary collapse

Instance Method Details

#create_notice_responsibility_type(model) ⇒ Object

Creates a new tax notice responsibility type.

This API is available by invitation only and only available for users with Compliance admin access.

Security Policies

  • This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
  • 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:

  • model (Object) —

    The responsibility type to create

Returns:

  • (Object) 


17
18
 
# File 'lib/avatax/client/notices.rb', line 17

def create_notice_responsibility_type(model)        path = "/api/v2/notices/responsibilities"
post(path, model, {}, AvaTax::VERSION)      end

#create_notice_root_cause_type(model) ⇒ Object

Creates a new tax notice root cause type.

This API is available by invitation only and only available for users with Compliance admin access.

Security Policies

  • This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
  • 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:

  • model (Object) —

    The root cause type to create

Returns:

  • (Object) 


31
32
 
# File 'lib/avatax/client/notices.rb', line 31

def create_notice_root_cause_type(model)        path = "/api/v2/notices/rootcauses"
post(path, model, {}, AvaTax::VERSION)      end

#delete_notice_responsibility_type(responsibilityId) ⇒ ErrorDetail[]

Delete a tax notice responsibility type.

This API is available by invitation only and only available for users with Compliance admin access.

Security Policies

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

Parameters:

  • responsibilityId (Integer) —

    The unique ID of the responsibility type

Returns:

  • (ErrorDetail[]) 


44
45
 
# File 'lib/avatax/client/notices.rb', line 44

def delete_notice_responsibility_type(responsibilityId)        path = "/api/v2/notices/responsibilities/#{responsibilityId}"
delete(path, {}, AvaTax::VERSION)      end

#delete_notice_root_cause_type(rootCauseId) ⇒ ErrorDetail[]

Delete a tax notice root cause type.

This API is available by invitation only and only available for users with Compliance admin access.

Security Policies

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

Parameters:

  • rootCauseId (Integer) —

    The unique ID of the root cause type

Returns:

  • (ErrorDetail[]) 


57
58
 
# File 'lib/avatax/client/notices.rb', line 57

def delete_notice_root_cause_type(rootCauseId)        path = "/api/v2/notices/rootcauses/#{rootCauseId}"
delete(path, {}, AvaTax::VERSION)      end