Method: AvaTax::Client::Customers#list_attributes_for_customer

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

#list_attributes_for_customer(companyId, customerCode) ⇒ FetchResult

Retrieve a customer's attributes

Retrieve the attributes linked to the customer identified by this URL.

A customer may have multiple attributes that control its behavior. You may link or unlink attributes to a customer at any time. The full list of defined attributes may be found using QueryCompanyCustomerAttributes API.

A customer object defines information about a person or business that purchases products from your company. When you create a tax transaction in AvaTax, you can use the customerCode from this record in your CreateTransaction API call. AvaTax will search for this customerCode value and identify any certificates linked to this customer object. If any certificate applies to the transaction, AvaTax will record the appropriate elements of the transaction as exempt and link it to the certificate.

Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage. Companies that do not have this storage system set up will see CertCaptureNotConfiguredError when they call exemption certificate related APIs. To check if this is set up for a company, call GetCertificateSetup. To request setup of exemption certificate storage for this company, call RequestCertificateSetup.

Security Policies

  • This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
  • This API depends on the following active services:Required (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms. Swagger Name: AvaTaxClient

Parameters:

  • companyId (Integer) —

    The unique ID number of the company that recorded the provided customer

  • customerCode (String) —

    The unique code representing the current customer

Returns:

  • (FetchResult) 


212
213
 
# File 'lib/avatax/client/customers.rb', line 212

def list_attributes_for_customer(companyId, customerCode)        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/attributes"
get(path, {}, AvaTax::VERSION)      end