Module: AvaTax::Client::Customers

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

Instance Method Summary collapse

Instance Method Details

#create_customers(companyId, model) ⇒ CustomerModel[]

Create customers for this company

Create one or more customers for this company.

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.

A nested object such as CustomFields could be specified and created along with the customer object. To fetch the nested object, please call 'GetCustomer' API with appropriate $include parameters.

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.
  • This API depends on the following active services:Required (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

  • companyId (Integer) —

    The unique ID number of the company that recorded this customer

  • model (CustomerModel[]) —

    The list of customer objects to be created

Returns:

  • (CustomerModel[]) 


32
33
 
# File 'lib/avatax/client/customers.rb', line 32

def create_customers(companyId, model)        path = "/api/v2/companies/#{companyId}/customers"
post(path, model, {}, AvaTax::VERSION)      end

#delete_customer(companyId, customerCode) ⇒ Object

Delete a customer record

Deletes the customer object referenced by this URL.

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.
  • This API depends on the following active services:Required (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

  • companyId (Integer) —

    The unique ID number of the company that recorded this customer

  • customerCode (String) —

    The unique code representing this customer

Returns:

  • []



58
59
 
# File 'lib/avatax/client/customers.rb', line 58

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

#get_customer(companyId, customerCode, options = {}) ⇒ Object

Retrieve a single customer

Retrieve the customer identified by this URL.

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.

You can use the $include parameter to fetch the following additional objects for expansion:

  • Certificates - Fetch a list of certificates linked to this customer.
  • CustomFields - Fetch a list of custom fields associated to this customer.
  • attributes - Retrieves all attributes applied to the customer.

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. Swagger Name: AvaTaxClient

Parameters:

  • companyId (Integer) —

    The unique ID number of the company that recorded this customer

  • customerCode (String) —

    The unique code representing this customer

  • include (String) —

    Specify optional additional objects to include in this fetch request

Returns:

  • (Object) 


91
92
 
# File 'lib/avatax/client/customers.rb', line 91

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

#link_attributes_to_customer(companyId, customerCode, model) ⇒ FetchResult

Link attributes to a customer

Link one or many attributes to a customer.

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.
  • This API depends on the following active services:Required (all): AvaTaxPro. 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

  • model (CustomerAttributeModel[]) —

    The list of attributes to link to the customer.

Returns:

  • (FetchResult) 


121
122
 
# File 'lib/avatax/client/customers.rb', line 121

def link_attributes_to_customer(companyId, customerCode, model)        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/attributes/link"
put(path, model, {}, AvaTax::VERSION)      end

#link_certificates_to_customer(companyId, customerCode, model) ⇒ FetchResult

Link certificates to a customer

Link one or more certificates to a customer.

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. Swagger Name: AvaTaxClient

Parameters:

  • companyId (Integer) —

    The unique ID number of the company that recorded this customer

  • customerCode (String) —

    The unique code representing this customer

  • model (Object) —

    The list of certificates to link to this customer

Returns:

  • (FetchResult) 


148
149
 
# File 'lib/avatax/client/customers.rb', line 148

def link_certificates_to_customer(companyId, customerCode, model)        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certificates/link"
post(path, model, {}, AvaTax::VERSION)      end

#link_ship_to_customers_to_bill_customer(companyId, code, model) ⇒ Object

Link two customer records together

Links a Ship-To customer record with a Bill-To customer record.

Customer records represent businesses or individuals who can provide exemption certificates. Some customers may have certificates that are linked to their shipping address or their billing address. To group these customer records together, you may link multiple bill-to and ship-to addresses together to represent a single entity that has multiple different addresses of different kinds.

In general, a customer will have only one primary billing address and multiple ship-to addresses, representing all of the different locations where they receive goods. To facilitate this type of customer, you can send in one bill-to customer code and multiple ship-to customer codes in a single API call.

Note that you can only link a ship-to customer record to a bill-to customer record. You may not link two customers of the same kind together.

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. Swagger Name: AvaTaxClient

Parameters:

  • companyId (Integer) —

    The unique ID number of the company defining customers.

  • code (String) —

    The code of the bill-to customer to link.

  • model (Object) —

    A list of information about ship-to customers to link to this bill-to customer.

Returns:

  • (Object) 


176
177
 
# File 'lib/avatax/client/customers.rb', line 176

def link_ship_to_customers_to_bill_customer(companyId, code, model)        path = "/api/v2/companies/#{companyId}/customers/billto/#{code}/shipto/link"
post(path, model, {}, AvaTax::VERSION)      end

#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. 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) 


205
206
 
# File 'lib/avatax/client/customers.rb', line 205

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

#list_certificates_for_customer(companyId, customerCode, options = {}) ⇒ FetchResult

List certificates linked to a customer

List all certificates linked to a customer.

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. Swagger Name: AvaTaxClient

Parameters:

  • companyId (Integer) —

    The unique ID number of the company that recorded this customer

  • customerCode (String) —

    The unique code representing this customer

  • include (String) —

    OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following: * customers - Retrieves the list of customers linked to the certificate. * po_numbers - Retrieves all PO numbers tied to the certificate. * attributes - Retrieves all attributes applied to the certificate.

  • filter (String) —

    A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
    Not filterable: exemptionNumber, status, ecmsId, ecmsStatus, pdf, pages

  • top (Integer) —

    If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.

  • skip (Integer) —

    If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.

  • orderBy (String) —

    A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC.

Returns:

  • (FetchResult) 


236
237
 
# File 'lib/avatax/client/customers.rb', line 236

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

#list_valid_certificates_for_customer(companyId, customerCode, country, region) ⇒ Object

List valid certificates for a location

List valid certificates linked to a customer in a particular country and region.

This API is intended to help identify whether a customer has already provided a certificate that applies to a particular country and region. This API is intended to help you remind a customer when they have or have not provided copies of their exemption certificates to you during the sales order process.

If a customer does not have a certificate on file and they wish to provide one, you should send the customer a CertExpress invitation link so that the customer can upload proof of their exemption certificate. Please see the CreateCertExpressInvitation API to create an invitation link for this customer.

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. Swagger Name: AvaTaxClient

Parameters:

  • companyId (Integer) —

    The unique ID number of the company that recorded this customer

  • customerCode (String) —

    The unique code representing this customer

  • country (String) —

    Search for certificates matching this country. Uses the ISO 3166 two character country code.

  • region (String) —

    Search for certificates matching this region. Uses the ISO 3166 two or three character state, region, or province code.

Returns:

  • (Object) 


267
268
 
# File 'lib/avatax/client/customers.rb', line 267

def list_valid_certificates_for_customer(companyId, customerCode, country, region)        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certificates/#{country}/#{region}"
get(path, {}, AvaTax::VERSION)      end

#query_customers(companyId, options = {}) ⇒ FetchResult

List all customers for this company

List all customers recorded by this company matching the specified criteria.

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.

You can use the $include parameter to fetch the following additional objects for expansion:

  • Certificates - Fetch a list of certificates linked to this customer.
  • attributes - Retrieves all attributes applied to the customer.

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. Swagger Name: AvaTaxClient

Parameters:

  • companyId (Integer) —

    The unique ID number of the company that recorded this customer

  • include (String) —

    OPTIONAL - You can specify the value certificates to fetch information about certificates linked to the customer.

  • filter (String) —

    A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
    Not filterable: shipTos

  • top (Integer) —

    If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.

  • skip (Integer) —

    If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.

  • orderBy (String) —

    A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC.

Returns:

  • (FetchResult) 


302
303
 
# File 'lib/avatax/client/customers.rb', line 302

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

#unlink_attributes_from_customer(companyId, customerCode, model) ⇒ FetchResult

Unlink attributes from a customer

Unlink one or many attributes from a customer.

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.
  • This API depends on the following active services:Required (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

  • companyId (Integer) —

    The unique ID number of the company that recorded the customer

  • customerCode (String) —

    The unique code representing the current customer

  • model (CustomerAttributeModel[]) —

    The list of attributes to unlink from the customer.

Returns:

  • (FetchResult) 


332
333
 
# File 'lib/avatax/client/customers.rb', line 332

def unlink_attributes_from_customer(companyId, customerCode, model)        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/attributes/unlink"
put(path, model, {}, AvaTax::VERSION)      end

#unlink_certificates_from_customer(companyId, customerCode, model) ⇒ FetchResult

Unlink certificates from a customer

Remove one or more certificates to a customer.

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. Swagger Name: AvaTaxClient

Parameters:

  • companyId (Integer) —

    The unique ID number of the company that recorded this customer

  • customerCode (String) —

    The unique code representing this customer

  • model (Object) —

    The list of certificates to link to this customer

Returns:

  • (FetchResult) 


359
360
 
# File 'lib/avatax/client/customers.rb', line 359

def unlink_certificates_from_customer(companyId, customerCode, model)        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certificates/unlink"
post(path, model, {}, AvaTax::VERSION)      end

#update_customer(companyId, customerCode, model) ⇒ Object

Update a single customer

Replace the customer object at this URL with a new record.

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.
  • This API depends on the following active services:Required (all): AvaTaxPro. Swagger Name: AvaTaxClient

Parameters:

  • companyId (Integer) —

    The unique ID number of the company that recorded this customer

  • customerCode (String) —

    The unique code representing this customer

  • model (Object) —

    The new customer model that will replace the existing record at this URL

Returns:

  • (Object) 


386
387
 
# File 'lib/avatax/client/customers.rb', line 386

def update_customer(companyId, customerCode, model)        path = "/api/v2/companies/#{companyId}/customers/#{customerCode}"
put(path, model, {}, AvaTax::VERSION)      end