Skip to navigation
AvaTaxPublic reference

List Cover Letters

View as Markdown

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

List available cover letters that can be used when sending invitation to use CertExpress to upload certificates.

The CoverLetter model represents a message sent along with an invitation to use CertExpress to upload certificates. An invitation allows customers to use CertExpress to upload their exemption certificates directly; this cover letter explains why the invitation was sent.

If you see the ‘CertCaptureNotConfiguredError’, please use CheckProvision and RequestProvision endpoints to check and provision account.

Authentication

Authorizationstring
API Key authentication via header

Headers

X-Avalara-ClientstringOptionalDefaults to Swagger UI; 26.7.0; Custom; 1.0

Identifies the software you are using to call this API. For more information on the client header, see Client Headers .

Query parameters

$filterstringOptional

A filter statement to identify specific records to retrieve. For more information on filtering, see Filtering in REST.
Not filterable: id, companyId, subject, description, createdDate, modifiedDate, pageCount, templateFilename, version

$topintegerOptional

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.

$skipintegerOptional

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

$orderBystringOptional

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

Response

Success
@recordsetCountintegerOptional
valuelist of objectsOptional
pageKeystringOptional