# The Avalara Registration and Licensing API

Avalara Registration and Licensing API provides access to the registration and licensing capability offered by the Avalara Compliance Cloud platform. This API is for use by technology partners to retrieve the status of their registrations.

This api is hosted under https://api.avalara.com.

Source: https://developer.avalara.com/products/activation-service/api/

**Version:** 0.1.0
**Base URL:** https://api.avalara.com/orl

---

## Endpoints

### Registrations

#### List all registrations associated with a tenant along with the status of each registration

`GET /registrations`

Use this endpoint to retrieve a list of registrations for this tenant. You can filter this list by any fields present in the top level of the objects returned (list of filterable properties are available in the specification below). You can optionally specify to include a count of the total registrations in the response. The response returns all available registrations for this tenant along with the status for each. Statuses can be `InformationRequired`, `InProgress`, `Failure`, or `Completed`.

**Parameters:**

| Name | Type | In | Required | Description |
|---|---|---|---|---|
| `undefined` |  |  | No |  |
| `undefined` |  |  | No |  |
| `undefined` |  |  | No |  |
| `undefined` |  |  | No |  |
| `undefined` |  |  | No |  |
| `undefined` |  |  | No |  |
| `undefined` |  |  | No |  |
| `undefined` |  |  | No |  |

#### Use this endpoint to  retrieve information for a single registration

`GET /registrations/{registrationId}`

Use this endpoint to retrieve information for a single registration. Information returned shall include the registration status along with additional information depending on the registrationType.

**Parameters:**

| Name | Type | In | Required | Description |
|---|---|---|---|---|
| `undefined` |  |  | No |  |
| `undefined` |  |  | No |  |
| `undefined` |  |  | No |  |
| `undefined` |  |  | No |  |

---

## Models

### StatusGeneral

Status of the registration

| Property | Type | Description |
|---|---|---|
| `code` | string | A code identifying the registration status. Available codes are `InformationRequired`, `InProgress`, `Failure`, and `Completed`. |
| `message` | string | Text that provides additional information about the status code |

### CompanyDetails

Reference to the Company under which this registration is applicable

| Property | Type | Description |
|---|---|---|
| `identifier` | string | Unique Identifier of the object |
| `displayName` | string | Name of the object. This is used for display purposes. |
| `location` | string | URL to access the Company |

### Mandates

| Property | Type | Description |
|---|---|---|
| `countryMandate` | string | Describes the country, type of business, and the e-invoicing network applicable to this mandate |
| `countryCode` | string | The country code where the mandate activation is applicable |
| `mandateType` | string | The type of mandate being activated |

### Meta

| Property | Type | Description |
|---|---|---|
| `created` | string | Date and time information when this object was created |
| `createdBy` | string | ID of the user/app that created this object |
| `lastModified` | string | Date and time information when this object was last modified |
| `modifiedBy` | string | ID of the user/app that last modified this object |
| `location` | string | The URI of the Resource being returned |

### RegistrationStatus

| Property | Type | Description |
|---|---|---|
| `id` | string | ID of the registration |
| `registrationType` | string | The type of registration |
| `status` | StatusGeneral |  |
| `company` | CompanyDetails |  |
| `mandates` | array |  |
| `meta` | Meta |  |

### RegistrationStatusFetchResults

| Property | Type | Description |
|---|---|---|
| `@recordSetCount` | integer | The record count value for this record |
| `@nextLink` | string | Link provided for pagination |
| `value` | array |  |

### ErrorInfo

| Property | Type | Description |
|---|---|---|
| `title` | string |  |
| `status` | string |  |
| `detail` | string |  |
| `instance` | string |  |