Module: AvaTax::Client::Onboarding

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

Instance Method Summary collapse

Instance Method Details

#request_new_account(model) ⇒ Object

Request a new Avalara account

This API is for use by partner onboarding services customers only.

Avalara invites select partners to refer new customers to the AvaTax service using the onboarding features of AvaTax. These partners can create accounts for new customers using this API.

Calling this API creates an account with the specified product subscriptions, but does not configure billing. The customer will receive information from Avalara about how to configure billing for their account. You should call this API when a customer has requested to begin using Avalara services.

If the newly created account owner wishes, they can confirm that they have read and agree to the Avalara terms and conditions. If they do so, they can receive a license key as part of this API and their API will be created in Active status. If the customer has not yet read and accepted these terms and conditions, the account will be created in New status and they can receive a license key by logging onto the AvaTax website and reviewing terms and conditions online.

Security Policies

  • This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
  • This API is available by invitation only.
  • This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Onboarding:RequestNewAccount].

Parameters:

  • model (Object) —

    Information about the account you wish to create and the selected product offerings.

Returns:

  • (Object) 


30
31
32
33
 
# File 'lib/avatax/client/onboarding.rb', line 30

def (model)
  path = "/api/v2/accounts/request"
  post(path, model)
end

#request_new_entitlement(id, offer) ⇒ Object

Request a new entitilement to an existing customer

This API is for use by partner onboarding services customers only. This will allow the partners to allow the add new entitlement to an existing customer

Security Policies

  • This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
  • This API is available by invitation only.
  • This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Onboarding:RequestNewAccount].

Parameters:

  • id (Integer) —

    The avatax account id of the customer

  • offer (String) —

    The offer to be added to an already existing customer

Returns:

  • (Object) 


49
50
51
52
 
# File 'lib/avatax/client/onboarding.rb', line 49

def request_new_entitlement(id, offer)
  path = "/api/v2/accounts/#{id}/entitlements/#{offer}"
  post(path)
end