Method: AvaTax::Client::Nexus#get_nexus

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

#get_nexus(companyId, id, options = {}) ⇒ Object

Retrieve a single nexus

Get the nexus object identified by this URL.

The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional taxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your accountant or lawyer prior to declaring nexus. You may specify one or more of the following values in the '$include' parameter to fetch additional nested data, using commas to separate multiple values:

  • Parameters

Security Policies

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

Parameters:

  • companyId (Integer) —

    The ID of the company that owns this nexus object

  • id (Integer) —

    The primary key of this nexus

  • include (String)

Returns:

  • (Object) 


170
171
 
# File 'lib/avatax/client/nexus.rb', line 170

def get_nexus(companyId, id, options={})        path = "/api/v2/companies/#{companyId}/nexus/#{id}"
get(path, options, AvaTax::VERSION)      end