REST interface to Avalara's enterprise tax service, AvaTax.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"3159278","collectionId":"7d7e8f34-3c19-44c0-9b48-04454d7ebcb0","publishedId":"TVYJ4wfR","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-10-28T07:28:31.000Z"},"item":[{"name":"Retrieve all accounts","id":"46fe0b7b-5ba7-4d12-9a18-38250dea0e8a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/accounts","description":"List all account objects that can be seen by the current user.
\nThis API lists all accounts you are allowed to see. In general, most users will only be able to see their own account.
\nSearch for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby parameters.\nYou may specify one or more of the following values in the $include parameter to fetch additional nested data, using commas to separate multiple values:
For more information about filtering in REST, please see the documentation at http://developer.avalara.com/avatax/filtering-in-rest/ .
\nThis API is for use by Avalara Registrar administrative users only.
\nCreate a single new account object.\nWhen creating an account object you may attach subscriptions and users as part of the 'Create' call.
\nGet the account object identified by this URL.\nYou may use the '$include' parameter to fetch additional nested data:
\nThis API is for use by Avalara Registrar administrative users only.
\nReplace an existing account object with an updated account object.
\nThis API is for use by Avalara Registrar administrative users only.
\nDelete an account.\nDeleting an account will delete all companies, all account level users and license keys attached to this account.
\nActivate the account specified by the unique accountId number.
\nThis activation request can only be called by account administrators. You must indicate\nthat you have read and accepted Avalara's terms and conditions to call this API.
\nOnce you have activated your account, use the AccountResetLicenseKey API to generate\na license key for your account.
If you have not read or accepted the terms and conditions, this API call will return the\nunchanged account model.
\nRetrieve audit trace history for an account.
\nYour audit trace history contains a record of all API calls made against the AvaTax REST API that returned an error. You can use this API to investigate\nproblems and see exactly what information was sent back and forth between your code and AvaTax.
\nWhen specifying a start and end datetime, please include a valid timezone indicator, such as the \"Z\" present in the examples for the start and end query parameters.\nYou can learn more about valid time zone designators at https://en.wikipedia.org/wiki/ISO_8601#Time_zone_designators.
\nThis API enforces limits to the amount of data retrieved. These limits are subject to change.
\nRetrieve a list of all configuration settings tied to this account.
\nConfiguration settings provide you with the ability to control features of your account and of your\ntax software. The category names TaxServiceConfig and AddressServiceConfig are reserved for\nAvalara internal software configuration values; to store your own account-level settings, please\ncreate a new category name that begins with X-, for example, X-MyCustomCategory.
Account settings are permanent settings that cannot be deleted. You can set the value of an\naccount setting to null if desired.
\nAvalara-based account settings for TaxServiceConfig and AddressServiceConfig affect your account's\ntax calculation and address resolution, and should only be changed with care.
Update configuration settings tied to this account.
\nConfiguration settings provide you with the ability to control features of your account and of your\ntax software. The category names TaxServiceConfig and AddressServiceConfig are reserved for\nAvalara internal software configuration values; to store your own account-level settings, please\ncreate a new category name that begins with X-, for example, X-MyCustomCategory.
Account settings are permanent settings that cannot be deleted. You can set the value of an\naccount setting to null if desired.
\nAvalara-based account settings for TaxServiceConfig and AddressServiceConfig affect your account's\ntax calculation and address resolution, and should only be changed with care.
Creates a new license key for this account.
\nTo create a license key for your account, you must specify the ID of the account and license key name.
\nThis API is only available to account administrators for the account in question, and may only be called after\nan account has been activated by reading and accepting Avalara's terms and conditions. To activate your account\nplease log onto the AvaTax website or call the ActivateAccount API.
You will reference this key using license key name. The existing license key will be using 'Default' as license key name.\nHence make sure that the license key name is unique per account considering the existing license key name 'Default'
\nDeletes the license key for this account using license key name.
\nTo delete a license key for your account, you must specify the accountID of the account and license key name.
\nThis API is only available to account administrators for the account in question.
\nGets list of all the license keys used by the account.
\nResets the existing license key for this account to a new key.
\nTo reset your account, you must specify the ID of the account you wish to reset and confirm the action.
\nThis API is only available to account administrators for the account in question, and may only be called after\nan account has been activated by reading and accepting Avalara's terms and conditions. To activate your account\nplease log onto the AvaTax website or call the ActivateAccount API.
You can only reset license with 'Default' license key name. \nResetting a license key cannot be undone. Any previous license keys will immediately cease to work when a new key is created.
\nWhen you call this API, all account administrators for this account will receive an email with the newly updated license key.\nThe email will specify which user reset the license key and it will contain the new key to use to update your connectors.\nNote: The reset license key functionality will only be available for existing active license key i.e. when you reset license key for the account, the Default license key will be reset.The reset license key functionality is not available for newly created license keys i.e. license keys other than Default
\nResolve an address against Avalara's address-validation system. If the address can be resolved, this API\nprovides the latitude and longitude of the resolved location. The value 'resolutionQuality' can be used\nto identify how closely this address can be located. If the address cannot be clearly located, use the\n'messages' structure to learn more about problems with this address.\nThis is the same API as the GET /api/v2/addresses/resolve endpoint.\nBoth verbs are supported to provide for flexible implementation.
\nResolve an address against Avalara's address-validation system. If the address can be resolved, this API\nprovides the latitude and longitude of the resolved location. The value 'resolutionQuality' can be used\nto identify how closely this address can be located. If the address cannot be clearly located, use the\n'messages' structure to learn more about problems with this address.\nThis is the same API as the POST /api/v2/addresses/resolve endpoint.\nBoth verbs are supported to provide for flexible implementation.
\nInorder to get any evaluation for an address please provide atleast one of the following fields/pairs:
\nCreates a new version of the advanced rule
\n","urlObject":{"protocol":"https","path":["api","v2","advancedrules","rules","{ruleId}"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e4cdd8d4-2367-48b0-9780-b75e60b95c71"},{"name":"Delete an advanced rule that is not in use by a company","id":"4376c9fb-e08b-4e33-936c-34fa38eb20ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/advancedrules/rules/{ruleId}","urlObject":{"protocol":"https","path":["api","v2","advancedrules","rules","{ruleId}"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4376c9fb-e08b-4e33-936c-34fa38eb20ed"},{"name":"Set rule approved or unapproved","id":"6ea5f166-2aca-45d8-b865-14ab80082e11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"isApproved\":true}"},"url":"https://sandbox-rest.avatax.com/api/v2/advancedrules/rules/{ruleId}/approve","urlObject":{"protocol":"https","path":["api","v2","advancedrules","rules","{ruleId}","approve"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6ea5f166-2aca-45d8-b865-14ab80082e11"},{"name":"Retrieve companies that have an advanced rule configured in its rule execution configuration","id":"e4ebf153-6970-4365-b7f6-0c485238fa6f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/advancedrules/rules/{ruleId}/companies","urlObject":{"protocol":"https","path":["api","v2","advancedrules","rules","{ruleId}","companies"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e4ebf153-6970-4365-b7f6-0c485238fa6f"},{"name":"Copy an existing advanced rule to a new environment","id":"3201377d-2128-44ff-844a-7b75bda4098f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"isApproved\":false,\"isSystemRule\":false,\"isVisibleInCUP\":false,\"isTest\":true,\"version\":0,\"ruleId\":\"75f7e396fd854ba299f9fd6a218b514a\",\"name\":\"Generic replace rule\",\"description\":\"This is just an example\",\"arEntitlementRequired\":false}"},"url":"https://sandbox-rest.avatax.com/api/v2/advancedrules/rules/{ruleId}/copy","urlObject":{"protocol":"https","path":["api","v2","advancedrules","rules","{ruleId}","copy"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3201377d-2128-44ff-844a-7b75bda4098f"},{"name":"Set rule visible or not visible for an account","id":"ccc909b1-4836-4390-b6ef-d09681cda7f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"isVisible\":true,\"accountId\":0}"},"url":"https://sandbox-rest.avatax.com/api/v2/advancedrules/rules/{ruleId}/visible","urlObject":{"protocol":"https","path":["api","v2","advancedrules","rules","{ruleId}","visible"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ccc909b1-4836-4390-b6ef-d09681cda7f1"},{"name":"Get an advanced rule by name","id":"3fb70525-3176-48df-8231-87d7e1f46183","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/advancedrules/rules/name/{name}","urlObject":{"protocol":"https","path":["api","v2","advancedrules","rules","name","{name}"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3fb70525-3176-48df-8231-87d7e1f46183"},{"name":"Retrieve all AvaFileForms","id":"a7d50e77-5be8-4721-9e1d-aaa1b04f6bad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/avafileforms","description":"Search for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby parameters.
Create one or more AvaFileForms\nA 'AvaFileForm' represents a form supported by our returns team
\nGet the AvaFileForm object identified by this URL.
\nAll data from the existing object will be replaced with data in the object you PUT.\nTo set a field's value to null, you may either set its value to null or omit that field from the object you post.
\nMarks the existing AvaFileForm object at this URL as deleted.
\nGet multiple batch objects across all companies.
\nA batch object is a large collection of API calls stored in a compact file.
\nSearch for specific objects using the criteria in the $filter parameter;\nfull documentation is available on Filtering in REST .\nPaginate results using the $top, $skip, and $orderby parameters.
When a batch is created, it is added to the AvaTax Batch Queue and will be\nprocessed as quickly as possible in the order it was received. To check the\nstatus of a batch, fetch the batch and retrieve the results of the batch\noperation.
\nBecause the batch system processes with a degree of concurrency, and\nbecause of batch sizes in the queue vary, AvaTax API is unable to accurately\npredict when a batch will complete. If high performance processing is\nrequired, please use the\nCreateTransaction API.
\nList all batch objects attached to the specified company.
\nA batch object is a large collection of API calls stored in a compact file.
\nSearch for specific objects using the criteria in the $filter parameter;\nfull documentation is available on Filtering in REST .\nPaginate results using the $top, $skip, and $orderby parameters.
Use GetBatch\nto retrieve the results, or check the status, of an individual batch.
\nWhen a batch is created, it is added to the AvaTax Batch Queue and will be\nprocessed as quickly as possible in the order it was received. To check the\nstatus of a batch, fetch the batch and retrieve the results of the batch\noperation.
\nBecause the batch system processes with a degree of concurrency, and\nbecause of batch sizes in the queue vary, AvaTax API is unable to accurately\npredict when a batch will complete. If high performance processing is\nrequired, please use the\nCreateTransaction API.
\nCreate one or more new batch objects attached to this company.
\nEach batch object may have one or more file objects (currently only one file is supported).
\nWhen a batch is created, it is added to the AvaTax Batch Queue and will be\nprocessed as quickly as possible in the order it was received. To check the\nstatus of a batch, fetch the batch and retrieve the results of the batch\noperation.
\nBecause the batch system processes with a degree of concurrency, and\nbecause of batch sizes in the queue vary, AvaTax API is unable to accurately\npredict when a batch will complete. If high performance processing is\nrequired, please use the\nCreateTransaction API.
\nThe maximum content length of the request body is limited to 28.6 MB. If this limit\nis exceeded, a 404 Not Found status will be returned (possibly with a CORS error if\nthe API is called from a browser). In this situation, please split the request into\nsmaller batches.
\nDownload a single batch file identified by this URL.
\nGet the batch object identified by this URL. A batch object is a large\ncollection of API calls stored in a compact file.
\nUse this endpoint to retrieve the results or check the status of a batch.
\nWhen a batch is created, it is added to the AvaTax Batch Queue and will be\nprocessed as quickly as possible in the order it was received. To check the\nstatus of a batch, fetch the batch and retrieve the results of the batch\noperation.
\nBecause the batch system processes with a degree of concurrency, and\nbecause of batch sizes in the queue vary, AvaTax API is unable to accurately\npredict when a batch will complete. If high performance processing is\nrequired, please use the\nCreateTransaction API.
\nMarks the batch identified by this URL as deleted.
\nIf you attempt to delete a batch that is being processed, you will receive an error message.\nDeleting a batch does not delete any transactions that were created by importing the batch.
\nBecause the batch system processes with a degree of concurrency, and\nbecause of batch sizes in the queue vary, AvaTax API is unable to accurately\npredict when a batch will complete. If high performance processing is\nrequired, please use the\nCreateTransaction API.
\nMarks the in progress batch identified by this URL as cancelled.
\nOnly JSON batches can be cancelled. If you attempt to cancel a file batch, you will receive an error message.
\nOnly in progress batches can be cancelled. If you attempt to cancel a batch that its status is not Waiting or Processing, you will receive an error message.\nCancelling an in progress batch does not delete any transactions that were created before the cancellation.
\nBecause the batch system processes with a degree of concurrency, and\nbecause of batch sizes in the queue vary, AvaTax API is unable to accurately\npredict when a batch will complete. If high performance processing is\nrequired, please use the\nCreateTransaction API.
\nCreate a new transaction batch objects attached to this company.
\nWhen a transaction batch is created, it is added to the AvaTax Batch v2 Queue and will be\nprocessed as quickly as possible in the order it was received. To check the\nstatus of a batch, fetch the batch and retrieve the results of the batch\noperation.
\nBecause the batch system processes with a degree of concurrency, and\nbecause of batch sizes in the queue vary, AvaTax API is unable to accurately\npredict when a batch will complete. If high performance processing is\nrequired, please use the\nCreateTransaction API.
\nThe maximum content length of the request body is limited to 28.6 MB. If this limit\nis exceeded, a 404 Not Found status will be returned (possibly with a CORS error if\nthe API is called from a browser). In this situation, please split the request into\nsmaller batches.
\nRetrieve CertExpress invitations sent by this company.
\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.
\nThe CertExpress website 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.
\nUsing exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.\nCompanies that do not have this storage system set up will receive the error CertCaptureNotConfiguredError when they call exemption\ncertificate related APIs. To check if this company is set up, call GetCertificateSetup. To request setup of the auditable document\nstorage for this company, call RequestCertificateSetup.
Creates an invitation for a customer to self-report certificates using the CertExpress website.
\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.
\nThe CertExpress website 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.
\nUsing exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.\nCompanies that do not have this storage system set up will receive the error CertCaptureNotConfiguredError when they call exemption\ncertificate related APIs. To check if this company is set up, call GetCertificateSetup. To request setup of the auditable document\nstorage for this company, call RequestCertificateSetup.
Retrieve an existing CertExpress invitation sent to a customer.
\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.
\nThe CertExpress website 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.
\nUsing exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.\nCompanies that do not have this storage system set up will receive the error CertCaptureNotConfiguredError when they call exemption\ncertificate related APIs. To check if this company is set up, call GetCertificateSetup. To request setup of the auditable document\nstorage for this company, call RequestCertificateSetup.
List all certificates recorded by a company
\nA certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document\ncan contain information about a customer's eligibility for exemption from sales or use taxes based on\ncriteria you specify when you store the certificate. To view or manage your certificates directly, please\nlog onto the administrative website for the product you purchased.
\nYou can use the $include parameter to fetch the following additional objects for expansion:
Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.\nCompanies that do not have this storage system set up will receive the error CertCaptureNotConfiguredError when they call exemption\ncertificate related APIs. To check if this company is set up, call GetCertificateSetup. To request setup of the auditable document\nstorage for this company, call RequestCertificateSetup.
Record one or more certificates document for this company.
\nA certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document\ncan contain information about a customer's eligibility for exemption from sales or use taxes based on\ncriteria you specify when you store the certificate. To view or manage your certificates directly, please\nlog onto the administrative website for the product you purchased.
\nWhen you create a certificate, it will be processed by Avalara and will become available for use in\ncalculating tax exemptions when processing is complete. For a certificate to be used in calculating exemptions,\nit must have the following:
\nUsing exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.\nCompanies that do not have this storage system set up will receive the error CertCaptureNotConfiguredError when they call exemption\ncertificate related APIs. To check if this company is set up, call GetCertificateSetup. To request setup of the auditable document\nstorage for this company, call RequestCertificateSetup.
If the users specified in the certificates do not exist, the API will create the user and link them to the certificate
\nGet the current certificate identified by this URL.
\nA certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document\ncan contain information about a customer's eligibility for exemption from sales or use taxes based on\ncriteria you specify when you store the certificate. To view or manage your certificates directly, please\nlog onto the administrative website for the product you purchased.
\nYou can use the $include parameter to fetch the following additional objects for expansion:
Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.\nCompanies that do not have this storage system set up will receive the error CertCaptureNotConfiguredError when they call exemption\ncertificate related APIs. To check if this company is set up, call GetCertificateSetup. To request setup of the auditable document\nstorage for this company, call RequestCertificateSetup.
Replace the certificate identified by this URL with a new one.
\nA certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document\ncan contain information about a customer's eligibility for exemption from sales or use taxes based on\ncriteria you specify when you store the certificate. To view or manage your certificates directly, please\nlog onto the administrative website for the product you purchased.
\nUsing exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.\nCompanies that do not have this storage system set up will receive the error CertCaptureNotConfiguredError when they call exemption\ncertificate related APIs. To check if this company is set up, call GetCertificateSetup. To request setup of the auditable document\nstorage for this company, call RequestCertificateSetup.
Revoke the certificate identified by this URL, then delete it.
\nA certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document\ncan contain information about a customer's eligibility for exemption from sales or use taxes based on\ncriteria you specify when you store the certificate. To view or manage your certificates directly, please\nlog onto the administrative website for the product you purchased.
\nRevoked certificates can no longer be used.
\nUsing exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.\nCompanies that do not have this storage system set up will receive the error CertCaptureNotConfiguredError when they call exemption\ncertificate related APIs. To check if this company is set up, call GetCertificateSetup. To request setup of the auditable document\nstorage for this company, call RequestCertificateSetup.
Upload an image or PDF attachment for this certificate.
\nImage attachments can be of the format PDF, JPEG, TIFF, or PNG. To upload a multi-page image, please\nuse the PDF data type.
A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document\ncan contain information about a customer's eligibility for exemption from sales or use taxes based on\ncriteria you specify when you store the certificate. To view or manage your certificates directly, please\nlog onto the administrative website for the product you purchased.
\nUsing exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.\nCompanies that do not have this storage system set up will receive the error CertCaptureNotConfiguredError when they call exemption\ncertificate related APIs. To check if this company is set up, call GetCertificateSetup. To request setup of the auditable document\nstorage for this company, call RequestCertificateSetup.
Download an image or PDF file for this certificate.
\nThis API can be used to download either a single-page preview of the certificate or a full PDF document.\nTo retrieve a preview image, set the $type parameter to Jpeg and the $page parameter to 1.
A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document\ncan contain information about a customer's eligibility for exemption from sales or use taxes based on\ncriteria you specify when you store the certificate. To view or manage your certificates directly, please\nlog onto the administrative website for the product you purchased.
\nUsing exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.\nCompanies that do not have this storage system set up will receive the error CertCaptureNotConfiguredError when they call exemption\ncertificate related APIs. To check if this company is set up, call GetCertificateSetup. To request setup of the auditable document\nstorage for this company, call RequestCertificateSetup.
Retrieve the list of attributes that are linked to this certificate.
\nA certificate may have multiple attributes that control its behavior. You may link or unlink attributes to a\ncertificate at any time. The full list of defined attributes may be found using ListCertificateAttributes API.
\nA certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document\ncan contain information about a customer's eligibility for exemption from sales or use taxes based on\ncriteria you specify when you store the certificate. To view or manage your certificates directly, please\nlog onto the administrative website for the product you purchased.
\nUsing exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.\nCompanies that do not have this storage system set up will receive the error CertCaptureNotConfiguredError when they call exemption\ncertificate related APIs. To check if this company is set up, call GetCertificateSetup. To request setup of the auditable document\nstorage for this company, call RequestCertificateSetup.
Link one or many attributes to a certificate.
\nA certificate may have multiple attributes that control its behavior. You may link or unlink attributes to a\ncertificate at any time. The full list of defined attributes may be found using ListCertificateAttributes.
A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document\ncan contain information about a customer's eligibility for exemption from sales or use taxes based on\ncriteria you specify when you store the certificate. To view or manage your certificates directly, please\nlog onto the administrative website for the product you purchased.
\nUsing exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.\nCompanies that do not have this storage system set up will receive the error CertCaptureNotConfiguredError when they call exemption\ncertificate related APIs. To check if this company is set up, call GetCertificateSetup. To request setup of the auditable document\nstorage for this company, call RequestCertificateSetup.
Unlink one or many attributes from a certificate.
\nA certificate may have multiple attributes that control its behavior. You may link or unlink attributes to a\ncertificate at any time. The full list of defined attributes may be found using ListCertificateAttributes.
A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document\ncan contain information about a customer's eligibility for exemption from sales or use taxes based on\ncriteria you specify when you store the certificate. To view or manage your certificates directly, please\nlog onto the administrative website for the product you purchased.
\nUsing exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.\nCompanies that do not have this storage system set up will receive the error CertCaptureNotConfiguredError when they call exemption\ncertificate related APIs. To check if this company is set up, call GetCertificateSetup. To request setup of the auditable document\nstorage for this company, call RequestCertificateSetup.
List all customers linked to this certificate.
\nCustomers must be linked to a certificate in order to make use of its tax exemption features. You\ncan link or unlink customers to a certificate at any time.
\nA certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document\ncan contain information about a customer's eligibility for exemption from sales or use taxes based on\ncriteria you specify when you store the certificate. To view or manage your certificates directly, please\nlog onto the administrative website for the product you purchased.
\nUsing exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.\nCompanies that do not have this storage system set up will receive the error CertCaptureNotConfiguredError when they call exemption\ncertificate related APIs. To check if this company is set up, call GetCertificateSetup. To request setup of the auditable document\nstorage for this company, call RequestCertificateSetup.
Link one or more customers to an existing certificate.
\nCustomers and certificates must be linked before a customer can make use of a certificate to obtain\na tax exemption in AvaTax. Since some certificates may cover more than one business entity, a certificate\ncan be connected to multiple customer records using the LinkCustomersToCertificate API.
A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document\ncan contain information about a customer's eligibility for exemption from sales or use taxes based on\ncriteria you specify when you store the certificate. To view or manage your certificates directly, please\nlog onto the administrative website for the product you purchased.
\nUsing exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.\nCompanies that do not have this storage system set up will receive the error CertCaptureNotConfiguredError when they call exemption\ncertificate related APIs. To check if this company is set up, call GetCertificateSetup. To request setup of the auditable document\nstorage for this company, call RequestCertificateSetup.
Unlinks one or more customers from a certificate.
\nUnlinking a certificate from a customer will prevent the certificate from being used to generate\ntax exemptions for the customer in the future. If any previous transactions for this customer had\nused this linked certificate, those transactions will be unchanged and will still have a link to the\nexemption certificate in question.
\nA certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document\ncan contain information about a customer's eligibility for exemption from sales or use taxes based on\ncriteria you specify when you store the certificate. To view or manage your certificates directly, please\nlog onto the administrative website for the product you purchased.
\nUsing exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.\nCompanies that do not have this storage system set up will receive the error CertCaptureNotConfiguredError when they call exemption\ncertificate related APIs. To check if this company is set up, call GetCertificateSetup. To request setup of the auditable document\nstorage for this company, call RequestCertificateSetup.
Checks whether this company is configured to use exemption certificates in AvaTax.
\nExemption certificates are tracked through a different auditable data store than the one that\nholds AvaTax transactions. To use the AvaTax exemption certificate document store, please call\nGetCertificateSetup to see if your company is configured to use the exemption certificate\ndocument store. To request setup, please call RequestCertificateSetup and your company will\nbe configured with data storage in the auditable certificate system.
Requests the setup of exemption certificates for this company.
\nExemption certificates are tracked through a different auditable data store than the one that\nholds AvaTax transactions. To use the AvaTax exemption certificate document store, please call\nGetCertificateSetup to see if your company is configured to use the exemption certificate\ndocument store. To request setup, please call RequestCertificateSetup and your company will\nbe configured with data storage in the auditable certificate system.
This API will return the current status of exemption certificate setup for this company.
\nGet multiple company objects.
\nA company represents a single corporation or individual that is registered to handle transactional taxes.
Search for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby parameters.\nYou may specify one or more of the following values in the $include parameter to fetch additional nested data, using commas to separate multiple values:
Create one or more new company objects.\nA 'company' represents a single corporation or individual that is registered to handle transactional taxes.\nYou may attach nested data objects such as contacts, locations, and nexus with this CREATE call, and those objects will be created with the company.
\nNOTE: Please do not use these blacklisted characters in company name and code: ';', '', '|'.
\nThis API is available by invitation only.\nRequires a subscription to Avalara Managed Returns or SST Certified Service Provider.\nReturns the funding configuration of the requested company.\n.
\nThis API is available by invitation only.\nRequires a subscription to Avalara Managed Returns or SST Certified Service Provider.\nReturns the funding configuration of the requested company.\n.
\nAdd parameters to a company.
\nSome companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called \"parameters\".
\nA parameter added to a company will be used by default in tax calculation but will not show on the transaction line referencing the company.
\nA company location parameter specified on a transaction line will override a company parameter if they share the same parameter name.
\nTo see available parameters for this company, call /api/v2/definitions/parameters?$filter=attributeType eq Company
Some parameters are only available for use if you have subscribed to specific AvaTax services. To see which parameters you are able to use, add the query parameter \"$showSubscribed=true\" to the parameter definition call above.
\nRetrieve all parameters of a company.
\nSome companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called \"parameters\".
\nA parameter added to a company will be used by default in tax calculation but will not show on the transaction line referencing the company.
\nA company location parameter specified on a transaction line will override a company parameter if they share the same parameter name.
\nSearch for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby parameters.
Retrieves a single parameter of a company.
\nSome companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called \"parameters\".
\nA parameter added to a company will be used by default in tax calculation but will not show on the transaction line referencing the company.
\nA company location parameter specified on a transaction line will override a company parameter if they share the same parameter name.
\nUpdate a parameter of a company.
\nSome companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called \"parameters\".
\nA parameter added to a company will be used by default in tax calculation but will not show on the transaction line referencing the company.
\nA company location parameter specified on a transaction line will override a company parameter if they share the same parameter name.
\nDelete a parameter of a company.\nSome companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called \"parameters\".
\nA parameter added to a company will be used by default in tax calculation but will not show on the transaction line referencing the company.
\nA company location parameter specified on a transaction line will override a company parameter if they share the same parameter name.
\nGet the company object identified by this URL.\nA 'company' represents a single corporation or individual that is registered to handle transactional taxes.\nYou may specify one or more of the following values in the '$include' parameter to fetch additional nested data, using commas to separate multiple values:
\nReplace the existing company object at this URL with an updated object.
\nA CompanyModel represents a single corporation or individual that is registered to handle transactional taxes.\nAll data from the existing object will be replaced with data in the object you PUT.
When calling UpdateCompany, you are permitted to update the company itself. Updates to the nested objects\nsuch as contacts, locations, or settings are not permitted. To update the nested objects
To set a field's value to null, you may either set its value to null or omit that field from the object you PUT.
NOTE: Please do not use these blacklisted characters in company name and code: ';', '', '|'.
\nDeleting a company will delete all child companies, and all users attached to this company.
\nExamines the most recent 100 transactions or data from the last month when verifying transaction-related integrations.\nFor partners who write integrations against AvaTax for many clients, this API is a way to do a quick self testing to verify whether the\nwritten integrations for a company are sufficient enough to be delivered to the respective customers to start using it.
\nThis API provides messages specific enough (through predefined checks) to guide the partner on what integrations are still missing from the company to get fully certified.\nThe API makes the following checks to conclude if the company is NOT fully certified:
\nRetrieve a list of all configuration settings tied to this company.
\nConfiguration settings provide you with the ability to control features of your account and of your\ntax software. The category name AvaCertServiceConfig is reserved for\nAvalara internal software configuration values; to store your own company-level settings, please\ncreate a new category name that begins with X-, for example, X-MyCustomCategory.
Company settings are permanent settings that cannot be deleted. You can set the value of a\ncompany setting to null if desired and if the particular setting supports it.
\nAvalara-based company settings for AvaCertServiceConfig affect your company's exemption certificate\nprocessing, and should be changed with care.
Update configuration settings tied to this company.
\nConfiguration settings provide you with the ability to control features of your account and of your\ntax software. The category names AvaCertServiceConfig is reserved for\nAvalara internal software configuration values; to store your own company-level settings, please\ncreate a new category name that begins with X-, for example, X-MyCustomCategory.
Company settings are permanent settings that cannot be deleted. You can set the value of a\ncompany setting to null if desired and if the particular setting supports it.
\nAvalara-based company settings for AvaCertServiceConfig affect your company's exemption certificate\nprocessing, and should be changed with care.
Retrieve the current filing status of this company.
\nFor customers using Avalara's Managed Returns Service, each company within their account can request\nfor Avalara to file tax returns on their behalf. Avalara compliance team members will review all\nrequested filing calendars prior to beginning filing tax returns on behalf of this company.
\nA company's filing status can be one of the following values:
\nNoReporting - This company is not configured to report tax returns; instead, it reports through a parent company.NotYetFiling - This company has not yet begun filing tax returns through Avalara's Managed Returns Service.FilingRequested - The company has requested to begin filing tax returns, but Avalara's compliance team has not yet begun filing.FirstFiling - The company has recently filing tax returns and is in a new status.Active - The company is currently active and is filing tax returns via Avalara Managed Returns.Changes the current filing status of this company.
\nFor customers using Avalara's Managed Returns Service, each company within their account can request\nfor Avalara to file tax returns on their behalf. Avalara compliance team members will review all\nrequested filing calendars prior to beginning filing tax returns on behalf of this company.
\nThe following changes may be requested through this API:
\nNotYetFiling status, the customer may request this be changed to FilingRequested.FilingRequested to FirstFiling.FirstFiling to Active.All other status changes must be requested through the Avalara customer support team.
\nThis API is available by invitation only.\nRequires a subscription to Avalara Managed Returns or SST Certified Service Provider.\nReturns a list of funding setup requests and their current status.\nEach object in the result is a request that was made to setup or adjust funding status for this company.
\nThis API is available by invitation only.\nCompanies that use the Avalara Managed Returns or the SST Certified Service Provider services are\nrequired to setup their funding configuration before Avalara can begin filing tax returns on their\nbehalf.\nFunding configuration for each company is set up by submitting a funding setup request, which can\nbe sent either via email or via an embedded HTML widget.\nWhen the funding configuration is submitted to Avalara, it will be reviewed by treasury team members\nbefore approval.\nThis API records that an ambedded HTML funding setup widget was activated.\nThis API requires a subscription to Avalara Managed Returns or SST Certified Service Provider.
\nShortcut to quickly setup a single-physical-location company with critical information and activate it.\nThis API provides quick and simple company setup functionality and does the following things:
\nThis API only provides a limited subset of functionality compared to the 'Create Company' API call.\nIf you need additional features or options not present in this 'Quick Setup' API call, please use the full 'Create Company' call instead.\nPlease allow 1 minute before making transactions using the company.
\nThis API is available by invitation only.
\nGet a list of companies with an active MRS service.
\nThis API is available by invitation only.
\nThis API is available by invitation only.
\nYou may specify one or more of the following values in the '$include' parameter to fetch additional nested data, using commas to separate multiple values:
\nThis API is available by invitation only.
\nThis API is available by invitation only.
\nThis API is available by invitation only.
\nThis API is available by invitation only.
\nThis API is available by invitation only.
\nCreate one or more new contact objects.\nA 'contact' is a person associated with a company who is designated to handle certain responsibilities of\na tax collecting and filing entity.
\nList all contact objects assigned to this company.
\nSearch for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby parameters.
Get the contact object identified by this URL.\nA 'contact' is a person associated with a company who is designated to handle certain responsibilities of\na tax collecting and filing entity.
\nReplace the existing contact object at this URL with an updated object.\nA 'contact' is a person associated with a company who is designated to handle certain responsibilities of\na tax collecting and filing entity.\nAll data from the existing object will be replaced with data in the object you PUT.\nTo set a field's value to null, you may either set its value to null or omit that field from the object you post.
\nMark the existing contact object at this URL as deleted.
\nGet multiple contact objects across all companies.\nA 'contact' is a person associated with a company who is designated to handle certain responsibilities of\na tax collecting and filing entity.
\nSearch for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby parameters.
List all customers recorded by this company matching the specified criteria.
\nA customer object defines information about a person or business that purchases products from your\ncompany. When you create a tax transaction in AvaTax, you can use the customerCode from this\nrecord in your CreateTransaction API call. AvaTax will search for this customerCode value and\nidentify any certificates linked to this customer object. If any certificate applies to the transaction,\nAvaTax will record the appropriate elements of the transaction as exempt and link it to the certificate.
You can use the $include parameter to fetch the following additional objects for expansion:
Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.\nCompanies that do not have this storage system set up will receive the error CertCaptureNotConfiguredError when they call exemption\ncertificate related APIs. To check if this company is set up, call GetCertificateSetup. To request setup of the auditable document\nstorage for this company, call RequestCertificateSetup.
Create one or more customers for this company.
\nA customer object defines information about a person or business that purchases products from your\ncompany. When you create a tax transaction in AvaTax, you can use the customerCode from this\nrecord in your CreateTransaction API call. AvaTax will search for this customerCode value and\nidentify any certificates linked to this customer object. If any certificate applies to the transaction,\nAvaTax will record the appropriate elements of the transaction as exempt and link it to the certificate.
A nested object such as CustomFields could be specified and created along with the customer object. To fetch the\nnested object, please call 'GetCustomer' API with appropriate $include parameters.
\nUsing exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.\nCompanies that do not have this storage system set up will receive the error CertCaptureNotConfiguredError when they call exemption\ncertificate related APIs. To check if this company is set up, call GetCertificateSetup. To request setup of the auditable document\nstorage for this company, call RequestCertificateSetup.
Retrieve the customer identified by this URL.
\nA customer object defines information about a person or business that purchases products from your\ncompany. When you create a tax transaction in AvaTax, you can use the customerCode from this\nrecord in your CreateTransaction API call. AvaTax will search for this customerCode value and\nidentify any certificates linked to this customer object. If any certificate applies to the transaction,\nAvaTax will record the appropriate elements of the transaction as exempt and link it to the certificate.
You can use the $include parameter to fetch the following additional objects for expansion:
Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.\nCompanies that do not have this storage system set up will receive the error CertCaptureNotConfiguredError when they call exemption\ncertificate related APIs. To check if this company is set up, call GetCertificateSetup. To request setup of the auditable document\nstorage for this company, call RequestCertificateSetup.
Replace the customer object at this URL with a new record.
\nA customer object defines information about a person or business that purchases products from your\ncompany. When you create a tax transaction in AvaTax, you can use the customerCode from this\nrecord in your CreateTransaction API call. AvaTax will search for this customerCode value and\nidentify any certificates linked to this customer object. If any certificate applies to the transaction,\nAvaTax will record the appropriate elements of the transaction as exempt and link it to the certificate.
Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.\nCompanies that do not have this storage system set up will receive the error CertCaptureNotConfiguredError when they call exemption\ncertificate related APIs. To check if this company is set up, call GetCertificateSetup. To request setup of the auditable document\nstorage for this company, call RequestCertificateSetup.
Deletes the customer object referenced by this URL.
\nA customer object defines information about a person or business that purchases products from your\ncompany. When you create a tax transaction in AvaTax, you can use the customerCode from this\nrecord in your CreateTransaction API call. AvaTax will search for this customerCode value and\nidentify any certificates linked to this customer object. If any certificate applies to the transaction,\nAvaTax will record the appropriate elements of the transaction as exempt and link it to the certificate.
Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.\nCompanies that do not have this storage system set up will receive the error CertCaptureNotConfiguredError when they call exemption\ncertificate related APIs. To check if this company is set up, call GetCertificateSetup. To request setup of the auditable document\nstorage for this company, call RequestCertificateSetup.
Retrieve the attributes linked to the customer identified by this URL.
\nA customer may have multiple attributes that control its behavior. You may link or unlink attributes to a\ncustomer at any time. The full list of defined attributes may be found using QueryCompanyCustomerAttributes API.
A customer object defines information about a person or business that purchases products from your\ncompany. When you create a tax transaction in AvaTax, you can use the customerCode from this\nrecord in your CreateTransaction API call. AvaTax will search for this customerCode value and\nidentify any certificates linked to this customer object. If any certificate applies to the transaction,\nAvaTax will record the appropriate elements of the transaction as exempt and link it to the certificate.
Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.\nCompanies that do not have this storage system set up will receive the error CertCaptureNotConfiguredError when they call exemption\ncertificate related APIs. To check if this company is set up, call GetCertificateSetup. To request setup of the auditable document\nstorage for this company, call RequestCertificateSetup.
Link one or many attributes to a customer.
\nA customer may have multiple attributes that control its behavior. You may link or unlink attributes to a\ncustomer at any time. The full list of defined attributes may be found using QueryCompanyCustomerAttributes API.
A customer object defines information about a person or business that purchases products from your\ncompany. When you create a tax transaction in AvaTax, you can use the customerCode from this\nrecord in your CreateTransaction API call. AvaTax will search for this customerCode value and\nidentify any certificates linked to this customer object. If any certificate applies to the transaction,\nAvaTax will record the appropriate elements of the transaction as exempt and link it to the certificate.
Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.\nCompanies that do not have this storage system set up will receive the error CertCaptureNotConfiguredError when they call exemption\ncertificate related APIs. To check if this company is set up, call GetCertificateSetup. To request setup of the auditable document\nstorage for this company, call RequestCertificateSetup.
Unlink one or many attributes from a customer.
\nA customer may have multiple attributes that control its behavior. You may link or unlink attributes to a\ncustomer at any time. The full list of defined attributes may be found using QueryCompanyCustomerAttributes API.
A customer object defines information about a person or business that purchases products from your\ncompany. When you create a tax transaction in AvaTax, you can use the customerCode from this\nrecord in your CreateTransaction API call. AvaTax will search for this customerCode value and\nidentify any certificates linked to this customer object. If any certificate applies to the transaction,\nAvaTax will record the appropriate elements of the transaction as exempt and link it to the certificate.
Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.\nCompanies that do not have this storage system set up will receive the error CertCaptureNotConfiguredError when they call exemption\ncertificate related APIs. To check if this company is set up, call GetCertificateSetup. To request setup of the auditable document\nstorage for this company, call RequestCertificateSetup.
List all certificates linked to a customer.
\nA customer object defines information about a person or business that purchases products from your\ncompany. When you create a tax transaction in AvaTax, you can use the customerCode from this\nrecord in your CreateTransaction API call. AvaTax will search for this customerCode value and\nidentify any certificates linked to this customer object. If any certificate applies to the transaction,\nAvaTax will record the appropriate elements of the transaction as exempt and link it to the certificate.
Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.\nCompanies that do not have this storage system set up will receive the error CertCaptureNotConfiguredError when they call exemption\ncertificate related APIs. To check if this company is set up, call GetCertificateSetup. To request setup of the auditable document\nstorage for this company, call RequestCertificateSetup.
List valid certificates linked to a customer in a particular country and region.
\nThis API is intended to help identify whether a customer has already provided a certificate that\napplies to a particular country and region. This API is intended to help you remind a customer\nwhen they have or have not provided copies of their exemption certificates to you during the sales\norder process.
\nIf a customer does not have a certificate on file and they wish to provide one, you should send the customer\na CertExpress invitation link so that the customer can upload proof of their exemption certificate. Please\nsee the CreateCertExpressInvitation API to create an invitation link for this customer.
Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.\nCompanies that do not have this storage system set up will receive the error CertCaptureNotConfiguredError when they call exemption\ncertificate related APIs. To check if this company is set up, call GetCertificateSetup. To request setup of the auditable document\nstorage for this company, call RequestCertificateSetup.
Link one or more certificates to a customer.
\nA customer object defines information about a person or business that purchases products from your\ncompany. When you create a tax transaction in AvaTax, you can use the customerCode from this\nrecord in your CreateTransaction API call. AvaTax will search for this customerCode value and\nidentify any certificates linked to this customer object. If any certificate applies to the transaction,\nAvaTax will record the appropriate elements of the transaction as exempt and link it to the certificate.
Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.\nCompanies that do not have this storage system set up will receive the error CertCaptureNotConfiguredError when they call exemption\ncertificate related APIs. To check if this company is set up, call GetCertificateSetup. To request setup of the auditable document\nstorage for this company, call RequestCertificateSetup.
Remove one or more certificates to a customer.
\nA customer object defines information about a person or business that purchases products from your\ncompany. When you create a tax transaction in AvaTax, you can use the customerCode from this\nrecord in your CreateTransaction API call. AvaTax will search for this customerCode value and\nidentify any certificates linked to this customer object. If any certificate applies to the transaction,\nAvaTax will record the appropriate elements of the transaction as exempt and link it to the certificate.
Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.\nCompanies that do not have this storage system set up will receive the error CertCaptureNotConfiguredError when they call exemption\ncertificate related APIs. To check if this company is set up, call GetCertificateSetup. To request setup of the auditable document\nstorage for this company, call RequestCertificateSetup.
Links a Ship-To customer record with a Bill-To customer record.
\nCustomer records represent businesses or individuals who can provide exemption certificates. Some customers\nmay have certificates that are linked to their shipping address or their billing address. To group these\ncustomer records together, you may link multiple bill-to and ship-to addresses together to represent a single\nentity that has multiple different addresses of different kinds.
\nIn general, a customer will have only one primary billing address and multiple ship-to addresses, representing\nall of the different locations where they receive goods. To facilitate this type of customer, you can send in\none bill-to customer code and multiple ship-to customer codes in a single API call.
\nNote that you can only link a ship-to customer record to a bill-to customer record. You may not link two customers\nof the same kind together.
\nCreate one or more datasource objects.
\nGets multiple datasource objects for a given company.
\nRetrieve the data source by its unique ID number.
\nUpdates a datasource for a company.
\nMarks the existing datasource for a company as deleted.
\nGet multiple datasource objects across all companies.
\nSearch for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby parameters.
This API is deprecated.
\nPlease use the ListTaxForms API.
\nReturns the full list of Avalara-supported AvaFile Forms\nThis API is intended to be useful to identify all the different AvaFile Forms
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","avafileforms"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"50190de9-2c29-43d7-b6a1-df0e2ebebffc"},{"name":"List certificate attributes used by a company","id":"e828d1d7-255b-4956-a7ea-e51f893a1fe8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/certificateattributes","description":"List the certificate attributes defined by a company either specified by the user or the user's default company.
\nA certificate may have multiple attributes that control its behavior. You may apply or remove attributes to a\ncertificate at any time.
\nIf you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to\ncheck and provision account.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","certificateattributes"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e828d1d7-255b-4956-a7ea-e51f893a1fe8"},{"name":"List the certificate exempt reasons defined by a company","id":"6de8150e-c9ba-491c-8e86-f198a4b2e25c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/certificateexemptreasons","description":"List the certificate exempt reasons defined by a company.
\nAn exemption reason defines why a certificate allows a customer to be exempt\nfor purposes of tax calculation.
\nIf you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to\ncheck and provision account.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","certificateexemptreasons"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6de8150e-c9ba-491c-8e86-f198a4b2e25c"},{"name":"List certificate exposure zones used by a company","id":"b1ca9681-a11c-44b7-84ab-26c7db21d244","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/certificateexposurezones","description":"List the certificate exposure zones defined by a company.
\nAn exposure zone is a location where a certificate can be valid. Exposure zones may indicate a taxing\nauthority or other legal entity to which a certificate may apply.
\nIf you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to\ncheck and provision account.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","certificateexposurezones"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b1ca9681-a11c-44b7-84ab-26c7db21d244"},{"name":"Retrieve the full list of communications transactiontypes","id":"e9ff6351-3b69-45b9-ab23-923861fa9fda","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/communications/transactiontypes","description":"Returns full list of communications transaction types which\nare accepted in communication tax calculation requests.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","communications","transactiontypes"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e9ff6351-3b69-45b9-ab23-923861fa9fda"},{"name":"Retrieve the full list of communications service types","id":"90dce396-06d0-4026-93f5-6f5496b29547","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/communications/transactiontypes/{id}/servicetypes","description":"Returns full list of service types for a given transaction type ID.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","communications","transactiontypes","{id}","servicetypes"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"90dce396-06d0-4026-93f5-6f5496b29547"},{"name":"Retrieve the full list of communications transaction/service type pairs","id":"f9a65b91-7d41-4791-b082-b56d038c82e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/communications/tspairs","description":"Returns full list of communications transaction/service type pairs which\nare accepted in communication tax calculation requests.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","communications","tspairs"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f9a65b91-7d41-4791-b082-b56d038c82e4"},{"name":"List all ISO 3166 countries","id":"6b45ae0a-bc4d-410e-8d38-8e340021b724","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/countries","description":"Returns a list of all ISO 3166 country codes, and their US English friendly names.\nThis API is intended to be useful when presenting a dropdown box in your website to allow customers to select a country for\na shipping address.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","countries"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6b45ae0a-bc4d-410e-8d38-8e340021b724"},{"name":"Retrieve the full list of rate types for each country","id":"505bd038-73d6-4f48-b017-72c912e7e07f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/countries/{country}/ratetypes","description":"Returns the full list of Avalara-supported rate type file types\nThis API is intended to be useful to identify all the different rate types.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","countries","{country}","ratetypes"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"505bd038-73d6-4f48-b017-72c912e7e07f"},{"name":"List all ISO 3166 regions for a country","id":"ba24c4f9-0cf9-4b83-8fdd-a64ac31b1a39","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/countries/{country}/regions","description":"Returns a list of all ISO 3166 region codes for a specific country code, and their US English friendly names.\nThis API is intended to be useful when presenting a dropdown box in your website to allow customers to select a region\nwithin the country for a shipping addresses.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","countries","{country}","regions"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ba24c4f9-0cf9-4b83-8fdd-a64ac31b1a39"},{"name":"List certificate exposure zones used by a company","id":"9d0136f0-8079-4a62-9bdc-fd9aebc39acb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/coverletters","description":"List available cover letters that can be used when sending invitation to use CertExpress to upload certificates.
\nThe CoverLetter model represents a message sent along with an invitation to use CertExpress to\nupload certificates. An invitation allows customers to use CertExpress to upload their exemption\ncertificates directly; this cover letter explains why the invitation was sent.
\nIf you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to\ncheck and provision account.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","coverletters"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9d0136f0-8079-4a62-9bdc-fd9aebc39acb"},{"name":"Lists the next level of HS Codes given a destination country and HS Code prefix.","id":"b61c5b42-0d6d-47dc-9ab4-cdf183048388","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/crossborder/{country}/{hsCode}","description":"Retrieves a list of HS Codes that are the children of the prefix for the given destination country, if\nadditional children are available.
\nHS Code is interchangeable with \"tariff code\" and definitions are generally unique to a destination country.\nAn HS Code describes an item and its eligibility/rate for tariffs. HS Codes are organized by\nSection/Chapter/Heading/Subheading/Classification.
\nThis API is intended to be useful to identify the correct HS Code to use for your item.
\nRetrieves the specified HS code and all of its parents, reflecting all sections, chapters, headings, and subheadings
\na list of HS Codes that are the parents and information branches of the HS Code for the given\ndestination country, if lower detail is available.
\nThis API will include information branches if applicable. These do not have HS Codes and cannot be referenced,\nbut can contain information relevant to deciding the correct HS Code.
\nThis API is intended to be useful to review the descriptive hierarchy of an HS Code, which can be particularly helpful\nwhen HS Codes can have multiple levels of generic descriptions.
\nReturns the full list of top level HS Code Sections. Sections are the broadest level of detail for\nclassifying tariff codes and the items to which they apply. HS Codes are organized\nby Section/Chapter/Heading/Subheading/Classification.
\nThis API is intended to be useful to identify the top level Sections for\nfurther LandedCost HS Code lookups.
\nLists all ISO 4217 currencies supported by AvaTax.
\nThis API produces a list of currency codes that can be used when calling AvaTax. The values from this API can be used to fill out the\ncurrencyCode field in a CreateTransactionModel.
List the customer attributes defined by a company.
\nA customer may have multiple attributes that control its behavior. You may apply or remove attributes to a\ncustomer at any time.
\nIf you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to\ncheck and provision account.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","customerattributes"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7173d877-f014-46a9-a0f0-c38a05d61456"},{"name":"Retrieve the full list of Avalara-supported entity use codes","id":"0300dcf7-3e5f-42cf-ad3f-8a405855ed89","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/entityusecodes","description":"Returns the full list of Avalara-supported entity use codes.\nEntity/Use Codes are definitions of the entity who is purchasing something, or the purpose for which the transaction\nis occurring. This information is generally used to determine taxability of the product.\nIn order to facilitate correct reporting of your taxes, you are encouraged to select the proper entity use codes for\nall transactions that are exempt.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","entityusecodes"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0300dcf7-3e5f-42cf-ad3f-8a405855ed89"},{"name":"List all forms where logins can be verified automatically","id":"db66c99c-222b-4ab8-b08e-9301ab936d54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/filingcalendars/loginverifiers","description":"List all forms where logins can be verified automatically.\nThis API is intended to be useful to identify whether the user should be allowed\nto automatically verify their login and password.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","filingcalendars","loginverifiers"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"db66c99c-222b-4ab8-b08e-9301ab936d54"},{"name":"Test whether a form supports online login verification","id":"b03a9011-ce33-411a-8f70-3c329799aded","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/filingcalendars/loginverifiers/{form}","description":"This API is intended to be useful to identify whether the user should be allowed\nto automatically verify their login and password. This API will provide a result only if the form supports automatic online login verification.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","filingcalendars","loginverifiers","{form}"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b03a9011-ce33-411a-8f70-3c329799aded"},{"name":"Retrieve the full list of Avalara-supported filing frequencies.","id":"878c0345-159c-4bea-aeaa-4bd92dd6924f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/filingfrequencies","description":"Returns the full list of Avalara-supported filing frequencies.\nThis API is intended to be useful to identify all the different filing frequencies that can be used in notices.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","filingfrequencies"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"878c0345-159c-4bea-aeaa-4bd92dd6924f"},{"name":"List jurisdictions based on the filter provided","id":"8187ad7c-ff30-43ee-9497-69ad544ddf07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/jurisdictions","description":"Returns a list of all Avalara-supported taxing jurisdictions.
\nThis API allows you to examine all Avalara-supported jurisdictions. You can filter your search by supplying\nSQL-like query for fetching only the ones you concerned about. For example: effectiveDate > '2016-01-01'
\nThe rate, salesRate, and useRate fields are not available on the JurisdictionModels returned by this API.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","jurisdictions"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8187ad7c-ff30-43ee-9497-69ad544ddf07"},{"name":"List jurisdictions near a specific address","id":"5a8c4f7f-cb61-4883-afa3-81d7d77c8f3e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/jurisdictionsnearaddress","description":"Returns a list of all Avalara-supported taxing jurisdictions that apply to this address.
\nThis API allows you to identify which jurisdictions are nearby a specific address according to the best available geocoding information.\nIt is intended to allow you to create a \"Jurisdiction Override\", which allows an address to be configured as belonging to a nearby\njurisdiction in AvaTax.
\nThe results of this API call can be passed to the CreateJurisdictionOverride API call.
Returns the list of additional questions you must answer when declaring a location in certain taxing jurisdictions.\nSome tax jurisdictions require that you register or provide additional information to configure each physical place where\nyour company does business.\nThis information is not usually required in order to calculate tax correctly, but is almost always required to file your tax correctly.\nYou can call this API call for any address and obtain information about what questions must be answered in order to properly\nfile tax in that location.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","locationquestions"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c8eec2aa-84e2-4b75-a9ca-3165d378fa8e"},{"name":"Retrieve the list of locations for a marketplace.","id":"bd0ec826-4da7-4c7a-9be7-dc251011a418","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/marketplacelocations","description":"Retrieves the list of suggested locations for a marketplace.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","marketplacelocations"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bd0ec826-4da7-4c7a-9be7-dc251011a418"},{"name":"Retrieve the full list of Avalara-supported nexus for all countries and regions.","id":"0e068729-34e1-40bc-945d-e06c9e5b8b67","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/nexus","description":"Returns the full list of all Avalara-supported nexus for all countries and regions.
\nThis API is intended to be useful if your user interface needs to display a selectable list of nexus.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","nexus"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0e068729-34e1-40bc-945d-e06c9e5b8b67"},{"name":"Retrieve the full list of Avalara-supported nexus for a country.","id":"f4ab1292-8438-43e1-838c-9d0bcdaa3007","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/nexus/{country}","description":"Returns all Avalara-supported nexus for the specified country.
\nThis API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","nexus","{country}"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f4ab1292-8438-43e1-838c-9d0bcdaa3007"},{"name":"Retrieve the full list of Avalara-supported nexus for a country and region.","id":"e0140ace-9f86-47e4-a941-8200f4eea821","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/nexus/{country}/{region}","description":"Returns all Avalara-supported nexus for the specified country and region.
\nThis API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country and region.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","nexus","{country}","{region}"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e0140ace-9f86-47e4-a941-8200f4eea821"},{"name":"List all nexus that apply to a specific address.","id":"04eb95d9-9fbb-4b59-83cb-ed3b28ebae29","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/nexus/byaddress","description":"Returns a list of all Avalara-supported taxing jurisdictions that apply to this address.\nThis API allows you to identify which tax authorities apply to a physical location, salesperson address, or point of sale.\nIn general, it is usually expected that a company will declare nexus in all the jurisdictions that apply to each physical address\nwhere the company does business.\nThe results of this API call can be passed to the 'Create Nexus' API call to declare nexus for this address.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","nexus","byaddress"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"04eb95d9-9fbb-4b59-83cb-ed3b28ebae29"},{"name":"List nexus related to a tax form","id":"77a79fcb-a40e-4823-8aff-eaac5f6172ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/nexus/byform/{formCode}","description":"Retrieves a list of nexus related to a tax form.
\nThe concept of Nexus indicates a place where your company has sufficient physical presence and is obligated\nto collect and remit transaction-based taxes.
When defining companies in AvaTax, you must declare nexus for your company in order to correctly calculate tax\nin all jurisdictions affected by your transactions.
\nThis API is intended to provide useful information when examining a tax form. If you are about to begin filing\na tax form, you may want to know whether you have declared nexus in all the jurisdictions related to that tax\nform in order to better understand how the form will be filled out.
\nReturns all Avalara-supported nexus for the specified specified tax type group.
\nThis API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by tax type group.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","nexus","bytaxtypegroup","{taxTypeGroup}"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3c755045-8c91-4006-a502-62ad2e210fc0"},{"name":"Retrieve the full list of nexus tax type groups","id":"eb57ccf0-0616-4d8a-b3cc-3901f9c03144","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/nexustaxtypegroups","description":"Returns the full list of Avalara-supported nexus tax type groups\nThis API is intended to be useful to identify all the different tax sub-types.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","nexustaxtypegroups"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"eb57ccf0-0616-4d8a-b3cc-3901f9c03144"},{"name":"Retrieve the full list of Avalara-supported tax notice customer funding options.","id":"f8b08e53-e738-47eb-909c-a20dc47951c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/noticecustomerfundingoptions","description":"Returns the full list of Avalara-supported tax notice customer funding options.\nThis API is intended to be useful to identify all the different notice customer funding options that can be used in notices.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","noticecustomerfundingoptions"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f8b08e53-e738-47eb-909c-a20dc47951c4"},{"name":"Retrieve the full list of Avalara-supported tax notice customer types.","id":"58157fe6-38e3-4a8d-82dd-0cac985ff6f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/noticecustomertypes","description":"Returns the full list of Avalara-supported tax notice customer types.\nThis API is intended to be useful to identify all the different notice customer types.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","noticecustomertypes"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"58157fe6-38e3-4a8d-82dd-0cac985ff6f0"},{"name":"Retrieve the full list of Avalara-supported tax notice filing types.","id":"d3d652de-cbfa-4204-9e43-1b1bf0a3d886","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/noticefilingtypes","description":"Returns the full list of Avalara-supported tax notice filing types.\nThis API is intended to be useful to identify all the different notice filing types that can be used in notices.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","noticefilingtypes"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d3d652de-cbfa-4204-9e43-1b1bf0a3d886"},{"name":"Retrieve the full list of Avalara-supported tax notice priorities.","id":"469cf611-36f6-48fd-b083-503def3d1283","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/noticepriorities","description":"Returns the full list of Avalara-supported tax notice priorities.\nThis API is intended to be useful to identify all the different notice priorities that can be used in notices.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","noticepriorities"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"469cf611-36f6-48fd-b083-503def3d1283"},{"name":"Retrieve the full list of Avalara-supported tax notice reasons.","id":"723057ba-efe3-4fe6-bf67-aa2d6e09a3a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/noticereasons","description":"Returns the full list of Avalara-supported tax notice reasons.\nThis API is intended to be useful to identify all the different tax notice reasons.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","noticereasons"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"723057ba-efe3-4fe6-bf67-aa2d6e09a3a5"},{"name":"Retrieve the full list of Avalara-supported tax notice responsibility ids","id":"97473df5-dadd-45ad-b827-e468d8c6018e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/noticeresponsibilities","description":"Returns the full list of Avalara-supported tax notice responsibility ids\nThis API is intended to be useful to identify all the different tax notice responsibilities.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","noticeresponsibilities"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"97473df5-dadd-45ad-b827-e468d8c6018e"},{"name":"Retrieve the full list of Avalara-supported tax notice root causes","id":"f5adb933-e4b1-468f-88bb-7282baf4a02a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/noticerootcauses","description":"Returns the full list of Avalara-supported tax notice root causes\nThis API is intended to be useful to identify all the different tax notice root causes.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","noticerootcauses"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f5adb933-e4b1-468f-88bb-7282baf4a02a"},{"name":"Retrieve the full list of Avalara-supported tax notice statuses.","id":"9f81fdd5-b7bb-4de6-9929-c68615d14c1f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/noticestatuses","description":"Returns the full list of Avalara-supported tax notice statuses.\nThis API is intended to be useful to identify all the different tax notice statuses.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","noticestatuses"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9f81fdd5-b7bb-4de6-9929-c68615d14c1f"},{"name":"Retrieve the full list of Avalara-supported tax notice types.","id":"d5474ff1-d474-4376-a6de-32a5a24f2526","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/noticetypes","description":"Returns the full list of Avalara-supported tax notice types.\nThis API is intended to be useful to identify all the different notice types that can be used in notices.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","noticetypes"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d5474ff1-d474-4376-a6de-32a5a24f2526"},{"name":"Retrieve the full list of Avalara-supported extra parameters for creating transactions.","id":"3f391c4d-2387-4fda-9a9c-22ee940987cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/parameters","description":"Returns the full list of Avalara-supported extra parameters for the 'Create Transaction' API call.\nThis list of parameters is available for use when configuring your transaction.\nSome parameters are only available for use if you have subscribed to certain features of AvaTax.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","parameters"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3f391c4d-2387-4fda-9a9c-22ee940987cc"},{"name":"Retrieve the parameters by companyCode and itemCode.","id":"07ee5354-66d7-41a5-889c-b0e220673e16","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/parameters/byitem/{companyCode}/{itemCode}","description":"Returns the list of parameters based on the company country and state jurisdiction and the item code.
\nReturns the full list of Avalara-supported usage of extra parameters for the 'Create Transaction' API call.\nThis list of parameters is available for use when configuring your transaction.\nSome parameters are only available for use if you have subscribed to certain features of AvaTax.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","parametersusage"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e9e65867-a25b-4b39-8a37-dd85dc3ba68f"},{"name":"Retrieve the full list of Avalara-supported permissions","id":"09bad27d-a8da-456e-a143-43c4ce106e16","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/permissions","description":"Returns the full list of Avalara-supported permission types.\nThis API is intended to be useful to identify the capabilities of a particular user logon.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","permissions"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"09bad27d-a8da-456e-a143-43c4ce106e16"},{"name":"Retrieve the full list of Avalara-supported postal codes.","id":"0c1b0ede-6689-42a3-a731-cb239472edd9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/postalcodes","description":"Retrieves the list of Avalara-supported postal codes.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","postalcodes"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0c1b0ede-6689-42a3-a731-cb239472edd9"},{"name":"List all customs duty programs recognized by AvaTax","id":"f3fb7bd3-6142-4a16-920f-0ba652322b84","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/preferredprograms","description":"List all preferred customs duty programs recognized by AvaTax.
\nA customs duty program is an optional program you can use to obtain favorable treatment from customs and duty agents.\nAn example of a preferred program is NAFTA, which provides preferential rates for products being shipped from neighboring\ncountries.
\nTo select a preferred program for calculating customs and duty rates, call this API to find the appropriate code for your\npreferred program. Next, set the parameter AvaTax.LC.PreferredProgram in your CreateTransaction call to the code of\nthe program.
List all available product classification systems.
\nTax authorities use product classification systems as a way to identify products and associate them with a tax rate.\nMore than one tax authority might use the same product classification system, but they might charge different tax rates for products.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","productclassificationsystems"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c32e4baa-884b-4238-a9a7-8a3bc15a6044"},{"name":"List all product classification systems available to a company based on its nexus.","id":"e8e3cac6-202f-4b64-9077-d1ab19fd6986","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/productclassificationsystems/bycompany/{companyCode}","description":"Lists all product classification systems available to a company based on its nexus.
\nTax authorities use product classification systems as a way to identify products and associate them with a tax rate.\nMore than one tax authority might use the same product classification system, but they might charge different tax rates for products.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","productclassificationsystems","bycompany","{companyCode}"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e8e3cac6-202f-4b64-9077-d1ab19fd6986"},{"name":"List all ISO 3166 regions","id":"701b60f9-5447-46b2-9379-8c8c243c37bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/regions","description":"Returns a list of all ISO 3166 region codes and their US English friendly names.\nThis API is intended to be useful when presenting a dropdown box in your website to allow customers to select a region\nwithin the country for a shipping addresses.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","regions"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"701b60f9-5447-46b2-9379-8c8c243c37bd"},{"name":"Retrieve the full list of Avalara-supported resource file types","id":"fa91c5de-0bf7-4e8d-86db-ab6f3ad647fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/resourcefiletypes","description":"Returns the full list of Avalara-supported resource file types\nThis API is intended to be useful to identify all the different resource file types.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","resourcefiletypes"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"fa91c5de-0bf7-4e8d-86db-ab6f3ad647fd"},{"name":"Retrieve the full list of Avalara-supported permissions","id":"91dea7fa-b171-4404-a90e-9bb77ea62ea1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/securityroles","description":"Returns the full list of Avalara-supported permission types.\nThis API is intended to be useful when designing a user interface for selecting the security role of a user account.\nSome security roles are restricted for Avalara internal use.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","securityroles"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"91dea7fa-b171-4404-a90e-9bb77ea62ea1"},{"name":"Retrieve the full list of Avalara-supported subscription types","id":"a6662774-e679-4b68-b524-b661fd65186b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/subscriptiontypes","description":"Returns the full list of Avalara-supported subscription types.\nThis API is intended to be useful for identifying which features you have added to your account.\nYou may always contact Avalara's sales department for information on available products or services.\nYou cannot change your subscriptions directly through the API.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","subscriptiontypes"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a6662774-e679-4b68-b524-b661fd65186b"},{"name":"Retrieve the full list of Avalara-supported tax authorities.","id":"90907e35-ea12-4955-8177-bacbda441f01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/taxauthorities","description":"Returns the full list of Avalara-supported tax authorities.\nThis API is intended to be useful to identify all the different authorities that receive tax.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","taxauthorities"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"90907e35-ea12-4955-8177-bacbda441f01"},{"name":"Retrieve the full list of Avalara-supported forms for each tax authority.","id":"35dbd5c7-00d7-4327-919d-f446e61e419c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/taxauthorityforms","description":"Returns the full list of Avalara-supported forms for each tax authority.\nThis list represents tax forms that Avalara recognizes.\nCustomers who subscribe to Avalara Managed Returns Service can request these forms to be filed automatically\nbased on the customer's AvaTax data.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","taxauthorityforms"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"35dbd5c7-00d7-4327-919d-f446e61e419c"},{"name":"Retrieve the full list of Avalara-supported tax authority types.","id":"7c6f136c-3c29-43d5-a9b4-9ebf446d0783","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/taxauthoritytypes","description":"Returns the full list of Avalara-supported tax authority types.\nThis API is intended to be useful to identify all the different authority types.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","taxauthoritytypes"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7c6f136c-3c29-43d5-a9b4-9ebf446d0783"},{"name":"Retrieve the full list of Avalara-supported tax codes.","id":"efd0e196-ed4c-495e-ae01-5408ebf503fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/taxcodes","description":"Retrieves the list of Avalara-supported system tax codes.\nA 'TaxCode' represents a uniquely identified type of product, good, or service.\nAvalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.\nIf you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and\ntaxability rules for this product in all supported jurisdictions.
\nReturns the full list of recognized tax code types.\nA 'Tax Code Type' represents a broad category of tax codes, and is less detailed than a single TaxCode.\nThis API is intended to be useful for broadly searching for tax codes by tax code type.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","taxcodetypes"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9d09b560-925f-4803-b254-0b63345655ce"},{"name":"Retrieve the full list of the Tax Forms available","id":"9da4704e-0454-4b01-9f53-d98e8525f1b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/taxforms","description":"Returns the full list of Avalara-supported Tax Forms\nThis API is intended to be useful to identify all the different Tax Forms
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","taxforms"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9da4704e-0454-4b01-9f53-d98e8525f1b0"},{"name":"Retrieve the full list of tax sub types","id":"fb03a458-381b-4cb6-b6b3-698e2125516f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/taxsubtypes","description":"Returns the full list of Avalara-supported tax sub-types\nThis API is intended to be useful to identify all the different tax sub-types.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","taxsubtypes"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"fb03a458-381b-4cb6-b6b3-698e2125516f"},{"name":"Retrieve the full list of tax sub types by jurisdiction code and region","id":"424c865c-8822-4923-bc90-32b4bcbc9e97","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/taxsubtypes/{jurisdictionCode}/{region}","description":"Returns the full list of Avalara-supported tax sub-types by jurisdiction and region\nThis API is intended to be useful to identify all the different tax sub-types.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","taxsubtypes","{jurisdictionCode}","{region}"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"424c865c-8822-4923-bc90-32b4bcbc9e97"},{"name":"Retrieve the full list of tax type groups","id":"645ba74b-5296-4535-a07c-a23913ecf9fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/taxtypegroups","description":"Returns the full list of Avalara-supported tax type groups\nThis API is intended to be useful to identify all the different tax type groups.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","taxtypegroups"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"645ba74b-5296-4535-a07c-a23913ecf9fd"},{"name":"List all defined units of measurement","id":"455fff5a-4d5e-46a9-a66f-fb8c4b104be9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/definitions/unitofmeasurements","description":"List all units of measurement systems defined by Avalara.
\nA unit of measurement system is a method of measuring a quantity, such as distance, mass, or others.
\n","urlObject":{"protocol":"https","path":["api","v2","definitions","unitofmeasurements"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"455fff5a-4d5e-46a9-a66f-fb8c4b104be9"},{"name":"Retrieve all DistanceThresholds for this company.","id":"f928edaa-ee94-40cb-9e73-cb3697157878","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/companies/{companyId}/distancethresholds","description":"Lists all DistanceThreshold objects that belong to this company.
\nA company-distance-threshold model indicates the distance between a company\nand the taxing borders of various countries. Distance thresholds are necessary\nto correctly calculate some value-added taxes.
\nCreate one or more DistanceThreshold objects for this company.
\nA company-distance-threshold model indicates the distance between a company\nand the taxing borders of various countries. Distance thresholds are necessary\nto correctly calculate some value-added taxes.
\nRetrieves a single DistanceThreshold object defined by this URL.
\nA company-distance-threshold model indicates the distance between a company\nand the taxing borders of various countries. Distance thresholds are necessary\nto correctly calculate some value-added taxes.
\nReplace the existing DistanceThreshold object at this URL with an updated object.
\nA company-distance-threshold model indicates the distance between a company\nand the taxing borders of various countries. Distance thresholds are necessary\nto correctly calculate some value-added taxes.
\nAll data from the existing object will be replaced with data in the object you PUT.\nTo set a field's value to null, you may either set its value to null or omit that field from the object you post.
\nMarks the DistanceThreshold object identified by this URL as deleted.
\nA company-distance-threshold model indicates the distance between a company\nand the taxing borders of various countries. Distance thresholds are necessary\nto correctly calculate some value-added taxes.
\nLists all DistanceThreshold objects that belong to this account.
\nA company-distance-threshold model indicates the distance between a company\nand the taxing borders of various countries. Distance thresholds are necessary\nto correctly calculate some value-added taxes.
\nSearch for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby parameters.
Get list of ECMS data for this company\nAn ECMS data represents a documentation based on which companies can claim tax exemption\nYou may attach nested data objects such as ECMS detail, and those objects will be created with certificate.\nYou may specify one or more of the following values in the $include parameter to fetch additional nested data, using commas to separate multiple values:
Get an ECMS identified by company id and ECMS id.\nAn ECMS data represents a documentation based on which companies can claim tax exemption\nYou may attach nested data objects such as exempt cert detail, and those objects will be created with certificate.\nYou may specify one or more of the following values in the $include parameter to fetch additional nested data, using commas to separate multiple values:
Get all ECMS currently available in database.\nAn ECMS data represents a documentation based on which companies can claim tax exemption\nYou may attach nested data objects such as ECMS detail, and those objects will be created with certificate.\nSearch for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby parameters.\nYou may specify one or more of the following values in the $include parameter to fetch additional nested data, using commas to separate multiple values:
Creates a new eCommerce token.
\nThis API is used to create a new eCommerce token. An eCommerce token is required in order to launch the CertCapture eCommerce plugin. Create a token for each of your CertCapture customers.
\nRefresh an eCommerce token.
\nCertCapture eCommerce tokens expire after one hour. This API is used to refresh an eCommerce token that is about to expire. This API can only be used with active tokens. If your token has expired, you must generate a new one.
\nList error transactions attached to this company. Results are dependent on $filter if provided.
This endpoint is limited to returning 1000 error transactions at a time maximum.
\nSearch for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby parameters.
Delete a batch of error transactions attached to a company.
\nIf any of the provided error transaction isn't found then it'll be treated as a success.
\nGet a list of error transactions' error codes and their counts\nWhen you try to create or adjust a transaction with a datasource for a company and for any reason that call fails with an error,\nthose errors with their count can be retrieved by this API.
\nThis API is available by invitation only.
\nThis API is available by invitation only and only available for users with Compliance access\nA \"filing request\" represents information that compliance uses to file a return
\nThis API is available by invitation only and only available for users with Compliance access
\nThis API is available by invitation only and only available for users with Compliance access
\nThis API is available by invitation only.
\nThis API is available by invitation only.\nMark the existing notice object at this URL as deleted.\nA 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara\nReturns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
\nThis API is available by invitation only.
\nThis API is available by invitation only.
\nThis API is available by invitation only.
\nA \"filing request\" represents a request to change an existing filing calendar. Filing requests\nare reviewed and validated by Avalara Compliance before being implemented.
\nThis API is available by invitation only.
\nThis API is available by invitation only.
\nA \"filing request\" represents a request to change an existing filing calendar. Filing requests\nare reviewed and validated by Avalara Compliance before being implemented.
\nCertain users may not update filing calendars directly. Instead, they may submit an edit request\nto modify the value of a filing calendar using this API.
\nThis API is available by invitation only.
\nThis API is available by invitation only.\nA \"filing request\" represents a request to change an existing filing calendar. Filing requests\nare reviewed and validated by Avalara Compliance before being implemented.
\nThis API is available by invitation only.
\nThis API fetches valid POA's for a company by TaxFormCode or by country/region
\nThis API is available by invitation only.\nA \"filing request\" represents a request to change an existing filing calendar. Filing requests\nare reviewed and validated by Avalara Compliance before being implemented.
\nThis API is available by invitation only.\nA \"filing request\" represents a request to change an existing filing calendar. Filing requests\nare reviewed and validated by Avalara Compliance before being implemented.
\nThis API is available by invitation only.\nA \"filing request\" represents a request to change an existing filing calendar. Filing requests\nare reviewed and validated by Avalara Compliance before being implemented.
\nThis API is available by invitation only.\nA \"filing request\" represents a request to change an existing filing calendar. Filing requests\nare reviewed and validated by Avalara Compliance before being implemented.\nThe filing request must be in the \"ChangeRequest\" status to be approved.
\nThis API is available by invitation only.\nA \"filing request\" represents a request to change an existing filing calendar. Filing requests\nare reviewed and validated by Avalara Compliance before being implemented.
\nThis API is available by invitation only.
\nThis API is deprecated - please use POST /api/v2/filingrequests/query API.
This API is available by invitation only.
\nThis API checks the status of a login verification request. It may only be called by authorized users from the account\nthat initially requested the login verification.
\nThis API is available by invitation only.
\nThis API verifies that a customer has submitted correct login credentials for a tax authority's online filing system.
\nThis API is available by invitation only.
\nThis API is intended to replace the GET /api/v2/filingcalendars API. The fetch request object is posted on the body of the request instead of the URI, so it's not limited by a set number of characters.\nThe documentation of the GET API shows how filtering, sorting and pagination works.
This API is available by invitation only.
\nThis API is deprecated - please use POST /api/v2/filingrequests/query API.
A \"filing request\" represents a request to change an existing filing calendar. Filing requests\nare reviewed and validated by Avalara Compliance before being implemented.
\nSearch for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby parameters.
This API is available by invitation only.
\nThis API is intended to replace the GET /api/v2/filingrequests API. The fetch request object is posted on the body of the request instead of the URI, so it's not limited by a set number of characters.\nThe documentation of the GET API shows how filtering, sorting and pagination works.
This API is available by invitation only.\nA \"filing period\" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,\nbased on filing frequency of filing.
\nThis API is available by invitation only.
\nThis API is available by invitation only.
\nThis API is available by invitation only.\nA \"filing period\" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,\nbased on filing frequency of filing.
\nThis API is available by invitation only.\nA \"filing period\" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,\nbased on filing frequency of filing.
\nThis API is available by invitation only.\nA \"filing period\" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,\nbased on filing frequency of filing.
\nThis API is available by invitation only.\nA \"filing period\" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,\nbased on filing frequency of filing.
\nThis API is available by invitation only.\nAn \"Adjustment\" is usually an increase or decrease to customer funding to Avalara,\nsuch as early filer discount amounts that are refunded to the customer, or efile fees from websites.\nSometimes may be a manual change in tax liability similar to an augmentation.\nThis API creates a new adjustment for an existing tax filing.\nThis API can only be used when the filing has not yet been approved.
\nThis API is available by invitation only.\nAn \"Augmentation\" is a manually added increase or decrease in tax liability, by either customer or Avalara\nusually due to customer wanting to report tax Avatax does not support, e.g. bad debts, rental tax.\nThis API creates a new augmentation for an existing tax filing.\nThis API can only be used when the filing has not been approved.
\nThis API is available by invitation only.\nAn \"Payment\" is usually an increase or decrease to customer funding to Avalara,\nsuch as early filer discount amounts that are refunded to the customer, or efile fees from websites.\nSometimes may be a manual change in tax liability similar to an augmentation.\nThis API creates a new payment for an existing tax filing.\nThis API can only be used when the filing has not yet been approved.
\nThis API is available by invitation only.\nApproving a return means the customer is ready to let Avalara file that return.\nCustomer either approves themselves from admin console,\nelse system auto-approves the night before the filing cycle\nSometimes Compliance has to manually unapprove and reapprove to modify liability or filing for the customer.\nA \"filing period\" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,\nbased on filing frequency of filing.
\nThis API is available by invitation only.audit.CheckAuthorizationReturns(null, companyId);\nRebuilding a return means re-creating or updating the amounts to be filed for a filing.\nRebuilding has to be done whenever a customer adds transactions to a filing.\nA \"filing period\" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,\nbased on filing frequency of filing.\nThis API requires filing to be unapproved.
\nThis API is available by invitation only.\nApproving a return means the customer is ready to let Avalara file that return.\nCustomer either approves themselves from admin console,\nelse system auto-approves the night before the filing cycle.\nSometimes Compliance has to manually unapprove and reapprove to modify liability or filing for the customer.\nA \"filing period\" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,\nbased on filing frequency of filing.
\nThis API is available by invitation only.\nRebuilding a return means re-creating or updating the amounts to be filed (worksheet) for a filing.\nRebuilding has to be done whenever a customer adds transactions to a filing.\nA \"filing period\" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,\nbased on filing frequency of filing.\nThis API requires filing to be unapproved.
\nThis API is available by invitation only.\nApproving a return means the customer is ready to let Avalara file that return.\nCustomer either approves themselves from admin console,\nelse system auto-approves the night before the filing cycle.\nSometimes Compliance has to manually unapprove and reapprove to modify liability or filing for the customer.\nA \"filing period\" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,\nbased on filing frequency of filing.
\nThis API is available by invitation only.\nA \"filing period\" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,\nbased on filing frequency of filing.
\nThis API is available by invitation only.\nA \"filing period\" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,\nbased on filing frequency of filing.
\nThis API is available by invitation only.
\nThis API is available by invitation only.\nRebuilding a return means re-creating or updating the amounts to be filed (worksheet) for a filing.\nRebuilding has to be done whenever a customer adds transactions to a filing.\nA \"filing period\" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,\nbased on filing frequency of filing.\nThis API requires filing to be unapproved.
\nThis API is available by invitation only.\nAn \"Adjustment\" is usually an increase or decrease to customer funding to Avalara,\nsuch as early filer discount amounts that are refunded to the customer, or efile fees from websites.\nSometimes may be a manual change in tax liability similar to an augmentation.\nThis API modifies an adjustment for an existing tax filing.\nThis API can only be used when the filing has not yet been approved.
\nThis API is available by invitation only.\nAn \"Adjustment\" is usually an increase or decrease to customer funding to Avalara,\nsuch as early filer discount amounts that are refunded to the customer, or efile fees from websites.\nSometimes may be a manual change in tax liability similar to an augmentation.\nThis API deletes an adjustment for an existing tax filing.\nThis API can only be used when the filing has been unapproved.
\nThis API is available by invitation only.\nAn \"Augmentation\" is a manually added increase or decrease in tax liability, by either customer or Avalara\nusually due to customer wanting to report tax Avatax does not support, e.g. bad debts, rental tax.\nThis API modifies an augmentation for an existing tax filing.\nThis API can only be used when the filing has not been approved.
\nThis API is available by invitation only.\nAn \"Augmentation\" is a manually added increase or decrease in tax liability, by either customer or Avalara\nusually due to customer wanting to report tax Avatax does not support, e.g. bad debts, rental tax.\nThis API deletes an augmentation for an existing tax filing.\nThis API can only be used when the filing has been unapproved.
\nThis API is available by invitation only.\nAn \"Payment\" is usually an increase or decrease to customer funding to Avalara,\nsuch as early filer discount amounts that are refunded to the customer, or efile fees from websites.\nSometimes may be a manual change in tax liability similar to an augmentation.\nThis API modifies an payment for an existing tax filing.\nThis API can only be used when the filing has not yet been approved.
\nThis API is available by invitation only.\nAn \"Payment\" is usually an increase or decrease to customer funding to Avalara,\nsuch as early filer discount amounts that are refunded to the customer, or efile fees from websites.\nSometimes may be a manual change in tax liability similar to an augmentation.\nThis API deletes an payment for an existing tax filing.\nThis API can only be used when the filing has been unapproved.
\nThis API is available by invitation only.\nA \"filing period\" is the year and month of the date of the latest customer transaction allowed to be reported on a filing,\nbased on filing frequency of filing.
\nThis API enables the firm or account users to request the associated linkages to the account.
\nThis API enables the firm admins/firm users to request the linkage of a firm account and a client account.
\nThis API enables the firm admins/firm users to request the linkage of a firm account and a client account.
\nThis API marks a linkage between a firm and client as deleted.
\nThis API enables the account admin of a client account to approve linkage request by a firm.
\nThis API enables the account admin of a client account to reject linkage request by a firm.
\nThis API enables the firm admin of a client account to reset a previously created linkage request by a firm.
\nThis API enables the account admin of a client account to revoke a previously approved linkage request by a firm.
\nThis API is for use by Firms only.
\nAvalara allows firms to manage returns for clients without the clients needing to use AvaTax service.\nFirms can create accounts of FirmClient for customers they are managing using this API.
\nCalling this API creates an account with the specified product subscriptions, but without a new user for account.\nAccount is then linked to the Firm so they can managed their returns.\nYou should call this API when a customer does not have an AvaTax account and is to be managed only by the firm.
\nThe created account will be created in Active status but there will be no user or license key associated with account.
Call this API to obtain a free AvaTax account.
\nThis API is free to use. No authentication credentials are required to call this API. You must read and\naccept Avalara's terms and conditions for the account to be\ncreated.
\nIf all conditions are met, this API will grant a free trial version of AvaTax. For a list of functionality\navailable in the free trial and its limitations, please see the AvaTax Developer Website Free Trial page.
\nAfter your free trial concludes, you will still be able to use the Free AvaTax API Suite.
\nThe TaxRates API is a free-to-use, no cost option for estimating sales tax rates.\nAny customer can request a free AvaTax account and make use of the TaxRates API.
\nUsage of this API is subject to rate limits. Users who exceed the rate limit will receive HTTP\nresponse code 429 - Too Many Requests.
This API assumes that you are selling general tangible personal property at a retail point-of-sale\nlocation in the United States only.
\nFor more powerful tax calculation, please consider upgrading to the CreateTransaction API,\nwhich supports features including, but not limited to:
Please see Estimating Tax with REST v2\nfor information on how to upgrade to the full AvaTax CreateTransaction API.
\n","urlObject":{"protocol":"https","path":["api","v2","taxrates","byaddress"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2853cfd7-b91d-4ae6-b5e0-50478e93251e"},{"name":"FREE API - Sales tax rates for a specified country and postal code. This API is only available for US postal codes.","id":"5109a47e-a6f7-4f97-a339-9b0c95bc0e4e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/taxrates/bypostalcode","description":"This API is only available for a US postal codes.
\nThe TaxRates API is a free-to-use, no cost option for estimating sales tax rates.\nAny customer can request a free AvaTax account and make use of the TaxRates API.
\nUsage of this API is subject to rate limits. Users who exceed the rate limit will receive HTTP\nresponse code 429 - Too Many Requests.
This API assumes that you are selling general tangible personal property at a retail point-of-sale\nlocation in the United States only.
\nFor more powerful tax calculation, please consider upgrading to the CreateTransaction API,\nwhich supports features including, but not limited to:
Please see Estimating Tax with REST v2\nfor information on how to upgrade to the full AvaTax CreateTransaction API.
\n","urlObject":{"protocol":"https","path":["api","v2","taxrates","bypostalcode"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5109a47e-a6f7-4f97-a339-9b0c95bc0e4e"},{"name":"Retrieve status about a funding setup request","id":"3f6d09eb-9eda-4205-86b3-dcaf5cb76a59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/fundingrequests/{id}","description":"This API is available by invitation only.\nCompanies that use the Avalara Managed Returns or the SST Certified Service Provider services are\nrequired to setup their funding configuration before Avalara can begin filing tax returns on their\nbehalf.\nFunding configuration for each company is set up by submitting a funding setup request, which can\nbe sent either via email or via an embedded HTML widget.\nWhen the funding configuration is submitted to Avalara, it will be reviewed by treasury team members\nbefore approval.\nThis API checks the status on an existing funding request.\nThis API requires a subscription to Avalara Managed Returns or SST Certified Service Provider.
\nThis API is available by invitation only.\nCompanies that use the Avalara Managed Returns or the SST Certified Service Provider services are\nrequired to setup their funding configuration before Avalara can begin filing tax returns on their\nbehalf.\nFunding configuration for each company is set up by submitting a funding setup request, which can\nbe sent either via email or via an embedded HTML widget.\nWhen the funding configuration is submitted to Avalara, it will be reviewed by treasury team members\nbefore approval.\nThis API returns back the actual javascript code to insert into your application to render the\nJavaScript funding setup widget inline.\nUse the 'methodReturn.javaScript' return value to insert this widget into your HTML page.\nThis API requires a subscription to Avalara Managed Returns or SST Certified Service Provider.
\nList all items defined for the current company.
\nItems are a way of separating your tax calculation process from your tax configuration details. If you choose, you\ncan provide itemCode values for each CreateTransaction() API call rather than specifying tax codes, parameters, descriptions,\nand other data fields. AvaTax will automatically look up each itemCode and apply the correct tax codes and parameters\nfrom the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance\nteam can manage your item catalog and adjust the tax behavior of items without having to modify your software.
Search for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .
Paginate your results using the $top, $skip, and $orderby parameters.
You may specify one or more of the following values in the $include parameter to fetch additional nested data, using commas to separate multiple values:
Creates one or more new item objects attached to this company.
\nItems are a way of separating your tax calculation process from your tax configuration details. If you choose, you\ncan provide itemCode values for each CreateTransaction() API call rather than specifying tax codes, parameters, descriptions,\nand other data fields. AvaTax will automatically look up each itemCode and apply the correct tax codes and parameters\nfrom the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance\nteam can manage your item catalog and adjust the tax behavior of items without having to modify your software.
The tax code takes precedence over the tax code id if both are provided.
\nGet the Item object identified by this URL.
Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you\ncan provide itemCode values for each CreateTransaction() API call rather than specifying tax codes, parameters, descriptions,\nand other data fields. AvaTax will automatically look up each itemCode and apply the correct tax codes and parameters\nfrom the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance\nteam can manage your item catalog and adjust the tax behavior of items without having to modify your software.
Replace the existing Item object at this URL with an updated object.
Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you\ncan provide itemCode values for each CreateTransaction() API call rather than specifying tax codes, parameters, descriptions,\nand other data fields. AvaTax will automatically look up each itemCode and apply the correct tax codes and parameters\nfrom the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance\nteam can manage your item catalog and adjust the tax behavior of items without having to modify your software.
All data from the existing object will be replaced with data in the object you PUT. To set a field's value to null,\nyou may either set its value to null or omit that field from the object you post.
\nThe tax code takes precedence over the tax code id if both are provided.
\nDeletes the item object at this URL.
\nItems are a way of separating your tax calculation process from your tax configuration details. If you choose, you\ncan provide itemCode values for each CreateTransaction() API call rather than specifying tax codes, parameters, descriptions,\nand other data fields. AvaTax will automatically look up each itemCode and apply the correct tax codes and parameters\nfrom the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance\nteam can manage your item catalog and adjust the tax behavior of items without having to modify your software.
Deleting an item will also delete the parameters and classifications associated with that item.
\nAdd classifications to an item.
\nA classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product.
\nWhen an item is used in a transaction, the applicable classification will be used to determine the appropriate tax rate.
\nAn item may only have one classification per tax system.
\nList classifications for an item.
\nA classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product.
\nWhen an item is used in a transaction, the applicable classification will be used to determine the appropriate tax rate.
\nSearch for specific objects using the criteria in the $filter classification; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby classifications.
Delete all the classifications for a given item.
\nA classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product.
\nWhen an item is used in a transaction, the applicable classification will be used to determine the appropriate tax rate.
\nRetrieve a single item classification.
\nA classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product.
\nWhen an item is used in a transaction, the applicable classification will be used to determine the appropriate tax rate.
\nUpdate an item classification.
\nA classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product.
\nWhen an item is used in a transaction, the applicable classification will be used to determine the appropriate tax rate.
\nAn item may only have one classification per tax system.
\nDelete a single item classification.
\nA classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems which may have different tax rates for a product.
\nWhen an item is used in a transaction, the applicable classification will be used to determine the appropriate tax rate.
\nAdd parameters to an item.
\nSome items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called \"parameters\".
\nA parameter added to an item will be used by default in tax calculation but will not show on the transaction line referencing the item .
\nA parameter specified on a transaction line will override an item parameter if they share the same parameter name.
\nTo see available parameters for this item, call /api/v2/definitions/parameters?$filter=attributeType eq Product
Some parameters are only available for use if you have subscribed to specific AvaTax services. To see which parameters you are able to use, add the query parameter \"$showSubscribed=true\" to the parameter definition call above.
\nList parameters for an item.
\nSome items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called \"parameters\".
\nA parameter added to an item will be used by default in tax calculation but will not show on the transaction line referencing the item .
\nA parameter specified on a transaction line will override an item parameter if they share the same parameter name.
\nSearch for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby parameters.
Delete all the parameters for a given item.
\nSome items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called \"parameters\".
\nA parameter added to an item will be used by default in tax calculation but will not show on the transaction line referencing the item .
\nA parameter specified on a transaction line will override an item parameter if they share the same parameter name.
\nRetrieve a single item parameter.
\nSome items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called \"parameters\".
\nA parameter added to an item will be used by default in tax calculation but will not show on the transaction line referencing the item .
\nA parameter specified on a transaction line will override an item parameter if they share the same parameter name.
\nUpdate an item parameter.
\nSome items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called \"parameters\".
\nA parameter added to an item will be used by default in tax calculation but will not show on the transaction line referencing the item .
\nA parameter specified on a transaction line will override an item parameter if they share the same parameter name.
\nDelete a single item parameter.
\nSome items can be taxed differently depending on the properties of that item, such as the item grade or by a particular measurement of that item. In AvaTax, these tax-affecting properties are called \"parameters\".
\nA parameter added to an item will be used by default in tax calculation but will not show on the transaction line referencing the item .
\nA parameter specified on a transaction line will override an item parameter if they share the same parameter name.
\nSyncs a list of items with AvaTax without waiting for them to be created. It is ideal for syncing large product catalogs\nwith AvaTax.
\nAny invalid or duplicate items will be ignored. To diagnose why an item is not created, use the normal create transaction API to receive validation information.
\nThis API is currently limited to 1000 items per call (the limit is subject to change).
\nItems are a way of separating your tax calculation process from your tax configuration details. If you choose, you\ncan provide itemCode values for each CreateTransaction() API call rather than specifying tax codes, parameters, descriptions,\nand other data fields. AvaTax will automatically look up each itemCode and apply the correct tax codes and parameters\nfrom the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance\nteam can manage your item catalog and adjust the tax behavior of items without having to modify your software.
Get multiple item objects across all companies.
\nItems are a way of separating your tax calculation process from your tax configuration details. If you choose, you\ncan provide itemCode values for each CreateTransaction() API call rather than specifying tax codes, parameters, descriptions,\nand other data fields. AvaTax will automatically look up each itemCode and apply the correct tax codes and parameters\nfrom the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance\nteam can manage your item catalog and adjust the tax behavior of items without having to modify your software.
Search for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .
Paginate your results using the $top, $skip, and $orderby parameters.
Creates one or more jurisdiction override objects for this account.
\nA Jurisdiction Override is a configuration setting that allows you to select the taxing\njurisdiction for a specific address. If you encounter an address that is on the boundary\nbetween two different jurisdictions, you can choose to set up a jurisdiction override\nto switch this address to use different taxing jurisdictions.
\nList all jurisdiction override objects defined for this account.
\nA Jurisdiction Override is a configuration setting that allows you to select the taxing\njurisdiction for a specific address. If you encounter an address that is on the boundary\nbetween two different jurisdictions, you can choose to set up a jurisdiction override\nto switch this address to use different taxing jurisdictions.
\nSearch for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby parameters.
Get the item object identified by this URL.
\nA Jurisdiction Override is a configuration setting that allows you to select the taxing\njurisdiction for a specific address. If you encounter an address that is on the boundary\nbetween two different jurisdictions, you can choose to set up a jurisdiction override\nto switch this address to use different taxing jurisdictions.
\nReplace the existing jurisdictionoverride object at this URL with an updated object.
\nMarks the item object at this URL as deleted.
\nGet multiple jurisdiction override objects across all companies.
\nA Jurisdiction Override is a configuration setting that allows you to select the taxing\njurisdiction for a specific address. If you encounter an address that is on the boundary\nbetween two different jurisdictions, you can choose to set up a jurisdiction override\nto switch this address to use different taxing jurisdictions.
\nSearch for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby parameters.
List all location objects defined for this company.\nAn 'Location' represents a physical address where a company does business.\nMany taxing authorities require that you define a list of all locations where your company does business.\nThese locations may require additional custom configuration or tax registration with these authorities.\nFor more information on metadata requirements, see the '/api/v2/definitions/locationquestions' API.
\nSearch for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby parameters.\nYou may specify one or more of the following values in the $include parameter to fetch additional nested data, using commas to separate multiple values:
Create one or more new location objects attached to this company.
\nGet the location object identified by this URL.\nAn 'Location' represents a physical address where a company does business.\nMany taxing authorities require that you define a list of all locations where your company does business.\nThese locations may require additional custom configuration or tax registration with these authorities.\nFor more information on metadata requirements, see the '/api/v2/definitions/locationquestions' API.
\nYou may specify one or more of the following values in the $include parameter to fetch additional nested data, using commas to separate multiple values:
Replace the existing location object at this URL with an updated object.\nAll data from the existing object will be replaced with data in the object you PUT.\nTo set a field's value to null, you may either set its value to null or omit that field from the object you post.
\nMark the location object at this URL as deleted.
\nUse when wanting to change the remittance of a company location of type Marketplace. The new Effective Date should be at least a day later than\nthe existing Effective Date but no greater than the existing End Date. This API will expire the existing location by\nsetting end date with the new effective date minus one day. Then create a new location with the same parameters except for the dates\nand the remittance type.
\nNOTES: Only to alternate between SellerRemitsTax and MarketPlaceRemitsTax address categories for location with address type MarketPlace.\nIf new Effective Date is greater than the existing End Date, in other words the new date range isn't overlapping with the existing date range,\nplease create a new location instead.
\nReturns validation information for this location.\nThis API call is intended to compare this location against the currently known taxing authority rules and regulations,\nand provide information about what additional work is required to completely setup this location.
\nAdd parameters to a location.
\nSome locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called \"parameters\".
\nA parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location.
\nA parameter specified on a transaction line will override a location parameter if they share the same parameter name.
\nTo see available parameters for this location, call /api/v2/definitions/parameters?$filter=attributeType eq Company
Some parameters are only available for use if you have subscribed to specific AvaTax services. To see which parameters you are able to use, add the query parameter \"$showSubscribed=true\" to the parameter definition call above.
\nList parameters for a location.
\nSome locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called \"parameters\".
\nA parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location.
\nA parameter specified on a transaction line will override a location parameter if they share the same parameter name.
\nSearch for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby parameters.
Retrieve a single location parameter.
\nSome locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called \"parameters\".
\nA parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location.
\nA parameter specified on a transaction line will override a location parameter if they share the same parameter name.
\nUpdate a location parameter.
\nSome locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called \"parameters\".
\nA parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location.
\nA parameter specified on a transaction line will override a location parameter if they share the same parameter name.
\nDelete a single location parameter.
\nSome locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called \"parameters\".
\nA parameter added to a location will be used by default in tax calculation but will not show on the transaction line referencing the location.
\nA parameter specified on a transaction line will override a location parameter if they share the same parameter name.
\nGet multiple location objects across all companies.\nAn 'Location' represents a physical address where a company does business.\nMany taxing authorities require that you define a list of all locations where your company does business.\nThese locations may require additional custom configuration or tax registration with these authorities.\nFor more information on metadata requirements, see the '/api/v2/definitions/locationquestions' API.
\nSearch for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby parameters.
You may specify one or more of the following values in the $include parameter to fetch additional nested data, using commas to separate multiple values:
Records a new MultiDocument transaction in AvaTax.
\nA traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can\ninvolve a marketplace of vendors, each of which contributes some portion of the final transaction. Within\na MultiDocument transaction, each individual buyer and seller pair are matched up and converted to a separate\ndocument. This separation of documents allows each seller to file their taxes separately.
\nThis API will report an error if you attempt to create a transaction when one already exists with the specified code.\nIf you would like the API to automatically update the transaction when it already exists, please set the allowAdjust\nvalue to true.
To generate a refund for a transaction, use the RefundTransaction API.
The field type identifies the kind of transaction - for example, a sale, purchase, or refund. If you do not specify\na type value, you will receive an estimate of type SalesOrder, which will not be recorded.
The origin and destination locations for a transaction must be identified by either address or geocode. For address-based transactions, please\nprovide addresses in the fields line, city, region, country and postalCode. For geocode-based transactions, please provide the geocode\ninformation in the fields latitude and longitude. If either latitude or longitude or both are null, the transaction will be calculated\nusing the best available address location information.
You may specify one or more of the following values in the $include parameter to fetch additional nested data, using commas to separate multiple values:
If you omit the $include parameter, the API will assume you want Summary,Addresses.
NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:
\nList all MultiDocument transactions within this account.
\nThis endpoint is limited to returning 1,000 MultiDocument transactions at a time. To retrieve more than 1,000 MultiDocument\ntransactions, please use the pagination features of the API.
\nA transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\nsales, purchases, inventory transfer, and returns (also called refunds).
\nSearch for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby parameters.
You may specify one or more of the following values in the $include parameter to fetch additional nested data, using commas to separate multiple values:
NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:
\nGet the current MultiDocument transaction identified by this URL.
\nIf this transaction was adjusted, the return value of this API will be the current transaction with this code.
\nYou may specify one or more of the following values in the $include parameter to fetch additional nested data, using commas to separate multiple values:
NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:
\nAdjusts the current MultiDocument transaction uniquely identified by this URL.
\nA transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\nsales, purchases, inventory transfer, and returns (also called refunds).
\nWhen you adjust a transaction, that transaction's status is recorded as Adjusted.
Both the revisions will be available for retrieval based on their code and ID numbers. Only transactions in Committed status can be reported on a tax filing by Avalara's Managed Returns Service.
\nTransactions that have been previously reported to a tax authority by Avalara Managed Returns are considered locked and are no longer available for adjustments.
\nNOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:
\nRetrieve audit information about a MultiDocument transaction stored in AvaTax.
\nThe audit API retrieves audit information related to a specific MultiDocument transaction. This audit\ninformation includes the following:
\ncode of the MultiDocument transactiontype of the MultiDocument transactionA transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\nsales, purchases, inventory transfer, and returns (also called refunds).
\nNOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:
\nCreate a refund for a MultiDocument transaction.
\nA traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can\ninvolve a marketplace of vendors, each of which contributes some portion of the final transaction. Within\na MultiDocument transaction, each individual buyer and seller pair are matched up and converted to a separate\ndocument. This separation of documents allows each seller to file their taxes separately.
\nThe RefundTransaction API allows you to quickly and easily create a ReturnInvoice representing a refund\nfor a previously created SalesInvoice transaction. You can choose to create a full or partial refund, and\nspecify individual line items from the original sale for refund.
The RefundTransaction API ensures that the tax amount you refund to the customer exactly matches the tax that\nwas calculated during the original transaction, regardless of any changes to your company's configuration, rules,\nnexus, or any other setting.
This API is intended to be a shortcut to allow you to quickly and accurately generate a refund for the following\ncommon refund scenarios:
\nFor more complex scenarios than the ones above, please use CreateTransaction with document type ReturnInvoice to\ncreate a custom refund transaction.
You may specify one or more of the following values in the $include parameter to fetch additional nested data, using commas to separate multiple values:
If you omit the $include parameter, the API will assume you want Summary,Addresses.
NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:
\nVoids the current transaction uniquely identified by this URL.
\nA transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\nsales, purchases, inventory transfer, and returns (also called refunds).
\nWhen you void a transaction, that transaction's status is recorded as DocVoided.
Transactions that have been previously reported to a tax authority by Avalara Managed Returns Service are considered locked,\nand they are no longer available to be voided.
NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:
\nGet the unique MultiDocument transaction identified by this URL.
\nA traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can\ninvolve a marketplace of vendors, each of which contributes some portion of the final transaction. Within\na MultiDocument transaction, each individual buyer and seller pair are matched up and converted to a separate\ndocument. This separation of documents allows each seller to file their taxes separately.
\nThis endpoint retrieves the exact transaction identified by this ID number even if that transaction was later adjusted\nby using the AdjustTransaction endpoint.
A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\nsales, purchases, inventory transfer, and returns (also called refunds).
\nYou may specify one or more of the following values in the $include parameter to fetch additional nested data, using commas to separate multiple values:
NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:
\nMarks a list of transactions by changing its status to Committed.
Transactions that are committed are available to be reported to a tax authority by Avalara Managed Returns.
\nA transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\nsales, purchases, inventory transfer, and returns (also called refunds).
\nAny changes made to a committed transaction will generate a transaction history.
\nNOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:
\nVerifies that the MultiDocument transaction uniquely identified by this URL matches certain expected values.
\nIf the transaction does not match these expected values, this API will return an error code indicating which value did not match.
\nA transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\nsales, purchases, inventory transfer, and returns (also called refunds).
\nNOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:
\nList all nexus objects defined for this company.
\nThe concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional\ntaxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your\naccountant or lawyer prior to declaring nexus.
\nSearch for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby parameters.\nYou may specify one or more of the following values in the '$include' parameter to fetch additional nested data, using commas to separate multiple values:
Creates one or more new nexus declarations attached to this company.
\nThe concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional\ntaxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your\naccountant or lawyer prior to declaring nexus.
\nTo create a nexus declaration for your company, you must first call the Definitions API ListNexus to obtain a\nlist of Avalara-defined nexus. Once you have determined which nexus you wish to declare, you should customize\nonly the user-selectable fields in this object.
The user selectable fields for the nexus object are companyId, effectiveDate, endDate, localNexusTypeId,\ntaxId, nexusTypeId, hasPermanentEstablishment, and isSellerImporterOfRecord.
When calling CreateNexus or UpdateNexus, all values in your nexus object except for the user-selectable fields\nmust match an Avalara-defined system nexus object. You can retrieve a list of Avalara-defined system nexus objects\nby calling ListNexus. If any data does not match, AvaTax may not recognize your nexus declaration.
Please note that nexus changes may not take effect immediately and you should plan to update your nexus settings in advance\nof calculating tax for a location.
\nGet the nexus object identified by this URL.
\nThe concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional\ntaxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your\naccountant or lawyer prior to declaring nexus.\nYou may specify one or more of the following values in the '$include' parameter to fetch additional nested data, using commas to separate multiple values:
\nReplace the existing nexus declaration object at this URL with an updated object.
\nThe concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional\ntaxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your\naccountant or lawyer prior to declaring nexus.
\nTo create a nexus declaration for your company, you must first call the Definitions API ListNexus to obtain a\nlist of Avalara-defined nexus. Once you have determined which nexus you wish to declare, you should customize\nonly the user-selectable fields in this object.
The user selectable fields for the nexus object are companyId, effectiveDate, endDate, localNexusTypeId,\ntaxId, nexusTypeId, hasPermanentEstablishment, and isSellerImporterOfRecord.
When calling CreateNexus or UpdateNexus, all values in your nexus object except for the user-selectable fields\nmust match an Avalara-defined system nexus object. You can retrieve a list of Avalara-defined system nexus objects\nby calling ListNexus. If any data does not match, AvaTax may not recognize your nexus declaration.
Please note that nexus changes may not take effect immediately and you should plan to update your nexus settings in advance\nof calculating tax for a location.
\nMarks the existing nexus object at this URL as deleted.
\nThe concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional\ntaxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your\naccountant or lawyer prior to declaring nexus.
\nPlease note that nexus changes may not take effect immediately and you should plan to update your nexus settings in advance\nof calculating tax for a location.
\nAdd parameters to the nexus.\nSome tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called \"parameters\".
\nA parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus.
\nA parameter specified on a transaction line will override an nexus parameter if they share the same parameter name.
\nTo see available parameters for this item, call /api/v2/definitions/parameters?$filter=attributeType eq Nexus
Some parameters are only available for use if you have subscribed to specific AvaTax services. To see which parameters you are able to use, add the query parameter \"$showSubscribed=true\" to the parameter definition call above.
\nList parameters for a nexus.\nSome tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called \"parameters\".
\nA parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus.
\nA parameter specified on a transaction line will override an nexus parameter if they share the same parameter name.
\nSearch for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby parameters.
Delete all the parameters for a given nexus.\nSome tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called \"parameters\".
\nA parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus.
\nA parameter specified on a transaction line will override an nexus parameter if they share the same parameter name.
\nRetrieve a single nexus parameter.\nSome tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller.In AvaTax, these tax-affecting properties are called \"parameters\".
\nA parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus.
\nA parameter specified on a transaction line will override an nexus parameter if they share the same parameter name.
\nUpdate an nexus parameter.
\nSome tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called \"parameters\".
\nA parameter added to a nexus will be used in tax calculation based on the locationcode and parameter value the transaction state line might have lines added.
\nA parameter specified on a transaction line will override an item parameter if they share the same parameter name.????? I dont know about this?
\nDelete a single nexus parameter.\nSome tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called \"parameters\".
\nA parameter added to an nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus.
\nA parameter specified on a transaction line will override an nexus parameter if they share the same parameter name.
\nThis call is intended to simplify adding all applicable nexus to a company, for an address or addresses. Calling this\nAPI declares nexus for this company, for the list of addresses provided,\nfor the date range provided. You may also use this API to extend effective date on an already-declared nexus.
\nThe concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional\ntaxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your\naccountant or lawyer prior to declaring nexus.
\nNote that not all fields within a nexus can be updated; Avalara publishes a list of all defined nexus at the\n'/api/v2/definitions/nexus' endpoint.
\nYou may only define nexus matching the official list of declared nexus.
\nPlease note that nexus changes may not take effect immediately and you should plan to update your nexus settings in advance\nof calculating tax for a location.
\nRetrieves a list of nexus related to a tax form.
\nThe concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional\ntaxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your\naccountant or lawyer prior to declaring nexus.
\nThis API is intended to provide useful information when examining a tax form. If you are about to begin filing\na tax form, you may want to know whether you have declared nexus in all the jurisdictions related to that tax\nform in order to better understand how the form will be filled out.\nYou may specify one or more of the following values in the '$include' parameter to fetch additional nested data, using commas to separate multiple values:
\nProvides a summary of nexus information useful for quickly displaying key information.
\nThe concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional\ntaxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your\naccountant or lawyer prior to declaring nexus.
\nThis API produces only basic information about your company's nexus declarations. For example, it will show\nthe number of nexus declarations of each tax type. To request more information about your company's nexus\ndeclarations, please use QueryNexus or ListNexusByCompany.
Get multiple nexus objects across all companies.
\nThe concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional\ntaxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your\naccountant or lawyer prior to declaring nexus.
\nSearch for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby parameters.\nYou may specify one or more of the following values in the '$include' parameter to fetch additional nested data, using commas to separate multiple values:
This API is available by invitation only.\nList all tax notice objects assigned to this company.\nA 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara\nReturns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
\nSearch for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby parameters.
This API is available by invitation only.\nCreate one or more new notice objects.\nA 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara\nReturns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
\nThis API is available by invitation only.\nGet the tax notice object identified by this URL.\nA 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara\nReturns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
\nThis API is available by invitation only.\nReplace the existing notice object at this URL with an updated object.\nA 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara\nReturns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.\nAll data from the existing object will be replaced with data in the object you PUT.\nTo set a field's value to null, you may either set its value to null or omit that field from the object you post.
\nThis API is available by invitation only.\nMark the existing notice object at this URL as deleted.\nA 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara\nReturns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
\nThis API is available by invitation only.\n'Notice comments' are updates by the notice team on the work to be done and that has been done so far on a notice.\nA 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara\nReturns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
\nThis API is available by invitation only.\n'Notice comments' are updates by the notice team on the work to be done and that has been done so far on a notice.\nA 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara\nReturns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
\nThis API is available by invitation only.\n'Notice comments' are updates by the notice team on the work to be done and that has been done so far on a notice.\nA 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara\nReturns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
\nThis API is available by invitation only.\n'Notice finance details' is the categorical breakdown of the total charge levied by the tax authority on our customer,\nas broken down in our \"notice log\" found in Workflow. Main examples of the categories are 'Tax Due', 'Interest', 'Penalty', 'Total Abated'.\nA 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara\nReturns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
\nThis API is available by invitation only.\n'Notice finance details' is the categorical breakdown of the total charge levied by the tax authority on our customer,\nas broken down in our \"notice log\" found in Workflow. Main examples of the categories are 'Tax Due', 'Interest', 'Penalty', 'Total Abated'.\nA 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara\nReturns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
\nThis API is available by invitation only.\n'Notice finance details' is the categorical breakdown of the total charge levied by the tax authority on our customer,\nas broken down in our \"notice log\" found in Workflow. Main examples of the categories are 'Tax Due', 'Interest', 'Penalty', 'Total Abated'.\nA 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara\nReturns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
\nThis API is available by invitation only.\n'Notice responsibilities' are are those who are responsible for the notice.\nA 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara\nReturns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
\nThis API is available by invitation only.\n'Notice comments' are updates by the notice team on the work to be done and that has been done so far on a notice.\nA 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara\nReturns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
\nThis API is available by invitation only.\n'Notice root causes' are are those who are responsible for the notice.\nA 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara\nReturns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
\nThis API is available by invitation only.\n'Notice root causes' are are those who are responsible for the notice.\nA 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara\nReturns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
\nThis API is available by invitation only.\nAll data from the existing object will be replaced with data in the object you PUT.\nTo set a field's value to null, you may either set its value to null or omit that field from the object you post.
\nThis API is available by invitation only.\nAll data from the existing object will be replaced with data in the object you PUT.\nTo set a field's value to null, you may either set its value to null or omit that field from the object you post.
\nThis API is available by invitation only.\nMark the existing notice object at this URL as deleted.\nA 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara\nReturns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
\nThis API is available by invitation only.\nMark the existing notice object at this URL as deleted.\nA 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara\nReturns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
\nThis API is available by invitation only.\nGet the file attachment identified by this URL.
\nThis API is available by invitation only.
\nUploads a file attachment for a tax notice.
\nThis API is available by invitation only.
\nThis API is deprecated - please use POST /api/v2/notices/query API.
Get multiple notice objects across all companies.\nA 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara\nReturns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
\nSearch for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby parameters.
This API is available by invitation only.
\nThis API is intended to replace the GET /api/v2/notices API. The fetch request object is posted on the body of the request instead of the URI, so it's not limited by a set number of characters.\nThe documentation of the GET API shows how filtering, sorting and pagination works.
List all notifications.
\nA notification is a message from Avalara that may have relevance to your business. You may want\nto regularly review notifications and then dismiss them when you are certain that you have addressed\nany relevant concerns raised by this notification.
\nAn example of a notification would be a message about new software, or a change to AvaTax that may\naffect you, or a potential issue with your company's tax profile.
\nYou may search for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby parameters.
This API is available by invitation only.
\nCreate a single notification.
\nA notification is a message from Avalara that may have relevance to your business. You may want\nto regularly review notifications and then dismiss them when you are certain that you have addressed\nany relevant concerns raised by this notification.
\nA Global notification is a message which is directed to all the accounts and is set to expire within\na certain time and cannot be dismissed by the user. Make accountId and companyId null to create a global notification.
\nAn example of a notification would be a message about new software, or a change to AvaTax that may\naffect you, or a potential issue with your company's tax profile.
\nRetrieve a single notification by its unique ID number.
\nA notification is a message from Avalara that may have relevance to your business. You may want\nto regularly review notifications and then dismiss them when you are certain that you have addressed\nany relevant concerns raised by this notification.
\nAn example of a notification would be a message about new software, or a change to AvaTax that may\naffect you, or a potential issue with your company's tax profile.
\nThis API is available by invitation only.
\nReplaces the notification identified by this URL with a new notification.
\nA notification is a message from Avalara that may have relevance to your business. You may want\nto regularly review notifications and then dismiss them when you are certain that you have addressed\nany relevant concerns raised by this notification.
\nAn example of a notification would be a message about new software, or a change to AvaTax that may\naffect you, or a potential issue with your company's tax profile.
\nThis API is available by invitation only.
\nDelete the existing notification identified by this URL.
\nA notification is a message from Avalara that may have relevance to your business. You may want\nto regularly review notifications and then dismiss them when you are certain that you have addressed\nany relevant concerns raised by this notification.
\nAn example of a notification would be a message about new software, or a change to AvaTax that may\naffect you, or a potential issue with your company's tax profile.
\nMarks the notification identified by this URL as dismissed.
\nA notification is a message from Avalara that may have relevance to your business. You may want\nto regularly review notifications and then dismiss them when you are certain that you have addressed\nany relevant concerns raised by this notification.
\nAn example of a notification would be a message about new software, or a change to AvaTax that may\naffect you, or a potential issue with your company's tax profile.
\nWhen you dismiss a notification, the notification will track the user and time when it was\ndismissed. You can then later review which employees of your company dismissed notifications to\ndetermine if they were resolved appropriately.
\nA Global notification with null accountId and companyId cannot be dismissed and will expire within a given time span.
\nThis API is for use by partner provisioning services customers only. This will allow the partners to allow\nthe add new entitlement to an existing customer
\nThis API is for use by partner provisioning services customers only.
\nAvalara invites select partners to refer new customers to the AvaTax service using the onboarding features\nof AvaTax. These partners can create accounts for new customers using this API.
\nCalling this API creates an account with the specified product subscriptions, but does not configure billing.\nThe customer will receive information from Avalara about how to configure billing for their account.\nYou should call this API when a customer has requested to begin using Avalara services.
\nIf the newly created account owner wishes, they can confirm that they have read and agree to the Avalara\nterms and conditions. If they do so, they can receive a license key as part of this API and their\nAPI will be created in Active status. If the customer has not yet read and accepted these terms and\nconditions, the account will be created in New status and they can receive a license key by logging\nonto the AvaTax website and reviewing terms and conditions online.
This API is for use by Avalara Registrar administrative users only.
\nThis API is for use by Avalara Registrar administrative users only.
\nAllows a system admin to reset the password for a specific user via the API.\nThis API is only available for Avalara Registrar Admins, and can be used to reset the password of any\nuser based on internal Avalara business processes.
\nBegins running an ExportDocumentLine report task and returns the identity of the report.
Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download\nfor up to 30 days after completion. To run an asynchronous report, you should follow these steps:
\nid value.GetReport and passing in the report's id value.Completed, call DownloadReport to retrieve the file.The ExportDocumentLine report produces information about invoice lines recorded within your account.
List all report tasks for your account.
\nReports are run as asynchronous report tasks on the server. When complete, the report file will be available for download\nfor up to 30 days after completion. To run an asynchronous report, you should follow these steps:
\nid value.GetReport and passing in the report's id value.Completed, call DownloadReport to retrieve the file.This API call returns information about all report types across your entire account.
\nRetrieve a single report by its unique ID number.
\nReports are run as asynchronous report tasks on the server. When complete, the report file will be available for download\nfor up to 30 days after completion. To run an asynchronous report, you should follow these steps:
\nid value.GetReport and passing in the report's id value.Completed, call DownloadReport to retrieve the file.This API call returns information about any report type.
\n","urlObject":{"protocol":"https","path":["api","v2","reports","{id}"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a3dccd32-a9b9-4e32-ba68-f39b4f60ab6f"},{"name":"Download a report","id":"359e478f-88e1-4481-ab58-8681d31a9daa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/reports/{id}/attachment","description":"This API downloads the file associated with a report.
\nIf the report is not yet complete, you will receive a ReportNotFinished error. To check if a report is complete,\nuse the GetReport API.
Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download\nfor up to 30 days after completion. To run an asynchronous report, you should follow these steps:
\nid value.GetReport and passing in the report's id value.Completed, call DownloadReport to retrieve the file.This API works for all report types.
\nList all setting objects attached to this company.
\nThe company settings system is a metadata system that you can use to store extra information\nabout a company. Your integration or connector could use this data storage to keep track of\npreference information, reminders, or any other storage that would need to persist even if\nthe customer uninstalls your application.
\nA setting can refer to any type of data you need to remember about this company object.\nWhen creating this object, you may define your own set, name, and value parameters.\nTo define your own values, please choose a set name that begins with X- to indicate an extension.
Search for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby parameters.
Create one or more new setting objects attached to this company.
\nThe company settings system is a metadata system that you can use to store extra information\nabout a company. Your integration or connector could use this data storage to keep track of\npreference information, reminders, or any other storage that would need to persist even if\nthe customer uninstalls your application.
\nA setting can refer to any type of data you need to remember about this company object.\nWhen creating this object, you may define your own set, name, and value parameters.\nTo define your own values, please choose a set name that begins with X- to indicate an extension.
Get a single setting object by its unique ID.
\nThe company settings system is a metadata system that you can use to store extra information\nabout a company. Your integration or connector could use this data storage to keep track of\npreference information, reminders, or any other storage that would need to persist even if\nthe customer uninstalls your application.
\nA setting can refer to any type of data you need to remember about this company object.\nWhen creating this object, you may define your own set, name, and value parameters.\nTo define your own values, please choose a set name that begins with X- to indicate an extension.
Replace the existing setting object at this URL with an updated object.
\nThe company settings system is a metadata system that you can use to store extra information\nabout a company. Your integration or connector could use this data storage to keep track of\npreference information, reminders, or any other storage that would need to persist even if\nthe customer uninstalls your application.
\nA setting can refer to any type of data you need to remember about this company object.\nWhen creating this object, you may define your own set, name, and value parameters.\nTo define your own values, please choose a set name that begins with X- to indicate an extension.
All data from the existing object will be replaced with data in the object you PUT.
To set a field's value to null, you may either set its value to null or omit that field from the object when calling update.
Mark the setting object at this URL as deleted.
\nThe company settings system is a metadata system that you can use to store extra information\nabout a company. Your integration or connector could use this data storage to keep track of\npreference information, reminders, or any other storage that would need to persist even if\nthe customer uninstalls your application.
\nA setting can refer to any type of data you need to remember about this company object.\nWhen creating this object, you may define your own set, name, and value parameters.\nTo define your own values, please choose a set name that begins with X- to indicate an extension.
Get multiple setting objects across all companies.
\nThe company settings system is a metadata system that you can use to store extra information\nabout a company. Your integration or connector could use this data storage to keep track of\npreference information, reminders, or any other storage that would need to persist even if\nthe customer uninstalls your application.
\nA setting can refer to any type of data you need to remember about this company object.\nWhen creating this object, you may define your own set, name, and value parameters.\nTo define your own values, please choose a set name that begins with X- to indicate an extension.
Search for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby parameters.
List all subscription objects attached to this account.\nA 'subscription' indicates a licensed subscription to a named Avalara service.\nTo request or remove subscriptions, please contact Avalara sales or your customer account manager.
\nSearch for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby parameters.
This API is for use by Avalara Registrar administrative users only.
\nCreate one or more new subscription objects attached to this account.\nA 'subscription' indicates a licensed subscription to a named Avalara service.\nTo request or remove subscriptions, please contact Avalara sales or your customer account manager.
\nGet the subscription object identified by this URL.\nA 'subscription' indicates a licensed subscription to a named Avalara service.\nTo request or remove subscriptions, please contact Avalara sales or your customer account manager.
\nThis API is for use by Avalara Registrar administrative users only.
\nReplace the existing subscription object at this URL with an updated object.\nA 'subscription' indicates a licensed subscription to a named Avalara service.\nTo request or remove subscriptions, please contact Avalara sales or your customer account manager.\nAll data from the existing object will be replaced with data in the object you PUT.\nTo set a field's value to null, you may either set its value to null or omit that field from the object you post.
\nThis API is for use by Avalara Registrar administrative users only.
\nMark the existing account identified by this URL as deleted.
\nGet multiple subscription objects across all accounts.\nA 'subscription' indicates a licensed subscription to a named Avalara service.\nTo request or remove subscriptions, please contact Avalara sales or your customer account manager.
\nSearch for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby parameters.
List all taxcode objects attached to this company.\nA 'TaxCode' represents a uniquely identified type of product, good, or service.\nAvalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.\nIf you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and\ntaxability rules for this product in all supported jurisdictions.
\nSearch for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby parameters.
Create one or more new taxcode objects attached to this company.\nA 'TaxCode' represents a uniquely identified type of product, good, or service.\nAvalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.\nIf you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and\ntaxability rules for this product in all supported jurisdictions.
\nGet the taxcode object identified by this URL.\nA 'TaxCode' represents a uniquely identified type of product, good, or service.\nAvalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.\nIf you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and\ntaxability rules for this product in all supported jurisdictions.
\nReplace the existing taxcode object at this URL with an updated object.\nA 'TaxCode' represents a uniquely identified type of product, good, or service.\nAvalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.\nIf you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and\ntaxability rules for this product in all supported jurisdictions.\nAll data from the existing object will be replaced with data in the object you PUT.\nTo set a field's value to null, you may either set its value to null or omit that field from the object you post.
\nMarks the existing TaxCode object at this URL as deleted.
\nGet multiple taxcode objects across all companies.\nA 'TaxCode' represents a uniquely identified type of product, good, or service.\nAvalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.\nIf you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and\ntaxability rules for this product in all supported jurisdictions.
\nSearch for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby parameters.
Builds a tax content file containing information useful for a retail point-of-sale solution.
\nSince tax rates may change based on decisions made by a variety of tax authorities, we recommend\nthat users of this tax content API download new data every day. Many tax authorities may finalize\ndecisions on tax changes at unexpected times and may make changes in response to legal issues or\ngovernmental priorities. Any tax content downloaded for future time periods is subject to change\nif tax rates or tax laws change.
\nA TaxContent file contains a matrix of the taxes that would be charged when you sell any of your\nItems at any of your Locations. To create items, use CreateItems(). To create locations, use\nCreateLocations(). The file is built by looking up the tax profile for your location and your\nitem and calculating taxes for each in turn. To include a custom TaxCode in this tax content\nfile, first create the custom tax code using CreateTaxCodes() to create the custom tax code,\nthen use CreateItems() to create an item that uses the custom tax code.
This data file can be customized for specific partner devices and usage conditions.
\nThe result of this API is the file you requested in the format you requested using the responseType field.
This API builds the file on demand, and is limited to files with no more than 7500 scenarios. To build a tax content\nfile for a multiple locations in a single file, please use BuildTaxContentFile.
NOTE: This API does not work for Tennessee tax holiday scenarios.
\nBuilds a tax content file containing information useful for a retail point-of-sale solution.
\nSince tax rates may change based on decisions made by a variety of tax authorities, we recommend\nthat users of this tax content API download new data every day. Many tax authorities may finalize\ndecisions on tax changes at unexpected times and may make changes in response to legal issues or\ngovernmental priorities. Any tax content downloaded for future time periods is subject to change\nif tax rates or tax laws change.
\nA TaxContent file contains a matrix of the taxes that would be charged when you sell any of your\nItems at any of your Locations. To create items, use CreateItems(). To create locations, use\nCreateLocations(). The file is built by looking up the tax profile for your location and your\nitem and calculating taxes for each in turn. To include a custom TaxCode in this tax content\nfile, first create the custom tax code using CreateTaxCodes() to create the custom tax code,\nthen use CreateItems() to create an item that uses the custom tax code.
This data file can be customized for specific partner devices and usage conditions.
\nThe result of this API is the file you requested in the format you requested using the responseType field.
This API builds the file on demand, and is limited to files with no more than 7500 scenarios. To build a tax content\nfile for a single location at a time, please use BuildTaxContentFileForLocation.
NOTE: This API does not work for Tennessee tax holiday scenarios.
\nThis API is available by invitation only.
\nThis API is available by invitation only.
\nDownload a CSV file containing all five digit postal codes in the United States and their sales\nand use tax rates for tangible personal property.
\nSince tax rates may change based on decisions made by a variety of tax authorities, we recommend\nthat users of this tax content API download new data every day. Many tax authorities may finalize\ndecisions on tax changes at unexpected times and may make changes in response to legal issues or\ngovernmental priorities. Any tax content downloaded for future time periods is subject to change\nif tax rates or tax laws change.
\nThis rates file is intended to be used as a default for tax calculation when your software cannot\ncall the CreateTransaction API call. When using this file, your software will be unable to\nhandle complex tax rules such as:
If you use this file to provide default tax rates, please ensure that your software calls CreateTransaction\nto reconcile the actual transaction and determine the difference between the estimated general tax\nrate and the final transaction tax.
The file provided by this API is in CSV format with the following columns:
\nFor more detailed tax content, please use the BuildTaxContentFile API which allows usage of exact items and exact locations.
Exports the tax profile of a company to a file, containing all information that affects tax calculation for this company.
\nA tax profile is a series of decisions and configuration choices that affect your company's tax calculation. These decisions\ninclude your nexus declarations, your item catalog, your custom tax rules, and so on.
\nThis API can be used to export a complete zip file containing your company's current tax profile, and you can then restore this\nprofile to a different company or compare it over time to see if your profile has been changed.
\nImports a tax profile to a new company, along with the option to import account settings.
\nList all taxrule objects attached to this company.
\nA tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules\ncan be used to change the taxability of an item, to change the tax base of an item, or to change the tax rate\ncharged when selling an item. Tax rules can also change tax behavior depending on the entityUseCode value submitted\nwith the transaction.
You can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your\nbusiness. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use\ncustom tax rules to redefine the behavior for your company or item.
\nPlease use custom tax rules carefully and ensure that these tax rules match the behavior agreed upon with your\nauditor, legal representative, and accounting team.
\nSearch for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby parameters.
Create one or more custom tax rules attached to this company.
\nA tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules\ncan be used to change the taxability of an item, to change the tax base of an item, or to change the tax rate\ncharged when selling an item. Tax rules can also change tax behavior depending on the entityUseCode value submitted\nwith the transaction.
You can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your\nbusiness. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use\ncustom tax rules to redefine the behavior for your company or item.
\nPlease use custom tax rules carefully and ensure that these tax rules match the behavior agreed upon with your\nauditor, legal representative, and accounting team.
\nGet the taxrule object identified by this URL.
\nA tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules\ncan be used to change the taxability of an item, to change the tax base of an item, or to change the tax rate\ncharged when selling an item. Tax rules can also change tax behavior depending on the entityUseCode value submitted\nwith the transaction.
You can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your\nbusiness. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use\ncustom tax rules to redefine the behavior for your company or item.
\nPlease use custom tax rules carefully and ensure that these tax rules match the behavior agreed upon with your\nauditor, legal representative, and accounting team.
\nReplace the existing custom tax rule object at this URL with an updated object.
\nA tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules\ncan be used to change the taxability of an item, to change the tax base of an item, or to change the tax rate\ncharged when selling an item. Tax rules can also change tax behavior depending on the entityUseCode value submitted\nwith the transaction.
You can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your\nbusiness. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use\ncustom tax rules to redefine the behavior for your company or item.
\nPlease use custom tax rules carefully and ensure that these tax rules match the behavior agreed upon with your\nauditor, legal representative, and accounting team.
\nMark the custom tax rule identified by this URL as deleted.
\nA tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules\ncan be used to change the taxability of an item, to change the tax base of an item, or to change the tax rate\ncharged when selling an item. Tax rules can also change tax behavior depending on the entityUseCode value submitted\nwith the transaction.
You can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your\nbusiness. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use\ncustom tax rules to redefine the behavior for your company or item.
\nPlease use custom tax rules carefully and ensure that these tax rules match the behavior agreed upon with your\nauditor, legal representative, and accounting team.
\nGet multiple taxrule objects across all companies.
\nA tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules\ncan be used to change the taxability of an item, to change the tax base of an item, or to change the tax rate\ncharged when selling an item. Tax rules can also change tax behavior depending on the entityUseCode value submitted\nwith the transaction.
You can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your\nbusiness. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use\ncustom tax rules to redefine the behavior for your company or item.
\nPlease use custom tax rules carefully and ensure that these tax rules match the behavior agreed upon with your\nauditor, legal representative, and accounting team.
\nSearch for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby parameters.
List all transactions attached to this company.
\nThis endpoint is limited to returning 1,000 transactions at a time maximum.
\nWhen listing transactions, you must specify a date range filter. If you do not specify a $filter that includes a date field\ncriteria, the query will default to looking at only those transactions with date in the past 30 days.
A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\nsales, purchases, inventory transfer, and returns (also called refunds).
\nSearch for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby parameters.
You may specify one or more of the following values in the $include parameter to fetch additional nested data, using commas to separate multiple values:
NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:
\nGet the current transaction identified by this company code, transaction code, and document type.
\nA transaction is uniquely identified by companyCode, code (often called Transaction Code), and documentType.
For compatibility purposes, when this API finds multiple transactions with the same transaction code, and if you have not specified\nthe type parameter to this API, it will default to selecting the SalesInvoices transaction. To change this behavior, use the\noptional documentType parameter to specify the specific document type you wish to find.
If this transaction was adjusted, the return value of this API will be the current transaction with this code.
\nYou may specify one or more of the following values in the $include parameter to fetch additional nested data, using commas to separate multiple values:
NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:
\nReplaces the current transaction uniquely identified by this URL with a new transaction.
\nA transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\nsales, purchases, inventory transfer, and returns (also called refunds).
\nWhen you adjust a committed transaction, the original transaction will be updated with the status code Adjusted, and\nboth revisions will be available for retrieval based on their code and ID numbers.\nOnly transactions in Committed status are reported by Avalara Managed Returns.
Transactions that have been previously reported to a tax authority by Avalara Managed Returns are considered locked and are\nno longer available for adjustments.
You may specify one or more of the following values in the $include parameter to fetch additional nested data, using commas to separate multiple values:
NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:
\nRetrieve audit information about a transaction stored in AvaTax.
\nThe AuditTransaction API retrieves audit information related to a specific transaction. This audit\ninformation includes the following:
CompanyId of the company that created the transactionThis API can be used to examine information about a previously created transaction.
\nA transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\nsales, purchases, inventory transfer, and returns (also called refunds).
\nNOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:
\nRenames a transaction uniquely identified by this URL by changing its code value.
This API is available as long as the transaction is in saved or posted status. When a transaction\nis committed, it can be modified by using the AdjustTransaction method.
After this API call succeeds, the transaction will have a new URL matching its new code.
If you have more than one document with the same code, specify the documentType parameter to choose between them.
A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\nsales, purchases, inventory transfer, and returns (also called refunds).
\nYou may specify one or more of the following values in the $include parameter to fetch additional nested data, using commas to separate multiple values:
NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:
\nMarks a transaction by changing its status to Committed.
Transactions that are committed are available to be reported to a tax authority by Avalara Managed Returns.
\nA transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\nsales, purchases, inventory transfer, and returns (also called refunds).
\nIf you have more than one document with the same code, specify the documentType parameter to choose between them.
Any changes made to a committed transaction will generate a transaction history.
\nYou may specify one or more of the following values in the $include parameter to fetch additional nested data, using commas to separate multiple values:
NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:
\nInspects a transaction line and presents the result with a human-readable text providing the reasoning behind\ndetermination like nexus, exemption, product taxability etc.
\nNOTE: In order to avoid ambiguity, DocumentType of 'Any' is invalid for this API as this API is designed to look for a specific line of a given document.
\nNOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:
\nLock a transaction uniquely identified by this URL.
\nThis API is mainly used for connector developer to simulate what happens when Returns product locks a document.\nAfter this API call succeeds, the document will be locked and can't be voided or adjusted.
\nThis API is only available to customers in Sandbox with AvaTaxPro subscription. On production servers, this API is available by invitation only.
\nIf you have more than one document with the same code, specify the documentType parameter to choose between them.
A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\nsales, purchases, inventory transfer, and returns (also called refunds).
\nYou may specify one or more of the following values in the $include parameter to fetch additional nested data, using commas to separate multiple values:
NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:
\nCreate a refund for a transaction.
\nThe RefundTransaction API allows you to quickly and easily create a ReturnInvoice representing a refund\nfor a previously created SalesInvoice transaction. You can choose to create a full or partial refund, and\nspecify individual line items from the original sale for refund.
The RefundTransaction API ensures that the tax amount you refund to the customer exactly matches the tax that\nwas calculated during the original transaction, regardless of any changes to your company's configuration, rules,\nnexus, or any other setting.
This API is intended to be a shortcut to allow you to quickly and accurately generate a refund for the following\ncommon refund scenarios:
\nFor more complex scenarios than the ones above, please use CreateTransaction with document type ReturnInvoice to\ncreate a custom refund transaction.
You may specify one or more of the following values in the $include parameter to fetch additional nested data, using commas to separate multiple values:
$include parameter, the API will assume you want Summary,Addresses.NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:
\nPerforms one or more actions against the current transaction uniquely identified by this URL.
\nThe SettleTransaction API call can perform the work of ChangeCode, VerifyTransaction, and CommitTransaction.
A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\nsales, purchases, inventory transfer, and returns (also called refunds).
\nIf you have more than one document with the same code, specify the documentType parameter to choose between them.
This API is available for users who want to execute more than one action at a time.
\nYou may specify one or more of the following values in the $include parameter to fetch additional nested data, using commas to separate multiple values:
NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:
\nDEPRECATED: Please use the GetTransactionByCode API instead.
NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:
\nRetrieve audit information about a transaction stored in AvaTax.
\nThe AuditTransaction API retrieves audit information related to a specific transaction. This audit\ninformation includes the following:
CompanyId of the company that created the transactionThis API can be used to examine information about a previously created transaction.
\nA transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\nsales, purchases, inventory transfer, and returns (also called refunds).
\nNOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:
\nAdjusts a transaction by changing it to an uncommitted status.
\nTransactions that have been previously reported to a tax authority by Avalara Managed Returns are considered locked and are\nno longer available to be uncommitted.
You may specify one or more of the following values in the $include parameter to fetch additional nested data, using commas to separate multiple values:
NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:
\nUnvoids a voided transaction
\nYou may specify one or more of the following values in the $include parameter to fetch additional nested data, using commas to separate multiple values:
NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:
\nVerifies that the transaction uniquely identified by this URL matches certain expected values.
\nIf the transaction does not match these expected values, this API will return an error code indicating which value did not match.
\nIf you have more than one document with the same code, specify the documentType parameter to choose between them.
A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\nsales, purchases, inventory transfer, and returns (also called refunds).
\nYou may specify one or more of the following values in the $include parameter to fetch additional nested data, using commas to separate multiple values:
NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:
\nVoids the current transaction uniquely identified by this URL.
\nA transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\nsales, purchases, inventory transfer, and returns (also called refunds).
\nWhen you void a transaction, that transaction's status is recorded as DocVoided.
If you have more than one document with the same code, specify the documentType parameter to choose between them.
Transactions that have been previously reported to a tax authority by Avalara Managed Returns are no longer available to be voided.
\nYou may specify one or more of the following values in the $include parameter to fetch additional nested data, using commas to separate multiple values:
NOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:
\nAdd lines to an existing unlocked transaction.
\n The AddLines API allows you to add additional transaction lines to existing transaction, so that customer will\n be able to append multiple calls together and form an extremely large transaction. If customer does not specify line number\n in the lines to be added, a new random Guid string will be generated for line number. If customer are not satisfied with\n the line number for the transaction lines, they can turn on the renumber switch to have REST v2 automatically renumber all\n transaction lines for them, in this case, the line number becomes: \"1\", \"2\", \"3\", ...
A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\n sales, purchases, inventory transfer, and returns (also called refunds).\n You may specify one or more of the following values in the $include parameter to fetch additional nested data, using commas to separate multiple values:
If you omit the $include parameter, the API will assume you want Summary,Addresses.
Remove lines to an existing unlocked transaction.
\n The DeleteLines API allows you to remove transaction lines from existing unlocked transaction, so that customer will\n be able to delete transaction lines and adjust original transaction the way they like
A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\n sales, purchases, inventory transfer, and returns (also called refunds).\n You may specify one or more of the following values in the $include parameter to fetch additional nested data, using commas to separate multiple values:
If you omit the $include parameter, the API will assume you want Summary,Addresses.
Get the unique transaction identified by this URL.
\nThis endpoint retrieves the exact transaction identified by this ID number even if that transaction was later adjusted\nby using the AdjustTransaction endpoint.
A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\nsales, purchases, inventory transfer, and returns (also called refunds).
\nYou may specify one or more of the following values in the $include parameter to fetch additional nested data, using commas to separate multiple values:
Records a new transaction in AvaTax.
\nA transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\nsales, purchases, inventory transfer, and returns (also called refunds).
\nThe CreateTransaction endpoint uses the tax profile of your company to identify the correct tax rules\nand rates to apply to all line items in this transaction. The end result will be the total tax calculated by AvaTax based on your\ncompany's configuration and the data provided in this API call.
The CreateTransaction API will report an error if a committed transaction already exists with the same code. To\navoid this error, use the CreateOrAdjustTransaction API - it will create the transaction if it does not exist, or\nupdate it if it does exist.
To generate a refund for a transaction, use the RefundTransaction API.
The field type identifies the kind of transaction - for example, a sale, purchase, or refund. If you do not specify\na type value, you will receive an estimate of type SalesOrder, which will not be recorded.
The origin and destination locations for a transaction must be identified by either address or geocode. For address-based transactions, please\nprovide addresses in the fields line, city, region, country and postalCode. For geocode-based transactions, please provide the geocode\ninformation in the fields latitude and longitude. If either latitude or longitude or both are null, the transaction will be calculated\nusing the best available address location information.
You may specify one or more of the following values in the $include parameter to fetch additional nested data, using commas to separate multiple values:
If you omit the $include parameter, the API will assume you want Summary,Addresses.
NOTE: Avoid using the following strings in your transaction codes as they are encoding strings and will be interpreted differently:
\nRecords a new transaction or adjust an existing transaction in AvaTax.
\nThe CreateOrAdjustTransaction endpoint is used to create a new transaction or update an existing one. This API\ncan help you create an idempotent service that creates transactions\nIf there exists a transaction identified by code, the original transaction will be adjusted by using the meta data\nin the input transaction.
The CreateOrAdjustTransaction API cannot modify any transaction that has been reported to a tax authority using\nthe Avalara Managed Returns Service or any other tax filing service. If you call this API to attempt to modify\na transaction that has been reported on a tax filing, you will receive the error CannotModifyLockedTransaction.
To generate a refund for a transaction, use the RefundTransaction API.
If you don't specify the field type in your request, you will get an estimate of type SalesOrder, which will not be recorded in the database.
A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\nsales, purchases, inventory transfer, and returns (also called refunds).\nYou may specify one or more of the following values in the $include parameter to fetch additional nested data, using commas to separate multiple values:
If you omit the $include parameter, the API will assume you want Summary,Addresses.
NOTE: Avoid using the following strings in your transaction codes as they are encoding strings and will be interpreted differently:
\nThis API is available by invitation only.
\nLock a set of transactions uniquely identified by DocumentIds provided. This API allows locking multiple documents at once.\nAfter this API call succeeds, documents will be locked and can't be voided.
\nA transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\nsales, purchases, inventory transfer, and returns (also called refunds).
\nList all UPC objects attached to this company.\nA UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC.
\nSearch for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby parameters.
Create one or more new UPC objects attached to this company.\nA UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC.
\nGet the UPC object identified by this URL.\nA UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC.
\nReplace the existing UPC object at this URL with an updated object.\nA UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC.\nAll data from the existing object will be replaced with data in the object you PUT.\nTo set a field's value to null, you may either set its value to null or omit that field from the object you post.
\nMarks the UPC object identified by this URL as deleted.
\nGet multiple UPC objects across all companies.\nA UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC.
\nSearch for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby parameters.
List all user objects attached to this account.\nA user represents one person with access privileges to make API calls and work with a specific account.
\nWhen an API is called using a legacy AvaTax License Key, the API log entry is recorded as being performed by a special user attached to that license key.\nBy default, this API will not return a listing of license key users. Users with registrar-level security may call this API to list license key users.
\nSearch for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby parameters.
You may specify one or more of the following values in the $include parameter to fetch additional nested data, using commas to separate multiple values:
Create one or more new user objects attached to this account.
\nA user represents one person with access privileges to make API calls and work with a specific account.
\nUsers who are account administrators or company users are permitted to create user records to invite\nadditional team members to work with AvaTax.
\nA newly created user will receive an email inviting them to create their password. This means that you\nmust provide a valid email address for all user accounts created.
\nGet the user object identified by this URL.\nA user represents one person with access privileges to make API calls and work with a specific account.
\n You may specify one or more of the following values in the $include parameter to fetch additional nested data, using commas to separate multiple values:
Replace the existing user object at this URL with an updated object.\nA user represents one person with access privileges to make API calls and work with a specific account.\nAll data from the existing object will be replaced with data in the object you PUT.\nTo set a field's value to null, you may either set its value to null or omit that field from the object you post.
\nMark the user object identified by this URL as deleted.
\nThis API is available for use by account and company administrators only.
\nAccount and company administrators may only delete users within the appropriate organizations\nthey control.
\nReturn a list of all entitlements to which this user has rights to access.\nEntitlements are a list of specified API calls the user is permitted to make, a list of identifier numbers for companies the user is\nallowed to use, and an access level identifier that indicates what types of access roles the user is allowed to use.\nThis API call is intended to provide a validation endpoint to determine, before making an API call, whether this call is likely to succeed.\nFor example, if user 567 within account 999 is attempting to create a new child company underneath company 12345, you could preview the user's\nentitlements and predict whether this call would succeed:
\nFor a full list of defined permissions, please use '/api/v2/definitions/permissions' .
\nAllows a user to change their password via an API call.
\nThis API allows an authenticated user to change their password via an API call. This feature is only available\nfor accounts that do not use SAML integrated password validation.
\nThis API only allows the currently authenticated user to change their password; it cannot be used to apply to a\ndifferent user than the one authenticating the current API call.
\nGet multiple user objects across all accounts.
\nA user represents one person or set of credentials with access privileges to make API calls and work with a specific account. A user can be authenticated\nvia either username / password authentication, an OpenID / OAuth Bearer Token, or a legacy AvaTax License Key.
\nWhen an API is called using a legacy AvaTax License Key, the API log entry is recorded as being performed by a special user attached to that license key.\nBy default, this API will not return a listing of license key users. Users with registrar-level security may call this API to list license key users.
\nSearch for specific objects using the criteria in the $filter parameter; full documentation is available on Filtering in REST .\nPaginate your results using the $top, $skip, and $orderby parameters.
You may specify one or more of the following values in the $include parameter to fetch additional nested data, using commas to separate multiple values:
Check connectivity to AvaTax and return information about the AvaTax API server.
\nThis API is intended to help you verify that your connection is working. This API will always succeed and will\nnever return a error. It provides basic information about the server you connect to:
\nversion - The version number of the AvaTax API server that responded to your request. The AvaTax API version number is updated once per month during Avalara's update process.authenticated - A boolean flag indicating whether or not you sent valid credentials with your API request.authenticationType - If you provided valid credentials to the API, this field will tell you whether you used Bearer, Username, or LicenseKey authentication.authenticatedUserName - If you provided valid credentials to the API, this field will tell you the username of the currently logged in user.authenticatedUserId - If you provided valid credentials to the API, this field will tell you the user ID of the currently logged in user.authenticatedAccountId - If you provided valid credentials to the API, this field will contain the account ID of the currently logged in user.This API helps diagnose connectivity problems between your application and AvaTax; you may call this API even\nif you do not have verified connection credentials. If this API fails, either your computer is not connected to\nthe internet, or there is a routing problem between your office and Avalara, or the Avalara server is not available.\nFor more information on the uptime of AvaTax, please see Avalara's AvaTax Status Page.
\nReturns the list of all subscriptions enabled for the currently logged in user.
\nThis API will return an error if it is called with invalid authentication credentials.
\nThis API is intended to help you determine whether you have the necessary subscription to use certain API calls\nwithin AvaTax. You can examine the subscriptions returned from this API call to look for a particular product\nor subscription to provide useful information to the current user as to whether they are entitled to use\nspecific features of AvaTax.
\n","urlObject":{"protocol":"https","path":["api","v2","utilities","subscriptions"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"65aebc44-8b07-451d-b6d2-5da4cfc39ae6"},{"name":"Checks if the current user is subscribed to a specific service","id":"a1b87b32-cdeb-43a7-894b-76e64cd94098","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://sandbox-rest.avatax.com/api/v2/utilities/subscriptions/{serviceTypeId}","description":"Returns a subscription object for the current account, or 404 Not Found if this subscription is not enabled for this account.
\nThis API will return an error if it is called with invalid authentication credentials.
\nThis API is intended to help you determine whether you have the necessary subscription to use certain API calls\nwithin AvaTax. You can examine the subscriptions returned from this API call to look for a particular product\nor subscription to provide useful information to the current user as to whether they are entitled to use\nspecific features of AvaTax.
\n","urlObject":{"protocol":"https","path":["api","v2","utilities","subscriptions","{serviceTypeId}"],"host":["sandbox-rest","avatax","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a1b87b32-cdeb-43a7-894b-76e64cd94098"}]}