Skip to navigation
E-InvoicingPublic reference

Returns a list of code lists for a specific country

View as Markdown

Access control: this endpoint is available to users with the everyone role.

Get a list of code lists on the Avalara E-Invoicing platform for the specified country. By default, the API returns only non-expired code lists (code lists where the sunset date has not passed). To retrieve expired code lists or filter by specific date ranges, use the effectiveDate and sunsetDate query parameters.

A Code List is a controlled set of predefined, standardized values used to populate specific fields in electronic documents (such as e-invoices). Each code has a stable, machine-readable identifier and a human-readable description. Code Lists are typically based on global standards (e.g., UN/CEFACT, ISO, EN16931) and may include jurisdiction-specific extensions or restrictions.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

avalara-versionstringRequiredformat: "string"

Header that specifies the API version to use (for example “1.6”).

X-Avalara-ClientstringOptionalformat: "string"

Optional header for a client identifier string used for diagnostics (for example “Fingerprint”).

Query parameters

countryCodestringRequired

Two-letter ISO 3166-1 alpha-2 country code indicating the jurisdiction for which code lists should be returned.

effectiveDatedateOptional

Filter code lists by effective date. Returns code lists that are effective on or before this date. Format: YYYY-MM-DD (ISO 8601). If not specified, defaults to the current date. sunsetDate is required when effectiveDate is provided.

sunsetDatedateOptional

Filter code lists by sunset date. Returns code lists that have not yet sunset on or before this date. Format: YYYY-MM-DD (ISO 8601). If not specified, only non-expired code lists are returned.

$countstringOptional
When set to true, the response body also includes the count of items in the collection.
$countOnlystringOptional
When set to true, the response returns only the count of items in the collection.
$topintegerOptional
The number of items to include in the result.
$skipintegerOptional
The number of items to skip in the result.

Response

OK
valuelist of objects
Array of code lists matching query parameters
@recordsetCountstringOptional
Count of code lists for the given query parameters

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error