Module: AvaTax::Client::FirmClientLinkages

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

Instance Method Summary collapse

Instance Method Details

#approve_firm_client_linkage(id) ⇒ Object

Approves linkage to a firm for a client account

This API enables the account admin of a client account to approve linkage request by a firm.

Security Policies

  • This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

  • id (Integer)

Returns:

  • (Object) 


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

def approve_firm_client_linkage(id)        path = "/api/v2/firmclientlinkages/#{id}/approve"
post(path, {}, {}, AvaTax::VERSION)      end

#create_and_link_new_firm_client_account(model) ⇒ Object

Request a new FirmClient account and create an approved linkage to it

This API is for use by Firms only.

Avalara allows firms to manage returns for clients without the clients needing to use AvaTax service. Firms can create accounts of FirmClient for customers they are managing using this API.

Calling this API creates an account with the specified product subscriptions, but without a new user for account. Account is then linked to the Firm so they can managed their returns. You should call this API when a customer does not have an AvaTax account and is to be managed only by the firm.

The created account will be created in Active status but there will be no user or license key associated with account.

Security Policies

  • This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SystemAdmin. Swagger Name: AvaTaxClient

Parameters:

  • model (Object) —

    Information about the account you wish to create.

Returns:

  • (Object) 


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

def (model)        path = "/api/v2/firmclientlinkages/createandlinkclient"
post(path, model, {}, AvaTax::VERSION)      end

#create_firm_client_linkage(model) ⇒ Object

Links a firm account with the client account

This API enables the firm admins/firm users to request the linkage of a firm account and a client account.

Security Policies

  • This API requires one of the following user roles: BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

  • model (Object) —

    FirmClientLinkageInputModel

Returns:

  • (Object) 


51
52
 
# File 'lib/avatax/client/firmclientlinkages.rb', line 51

def create_firm_client_linkage(model)        path = "/api/v2/firmclientlinkages"
post(path, model, {}, AvaTax::VERSION)      end

#delete_firm_client_linkage(id) ⇒ ErrorDetail[]

Delete a linkage

This API marks a linkage between a firm and client as deleted.

Security Policies

  • This API requires one of the following user roles: BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

  • id (Integer)

Returns:

  • (ErrorDetail[]) 


64
65
 
# File 'lib/avatax/client/firmclientlinkages.rb', line 64

def delete_firm_client_linkage(id)        path = "/api/v2/firmclientlinkages/#{id}"
delete(path, {}, AvaTax::VERSION)      end

#get_firm_client_linkage(id) ⇒ Object

Get linkage between a firm and client by id

This API enables the firm admins/firm users to request the linkage of a firm account and a client account.

Security Policies

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

Parameters:

  • id (Integer)

Returns:

  • (Object) 


77
78
 
# File 'lib/avatax/client/firmclientlinkages.rb', line 77

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

#list_firm_client_linkage(options = {}) ⇒ FetchResult

List client linkages for a firm or client

This API enables the firm or account users to request the associated linkages to the account.

Security Policies

  • This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser. 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: firmAccountName, clientAccountName

Returns:

  • (FetchResult) 


90
91
 
# File 'lib/avatax/client/firmclientlinkages.rb', line 90

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

#reject_firm_client_linkage(id) ⇒ Object

Rejects linkage to a firm for a client account

This API enables the account admin of a client account to reject linkage request by a firm.

Security Policies

  • This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

  • id (Integer)

Returns:

  • (Object) 


103
104
 
# File 'lib/avatax/client/firmclientlinkages.rb', line 103

def reject_firm_client_linkage(id)        path = "/api/v2/firmclientlinkages/#{id}/reject"
post(path, {}, {}, AvaTax::VERSION)      end

#reset_firm_client_linkage(id) ⇒ Object

Reset linkage status between a client and firm back to requested

This API enables the firm admin of a client account to reset a previously created linkage request by a firm.

Security Policies

  • This API requires one of the following user roles: BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

  • id (Integer)

Returns:

  • (Object) 


116
117
 
# File 'lib/avatax/client/firmclientlinkages.rb', line 116

def reset_firm_client_linkage(id)        path = "/api/v2/firmclientlinkages/#{id}/reset"
post(path, {}, {}, AvaTax::VERSION)      end

#revoke_firm_client_linkage(id) ⇒ Object

Revokes previously approved linkage to a firm for a client account

This API enables the account admin of a client account to revoke a previously approved linkage request by a firm.

Security Policies

  • This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin. Swagger Name: AvaTaxClient

Parameters:

  • id (Integer)

Returns:

  • (Object) 


129
130
 
# File 'lib/avatax/client/firmclientlinkages.rb', line 129

def revoke_firm_client_linkage(id)        path = "/api/v2/firmclientlinkages/#{id}/revoke"
post(path, {}, {}, AvaTax::VERSION)      end