ELR Postman collection

The ELR Postman collection helps you work with ELR APIs.

Use this collection to:

Demo ELR functionality
Add context to API documentation
Set expectations for a technology partner-built integration with the ELR service

The collection includes helper functions in prerequest scripts at both the collection and folder levels. These scripts help less technical users avoid manually refreshing access tokens, setting multiple values in different places, or creating duplicate values. The collection also includes chaining functions in the prerequest and test scripts. These functions let users run folders, or groups of requests, as workflows that reflect common ELR integration patterns.

CAUTION

This Postman collection doesn’t act as an SDK. Postman generates the code snippets for each request automatically. Avalara doesn’t control how these snippets are generated or whether they’ll work for you. As a developer, use your own judgment to investigate any exceptions triggered by these snippets. If Avalara resources are assigned to support you, they may not be able to help with your specific programming language.

To import and use this collection from a browser:

Select Run in Postman in the top-right corner of the webpage.
Select Postman for Windows when prompted.
Import the collection into the Postman workspace of your choice.

The import includes both a Collection and a template Environment.

After the import:

Open the imported Postman environment and make sure the serviceEnvironment variable is set for the client credentials you’ll use.
Use one of these values for serviceEnvironment:
- SBX for Sandbox, which is the default value in the environment template
- PRD for Production
In the same Postman environment, set the clientId and clientSecret variable values for the selected serviceEnvironment.

Try out some requests. We recommend starting with:

Connection > Authentication > requestToken
Company Management > ListCompanies

These endpoints don’t depend on any other setup steps.