logo

Create an Avalara credential

Creates an Avalara credential.

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

Avalara credential resource.

licenseKey
required
string <password>

Avalara license key.

accountId
required
string

Avalara account ID.

status
string

Status of the credential.

Enum: Description
active

Credential is active and can be used.

inactive

Credential is temporarily inactivated and cannot be used until reactivated.

deactivated

Credential is permanently deactivated and cannot be reactivated.

Responses
201

Avalara credential created.

Response Headers
Location
string <uri>

Location of the related resource.

Example: "https://api.rebilly.com/example"
Response Schema: application/json
licenseKey
required
string <password>

Avalara license key.

accountId
required
string

Avalara account ID.

hash
string <= 50 characters

Unique resource ID. Defaults to UUID v4.

status
string

Status of the credential.

Enum: Description
active

Credential is active and can be used.

inactive

Credential is temporarily inactivated and cannot be used until reactivated.

deactivated

Credential is permanently deactivated and cannot be reactivated.

deactivationTime
string <date-time>

Date and time when the credential is deactivated.

Array of objects (SelfLink)

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "self"
303

Existing Avalara credential retrieved.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

422

Invalid data sent.

post/credential-hashes/avalara
Request samples
application/json
{
  • "status": "active",
  • "licenseKey": "0ab15e3c1cc608b6f592fbddaddeb8f2",
  • "accountId": "a1b2c3d4e5f6"
}
Response samples
application/json
{
  • "hash": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "status": "active",
  • "deactivationTime": "2019-08-24T14:15:22Z",
  • "licenseKey": "0ab15e3c1cc608b6f592fbddaddeb8f2",
  • "accountId": "a1b2c3d4e5f6",
  • "_links": [
    ]
}
➔ Next to Retrieve an Avalara credential