openapi: 3.0.0
info:
title: Avalara AvaTax CertExpressInvites API
description: "Welcome to the AvaTax API Postman Collection! \n \nThis collection provides a REST interface to Avalara's enterprise tax service, AvaTax. You can use this collection to interact with the AvaTax APIs while building your integration. \n\nWhile using this collection, we recommend following along with our Developer Implementation Guide: https://developer.avalara.com/avatax/dev-guide/ \n\nAPI requests are grouped into folders to help you navigate through the collection easily. Each request includes a description of the operation and its associated URL, method, headers, and example request body (if applicable). \n\nThe collection uses Postman environment variables for the API base URL and credentials, making it easy to switch between the sandbox and production environments.\n\nTo get started, ensure you have the necessary credentials. Then, update the 'username' and 'password' variables in the 'Authorization' or 'Variables' section with your credentials if you prefer username and password authentication. Alternatively, you can use the 'account_id' and 'license_key' variables for authentication using an account ID and license key.\n\nWe recommend starting with the Ping API, located within the Utilities folder, to test your connectivity and ensure your authentication credentials are valid. The Ping API is a simple way to check if you can successfully communicate with AvaTax.\n\nCollection Variables:\n- Base URL: The base URL for the API. By default, it is set to the sandbox URL - https://sandbox-rest.avatax.com. \n - Change this variable to switch between sandbox and production environments:\n - Sandbox URL: https://sandbox-rest.avatax.com\n\t\t- Production URL: https://rest.avatax.com\n- Username: If you are using username and password authentication, enter your username for AvaTax.\n- Password: If you are using username and password authentication, enter your password for AvaTax.\n- Account ID: If you are using account ID and license key authentication, enter your AvaTax account ID. \n - Be sure to also replace the username variable in the authorization tab with account_id.\n- License Key: If you are using account ID and license key authentication, enter your AvaTax license key.\n - Be sure to also replace the password variable in the authorization tab with license_key.\n\nHappy testing with AvaTax APIs!"
version: 1.0.0
servers:
- url: http://{{baseurl}}
security:
- basicAuth: []
tags:
- name: CertExpressInvites
paths:
/api/v2/companies/{companyId}/customers/{customerCode}/certexpressinvites:
post:
tags:
- CertExpressInvites
summary: Avalara CreateCertExpressInvitation
description: "Creates an invitation for a customer to self-report certificates using the CertExpress website.\n \nThis invitation is delivered by your choice of method, or you can present a hyperlink to the user\ndirectly in your connector. Your customer will be redirected to https://app.certexpress.com/ where\nthey can follow a step-by-step guide to enter information about their exemption certificates. The\ncertificates entered will be recorded and automatically linked to their customer record.\n \nThe [CertExpress website](https://app.certexpress.com/home) is available for customers to use at any time.\nUsing CertExpress with this API will ensure that your certificates are automatically linked correctly into\nyour company so that they can be used for tax exemptions.\n \nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n* This API depends on the following active services:*Required* (all): AvaTaxPro.\n"
requestBody:
content:
application/json:
schema:
type: object
example:
recipient: bob@example.org
coverLetterTitle: STANDARD_REQUEST
exposureZones:
- 89
exemptReasons:
- 70
deliveryMethod: Download
parameters:
- name: Content-Type
in: header
schema:
type: string
example: application/json
- name: X-Avalara-Client
in: header
schema:
type: string
description: Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/).
example: AvaTax Postman Collection
- name: companyId
in: path
schema:
type: string
required: true
- name: customerCode
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
/api/v2/companies/{companyId}/customers/{customerCode}/certexpressinvites/{id}:
get:
tags:
- CertExpressInvites
summary: Avalara GetCertExpressInvitation
description: "Retrieve an existing CertExpress invitation sent to a customer.\n \nA CertExpression invitation allows a customer to follow a helpful step-by-step guide to provide information\nabout their certificates. This step by step guide allows the customer to complete and upload the full\ncertificate in a convenient, friendly web browser experience. When the customer completes their certificates,\nthey will automatically be recorded to your company and linked to the customer record.\n \nThe [CertExpress website](https://app.certexpress.com/home) is available for customers to use at any time.\nUsing CertExpress with this API will ensure that your certificates are automatically linked correctly into\nyour company so that they can be used for tax exemptions.\n \nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro.\n"
parameters:
- name: X-Avalara-Client
in: header
schema:
type: string
description: Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/).
example: AvaTax Postman Collection
- name: companyId
in: path
schema:
type: string
required: true
- name: customerCode
in: path
schema:
type: string
required: true
- name: id
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
/api/v2/companies/{companyId}/certexpressinvites:
get:
tags:
- CertExpressInvites
summary: Avalara ListCertExpressInvitations
description: "Retrieve CertExpress invitations sent by this company.\n \nA CertExpression invitation allows a customer to follow a helpful step-by-step guide to provide information\nabout their certificates. This step by step guide allows the customer to complete and upload the full\ncertificate in a convenient, friendly web browser experience. When the customer completes their certificates,\nthey will automatically be recorded to your company and linked to the customer record.\n \nThe [CertExpress website](https://app.certexpress.com/home) is available for customers to use at any time.\nUsing CertExpress with this API will ensure that your certificates are automatically linked correctly into\nyour company so that they can be used for tax exemptions.\n \nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro.\n"
parameters:
- name: X-Avalara-Client
in: header
schema:
type: string
description: Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/).
example: AvaTax Postman Collection
- name: companyId
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
components:
securitySchemes:
basicAuth:
type: http
scheme: basic