Exemption Certificate Management

CertCapture RESTful APIs

SettingModel

This object is used to keep track of custom information about a company.

The company settings system is a metadata system that you can use to store extra information about a company. Your integration or connector could use this data storage to keep track of preference information, reminders, or any other storage that would need to persist even if the customer uninstalls your application.

A setting can refer to any type of data you need to remember about this company object. When creating this object, you may define your own set, name, and value parameters. To define your own values, please choose a set name that begins with X- to indicate an extension.

This model is used in the following APIs:

Parameters
idRequired
integer

The unique ID number of this setting.

companyIdOptional
integer

The unique ID number of the company this setting refers to.

setRequired
string

A user-defined "set" containing this setting.

Avalara defines some sets that cannot be changed. To create your own set, choose a set name that begins with X- to indicate that this is an extension value.

We recommend that you choose a set name that clearly identifies your application, and then store data within name/value pairs within that set. For example, if you were creating an application called MyApp, you might choose to create a set named X-MyCompany-MyApp.

nameRequired
string

A user-defined "name" for this name-value pair.

valueOptional
string

The value of this name-value pair.

modifiedDateOptional
string

The value when the entry was last modified.

modifiedUserIdOptional
integer

The value identifying who last modified the entry.