{ "info": { "_postman_id": "80bdb472-b6af-4510-968f-5a09838ac1b3", "name": "AvaTax API", "description": "REST interface to Avalara's enterprise tax service, AvaTax.\n\nContact Support:\n Name: Avalara Developer Community", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "10149274", "_collection_link": "https://go.postman.co/collection/10149274-80bdb472-b6af-4510-968f-5a09838ac1b3?source=collection_link" }, "item": [ { "name": "api", "item": [ { "name": "v2", "item": [ { "name": "accounts", "item": [ { "name": "{id}", "item": [ { "name": "activate", "item": [ { "name": "Activate an account by accepting terms and conditions", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"acceptAvalaraTermsAndConditions\": true,\n \"haveReadAvalaraTermsAndConditions\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/activate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "activate" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account to activate" } ] }, "description": "Activate the account specified by the unique accountId number.\r\n \r\nThis activation request can only be called by account administrators. You must indicate\r\nthat you have read and accepted Avalara's terms and conditions to call this API.\r\n \r\nOnce you have activated your account, use the `AccountResetLicenseKey` API to generate\r\na license key for your account.\r\n \r\nIf you have not read or accepted the terms and conditions, this API call will return the\r\nunchanged account model.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"acceptAvalaraTermsAndConditions\": true,\n \"haveReadAvalaraTermsAndConditions\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/activate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "activate" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account to activate" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 12345,\n \"name\": \"Test Account\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"accountStatusId\": \"Test\",\n \"accountTypeId\": \"Regular\",\n \"isSamlEnabled\": false,\n \"isDeleted\": false\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"acceptAvalaraTermsAndConditions\": true,\n \"haveReadAvalaraTermsAndConditions\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/activate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "activate" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account to activate" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"acceptAvalaraTermsAndConditions\": true,\n \"haveReadAvalaraTermsAndConditions\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/activate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "activate" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account to activate" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"acceptAvalaraTermsAndConditions\": true,\n \"haveReadAvalaraTermsAndConditions\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/activate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "activate" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account to activate" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "audit", "item": [ { "name": "Retrieve audit history for an account.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/audit?start=1998-02-12T20:23:10.405Z&end=1998-02-12T20:23:10.405Z&$top=10&$skip=0", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "audit" ], "query": [ { "key": "start", "value": "1998-02-12T20:23:10.405Z", "description": "The start datetime of audit history you with to retrieve, e.g. \"2018-06-08T17:00:00Z\". Defaults to the past 15 minutes." }, { "key": "end", "value": "1998-02-12T20:23:10.405Z", "description": "The end datetime of audit history you with to retrieve, e.g. \"2018-06-08T17:15:00Z. Defaults to the current time. Maximum of an hour after the start time." }, { "key": "$top", "value": "10", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "0", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." } ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account you wish to audit." } ] }, "description": "Retrieve audit trace history for an account.\r\n \r\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\r\nproblems and see exactly what information was sent back and forth between your code and AvaTax.\r\n \r\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.\r\nYou can learn more about valid time zone designators at https://en.wikipedia.org/wiki/ISO_8601#Time_zone_designators.\r\n \r\nThis API enforces limits to the amount of data retrieved. These limits are subject to change.\r\n \r\n* You may request data from a maximum of a one-hour time period.\r\n* The amount of data and number of API calls returned by this API are limited and may be adjusted at any time.\r\n* Old records may be migrated out of immediately available storage. To request older data, please contact your account manager.\r\n* New records must migrate to available storage before they can be retrieved. You may need to wait a period of time before newly created records can be fetched.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/audit?start=1998-02-12T20:23:10.405Z&end=1998-02-12T20:23:10.405Z&$top=10&$skip=0", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "audit" ], "query": [ { "description": "The start datetime of audit history you with to retrieve, e.g. \"2018-06-08T17:00:00Z\". Defaults to the past 15 minutes.", "key": "start", "value": "1998-02-12T20:23:10.405Z" }, { "description": "The end datetime of audit history you with to retrieve, e.g. \"2018-06-08T17:15:00Z. Defaults to the current time. Maximum of an hour after the start time.", "key": "end", "value": "1998-02-12T20:23:10.405Z" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "10" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "0" } ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account you wish to audit." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 9223,\n \"value\": [\n {\n \"transactionId\": 123,\n \"accountId\": 123,\n \"userId\": 123,\n \"ipAddress\": \"123.0.0.123\",\n \"machineName\": \"AV-T1234-56789\",\n \"clientName\": \"Swagger UI\",\n \"clientVersion\": \"12.3.0\",\n \"adapterVersion\": \"1.0\",\n \"serverName\": \"AV-T1234-56789\",\n \"serverVersion\": \"12.3.0.0\",\n \"referenceId\": 0,\n \"severityLevelId\": 0,\n \"serverTimestamp\": \"2026-04-02T10:55:03.1697435Z\",\n \"serverDuration\": 12345,\n \"serviceName\": \"AccountSvcJson\",\n \"operation\": \"QueryCompanies\",\n \"referenceCode\": \"/api/v2/companies\",\n \"errorMessage\": \"\",\n \"loadBalancerDuration\": 0,\n \"recordCount\": 32309,\n \"referenceAuthorization\": \"\",\n \"isQueued\": false,\n \"databaseCallCount\": 1,\n \"databaseCallDuration\": \"00:00:00\",\n \"remoteCallDuration\": \"00:00:00\",\n \"requestUrl\": \"/api/v2/companies\",\n \"responseStatus\": 200,\n \"responseBody\": \"{\\r\\n \\\"@recordsetCount\\\": 0,\\r\\n \\\"value\\\": [],\\r\\n \\\"@nextLink\\\": \\\"/api/v2/companies?%24top=10&%24skip=10\\\"\\r\\n}\"\n },\n {\n \"transactionId\": 123,\n \"accountId\": 123,\n \"userId\": 123,\n \"ipAddress\": \"123.0.0.123\",\n \"machineName\": \"AV-T1234-56789\",\n \"clientName\": \"Swagger UI\",\n \"clientVersion\": \"12.3.0\",\n \"adapterVersion\": \"1.0\",\n \"serverName\": \"AV-T1234-56789\",\n \"serverVersion\": \"12.3.0.0\",\n \"referenceId\": 0,\n \"severityLevelId\": 0,\n \"serverTimestamp\": \"2026-04-02T10:55:03.1697435Z\",\n \"serverDuration\": 12345,\n \"serviceName\": \"AccountSvcJson\",\n \"operation\": \"QueryCompanies\",\n \"referenceCode\": \"/api/v2/companies\",\n \"errorMessage\": \"\",\n \"loadBalancerDuration\": 0,\n \"recordCount\": 32309,\n \"referenceAuthorization\": \"\",\n \"isQueued\": false,\n \"databaseCallCount\": 1,\n \"databaseCallDuration\": \"00:00:00\",\n \"remoteCallDuration\": \"00:00:00\",\n \"requestUrl\": \"/api/v2/companies\",\n \"responseStatus\": 200,\n \"responseBody\": \"{\\r\\n \\\"@recordsetCount\\\": 0,\\r\\n \\\"value\\\": [],\\r\\n \\\"@nextLink\\\": \\\"/api/v2/companies?%24top=10&%24skip=10\\\"\\r\\n}\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/audit?start=1998-02-12T20:23:10.405Z&end=1998-02-12T20:23:10.405Z&$top=10&$skip=0", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "audit" ], "query": [ { "description": "The start datetime of audit history you with to retrieve, e.g. \"2018-06-08T17:00:00Z\". Defaults to the past 15 minutes.", "key": "start", "value": "1998-02-12T20:23:10.405Z" }, { "description": "The end datetime of audit history you with to retrieve, e.g. \"2018-06-08T17:15:00Z. Defaults to the current time. Maximum of an hour after the start time.", "key": "end", "value": "1998-02-12T20:23:10.405Z" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "10" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "0" } ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account you wish to audit." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/audit?start=1998-02-12T20:23:10.405Z&end=1998-02-12T20:23:10.405Z&$top=10&$skip=0", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "audit" ], "query": [ { "description": "The start datetime of audit history you with to retrieve, e.g. \"2018-06-08T17:00:00Z\". Defaults to the past 15 minutes.", "key": "start", "value": "1998-02-12T20:23:10.405Z" }, { "description": "The end datetime of audit history you with to retrieve, e.g. \"2018-06-08T17:15:00Z. Defaults to the current time. Maximum of an hour after the start time.", "key": "end", "value": "1998-02-12T20:23:10.405Z" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "10" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "0" } ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account you wish to audit." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/audit?start=1998-02-12T20:23:10.405Z&end=1998-02-12T20:23:10.405Z&$top=10&$skip=0", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "audit" ], "query": [ { "description": "The start datetime of audit history you with to retrieve, e.g. \"2018-06-08T17:00:00Z\". Defaults to the past 15 minutes.", "key": "start", "value": "1998-02-12T20:23:10.405Z" }, { "description": "The end datetime of audit history you with to retrieve, e.g. \"2018-06-08T17:15:00Z. Defaults to the current time. Maximum of an hour after the start time.", "key": "end", "value": "1998-02-12T20:23:10.405Z" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "10" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "0" } ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account you wish to audit." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "configuration", "item": [ { "name": "Get configuration settings for this account", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/configuration", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "configuration" ], "variable": [ { "key": "id", "value": "451" } ] }, "description": "Retrieve a list of all configuration settings tied to this account.\r\n \r\nConfiguration settings provide you with the ability to control features of your account and of your\r\ntax software. The category names `TaxServiceConfig` and `AddressServiceConfig` are reserved for\r\nAvalara internal software configuration values; to store your own account-level settings, please\r\ncreate a new category name that begins with `X-`, for example, `X-MyCustomCategory`.\r\n \r\nAccount settings are permanent settings that cannot be deleted. You can set the value of an\r\naccount setting to null if desired.\r\n \r\nAvalara-based account settings for `TaxServiceConfig` and `AddressServiceConfig` affect your account's\r\ntax calculation and address resolution, and should only be changed with care.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/configuration", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "configuration" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"accountId\": 0,\n \"category\": \"TaxServiceConfig\",\n \"name\": \"MaxLines\",\n \"value\": \"1000\"\n },\n {\n \"accountId\": 0,\n \"category\": \"TaxServiceConfig\",\n \"name\": \"MaxLines\",\n \"value\": \"1000\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/configuration", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "configuration" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/configuration", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "configuration" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/configuration", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "configuration" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Change configuration settings for this account", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"accountId\": 0,\n \"category\": \"TaxServiceConfig\",\n \"name\": \"MaxLines\",\n \"value\": \"1000\"\n },\n {\n \"accountId\": 0,\n \"category\": \"TaxServiceConfig\",\n \"name\": \"MaxLines\",\n \"value\": \"1000\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/configuration", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "configuration" ], "variable": [ { "key": "id", "value": "451" } ] }, "description": "Update configuration settings tied to this account.\r\n \r\nConfiguration settings provide you with the ability to control features of your account and of your\r\ntax software. The category names `TaxServiceConfig` and `AddressServiceConfig` are reserved for\r\nAvalara internal software configuration values; to store your own account-level settings, please\r\ncreate a new category name that begins with `X-`, for example, `X-MyCustomCategory`.\r\n \r\nAccount settings are permanent settings that cannot be deleted. You can set the value of an\r\naccount setting to null if desired.\r\n \r\nAvalara-based account settings for `TaxServiceConfig` and `AddressServiceConfig` affect your account's\r\ntax calculation and address resolution, and should only be changed with care.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, BatchServiceAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"accountId\": 0,\n \"category\": \"TaxServiceConfig\",\n \"name\": \"MaxLines\",\n \"value\": \"1000\"\n },\n {\n \"accountId\": 0,\n \"category\": \"TaxServiceConfig\",\n \"name\": \"MaxLines\",\n \"value\": \"1000\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/configuration", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "configuration" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"accountId\": 0,\n \"category\": \"TaxServiceConfig\",\n \"name\": \"MaxLines\",\n \"value\": \"1000\"\n },\n {\n \"accountId\": 0,\n \"category\": \"TaxServiceConfig\",\n \"name\": \"MaxLines\",\n \"value\": \"1000\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"accountId\": 0,\n \"category\": \"TaxServiceConfig\",\n \"name\": \"MaxLines\",\n \"value\": \"1000\"\n },\n {\n \"accountId\": 0,\n \"category\": \"TaxServiceConfig\",\n \"name\": \"MaxLines\",\n \"value\": \"1000\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/configuration", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "configuration" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"accountId\": 0,\n \"category\": \"TaxServiceConfig\",\n \"name\": \"MaxLines\",\n \"value\": \"1000\"\n },\n {\n \"accountId\": 0,\n \"category\": \"TaxServiceConfig\",\n \"name\": \"MaxLines\",\n \"value\": \"1000\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/configuration", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "configuration" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"accountId\": 0,\n \"category\": \"TaxServiceConfig\",\n \"name\": \"MaxLines\",\n \"value\": \"1000\"\n },\n {\n \"accountId\": 0,\n \"category\": \"TaxServiceConfig\",\n \"name\": \"MaxLines\",\n \"value\": \"1000\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/configuration", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "configuration" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "licensekey", "item": [ { "name": "{licensekeyname}", "item": [ { "name": "Retrieve license key by license key name", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/licensekey/:licensekeyname", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "licensekey", ":licensekeyname" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account to retrieve" }, { "key": "licensekeyname", "value": "string", "description": "The license key name to be retrieved" } ] }, "description": "\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/licensekey/:licensekeyname", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "licensekey", ":licensekeyname" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account to retrieve" }, { "key": "licensekeyname", "value": "string", "description": "The license key name to be retrieved" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": \"ABCDEFGHIJK\",\n \"accountId\": 123456789,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"createdUserId\": 1,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 1\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/licensekey/:licensekeyname", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "licensekey", ":licensekeyname" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account to retrieve" }, { "key": "licensekeyname", "value": "string", "description": "The license key name to be retrieved" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/licensekey/:licensekeyname", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "licensekey", ":licensekeyname" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account to retrieve" }, { "key": "licensekeyname", "value": "string", "description": "The license key name to be retrieved" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/licensekey/:licensekeyname", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "licensekey", ":licensekeyname" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account to retrieve" }, { "key": "licensekeyname", "value": "string", "description": "The license key name to be retrieved" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete license key for this account by license key name", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/licensekey/:licensekeyname", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "licensekey", ":licensekeyname" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account you wish to update." }, { "key": "licensekeyname", "value": "string", "description": "The license key name you wish to update." } ] }, "description": "Deletes the license key for this account using license key name.\r\n \r\nTo delete a license key for your account, you must specify the accountID of the account and license key name.\r\n \r\nThis API is only available to account administrators for the account in question.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, BatchServiceAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/licensekey/:licensekeyname", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "licensekey", ":licensekeyname" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account you wish to update." }, { "key": "licensekeyname", "value": "string", "description": "The license key name you wish to update." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/licensekey/:licensekeyname", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "licensekey", ":licensekeyname" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account you wish to update." }, { "key": "licensekeyname", "value": "string", "description": "The license key name you wish to update." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/licensekey/:licensekeyname", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "licensekey", ":licensekeyname" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account you wish to update." }, { "key": "licensekeyname", "value": "string", "description": "The license key name you wish to update." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/licensekey/:licensekeyname", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "licensekey", ":licensekeyname" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account you wish to update." }, { "key": "licensekeyname", "value": "string", "description": "The license key name you wish to update." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Create license key for this account", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"ABCDEFGHIJK\",\n \"accountId\": 123456789,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"createdUserId\": 1,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 1\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/licensekey", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "licensekey" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account you wish to update." } ] }, "description": "Creates a new license key for this account.\r\n \r\nTo create a license key for your account, you must specify the ID of the account and license key name.\r\n \r\nThis API is only available to account administrators for the account in question, and may only be called after\r\nan account has been activated by reading and accepting Avalara's terms and conditions. To activate your account\r\nplease log onto the AvaTax website or call the `ActivateAccount` API.\r\n \r\nYou will reference this key using license key name. The existing license key will be using 'Default' as license key name.\r\nHence make sure that the license key name is unique per account considering the existing license key name 'Default'\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, BatchServiceAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"ABCDEFGHIJK\",\n \"accountId\": 123456789,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"createdUserId\": 1,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 1\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/licensekey", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "licensekey" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account you wish to update." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"accountId\": 123456789,\n \"privateLicenseKey\": \"742A02AA463CDE741E932EC365360CA3CF378BD9\",\n \"httpRequestHeader\": \"Basic MTIzNDU2Nzg5Ojc0MkEwMkFBNDYzQ0RFNzQxRTkzMkVDMzY1MzYwQ0EzQ0YzNzhCRDk=\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"ABCDEFGHIJK\",\n \"accountId\": 123456789,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"createdUserId\": 1,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 1\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/licensekey", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "licensekey" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account you wish to update." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"ABCDEFGHIJK\",\n \"accountId\": 123456789,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"createdUserId\": 1,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 1\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/licensekey", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "licensekey" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account you wish to update." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"ABCDEFGHIJK\",\n \"accountId\": 123456789,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"createdUserId\": 1,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 1\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/licensekey", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "licensekey" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account you wish to update." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "licensekeys", "item": [ { "name": "Retrieve all license keys for this account", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/licensekeys", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "licensekeys" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account to retrieve" } ] }, "description": "Gets list of all the license keys used by the account.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/licensekeys", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "licensekeys" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account to retrieve" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"name\": \"ABCDEFGHIJK\",\n \"accountId\": 123456789,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"createdUserId\": 1,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 1\n },\n {\n \"name\": \"ABCDEFGHIJK\",\n \"accountId\": 123456789,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"createdUserId\": 1,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 1\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/licensekeys", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "licensekeys" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account to retrieve" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/licensekeys", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "licensekeys" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account to retrieve" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/licensekeys", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "licensekeys" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account to retrieve" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "resetlicensekey", "item": [ { "name": "Reset this account's license key", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 123456789,\n \"confirmResetLicenseKey\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/resetlicensekey", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "resetlicensekey" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account you wish to update." } ] }, "description": "Resets the existing license key for this account to a new key.\r\n \r\nTo reset your account, you must specify the ID of the account you wish to reset and confirm the action.\r\n \r\nThis API is only available to account administrators for the account in question, and may only be called after\r\nan account has been activated by reading and accepting Avalara's terms and conditions. To activate your account\r\nplease log onto the AvaTax website or call the `ActivateAccount` API.\r\n \r\nYou can only reset license with 'Default' license key name.\r\nResetting a license key cannot be undone. Any previous license keys will immediately cease to work when a new key is created.\r\n \r\nWhen you call this API, all account administrators for this account will receive an email with the newly updated license key.\r\nThe email will specify which user reset the license key and it will contain the new key to use to update your connectors.\r\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\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, BatchServiceAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 123456789,\n \"confirmResetLicenseKey\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/resetlicensekey", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "resetlicensekey" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account you wish to update." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"accountId\": 123456789,\n \"privateLicenseKey\": \"742A02AA463CDE741E932EC365360CA3CF378BD9\",\n \"httpRequestHeader\": \"Basic MTIzNDU2Nzg5Ojc0MkEwMkFBNDYzQ0RFNzQxRTkzMkVDMzY1MzYwQ0EzQ0YzNzhCRDk=\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 123456789,\n \"confirmResetLicenseKey\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/resetlicensekey", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "resetlicensekey" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account you wish to update." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 123456789,\n \"confirmResetLicenseKey\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/resetlicensekey", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "resetlicensekey" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account you wish to update." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 123456789,\n \"confirmResetLicenseKey\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/resetlicensekey", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "resetlicensekey" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account you wish to update." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "entitlements", "item": [ { "name": "{offer}", "item": [ { "name": "Request a new entitilement to an existing customer", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/entitlements/:offer", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "entitlements", ":offer" ], "variable": [ { "key": "id", "value": "451", "description": "The avatax account id of the customer" }, { "key": "offer", "value": "string", "description": "The offer to be added to an already existing customer" } ] }, "description": "This API is for use by partner provisioning services customers only. This allows the partners to add\r\nnew entitlements to an existing customer.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n* This API is available by invitation only.\n* This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Provisioning:RequestNewAccount].\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/entitlements/:offer", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "entitlements", ":offer" ], "variable": [ { "key": "id", "value": "451", "description": "The avatax account id of the customer" }, { "key": "offer", "value": "string", "description": "The offer to be added to an already existing customer" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"1234567989\",\n \"offerMessage\": \"The offer abc has been added to the account 123456789 at 2018-07-08\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/entitlements/:offer", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "entitlements", ":offer" ], "variable": [ { "key": "id", "value": "451", "description": "The avatax account id of the customer" }, { "key": "offer", "value": "string", "description": "The offer to be added to an already existing customer" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/entitlements/:offer", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "entitlements", ":offer" ], "variable": [ { "key": "id", "value": "451", "description": "The avatax account id of the customer" }, { "key": "offer", "value": "string", "description": "The offer to be added to an already existing customer" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id/entitlements/:offer", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id", "entitlements", ":offer" ], "variable": [ { "key": "id", "value": "451", "description": "The avatax account id of the customer" }, { "key": "offer", "value": "string", "description": "The offer to be added to an already existing customer" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "Retrieve a single account", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id" ], "query": [ { "key": "$include", "value": "string", "description": "A comma separated list of special fetch options" } ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account to retrieve" } ] }, "description": "Get the account object identified by this URL.\r\nYou may use the '$include' parameter to fetch additional nested data:\r\n \r\n* Subscriptions\r\n* Users\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id" ], "query": [ { "description": "A comma separated list of special fetch options", "key": "$include", "value": "string" } ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account to retrieve" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 12345,\n \"name\": \"Test Account\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"accountStatusId\": \"Test\",\n \"accountTypeId\": \"Regular\",\n \"isSamlEnabled\": false,\n \"isDeleted\": false\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id" ], "query": [ { "description": "A comma separated list of special fetch options", "key": "$include", "value": "string" } ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account to retrieve" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id" ], "query": [ { "description": "A comma separated list of special fetch options", "key": "$include", "value": "string" } ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account to retrieve" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id" ], "query": [ { "description": "A comma separated list of special fetch options", "key": "$include", "value": "string" } ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account to retrieve" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Update a single account", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 12345,\n \"name\": \"Test Account\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"accountStatusId\": \"Test\",\n \"accountTypeId\": \"Regular\",\n \"isSamlEnabled\": false,\n \"isDeleted\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account you wish to update." } ] }, "description": "# For Registrar Use Only\r\nThis API is for use by Avalara Registrar administrative users only.\r\n \r\nReplace an existing account object with an updated account object.\n\n### Security Policies\n\n* This API requires one of the following user roles: BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 12345,\n \"name\": \"Test Account\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"accountStatusId\": \"Test\",\n \"accountTypeId\": \"Regular\",\n \"isSamlEnabled\": false,\n \"isDeleted\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account you wish to update." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 12345,\n \"name\": \"Test Account\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"accountStatusId\": \"Test\",\n \"accountTypeId\": \"Regular\",\n \"isSamlEnabled\": false,\n \"isDeleted\": false\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 12345,\n \"name\": \"Test Account\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"accountStatusId\": \"Test\",\n \"accountTypeId\": \"Regular\",\n \"isSamlEnabled\": false,\n \"isDeleted\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account you wish to update." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 12345,\n \"name\": \"Test Account\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"accountStatusId\": \"Test\",\n \"accountTypeId\": \"Regular\",\n \"isSamlEnabled\": false,\n \"isDeleted\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account you wish to update." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 12345,\n \"name\": \"Test Account\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"accountStatusId\": \"Test\",\n \"accountTypeId\": \"Regular\",\n \"isSamlEnabled\": false,\n \"isDeleted\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account you wish to update." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete a single account", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account you wish to delete." } ] }, "description": "# For Registrar Use Only\r\nThis API is for use by Avalara Registrar administrative users only.\r\n \r\nDelete an account.\r\nDeleting an account will delete all companies, all account level users and license keys attached to this account.\n\n### Security Policies\n\n* This API requires the user role SystemAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account you wish to delete." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account you wish to delete." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account you wish to delete." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the account you wish to delete." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "mrs", "item": [ { "name": "Retrieve a list of MRS Accounts", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/mrs", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", "mrs" ] }, "description": "This API is available by invitation only.\r\n \r\nGet a list of accounts with an active MRS service.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/mrs", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", "mrs" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 6227,\n \"value\": [\n {\n \"companyId\": 12345,\n \"companyName\": \"Default Company\",\n \"accountId\": 123456789,\n \"accountName\": \"Default Account\"\n },\n {\n \"companyId\": 12345,\n \"companyName\": \"Default Company\",\n \"accountId\": 123456789,\n \"accountName\": \"Default Account\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/mrs", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", "mrs" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/mrs", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", "mrs" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "{accountId}", "item": [ { "name": "jurisdictionoverrides", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a single override", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/jurisdictionoverrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "jurisdictionoverrides", ":id" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns this override" }, { "key": "id", "value": "451", "description": "The primary key of this override" } ] }, "description": "Get the item object identified by this URL.\r\n \r\nA Jurisdiction Override is a configuration setting that allows you to select the taxing\r\njurisdiction for a specific address. If you encounter an address that is on the boundary\r\nbetween two different jurisdictions, you can choose to set up a jurisdiction override\r\nto switch this address to use different taxing jurisdictions.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/jurisdictionoverrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "jurisdictionoverrides", ":id" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns this override" }, { "key": "id", "value": "451", "description": "The primary key of this override" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 0,\n \"accountId\": 0,\n \"description\": \"a test JO\",\n \"line1\": \"5500 Irvine Center Dr\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92618\",\n \"effectiveDate\": \"2006-08-01\",\n \"endDate\": \"2099-01-12\",\n \"jurisdictions\": [\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"type\": \"County\",\n \"region\": \"AR\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true,\n \"modifiedDate\": \"0001-01-01T00:00:00\"\n }\n ],\n \"taxRegionId\": 0,\n \"boundaryLevel\": \"Address\",\n \"isDefault\": false\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/jurisdictionoverrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "jurisdictionoverrides", ":id" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns this override" }, { "key": "id", "value": "451", "description": "The primary key of this override" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/jurisdictionoverrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "jurisdictionoverrides", ":id" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns this override" }, { "key": "id", "value": "451", "description": "The primary key of this override" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/jurisdictionoverrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "jurisdictionoverrides", ":id" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns this override" }, { "key": "id", "value": "451", "description": "The primary key of this override" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Update a single jurisdictionoverride", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"accountId\": 0,\n \"description\": \"a test JO\",\n \"line1\": \"5500 Irvine Center Dr\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92618\",\n \"effectiveDate\": \"2006-08-01\",\n \"endDate\": \"2099-01-12\",\n \"jurisdictions\": [\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"type\": \"County\",\n \"region\": \"AR\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true,\n \"modifiedDate\": \"0001-01-01T00:00:00\"\n }\n ],\n \"taxRegionId\": 0,\n \"boundaryLevel\": \"Address\",\n \"isDefault\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/jurisdictionoverrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "jurisdictionoverrides", ":id" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that this jurisdictionoverride belongs to." }, { "key": "id", "value": "451", "description": "The ID of the jurisdictionoverride you wish to update" } ] }, "description": "Replace the existing jurisdictionoverride object at this URL with an updated object.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, BatchServiceAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"accountId\": 0,\n \"description\": \"a test JO\",\n \"line1\": \"5500 Irvine Center Dr\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92618\",\n \"effectiveDate\": \"2006-08-01\",\n \"endDate\": \"2099-01-12\",\n \"jurisdictions\": [\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"type\": \"County\",\n \"region\": \"AR\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true,\n \"modifiedDate\": \"0001-01-01T00:00:00\"\n }\n ],\n \"taxRegionId\": 0,\n \"boundaryLevel\": \"Address\",\n \"isDefault\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/jurisdictionoverrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "jurisdictionoverrides", ":id" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that this jurisdictionoverride belongs to." }, { "key": "id", "value": "451", "description": "The ID of the jurisdictionoverride you wish to update" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 0,\n \"accountId\": 0,\n \"description\": \"a test JO\",\n \"line1\": \"5500 Irvine Center Dr\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92618\",\n \"effectiveDate\": \"2006-08-01\",\n \"endDate\": \"2099-01-12\",\n \"jurisdictions\": [\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"type\": \"County\",\n \"region\": \"AR\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true,\n \"modifiedDate\": \"0001-01-01T00:00:00\"\n }\n ],\n \"taxRegionId\": 0,\n \"boundaryLevel\": \"Address\",\n \"isDefault\": false\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"accountId\": 0,\n \"description\": \"a test JO\",\n \"line1\": \"5500 Irvine Center Dr\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92618\",\n \"effectiveDate\": \"2006-08-01\",\n \"endDate\": \"2099-01-12\",\n \"jurisdictions\": [\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"type\": \"County\",\n \"region\": \"AR\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true,\n \"modifiedDate\": \"0001-01-01T00:00:00\"\n }\n ],\n \"taxRegionId\": 0,\n \"boundaryLevel\": \"Address\",\n \"isDefault\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/jurisdictionoverrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "jurisdictionoverrides", ":id" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that this jurisdictionoverride belongs to." }, { "key": "id", "value": "451", "description": "The ID of the jurisdictionoverride you wish to update" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"accountId\": 0,\n \"description\": \"a test JO\",\n \"line1\": \"5500 Irvine Center Dr\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92618\",\n \"effectiveDate\": \"2006-08-01\",\n \"endDate\": \"2099-01-12\",\n \"jurisdictions\": [\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"type\": \"County\",\n \"region\": \"AR\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true,\n \"modifiedDate\": \"0001-01-01T00:00:00\"\n }\n ],\n \"taxRegionId\": 0,\n \"boundaryLevel\": \"Address\",\n \"isDefault\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/jurisdictionoverrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "jurisdictionoverrides", ":id" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that this jurisdictionoverride belongs to." }, { "key": "id", "value": "451", "description": "The ID of the jurisdictionoverride you wish to update" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"accountId\": 0,\n \"description\": \"a test JO\",\n \"line1\": \"5500 Irvine Center Dr\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92618\",\n \"effectiveDate\": \"2006-08-01\",\n \"endDate\": \"2099-01-12\",\n \"jurisdictions\": [\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"type\": \"County\",\n \"region\": \"AR\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true,\n \"modifiedDate\": \"0001-01-01T00:00:00\"\n }\n ],\n \"taxRegionId\": 0,\n \"boundaryLevel\": \"Address\",\n \"isDefault\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/jurisdictionoverrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "jurisdictionoverrides", ":id" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that this jurisdictionoverride belongs to." }, { "key": "id", "value": "451", "description": "The ID of the jurisdictionoverride you wish to update" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete a single override", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/jurisdictionoverrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "jurisdictionoverrides", ":id" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns this override" }, { "key": "id", "value": "451", "description": "The ID of the override you wish to delete" } ] }, "description": "Marks the item object at this URL as deleted.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, BatchServiceAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/jurisdictionoverrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "jurisdictionoverrides", ":id" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns this override" }, { "key": "id", "value": "451", "description": "The ID of the override you wish to delete" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/jurisdictionoverrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "jurisdictionoverrides", ":id" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns this override" }, { "key": "id", "value": "451", "description": "The ID of the override you wish to delete" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/jurisdictionoverrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "jurisdictionoverrides", ":id" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns this override" }, { "key": "id", "value": "451", "description": "The ID of the override you wish to delete" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/jurisdictionoverrides/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "jurisdictionoverrides", ":id" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns this override" }, { "key": "id", "value": "451", "description": "The ID of the override you wish to delete" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Create one or more overrides", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"description\": \"a test JO\",\n \"jurisdictions\": [\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 3018.28401908828,\n \"salesRate\": 6225.77337266019,\n \"region\": \"AR\",\n \"useRate\": 8061.375877259327,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true\n },\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 5292.851406530092,\n \"salesRate\": 5437.659446060033,\n \"region\": \"AR\",\n \"useRate\": 7807.329190415211,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true\n }\n ],\n \"postalCode\": \"92618\",\n \"region\": \"CA\",\n \"taxRegionId\": 0,\n \"accountId\": 0,\n \"line1\": \"5500 Irvine Center Dr\",\n \"city\": \"Irvine\",\n \"effectiveDate\": \"1977-02-10\",\n \"endDate\": \"1988-05-03\",\n \"isDefault\": true\n },\n {\n \"description\": \"a test JO\",\n \"jurisdictions\": [\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 7569.221140654827,\n \"salesRate\": 4550.648240176633,\n \"region\": \"AR\",\n \"useRate\": 1338.2477802780325,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true\n },\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 4658.470351284991,\n \"salesRate\": 9779.23747423826,\n \"region\": \"AR\",\n \"useRate\": 5935.821149129599,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true\n }\n ],\n \"postalCode\": \"92618\",\n \"region\": \"CA\",\n \"taxRegionId\": 0,\n \"accountId\": 0,\n \"line1\": \"5500 Irvine Center Dr\",\n \"city\": \"Irvine\",\n \"effectiveDate\": \"2016-02-12\",\n \"endDate\": \"1957-03-25\",\n \"isDefault\": true\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/jurisdictionoverrides", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "jurisdictionoverrides" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns this override" } ] }, "description": "Creates one or more jurisdiction override objects for this account.\r\n \r\nA Jurisdiction Override is a configuration setting that allows you to select the taxing\r\njurisdiction for a specific address. If you encounter an address that is on the boundary\r\nbetween two different jurisdictions, you can choose to set up a jurisdiction override\r\nto switch this address to use different taxing jurisdictions.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, BatchServiceAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"description\": \"a test JO\",\n \"jurisdictions\": [\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 3018.28401908828,\n \"salesRate\": 6225.77337266019,\n \"region\": \"AR\",\n \"useRate\": 8061.375877259327,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true\n },\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 5292.851406530092,\n \"salesRate\": 5437.659446060033,\n \"region\": \"AR\",\n \"useRate\": 7807.329190415211,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true\n }\n ],\n \"postalCode\": \"92618\",\n \"region\": \"CA\",\n \"taxRegionId\": 0,\n \"accountId\": 0,\n \"line1\": \"5500 Irvine Center Dr\",\n \"city\": \"Irvine\",\n \"effectiveDate\": \"1977-02-10\",\n \"endDate\": \"1988-05-03\",\n \"isDefault\": true\n },\n {\n \"description\": \"a test JO\",\n \"jurisdictions\": [\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 7569.221140654827,\n \"salesRate\": 4550.648240176633,\n \"region\": \"AR\",\n \"useRate\": 1338.2477802780325,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true\n },\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 4658.470351284991,\n \"salesRate\": 9779.23747423826,\n \"region\": \"AR\",\n \"useRate\": 5935.821149129599,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true\n }\n ],\n \"postalCode\": \"92618\",\n \"region\": \"CA\",\n \"taxRegionId\": 0,\n \"accountId\": 0,\n \"line1\": \"5500 Irvine Center Dr\",\n \"city\": \"Irvine\",\n \"effectiveDate\": \"2016-02-12\",\n \"endDate\": \"1957-03-25\",\n \"isDefault\": true\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/jurisdictionoverrides", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "jurisdictionoverrides" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns this override" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"description\": \"a test JO\",\n \"jurisdictions\": [\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 2986.4044402276613,\n \"salesRate\": 8174.89178386267,\n \"region\": \"AR\",\n \"useRate\": 9577.829012879396,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true,\n \"createDate\": \"2001-03-20T15:13:15.254Z\",\n \"isLocalAdmin\": false,\n \"modifiedDate\": \"0001-01-01T00:00:00\",\n \"taxAuthorityTypeId\": 9700\n },\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 782.1059635115013,\n \"salesRate\": 3744.59609063114,\n \"region\": \"AR\",\n \"useRate\": 2309.2021782448246,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true,\n \"createDate\": \"1991-03-15T16:05:19.941Z\",\n \"isLocalAdmin\": false,\n \"modifiedDate\": \"0001-01-01T00:00:00\",\n \"taxAuthorityTypeId\": 5363\n }\n ],\n \"postalCode\": \"92618\",\n \"region\": \"CA\",\n \"taxRegionId\": 0,\n \"id\": 0,\n \"accountId\": 0,\n \"line1\": \"5500 Irvine Center Dr\",\n \"city\": \"Irvine\",\n \"country\": \"US\",\n \"effectiveDate\": \"1980-04-07\",\n \"endDate\": \"1972-10-28\",\n \"createdDate\": \"1963-06-02T02:49:42.162Z\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"1971-06-24T05:39:35.084Z\",\n \"modifiedUserId\": 0,\n \"boundaryLevel\": \"Address\",\n \"isDefault\": false\n },\n {\n \"description\": \"a test JO\",\n \"jurisdictions\": [\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 6472.786799085803,\n \"salesRate\": 8900.98117973198,\n \"region\": \"AR\",\n \"useRate\": 6337.934337326478,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true,\n \"createDate\": \"1957-05-12T21:59:07.807Z\",\n \"isLocalAdmin\": true,\n \"modifiedDate\": \"0001-01-01T00:00:00\",\n \"taxAuthorityTypeId\": 5022\n },\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 5174.069174947153,\n \"salesRate\": 7541.687677238644,\n \"region\": \"AR\",\n \"useRate\": 1609.4369900852978,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true,\n \"createDate\": \"1954-10-04T10:35:41.305Z\",\n \"isLocalAdmin\": false,\n \"modifiedDate\": \"0001-01-01T00:00:00\",\n \"taxAuthorityTypeId\": 9570\n }\n ],\n \"postalCode\": \"92618\",\n \"region\": \"CA\",\n \"taxRegionId\": 0,\n \"id\": 0,\n \"accountId\": 0,\n \"line1\": \"5500 Irvine Center Dr\",\n \"city\": \"Irvine\",\n \"country\": \"US\",\n \"effectiveDate\": \"1989-11-14\",\n \"endDate\": \"1962-01-24\",\n \"createdDate\": \"2025-07-10T00:43:18.962Z\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"1973-01-29T06:45:32.927Z\",\n \"modifiedUserId\": 0,\n \"boundaryLevel\": \"Address\",\n \"isDefault\": false\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"description\": \"a test JO\",\n \"jurisdictions\": [\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 3018.28401908828,\n \"salesRate\": 6225.77337266019,\n \"region\": \"AR\",\n \"useRate\": 8061.375877259327,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true\n },\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 5292.851406530092,\n \"salesRate\": 5437.659446060033,\n \"region\": \"AR\",\n \"useRate\": 7807.329190415211,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true\n }\n ],\n \"postalCode\": \"92618\",\n \"region\": \"CA\",\n \"taxRegionId\": 0,\n \"accountId\": 0,\n \"line1\": \"5500 Irvine Center Dr\",\n \"city\": \"Irvine\",\n \"effectiveDate\": \"1977-02-10\",\n \"endDate\": \"1988-05-03\",\n \"isDefault\": true\n },\n {\n \"description\": \"a test JO\",\n \"jurisdictions\": [\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 7569.221140654827,\n \"salesRate\": 4550.648240176633,\n \"region\": \"AR\",\n \"useRate\": 1338.2477802780325,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true\n },\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 4658.470351284991,\n \"salesRate\": 9779.23747423826,\n \"region\": \"AR\",\n \"useRate\": 5935.821149129599,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true\n }\n ],\n \"postalCode\": \"92618\",\n \"region\": \"CA\",\n \"taxRegionId\": 0,\n \"accountId\": 0,\n \"line1\": \"5500 Irvine Center Dr\",\n \"city\": \"Irvine\",\n \"effectiveDate\": \"2016-02-12\",\n \"endDate\": \"1957-03-25\",\n \"isDefault\": true\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/jurisdictionoverrides", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "jurisdictionoverrides" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns this override" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"description\": \"a test JO\",\n \"jurisdictions\": [\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 3018.28401908828,\n \"salesRate\": 6225.77337266019,\n \"region\": \"AR\",\n \"useRate\": 8061.375877259327,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true\n },\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 5292.851406530092,\n \"salesRate\": 5437.659446060033,\n \"region\": \"AR\",\n \"useRate\": 7807.329190415211,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true\n }\n ],\n \"postalCode\": \"92618\",\n \"region\": \"CA\",\n \"taxRegionId\": 0,\n \"accountId\": 0,\n \"line1\": \"5500 Irvine Center Dr\",\n \"city\": \"Irvine\",\n \"effectiveDate\": \"1977-02-10\",\n \"endDate\": \"1988-05-03\",\n \"isDefault\": true\n },\n {\n \"description\": \"a test JO\",\n \"jurisdictions\": [\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 7569.221140654827,\n \"salesRate\": 4550.648240176633,\n \"region\": \"AR\",\n \"useRate\": 1338.2477802780325,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true\n },\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 4658.470351284991,\n \"salesRate\": 9779.23747423826,\n \"region\": \"AR\",\n \"useRate\": 5935.821149129599,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true\n }\n ],\n \"postalCode\": \"92618\",\n \"region\": \"CA\",\n \"taxRegionId\": 0,\n \"accountId\": 0,\n \"line1\": \"5500 Irvine Center Dr\",\n \"city\": \"Irvine\",\n \"effectiveDate\": \"2016-02-12\",\n \"endDate\": \"1957-03-25\",\n \"isDefault\": true\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/jurisdictionoverrides", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "jurisdictionoverrides" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns this override" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"description\": \"a test JO\",\n \"jurisdictions\": [\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 3018.28401908828,\n \"salesRate\": 6225.77337266019,\n \"region\": \"AR\",\n \"useRate\": 8061.375877259327,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true\n },\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 5292.851406530092,\n \"salesRate\": 5437.659446060033,\n \"region\": \"AR\",\n \"useRate\": 7807.329190415211,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true\n }\n ],\n \"postalCode\": \"92618\",\n \"region\": \"CA\",\n \"taxRegionId\": 0,\n \"accountId\": 0,\n \"line1\": \"5500 Irvine Center Dr\",\n \"city\": \"Irvine\",\n \"effectiveDate\": \"1977-02-10\",\n \"endDate\": \"1988-05-03\",\n \"isDefault\": true\n },\n {\n \"description\": \"a test JO\",\n \"jurisdictions\": [\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 7569.221140654827,\n \"salesRate\": 4550.648240176633,\n \"region\": \"AR\",\n \"useRate\": 1338.2477802780325,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true\n },\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 4658.470351284991,\n \"salesRate\": 9779.23747423826,\n \"region\": \"AR\",\n \"useRate\": 5935.821149129599,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true\n }\n ],\n \"postalCode\": \"92618\",\n \"region\": \"CA\",\n \"taxRegionId\": 0,\n \"accountId\": 0,\n \"line1\": \"5500 Irvine Center Dr\",\n \"city\": \"Irvine\",\n \"effectiveDate\": \"2016-02-12\",\n \"endDate\": \"1957-03-25\",\n \"isDefault\": true\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/jurisdictionoverrides", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "jurisdictionoverrides" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns this override" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Retrieve overrides for this account", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/jurisdictionoverrides?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "jurisdictionoverrides" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* country, Jurisdictions" }, { "key": "$include", "value": "string", "description": "A comma separated list of additional data to retrieve." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns this override" } ] }, "description": "List all jurisdiction override objects defined for this account.\r\n \r\nA Jurisdiction Override is a configuration setting that allows you to select the taxing\r\njurisdiction for a specific address. If you encounter an address that is on the boundary\r\nbetween two different jurisdictions, you can choose to set up a jurisdiction override\r\nto switch this address to use different taxing jurisdictions.\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/jurisdictionoverrides?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "jurisdictionoverrides" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* country, Jurisdictions", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns this override" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 4339,\n \"value\": [\n {\n \"description\": \"a test JO\",\n \"jurisdictions\": [\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 7434.001262750061,\n \"salesRate\": 157.10809959449844,\n \"region\": \"AR\",\n \"useRate\": 3116.1549977000714,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true,\n \"createDate\": \"2022-07-21T11:54:06.283Z\",\n \"isLocalAdmin\": false,\n \"modifiedDate\": \"0001-01-01T00:00:00\",\n \"taxAuthorityTypeId\": 1930\n },\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 6893.114877833215,\n \"salesRate\": 1388.7288213531801,\n \"region\": \"AR\",\n \"useRate\": 8819.808735847833,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true,\n \"createDate\": \"2015-03-31T01:57:48.787Z\",\n \"isLocalAdmin\": false,\n \"modifiedDate\": \"0001-01-01T00:00:00\",\n \"taxAuthorityTypeId\": 4031\n }\n ],\n \"postalCode\": \"92618\",\n \"region\": \"CA\",\n \"taxRegionId\": 0,\n \"id\": 0,\n \"accountId\": 0,\n \"line1\": \"5500 Irvine Center Dr\",\n \"city\": \"Irvine\",\n \"country\": \"US\",\n \"effectiveDate\": \"1975-09-07\",\n \"endDate\": \"1951-02-22\",\n \"createdDate\": \"1981-04-21T06:15:33.985Z\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2015-01-04T01:39:29.948Z\",\n \"modifiedUserId\": 0,\n \"boundaryLevel\": \"Address\",\n \"isDefault\": true\n },\n {\n \"description\": \"a test JO\",\n \"jurisdictions\": [\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 5103.872027961538,\n \"salesRate\": 9688.552832697666,\n \"region\": \"AR\",\n \"useRate\": 7145.500234004396,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true,\n \"createDate\": \"1952-12-06T04:55:22.594Z\",\n \"isLocalAdmin\": true,\n \"modifiedDate\": \"0001-01-01T00:00:00\",\n \"taxAuthorityTypeId\": 1053\n },\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 8997.610989995706,\n \"salesRate\": 6515.321052544796,\n \"region\": \"AR\",\n \"useRate\": 7832.759133100276,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true,\n \"createDate\": \"1968-08-11T15:23:10.914Z\",\n \"isLocalAdmin\": false,\n \"modifiedDate\": \"0001-01-01T00:00:00\",\n \"taxAuthorityTypeId\": 9463\n }\n ],\n \"postalCode\": \"92618\",\n \"region\": \"CA\",\n \"taxRegionId\": 0,\n \"id\": 0,\n \"accountId\": 0,\n \"line1\": \"5500 Irvine Center Dr\",\n \"city\": \"Irvine\",\n \"country\": \"US\",\n \"effectiveDate\": \"2007-08-28\",\n \"endDate\": \"1981-01-26\",\n \"createdDate\": \"1957-10-28T20:47:07.758Z\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2018-06-22T23:27:36.684Z\",\n \"modifiedUserId\": 0,\n \"boundaryLevel\": \"Address\",\n \"isDefault\": true\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/jurisdictionoverrides?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "jurisdictionoverrides" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* country, Jurisdictions", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns this override" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/jurisdictionoverrides?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "jurisdictionoverrides" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* country, Jurisdictions", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns this override" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/jurisdictionoverrides?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "jurisdictionoverrides" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* country, Jurisdictions", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns this override" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "subscriptions", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a single subscription", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/subscriptions/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "subscriptions", ":id" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns this subscription" }, { "key": "id", "value": "451", "description": "The primary key of this subscription" } ] }, "description": "Get the subscription object identified by this URL.\r\nA 'subscription' indicates a licensed subscription to a named Avalara service.\r\nTo request or remove subscriptions, please contact Avalara sales or your customer account manager.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/subscriptions/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "subscriptions", ":id" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns this subscription" }, { "key": "id", "value": "451", "description": "The primary key of this subscription" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 12345,\n \"accountId\": 123456789,\n \"subscriptionTypeId\": 2,\n \"subscriptionDescription\": \"AvaTaxPro\",\n \"effectiveDate\": \"2015-01-01\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/subscriptions/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "subscriptions", ":id" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns this subscription" }, { "key": "id", "value": "451", "description": "The primary key of this subscription" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/subscriptions/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "subscriptions", ":id" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns this subscription" }, { "key": "id", "value": "451", "description": "The primary key of this subscription" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/subscriptions/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "subscriptions", ":id" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns this subscription" }, { "key": "id", "value": "451", "description": "The primary key of this subscription" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Update a single subscription", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 12345,\n \"accountId\": 123456789,\n \"subscriptionTypeId\": 2,\n \"subscriptionDescription\": \"AvaTaxPro\",\n \"effectiveDate\": \"2015-01-01\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/subscriptions/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "subscriptions", ":id" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that this subscription belongs to." }, { "key": "id", "value": "451", "description": "The ID of the subscription you wish to update" } ] }, "description": "# For Registrar Use Only\r\nThis API is for use by Avalara Registrar administrative users only.\r\n \r\nReplace the existing subscription object at this URL with an updated object.\r\nA 'subscription' indicates a licensed subscription to a named Avalara service.\r\nTo request or remove subscriptions, please contact Avalara sales or your customer account manager.\r\nAll data from the existing object will be replaced with data in the object you PUT.\r\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.\n\n### Security Policies\n\n* This API requires one of the following user roles: BatchServiceAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 12345,\n \"accountId\": 123456789,\n \"subscriptionTypeId\": 2,\n \"subscriptionDescription\": \"AvaTaxPro\",\n \"effectiveDate\": \"2015-01-01\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/subscriptions/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "subscriptions", ":id" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that this subscription belongs to." }, { "key": "id", "value": "451", "description": "The ID of the subscription you wish to update" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 12345,\n \"accountId\": 123456789,\n \"subscriptionTypeId\": 2,\n \"subscriptionDescription\": \"AvaTaxPro\",\n \"effectiveDate\": \"2015-01-01\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 12345,\n \"accountId\": 123456789,\n \"subscriptionTypeId\": 2,\n \"subscriptionDescription\": \"AvaTaxPro\",\n \"effectiveDate\": \"2015-01-01\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/subscriptions/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "subscriptions", ":id" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that this subscription belongs to." }, { "key": "id", "value": "451", "description": "The ID of the subscription you wish to update" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 12345,\n \"accountId\": 123456789,\n \"subscriptionTypeId\": 2,\n \"subscriptionDescription\": \"AvaTaxPro\",\n \"effectiveDate\": \"2015-01-01\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/subscriptions/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "subscriptions", ":id" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that this subscription belongs to." }, { "key": "id", "value": "451", "description": "The ID of the subscription you wish to update" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 12345,\n \"accountId\": 123456789,\n \"subscriptionTypeId\": 2,\n \"subscriptionDescription\": \"AvaTaxPro\",\n \"effectiveDate\": \"2015-01-01\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/subscriptions/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "subscriptions", ":id" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that this subscription belongs to." }, { "key": "id", "value": "451", "description": "The ID of the subscription you wish to update" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete a single subscription", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/subscriptions/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "subscriptions", ":id" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns this subscription." }, { "key": "id", "value": "451", "description": "The ID of the subscription you wish to delete." } ] }, "description": "# For Registrar Use Only\r\nThis API is for use by Avalara Registrar administrative users only.\r\n \r\nMark the existing account identified by this URL as deleted.\n\n### Security Policies\n\n* This API requires one of the following user roles: BatchServiceAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/subscriptions/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "subscriptions", ":id" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns this subscription." }, { "key": "id", "value": "451", "description": "The ID of the subscription you wish to delete." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/subscriptions/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "subscriptions", ":id" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns this subscription." }, { "key": "id", "value": "451", "description": "The ID of the subscription you wish to delete." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/subscriptions/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "subscriptions", ":id" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns this subscription." }, { "key": "id", "value": "451", "description": "The ID of the subscription you wish to delete." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/subscriptions/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "subscriptions", ":id" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns this subscription." }, { "key": "id", "value": "451", "description": "The ID of the subscription you wish to delete." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Retrieve subscriptions for this account", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/subscriptions?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "subscriptions" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* subscriptionDescription" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns these subscriptions" } ] }, "description": "List all subscription objects attached to this account.\r\nA 'subscription' indicates a licensed subscription to a named Avalara service.\r\nTo request or remove subscriptions, please contact Avalara sales or your customer account manager.\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/subscriptions?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "subscriptions" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* subscriptionDescription", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns these subscriptions" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 5294,\n \"value\": [\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"subscriptionTypeId\": 2,\n \"subscriptionDescription\": \"AvaTaxPro\",\n \"effectiveDate\": \"2015-01-01\"\n },\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"subscriptionTypeId\": 2,\n \"subscriptionDescription\": \"AvaTaxPro\",\n \"effectiveDate\": \"2015-01-01\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/subscriptions?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "subscriptions" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* subscriptionDescription", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns these subscriptions" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/subscriptions?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "subscriptions" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* subscriptionDescription", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns these subscriptions" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/subscriptions?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "subscriptions" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* subscriptionDescription", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns these subscriptions" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Create a new subscription", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"subscriptionTypeId\": 2,\n \"subscriptionDescription\": \"AvaTaxPro\",\n \"effectiveDate\": \"2015-01-01\"\n },\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"subscriptionTypeId\": 2,\n \"subscriptionDescription\": \"AvaTaxPro\",\n \"effectiveDate\": \"2015-01-01\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "subscriptions" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns this subscription." } ] }, "description": "This API is for use by Avalara Registrar administrative users only.\r\n \r\nCreate one or more new subscription objects attached to this account.\r\nA 'subscription' indicates a licensed subscription to a named Avalara service.\r\nTo request or remove subscriptions, please contact Avalara sales or your customer account manager.\n\n### Security Policies\n\n* This API requires one of the following user roles: BatchServiceAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"subscriptionTypeId\": 2,\n \"subscriptionDescription\": \"AvaTaxPro\",\n \"effectiveDate\": \"2015-01-01\"\n },\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"subscriptionTypeId\": 2,\n \"subscriptionDescription\": \"AvaTaxPro\",\n \"effectiveDate\": \"2015-01-01\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "subscriptions" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns this subscription." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"subscriptionTypeId\": 2,\n \"subscriptionDescription\": \"AvaTaxPro\",\n \"effectiveDate\": \"2015-01-01\"\n },\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"subscriptionTypeId\": 2,\n \"subscriptionDescription\": \"AvaTaxPro\",\n \"effectiveDate\": \"2015-01-01\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"subscriptionTypeId\": 2,\n \"subscriptionDescription\": \"AvaTaxPro\",\n \"effectiveDate\": \"2015-01-01\"\n },\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"subscriptionTypeId\": 2,\n \"subscriptionDescription\": \"AvaTaxPro\",\n \"effectiveDate\": \"2015-01-01\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "subscriptions" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns this subscription." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"subscriptionTypeId\": 2,\n \"subscriptionDescription\": \"AvaTaxPro\",\n \"effectiveDate\": \"2015-01-01\"\n },\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"subscriptionTypeId\": 2,\n \"subscriptionDescription\": \"AvaTaxPro\",\n \"effectiveDate\": \"2015-01-01\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "subscriptions" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns this subscription." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"subscriptionTypeId\": 2,\n \"subscriptionDescription\": \"AvaTaxPro\",\n \"effectiveDate\": \"2015-01-01\"\n },\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"subscriptionTypeId\": 2,\n \"subscriptionDescription\": \"AvaTaxPro\",\n \"effectiveDate\": \"2015-01-01\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "subscriptions" ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account that owns this subscription." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "users", "item": [ { "name": "{id}", "item": [ { "name": "entitlements", "item": [ { "name": "Retrieve all entitlements for a single user", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/users/:id/entitlements", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "users", ":id", "entitlements" ], "variable": [ { "key": "accountId", "value": "451", "description": "The accountID of the user you wish to get." }, { "key": "id", "value": "451", "description": "The ID of the user to retrieve." } ] }, "description": "Return a list of all entitlements to which this user has rights to access.\r\nEntitlements are a list of specified API calls the user is permitted to make, a list of identifier numbers for companies the user is\r\nallowed to use, and an access level identifier that indicates what types of access roles the user is allowed to use.\r\nThis API call is intended to provide a validation endpoint to determine, before making an API call, whether this call is likely to succeed.\r\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\r\nentitlements and predict whether this call would succeed:\r\n \r\n* Retrieve entitlements by calling '/api/v2/accounts/999/users/567/entitlements' . If the call fails, you do not have accurate\r\n credentials for this user.\r\n* If the 'accessLevel' field within entitlements is 'None', the call will fail.\r\n* If the 'accessLevel' field within entitlements is 'SingleCompany' or 'SingleAccount', the call will fail if the companies\r\n table does not contain the ID number 12345.\r\n* If the 'permissions' array within entitlements does not contain 'AccountSvc.CompanySave', the call will fail.\r\n \r\nFor a full list of defined permissions, please use '/api/v2/definitions/permissions' .\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/users/:id/entitlements", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "users", ":id", "entitlements" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the user to retrieve." }, { "key": "accountId", "value": "451", "description": "The accountID of the user you wish to get." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"permissions\": [\n \"CompanyFetch\",\n \"CompanySave\",\n \"NexusFetch\",\n \"NexusSave\"\n ],\n \"accessLevel\": \"SingleAccount\",\n \"companies\": [\n 123,\n 456,\n 789\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/users/:id/entitlements", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "users", ":id", "entitlements" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the user to retrieve." }, { "key": "accountId", "value": "451", "description": "The accountID of the user you wish to get." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/users/:id/entitlements", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "users", ":id", "entitlements" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the user to retrieve." }, { "key": "accountId", "value": "451", "description": "The accountID of the user you wish to get." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/users/:id/entitlements", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "users", ":id", "entitlements" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the user to retrieve." }, { "key": "accountId", "value": "451", "description": "The accountID of the user you wish to get." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Retrieve a single user", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/users/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "users", ":id" ], "query": [ { "key": "$include", "value": "string", "description": "Optional fetch commands." } ], "variable": [ { "key": "accountId", "value": "451", "description": "The accountID of the user you wish to get." }, { "key": "id", "value": "451", "description": "The ID of the user to retrieve." } ] }, "description": "Get the user object identified by this URL.\r\nA user represents one person with access privileges to make API calls and work with a specific account.\r\n \r\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:\r\n \r\n* FetchDeleted\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/users/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "users", ":id" ], "query": [ { "description": "Optional fetch commands.", "key": "$include", "value": "string" } ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the user to retrieve." }, { "key": "accountId", "value": "451", "description": "The accountID of the user you wish to get." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 12345,\n \"accountId\": 123456789,\n \"companyId\": 123456,\n \"userName\": \"bobExample\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Example\",\n \"email\": \"bob@example.org\",\n \"postalCode\": \"98110\",\n \"securityRoleId\": \"AccountUser\",\n \"passwordStatus\": \"UserCanChange\",\n \"isActive\": true,\n \"suppressNewUserEmail\": false,\n \"isDeleted\": false\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/users/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "users", ":id" ], "query": [ { "description": "Optional fetch commands.", "key": "$include", "value": "string" } ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the user to retrieve." }, { "key": "accountId", "value": "451", "description": "The accountID of the user you wish to get." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/users/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "users", ":id" ], "query": [ { "description": "Optional fetch commands.", "key": "$include", "value": "string" } ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the user to retrieve." }, { "key": "accountId", "value": "451", "description": "The accountID of the user you wish to get." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/users/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "users", ":id" ], "query": [ { "description": "Optional fetch commands.", "key": "$include", "value": "string" } ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the user to retrieve." }, { "key": "accountId", "value": "451", "description": "The accountID of the user you wish to get." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Update a single user", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 12345,\n \"accountId\": 123456789,\n \"companyId\": 123456,\n \"userName\": \"bobExample\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Example\",\n \"email\": \"bob@example.org\",\n \"postalCode\": \"98110\",\n \"securityRoleId\": \"AccountUser\",\n \"passwordStatus\": \"UserCanChange\",\n \"isActive\": true,\n \"suppressNewUserEmail\": false,\n \"isDeleted\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/users/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "users", ":id" ], "variable": [ { "key": "accountId", "value": "451", "description": "The accountID of the user you wish to update." }, { "key": "id", "value": "451", "description": "The ID of the user you wish to update." } ] }, "description": "Replace the existing user object at this URL with an updated object.\r\nA user represents one person with access privileges to make API calls and work with a specific account.\r\nAll data from the existing object will be replaced with data in the object you PUT.\r\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.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 12345,\n \"accountId\": 123456789,\n \"companyId\": 123456,\n \"userName\": \"bobExample\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Example\",\n \"email\": \"bob@example.org\",\n \"postalCode\": \"98110\",\n \"securityRoleId\": \"AccountUser\",\n \"passwordStatus\": \"UserCanChange\",\n \"isActive\": true,\n \"suppressNewUserEmail\": false,\n \"isDeleted\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/users/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "users", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the user you wish to update." }, { "key": "accountId", "value": "451", "description": "The accountID of the user you wish to update." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 12345,\n \"accountId\": 123456789,\n \"companyId\": 123456,\n \"userName\": \"bobExample\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Example\",\n \"email\": \"bob@example.org\",\n \"postalCode\": \"98110\",\n \"securityRoleId\": \"AccountUser\",\n \"passwordStatus\": \"UserCanChange\",\n \"isActive\": true,\n \"suppressNewUserEmail\": false,\n \"isDeleted\": false\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 12345,\n \"accountId\": 123456789,\n \"companyId\": 123456,\n \"userName\": \"bobExample\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Example\",\n \"email\": \"bob@example.org\",\n \"postalCode\": \"98110\",\n \"securityRoleId\": \"AccountUser\",\n \"passwordStatus\": \"UserCanChange\",\n \"isActive\": true,\n \"suppressNewUserEmail\": false,\n \"isDeleted\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/users/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "users", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the user you wish to update." }, { "key": "accountId", "value": "451", "description": "The accountID of the user you wish to update." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 12345,\n \"accountId\": 123456789,\n \"companyId\": 123456,\n \"userName\": \"bobExample\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Example\",\n \"email\": \"bob@example.org\",\n \"postalCode\": \"98110\",\n \"securityRoleId\": \"AccountUser\",\n \"passwordStatus\": \"UserCanChange\",\n \"isActive\": true,\n \"suppressNewUserEmail\": false,\n \"isDeleted\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/users/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "users", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the user you wish to update." }, { "key": "accountId", "value": "451", "description": "The accountID of the user you wish to update." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 12345,\n \"accountId\": 123456789,\n \"companyId\": 123456,\n \"userName\": \"bobExample\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Example\",\n \"email\": \"bob@example.org\",\n \"postalCode\": \"98110\",\n \"securityRoleId\": \"AccountUser\",\n \"passwordStatus\": \"UserCanChange\",\n \"isActive\": true,\n \"suppressNewUserEmail\": false,\n \"isDeleted\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/users/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "users", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the user you wish to update." }, { "key": "accountId", "value": "451", "description": "The accountID of the user you wish to update." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete a single user", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/users/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "users", ":id" ], "variable": [ { "key": "accountId", "value": "451", "description": "The accountID of the user you wish to delete." }, { "key": "id", "value": "451", "description": "The ID of the user you wish to delete." } ] }, "description": "Mark the user object identified by this URL as deleted.\r\n \r\nThis API is available for use by account and company administrators only.\r\n \r\nAccount and company administrators may only delete users within the appropriate organizations\r\nthey control.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, Compliance Root User, CSPTester, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TreasuryAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/users/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "users", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the user you wish to delete." }, { "key": "accountId", "value": "451", "description": "The accountID of the user you wish to delete." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/users/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "users", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the user you wish to delete." }, { "key": "accountId", "value": "451", "description": "The accountID of the user you wish to delete." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/users/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "users", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the user you wish to delete." }, { "key": "accountId", "value": "451", "description": "The accountID of the user you wish to delete." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/users/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "users", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the user you wish to delete." }, { "key": "accountId", "value": "451", "description": "The accountID of the user you wish to delete." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Retrieve users for this account", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/users?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "users" ], "query": [ { "key": "$include", "value": "string", "description": "Optional fetch commands." }, { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* SuppressNewUserEmail" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "accountId", "value": "451", "description": "The accountID of the user you wish to list." } ] }, "description": "List all user objects attached to this account.\r\nA user represents one person with access privileges to make API calls and work with a specific account.\r\n \r\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.\r\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.\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\r\n \r\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:\r\n \r\n* FetchDeleted\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/users?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "users" ], "query": [ { "description": "Optional fetch commands.", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* SuppressNewUserEmail", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "accountId", "value": "451", "description": "The accountID of the user you wish to list." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 2171,\n \"value\": [\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"companyId\": 123456,\n \"userName\": \"bobExample\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Example\",\n \"email\": \"bob@example.org\",\n \"postalCode\": \"98110\",\n \"securityRoleId\": \"AccountUser\",\n \"passwordStatus\": \"UserCanChange\",\n \"isActive\": true,\n \"suppressNewUserEmail\": false,\n \"isDeleted\": false\n },\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"companyId\": 123456,\n \"userName\": \"bobExample\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Example\",\n \"email\": \"bob@example.org\",\n \"postalCode\": \"98110\",\n \"securityRoleId\": \"AccountUser\",\n \"passwordStatus\": \"UserCanChange\",\n \"isActive\": true,\n \"suppressNewUserEmail\": false,\n \"isDeleted\": false\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/users?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "users" ], "query": [ { "description": "Optional fetch commands.", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* SuppressNewUserEmail", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "accountId", "value": "451", "description": "The accountID of the user you wish to list." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/users?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "users" ], "query": [ { "description": "Optional fetch commands.", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* SuppressNewUserEmail", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "accountId", "value": "451", "description": "The accountID of the user you wish to list." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/users?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "users" ], "query": [ { "description": "Optional fetch commands.", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* SuppressNewUserEmail", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "accountId", "value": "451", "description": "The accountID of the user you wish to list." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Create new users", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"companyId\": 123456,\n \"userName\": \"bobExample\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Example\",\n \"email\": \"bob@example.org\",\n \"postalCode\": \"98110\",\n \"securityRoleId\": \"AccountUser\",\n \"passwordStatus\": \"UserCanChange\",\n \"isActive\": true,\n \"suppressNewUserEmail\": false,\n \"isDeleted\": false\n },\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"companyId\": 123456,\n \"userName\": \"bobExample\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Example\",\n \"email\": \"bob@example.org\",\n \"postalCode\": \"98110\",\n \"securityRoleId\": \"AccountUser\",\n \"passwordStatus\": \"UserCanChange\",\n \"isActive\": true,\n \"suppressNewUserEmail\": false,\n \"isDeleted\": false\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/users", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "users" ], "variable": [ { "key": "accountId", "value": "451", "description": "The unique ID number of the account where these users will be created." } ] }, "description": "Create one or more new user objects attached to this account.\r\n \r\nA user represents one person with access privileges to make API calls and work with a specific account.\r\n \r\nUsers who are account administrators or company users are permitted to create user records to invite\r\nadditional team members to work with AvaTax.\r\n \r\nA newly created user will receive an email inviting them to create their password. This means that you\r\nmust provide a valid email address for all user accounts created.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"companyId\": 123456,\n \"userName\": \"bobExample\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Example\",\n \"email\": \"bob@example.org\",\n \"postalCode\": \"98110\",\n \"securityRoleId\": \"AccountUser\",\n \"passwordStatus\": \"UserCanChange\",\n \"isActive\": true,\n \"suppressNewUserEmail\": false,\n \"isDeleted\": false\n },\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"companyId\": 123456,\n \"userName\": \"bobExample\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Example\",\n \"email\": \"bob@example.org\",\n \"postalCode\": \"98110\",\n \"securityRoleId\": \"AccountUser\",\n \"passwordStatus\": \"UserCanChange\",\n \"isActive\": true,\n \"suppressNewUserEmail\": false,\n \"isDeleted\": false\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/users", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "users" ], "variable": [ { "key": "accountId", "value": "451", "description": "The unique ID number of the account where these users will be created." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"companyId\": 123456,\n \"userName\": \"bobExample\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Example\",\n \"email\": \"bob@example.org\",\n \"postalCode\": \"98110\",\n \"securityRoleId\": \"AccountUser\",\n \"passwordStatus\": \"UserCanChange\",\n \"isActive\": true,\n \"suppressNewUserEmail\": false,\n \"isDeleted\": false\n },\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"companyId\": 123456,\n \"userName\": \"bobExample\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Example\",\n \"email\": \"bob@example.org\",\n \"postalCode\": \"98110\",\n \"securityRoleId\": \"AccountUser\",\n \"passwordStatus\": \"UserCanChange\",\n \"isActive\": true,\n \"suppressNewUserEmail\": false,\n \"isDeleted\": false\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"companyId\": 123456,\n \"userName\": \"bobExample\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Example\",\n \"email\": \"bob@example.org\",\n \"postalCode\": \"98110\",\n \"securityRoleId\": \"AccountUser\",\n \"passwordStatus\": \"UserCanChange\",\n \"isActive\": true,\n \"suppressNewUserEmail\": false,\n \"isDeleted\": false\n },\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"companyId\": 123456,\n \"userName\": \"bobExample\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Example\",\n \"email\": \"bob@example.org\",\n \"postalCode\": \"98110\",\n \"securityRoleId\": \"AccountUser\",\n \"passwordStatus\": \"UserCanChange\",\n \"isActive\": true,\n \"suppressNewUserEmail\": false,\n \"isDeleted\": false\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/users", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "users" ], "variable": [ { "key": "accountId", "value": "451", "description": "The unique ID number of the account where these users will be created." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"companyId\": 123456,\n \"userName\": \"bobExample\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Example\",\n \"email\": \"bob@example.org\",\n \"postalCode\": \"98110\",\n \"securityRoleId\": \"AccountUser\",\n \"passwordStatus\": \"UserCanChange\",\n \"isActive\": true,\n \"suppressNewUserEmail\": false,\n \"isDeleted\": false\n },\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"companyId\": 123456,\n \"userName\": \"bobExample\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Example\",\n \"email\": \"bob@example.org\",\n \"postalCode\": \"98110\",\n \"securityRoleId\": \"AccountUser\",\n \"passwordStatus\": \"UserCanChange\",\n \"isActive\": true,\n \"suppressNewUserEmail\": false,\n \"isDeleted\": false\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/users", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "users" ], "variable": [ { "key": "accountId", "value": "451", "description": "The unique ID number of the account where these users will be created." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"companyId\": 123456,\n \"userName\": \"bobExample\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Example\",\n \"email\": \"bob@example.org\",\n \"postalCode\": \"98110\",\n \"securityRoleId\": \"AccountUser\",\n \"passwordStatus\": \"UserCanChange\",\n \"isActive\": true,\n \"suppressNewUserEmail\": false,\n \"isDeleted\": false\n },\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"companyId\": 123456,\n \"userName\": \"bobExample\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Example\",\n \"email\": \"bob@example.org\",\n \"postalCode\": \"98110\",\n \"securityRoleId\": \"AccountUser\",\n \"passwordStatus\": \"UserCanChange\",\n \"isActive\": true,\n \"suppressNewUserEmail\": false,\n \"isDeleted\": false\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/:accountId/users", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", ":accountId", "users" ], "variable": [ { "key": "accountId", "value": "451", "description": "The unique ID number of the account where these users will be created." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "request", "item": [ { "name": "Request a new Avalara account", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"offer\": \"DeveloperDotAvalaraFreeTrial\",\n \"connectorId\": \"a0n4000000ChMwPAAV\",\n \"campaign\": \"70140000000TsVb\",\n \"leadSource\": \"Direct Visitor\",\n \"accountName\": \"BizTech Company Inc.\",\n \"website\": \"https://biztech.com\",\n \"paymentMethodId\": \"701abc-def\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Example\",\n \"email\": \"bob@example.org\",\n \"username\": \"bob\",\n \"welcomeEmail\": \"Normal\",\n \"companyAddress\": {\n \"line\": \"100 Ravine Ln\",\n \"region\": \"WA\",\n \"country\": \"US\",\n \"postalCode\": \"98010\"\n },\n \"acceptAvalaraTermsAndConditions\": true,\n \"haveReadAvalaraTermsAndConditions\": true,\n \"marketingContext\": {\n \"campaignId\": \"70140000000TsVb\",\n \"leadSource\": \"Direct Visitor\"\n },\n \"accountType\": \"Regular\",\n \"isTest\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/request", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", "request" ] }, "description": "This API is for use by partner provisioning services customers only.\r\n \r\nAvalara invites select partners to refer new customers to the AvaTax service using the onboarding features\r\nof AvaTax. These partners can create accounts for new customers using this API.\r\n \r\nCalling this API creates an account with the specified product subscriptions, but does not configure billing.\r\nThe customer will receive information from Avalara about how to configure billing for their account.\r\nYou should call this API when a customer has requested to begin using Avalara services.\r\n \r\nIf the newly created account owner wishes, they can confirm that they have read and agree to the Avalara\r\nterms and conditions. If they do so, they can receive a license key as part of this API and their\r\nAPI will be created in `Active` status. If the customer has not yet read and accepted these terms and\r\nconditions, the account will be created in `New` status and they can receive a license key by logging\r\nonto the AvaTax website and reviewing terms and conditions online.\r\n \r\nIn Sandbox environment, the account will always be created as a test account regardless of the IsTest\r\nparameter in the request.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n* This API is available by invitation only.\n* This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Provisioning:RequestNewAccount].\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"offer\": \"DeveloperDotAvalaraFreeTrial\",\n \"connectorId\": \"a0n4000000ChMwPAAV\",\n \"campaign\": \"70140000000TsVb\",\n \"leadSource\": \"Direct Visitor\",\n \"accountName\": \"BizTech Company Inc.\",\n \"website\": \"https://biztech.com\",\n \"paymentMethodId\": \"701abc-def\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Example\",\n \"email\": \"bob@example.org\",\n \"username\": \"bob\",\n \"welcomeEmail\": \"Normal\",\n \"companyAddress\": {\n \"line\": \"100 Ravine Ln\",\n \"region\": \"WA\",\n \"country\": \"US\",\n \"postalCode\": \"98010\"\n },\n \"acceptAvalaraTermsAndConditions\": true,\n \"haveReadAvalaraTermsAndConditions\": true,\n \"marketingContext\": {\n \"campaignId\": \"70140000000TsVb\",\n \"leadSource\": \"Direct Visitor\"\n },\n \"accountType\": \"Regular\",\n \"isTest\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/request", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", "request" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"accountId\": 123456789,\n \"accountDetailsEmailedTo\": \"bob@example.org\",\n \"createdDate\": \"0001-01-01T00:00:00\",\n \"emailedDate\": \"0001-01-01T00:00:00\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"offer\": \"DeveloperDotAvalaraFreeTrial\",\n \"connectorId\": \"a0n4000000ChMwPAAV\",\n \"campaign\": \"70140000000TsVb\",\n \"leadSource\": \"Direct Visitor\",\n \"accountName\": \"BizTech Company Inc.\",\n \"website\": \"https://biztech.com\",\n \"paymentMethodId\": \"701abc-def\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Example\",\n \"email\": \"bob@example.org\",\n \"username\": \"bob\",\n \"welcomeEmail\": \"Normal\",\n \"companyAddress\": {\n \"line\": \"100 Ravine Ln\",\n \"region\": \"WA\",\n \"country\": \"US\",\n \"postalCode\": \"98010\"\n },\n \"acceptAvalaraTermsAndConditions\": true,\n \"haveReadAvalaraTermsAndConditions\": true,\n \"marketingContext\": {\n \"campaignId\": \"70140000000TsVb\",\n \"leadSource\": \"Direct Visitor\"\n },\n \"accountType\": \"Regular\",\n \"isTest\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/request", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", "request" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"offer\": \"DeveloperDotAvalaraFreeTrial\",\n \"connectorId\": \"a0n4000000ChMwPAAV\",\n \"campaign\": \"70140000000TsVb\",\n \"leadSource\": \"Direct Visitor\",\n \"accountName\": \"BizTech Company Inc.\",\n \"website\": \"https://biztech.com\",\n \"paymentMethodId\": \"701abc-def\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Example\",\n \"email\": \"bob@example.org\",\n \"username\": \"bob\",\n \"welcomeEmail\": \"Normal\",\n \"companyAddress\": {\n \"line\": \"100 Ravine Ln\",\n \"region\": \"WA\",\n \"country\": \"US\",\n \"postalCode\": \"98010\"\n },\n \"acceptAvalaraTermsAndConditions\": true,\n \"haveReadAvalaraTermsAndConditions\": true,\n \"marketingContext\": {\n \"campaignId\": \"70140000000TsVb\",\n \"leadSource\": \"Direct Visitor\"\n },\n \"accountType\": \"Regular\",\n \"isTest\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts/request", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts", "request" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Retrieve all accounts", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts" ], "query": [ { "key": "$include", "value": "string", "description": "A comma separated list of objects to fetch underneath this account. Any object with a URL path underneath this account can be fetched by specifying its name." }, { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* subscriptions, users" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "List all account objects that can be seen by the current user.\r\n \r\nThis API lists all accounts you are allowed to see. In general, most users will only be able to see their own account.\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\r\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:\r\n \r\n* Subscriptions\r\n* Users\r\n \r\nFor more information about filtering in REST, please see the documentation at http://developer.avalara.com/avatax/filtering-in-rest/ .\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts" ], "query": [ { "description": "A comma separated list of objects to fetch underneath this account. Any object with a URL path underneath this account can be fetched by specifying its name.", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* subscriptions, users", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 2224,\n \"value\": [\n {\n \"id\": 12345,\n \"name\": \"Test Account\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"accountStatusId\": \"Test\",\n \"accountTypeId\": \"Regular\",\n \"isSamlEnabled\": false,\n \"isDeleted\": false\n },\n {\n \"id\": 12345,\n \"name\": \"Test Account\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"accountStatusId\": \"Test\",\n \"accountTypeId\": \"Regular\",\n \"isSamlEnabled\": false,\n \"isDeleted\": false\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts" ], "query": [ { "description": "A comma separated list of objects to fetch underneath this account. Any object with a URL path underneath this account can be fetched by specifying its name.", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* subscriptions, users", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/accounts?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts" ], "query": [ { "description": "A comma separated list of objects to fetch underneath this account. Any object with a URL path underneath this account can be fetched by specifying its name.", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* subscriptions, users", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Create a new account", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 12345,\n \"name\": \"Test Account\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"accountStatusId\": \"Test\",\n \"accountTypeId\": \"Regular\",\n \"isSamlEnabled\": false,\n \"isDeleted\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts" ] }, "description": "# For Registrar Use Only\r\nThis API is for use by Avalara Registrar administrative users only.\r\n \r\nCreate a single new account object.\r\nWhen creating an account object you may attach subscriptions and users as part of the 'Create' call.\n\n### Security Policies\n\n* This API requires one of the following user roles: BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 12345,\n \"name\": \"Test Account\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"accountStatusId\": \"Test\",\n \"accountTypeId\": \"Regular\",\n \"isSamlEnabled\": false,\n \"isDeleted\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": 12345,\n \"name\": \"Test Account\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"accountStatusId\": \"Test\",\n \"accountTypeId\": \"Regular\",\n \"isSamlEnabled\": false,\n \"isDeleted\": false\n },\n {\n \"id\": 12345,\n \"name\": \"Test Account\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"accountStatusId\": \"Test\",\n \"accountTypeId\": \"Regular\",\n \"isSamlEnabled\": false,\n \"isDeleted\": false\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 12345,\n \"name\": \"Test Account\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"accountStatusId\": \"Test\",\n \"accountTypeId\": \"Regular\",\n \"isSamlEnabled\": false,\n \"isDeleted\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 12345,\n \"name\": \"Test Account\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"accountStatusId\": \"Test\",\n \"accountTypeId\": \"Regular\",\n \"isSamlEnabled\": false,\n \"isDeleted\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/accounts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "accounts" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "addresses", "item": [ { "name": "resolve", "item": [ { "name": "Retrieve geolocation information for a specified US or Canadian address", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"line1\": \"2000 Main Street\",\n \"textCase\": \"Upper\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/addresses/resolve", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "addresses", "resolve" ] }, "description": "Resolve a US or Canadian address against Avalara's address validation system. Note that this API is \r\nvalid for US and Canadian addresses only. \r\n\r\nIf the address can be resolved, this API provides the latitude and longitude of the resolved location. \r\nThe value `resolutionQuality` can be used to identify how closely this address can be located. If the \r\naddress cannot be clearly located, use the `messages` structure to learn more about problems with this \r\naddress. This is the same API as the GET /api/v2/addresses/resolve endpoint.\r\nBoth verbs are supported to provide for flexible implementation.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AutoAddress.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"line1\": \"2000 Main Street\",\n \"textCase\": \"Upper\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/addresses/resolve", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "addresses", "resolve" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"address\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n },\n \"coordinates\": {\n \"latitude\": 33.684884,\n \"longitude\": -117.851321\n },\n \"resolutionQuality\": \"Intersection\",\n \"taxAuthorities\": [\n {\n \"avalaraId\": \"AGAM\",\n \"jurisdictionName\": \"CALIFORNIA\",\n \"jurisdictionType\": \"State\",\n \"signatureCode\": \"AGAM\"\n }\n ],\n \"messages\": [\n {\n \"summary\": \"The address is not deliverable.\",\n \"details\": \"The physical location exists but there are no homes on this street. One reason might be railroad tracks or rivers running alongside this street, as they would prevent construction of homes in this location.\",\n \"refersTo\": \"address\",\n \"severity\": \"Error\",\n \"source\": \"Avalara.AvaTax.Services.Address\"\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"line1\": \"2000 Main Street\",\n \"textCase\": \"Upper\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/addresses/resolve", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "addresses", "resolve" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"line1\": \"2000 Main Street\",\n \"textCase\": \"Upper\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/addresses/resolve", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "addresses", "resolve" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Retrieve geolocation information for a specified US or Canadian address", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/addresses/resolve?line1=string&line2=string&line3=string&city=string®ion=string&postalCode=string&country=string&textCase=Mixed", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "addresses", "resolve" ], "query": [ { "key": "line1", "value": "string", "description": "Line 1" }, { "key": "line2", "value": "string", "description": "Line 2" }, { "key": "line3", "value": "string", "description": "Line 3" }, { "key": "city", "value": "string", "description": "City" }, { "key": "region", "value": "string", "description": "State / Province / Region" }, { "key": "postalCode", "value": "string", "description": "Postal Code / Zip Code" }, { "key": "country", "value": "string", "description": "Two character ISO 3166 Country Code (see /api/v2/definitions/countries for a full list)" }, { "key": "textCase", "value": "Mixed", "description": "selectable text case for address validation" } ] }, "description": "Resolve a US or Canadian address against Avalara's address validation system. Note that this API is \r\nvalid for US and Canadian addresses only. \r\n\r\nIf the address can be resolved, this API provides the latitude and longitude of the resolved location. \r\nThe value `resolutionQuality` can be used to identify how closely this address can be located. If the \r\naddress cannot be clearly located, use the `messages` structure to learn more about problems with this address.\r\nThis is the same API as the POST /api/v2/addresses/resolve endpoint.\r\nBoth verbs are supported to provide for flexible implementation.\r\n \r\nIn order to get any evaluation for an address, please provide at least one of the following fields/pairs:\r\n1. postal code\r\n2. line1 + city + region\r\n3. line1 + postal code\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AutoAddress.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/addresses/resolve?line1=string&line2=string&line3=string&city=string®ion=string&postalCode=string&country=string&textCase=Mixed", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "addresses", "resolve" ], "query": [ { "description": "Line 1", "key": "line1", "value": "string" }, { "description": "Line 2", "key": "line2", "value": "string" }, { "description": "Line 3", "key": "line3", "value": "string" }, { "description": "City", "key": "city", "value": "string" }, { "description": "State / Province / Region", "key": "region", "value": "string" }, { "description": "Postal Code / Zip Code", "key": "postalCode", "value": "string" }, { "description": "Two character ISO 3166 Country Code (see /api/v2/definitions/countries for a full list)", "key": "country", "value": "string" }, { "description": "selectable text case for address validation", "key": "textCase", "value": "Mixed" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"address\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n },\n \"coordinates\": {\n \"latitude\": 33.684884,\n \"longitude\": -117.851321\n },\n \"resolutionQuality\": \"Intersection\",\n \"taxAuthorities\": [\n {\n \"avalaraId\": \"AGAM\",\n \"jurisdictionName\": \"CALIFORNIA\",\n \"jurisdictionType\": \"State\",\n \"signatureCode\": \"AGAM\"\n }\n ],\n \"messages\": [\n {\n \"summary\": \"The address is not deliverable.\",\n \"details\": \"The physical location exists but there are no homes on this street. One reason might be railroad tracks or rivers running alongside this street, as they would prevent construction of homes in this location.\",\n \"refersTo\": \"address\",\n \"severity\": \"Error\",\n \"source\": \"Avalara.AvaTax.Services.Address\"\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/addresses/resolve?line1=string&line2=string&line3=string&city=string®ion=string&postalCode=string&country=string&textCase=Mixed", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "addresses", "resolve" ], "query": [ { "description": "Line 1", "key": "line1", "value": "string" }, { "description": "Line 2", "key": "line2", "value": "string" }, { "description": "Line 3", "key": "line3", "value": "string" }, { "description": "City", "key": "city", "value": "string" }, { "description": "State / Province / Region", "key": "region", "value": "string" }, { "description": "Postal Code / Zip Code", "key": "postalCode", "value": "string" }, { "description": "Two character ISO 3166 Country Code (see /api/v2/definitions/countries for a full list)", "key": "country", "value": "string" }, { "description": "selectable text case for address validation", "key": "textCase", "value": "Mixed" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/addresses/resolve?line1=string&line2=string&line3=string&city=string®ion=string&postalCode=string&country=string&textCase=Mixed", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "addresses", "resolve" ], "query": [ { "description": "Line 1", "key": "line1", "value": "string" }, { "description": "Line 2", "key": "line2", "value": "string" }, { "description": "Line 3", "key": "line3", "value": "string" }, { "description": "City", "key": "city", "value": "string" }, { "description": "State / Province / Region", "key": "region", "value": "string" }, { "description": "Postal Code / Zip Code", "key": "postalCode", "value": "string" }, { "description": "Two character ISO 3166 Country Code (see /api/v2/definitions/countries for a full list)", "key": "country", "value": "string" }, { "description": "selectable text case for address validation", "key": "textCase", "value": "Mixed" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "apconfigsetting", "item": [ { "name": "Retrieve all rules", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/apconfigsetting?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "apconfigsetting" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* meta, amount, amountToMarkForReview, ignoreThresholdWhenVCTZero, varianceForIgnore, varianceForAccrue, variancePercent, apConfigToleranceType, payAsBilledNoAccrual, payAsBilledAccrueUndercharge, shortPayItemsAccrueUndercharge, markForReviewUndercharge, rejectUndercharge, payAsBilledOvercharge, shortPayAvalaraCalculated, shortPayItemsAccrueOvercharge, markForReviewOvercharge, rejectOvercharge, isActive" }, { "key": "$include", "value": "string", "description": "A comma separated list of additional data to retrieve." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/apconfigsetting?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "apconfigsetting" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* meta, amount, amountToMarkForReview, ignoreThresholdWhenVCTZero, varianceForIgnore, varianceForAccrue, variancePercent, apConfigToleranceType, payAsBilledNoAccrual, payAsBilledAccrueUndercharge, shortPayItemsAccrueUndercharge, markForReviewUndercharge, rejectUndercharge, payAsBilledOvercharge, shortPayAvalaraCalculated, shortPayItemsAccrueOvercharge, markForReviewOvercharge, rejectOvercharge, isActive", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 1251,\n \"value\": [\n {\n \"ruleId\": 0,\n \"companyId\": 1,\n \"meta\": {\n \"createdDate\": \"0001-01-01\",\n \"modifiedDate\": \"0001-01-01\"\n },\n \"amount\": 1000,\n \"amountToMarkForReview\": 2000,\n \"ignoreThresholdWhenVCTZero\": true,\n \"varianceForIgnore\": 100,\n \"varianceForAccrue\": 100,\n \"variancePercent\": 10,\n \"apConfigToleranceType\": \"Batch\",\n \"payAsBilledNoAccrual\": 1,\n \"payAsBilledAccrueUndercharge\": 2,\n \"shortPayItemsAccrueUndercharge\": 3,\n \"markForReviewUndercharge\": 4,\n \"rejectUndercharge\": 5,\n \"payAsBilledOvercharge\": 1,\n \"shortPayAvalaraCalculated\": 2,\n \"shortPayItemsAccrueOvercharge\": 3,\n \"markForReviewOvercharge\": 4,\n \"rejectOvercharge\": 5,\n \"isActive\": false\n },\n {\n \"ruleId\": 0,\n \"companyId\": 1,\n \"meta\": {\n \"createdDate\": \"0001-01-01\",\n \"modifiedDate\": \"0001-01-01\"\n },\n \"amount\": 1000,\n \"amountToMarkForReview\": 2000,\n \"ignoreThresholdWhenVCTZero\": true,\n \"varianceForIgnore\": 100,\n \"varianceForAccrue\": 100,\n \"variancePercent\": 10,\n \"apConfigToleranceType\": \"Batch\",\n \"payAsBilledNoAccrual\": 1,\n \"payAsBilledAccrueUndercharge\": 2,\n \"shortPayItemsAccrueUndercharge\": 3,\n \"markForReviewUndercharge\": 4,\n \"rejectUndercharge\": 5,\n \"payAsBilledOvercharge\": 1,\n \"shortPayAvalaraCalculated\": 2,\n \"shortPayItemsAccrueOvercharge\": 3,\n \"markForReviewOvercharge\": 4,\n \"rejectOvercharge\": 5,\n \"isActive\": false\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/apconfigsetting?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "apconfigsetting" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* meta, amount, amountToMarkForReview, ignoreThresholdWhenVCTZero, varianceForIgnore, varianceForAccrue, variancePercent, apConfigToleranceType, payAsBilledNoAccrual, payAsBilledAccrueUndercharge, shortPayItemsAccrueUndercharge, markForReviewUndercharge, rejectUndercharge, payAsBilledOvercharge, shortPayAvalaraCalculated, shortPayItemsAccrueOvercharge, markForReviewOvercharge, rejectOvercharge, isActive", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/apconfigsetting?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "apconfigsetting" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* meta, amount, amountToMarkForReview, ignoreThresholdWhenVCTZero, varianceForIgnore, varianceForAccrue, variancePercent, apConfigToleranceType, payAsBilledNoAccrual, payAsBilledAccrueUndercharge, shortPayItemsAccrueUndercharge, markForReviewUndercharge, rejectUndercharge, payAsBilledOvercharge, shortPayAvalaraCalculated, shortPayItemsAccrueOvercharge, markForReviewOvercharge, rejectOvercharge, isActive", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/apconfigsetting?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "apconfigsetting" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* meta, amount, amountToMarkForReview, ignoreThresholdWhenVCTZero, varianceForIgnore, varianceForAccrue, variancePercent, apConfigToleranceType, payAsBilledNoAccrual, payAsBilledAccrueUndercharge, shortPayItemsAccrueUndercharge, markForReviewUndercharge, rejectUndercharge, payAsBilledOvercharge, shortPayAvalaraCalculated, shortPayItemsAccrueOvercharge, markForReviewOvercharge, rejectOvercharge, isActive", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/apconfigsetting?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "apconfigsetting" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* meta, amount, amountToMarkForReview, ignoreThresholdWhenVCTZero, varianceForIgnore, varianceForAccrue, variancePercent, apConfigToleranceType, payAsBilledNoAccrual, payAsBilledAccrueUndercharge, shortPayItemsAccrueUndercharge, markForReviewUndercharge, rejectUndercharge, payAsBilledOvercharge, shortPayAvalaraCalculated, shortPayItemsAccrueOvercharge, markForReviewOvercharge, rejectOvercharge, isActive", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Conflict", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/apconfigsetting?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "apconfigsetting" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* meta, amount, amountToMarkForReview, ignoreThresholdWhenVCTZero, varianceForIgnore, varianceForAccrue, variancePercent, apConfigToleranceType, payAsBilledNoAccrual, payAsBilledAccrueUndercharge, shortPayItemsAccrueUndercharge, markForReviewUndercharge, rejectUndercharge, payAsBilledOvercharge, shortPayAvalaraCalculated, shortPayItemsAccrueOvercharge, markForReviewOvercharge, rejectOvercharge, isActive", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/apconfigsetting?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "apconfigsetting" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* meta, amount, amountToMarkForReview, ignoreThresholdWhenVCTZero, varianceForIgnore, varianceForAccrue, variancePercent, apConfigToleranceType, payAsBilledNoAccrual, payAsBilledAccrueUndercharge, shortPayItemsAccrueUndercharge, markForReviewUndercharge, rejectUndercharge, payAsBilledOvercharge, shortPayAvalaraCalculated, shortPayItemsAccrueOvercharge, markForReviewOvercharge, rejectOvercharge, isActive", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" } ] } ] }, { "name": "companies", "item": [ { "name": "{companyid}", "item": [ { "name": "apconfigsetting", "item": [ { "name": "Create new rule", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": 1000,\n \"amountToMarkForReview\": 2000,\n \"ignoreThresholdWhenVCTZero\": true,\n \"varianceForIgnore\": 100,\n \"varianceForAccrue\": 100,\n \"variancePercent\": 10,\n \"apConfigToleranceType\": \"Batch\",\n \"payAsBilledNoAccrual\": 1,\n \"payAsBilledAccrueUndercharge\": 2,\n \"shortPayItemsAccrueUndercharge\": 3,\n \"markForReviewUndercharge\": 4,\n \"rejectUndercharge\": 5,\n \"payAsBilledOvercharge\": 1,\n \"shortPayAvalaraCalculated\": 2,\n \"shortPayItemsAccrueOvercharge\": 3,\n \"markForReviewOvercharge\": 4,\n \"rejectOvercharge\": 5,\n \"isActive\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/apconfigsetting", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "apconfigsetting" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this AP Config Setting object" } ] } }, "response": [ { "name": "Created", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"amount\": 1000,\n \"amountToMarkForReview\": 2000,\n \"ignoreThresholdWhenVCTZero\": true,\n \"varianceForIgnore\": 100,\n \"varianceForAccrue\": 100,\n \"variancePercent\": 10,\n \"apConfigToleranceType\": \"Batch\",\n \"payAsBilledNoAccrual\": 1,\n \"payAsBilledAccrueUndercharge\": 2,\n \"shortPayItemsAccrueUndercharge\": 3,\n \"markForReviewUndercharge\": 4,\n \"rejectUndercharge\": 5,\n \"payAsBilledOvercharge\": 1,\n \"shortPayAvalaraCalculated\": 2,\n \"shortPayItemsAccrueOvercharge\": 3,\n \"markForReviewOvercharge\": 4,\n \"rejectOvercharge\": 5,\n \"isActive\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/apconfigsetting", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "apconfigsetting" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this AP Config Setting object" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"ruleId\": 0,\n \"companyId\": 1,\n \"meta\": {\n \"createdDate\": \"0001-01-01\",\n \"modifiedDate\": \"0001-01-01\"\n },\n \"amount\": 1000,\n \"amountToMarkForReview\": 2000,\n \"ignoreThresholdWhenVCTZero\": true,\n \"varianceForIgnore\": 100,\n \"varianceForAccrue\": 100,\n \"variancePercent\": 10,\n \"apConfigToleranceType\": \"Batch\",\n \"payAsBilledNoAccrual\": 1,\n \"payAsBilledAccrueUndercharge\": 2,\n \"shortPayItemsAccrueUndercharge\": 3,\n \"markForReviewUndercharge\": 4,\n \"rejectUndercharge\": 5,\n \"payAsBilledOvercharge\": 1,\n \"shortPayAvalaraCalculated\": 2,\n \"shortPayItemsAccrueOvercharge\": 3,\n \"markForReviewOvercharge\": 4,\n \"rejectOvercharge\": 5,\n \"isActive\": false\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"amount\": 1000,\n \"amountToMarkForReview\": 2000,\n \"ignoreThresholdWhenVCTZero\": true,\n \"varianceForIgnore\": 100,\n \"varianceForAccrue\": 100,\n \"variancePercent\": 10,\n \"apConfigToleranceType\": \"Batch\",\n \"payAsBilledNoAccrual\": 1,\n \"payAsBilledAccrueUndercharge\": 2,\n \"shortPayItemsAccrueUndercharge\": 3,\n \"markForReviewUndercharge\": 4,\n \"rejectUndercharge\": 5,\n \"payAsBilledOvercharge\": 1,\n \"shortPayAvalaraCalculated\": 2,\n \"shortPayItemsAccrueOvercharge\": 3,\n \"markForReviewOvercharge\": 4,\n \"rejectOvercharge\": 5,\n \"isActive\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/apconfigsetting", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "apconfigsetting" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this AP Config Setting object" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"amount\": 1000,\n \"amountToMarkForReview\": 2000,\n \"ignoreThresholdWhenVCTZero\": true,\n \"varianceForIgnore\": 100,\n \"varianceForAccrue\": 100,\n \"variancePercent\": 10,\n \"apConfigToleranceType\": \"Batch\",\n \"payAsBilledNoAccrual\": 1,\n \"payAsBilledAccrueUndercharge\": 2,\n \"shortPayItemsAccrueUndercharge\": 3,\n \"markForReviewUndercharge\": 4,\n \"rejectUndercharge\": 5,\n \"payAsBilledOvercharge\": 1,\n \"shortPayAvalaraCalculated\": 2,\n \"shortPayItemsAccrueOvercharge\": 3,\n \"markForReviewOvercharge\": 4,\n \"rejectOvercharge\": 5,\n \"isActive\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/apconfigsetting", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "apconfigsetting" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this AP Config Setting object" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"amount\": 1000,\n \"amountToMarkForReview\": 2000,\n \"ignoreThresholdWhenVCTZero\": true,\n \"varianceForIgnore\": 100,\n \"varianceForAccrue\": 100,\n \"variancePercent\": 10,\n \"apConfigToleranceType\": \"Batch\",\n \"payAsBilledNoAccrual\": 1,\n \"payAsBilledAccrueUndercharge\": 2,\n \"shortPayItemsAccrueUndercharge\": 3,\n \"markForReviewUndercharge\": 4,\n \"rejectUndercharge\": 5,\n \"payAsBilledOvercharge\": 1,\n \"shortPayAvalaraCalculated\": 2,\n \"shortPayItemsAccrueOvercharge\": 3,\n \"markForReviewOvercharge\": 4,\n \"rejectOvercharge\": 5,\n \"isActive\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/apconfigsetting", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "apconfigsetting" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this AP Config Setting object" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"amount\": 1000,\n \"amountToMarkForReview\": 2000,\n \"ignoreThresholdWhenVCTZero\": true,\n \"varianceForIgnore\": 100,\n \"varianceForAccrue\": 100,\n \"variancePercent\": 10,\n \"apConfigToleranceType\": \"Batch\",\n \"payAsBilledNoAccrual\": 1,\n \"payAsBilledAccrueUndercharge\": 2,\n \"shortPayItemsAccrueUndercharge\": 3,\n \"markForReviewUndercharge\": 4,\n \"rejectUndercharge\": 5,\n \"payAsBilledOvercharge\": 1,\n \"shortPayAvalaraCalculated\": 2,\n \"shortPayItemsAccrueOvercharge\": 3,\n \"markForReviewOvercharge\": 4,\n \"rejectOvercharge\": 5,\n \"isActive\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/apconfigsetting", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "apconfigsetting" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this AP Config Setting object" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Conflict", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"amount\": 1000,\n \"amountToMarkForReview\": 2000,\n \"ignoreThresholdWhenVCTZero\": true,\n \"varianceForIgnore\": 100,\n \"varianceForAccrue\": 100,\n \"variancePercent\": 10,\n \"apConfigToleranceType\": \"Batch\",\n \"payAsBilledNoAccrual\": 1,\n \"payAsBilledAccrueUndercharge\": 2,\n \"shortPayItemsAccrueUndercharge\": 3,\n \"markForReviewUndercharge\": 4,\n \"rejectUndercharge\": 5,\n \"payAsBilledOvercharge\": 1,\n \"shortPayAvalaraCalculated\": 2,\n \"shortPayItemsAccrueOvercharge\": 3,\n \"markForReviewOvercharge\": 4,\n \"rejectOvercharge\": 5,\n \"isActive\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/apconfigsetting", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "apconfigsetting" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this AP Config Setting object" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Server Error", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"amount\": 1000,\n \"amountToMarkForReview\": 2000,\n \"ignoreThresholdWhenVCTZero\": true,\n \"varianceForIgnore\": 100,\n \"varianceForAccrue\": 100,\n \"variancePercent\": 10,\n \"apConfigToleranceType\": \"Batch\",\n \"payAsBilledNoAccrual\": 1,\n \"payAsBilledAccrueUndercharge\": 2,\n \"shortPayItemsAccrueUndercharge\": 3,\n \"markForReviewUndercharge\": 4,\n \"rejectUndercharge\": 5,\n \"payAsBilledOvercharge\": 1,\n \"shortPayAvalaraCalculated\": 2,\n \"shortPayItemsAccrueOvercharge\": 3,\n \"markForReviewOvercharge\": 4,\n \"rejectOvercharge\": 5,\n \"isActive\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/apconfigsetting", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "apconfigsetting" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this AP Config Setting object" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" } ] }, { "name": "Update a AP config setting", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": 1000,\n \"amountToMarkForReview\": 2000,\n \"ignoreThresholdWhenVCTZero\": true,\n \"varianceForIgnore\": 100,\n \"varianceForAccrue\": 100,\n \"variancePercent\": 10,\n \"apConfigToleranceType\": \"Batch\",\n \"payAsBilledNoAccrual\": 1,\n \"payAsBilledAccrueUndercharge\": 2,\n \"shortPayItemsAccrueUndercharge\": 3,\n \"markForReviewUndercharge\": 4,\n \"rejectUndercharge\": 5,\n \"payAsBilledOvercharge\": 1,\n \"shortPayAvalaraCalculated\": 2,\n \"shortPayItemsAccrueOvercharge\": 3,\n \"markForReviewOvercharge\": 4,\n \"rejectOvercharge\": 5,\n \"isActive\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/apconfigsetting", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "apconfigsetting" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this AP config setting object" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"amount\": 1000,\n \"amountToMarkForReview\": 2000,\n \"ignoreThresholdWhenVCTZero\": true,\n \"varianceForIgnore\": 100,\n \"varianceForAccrue\": 100,\n \"variancePercent\": 10,\n \"apConfigToleranceType\": \"Batch\",\n \"payAsBilledNoAccrual\": 1,\n \"payAsBilledAccrueUndercharge\": 2,\n \"shortPayItemsAccrueUndercharge\": 3,\n \"markForReviewUndercharge\": 4,\n \"rejectUndercharge\": 5,\n \"payAsBilledOvercharge\": 1,\n \"shortPayAvalaraCalculated\": 2,\n \"shortPayItemsAccrueOvercharge\": 3,\n \"markForReviewOvercharge\": 4,\n \"rejectOvercharge\": 5,\n \"isActive\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/apconfigsetting", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "apconfigsetting" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this AP config setting object" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"ruleId\": 0,\n \"companyId\": 1,\n \"meta\": {\n \"createdDate\": \"0001-01-01\",\n \"modifiedDate\": \"0001-01-01\"\n },\n \"amount\": 1000,\n \"amountToMarkForReview\": 2000,\n \"ignoreThresholdWhenVCTZero\": true,\n \"varianceForIgnore\": 100,\n \"varianceForAccrue\": 100,\n \"variancePercent\": 10,\n \"apConfigToleranceType\": \"Batch\",\n \"payAsBilledNoAccrual\": 1,\n \"payAsBilledAccrueUndercharge\": 2,\n \"shortPayItemsAccrueUndercharge\": 3,\n \"markForReviewUndercharge\": 4,\n \"rejectUndercharge\": 5,\n \"payAsBilledOvercharge\": 1,\n \"shortPayAvalaraCalculated\": 2,\n \"shortPayItemsAccrueOvercharge\": 3,\n \"markForReviewOvercharge\": 4,\n \"rejectOvercharge\": 5,\n \"isActive\": false\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"amount\": 1000,\n \"amountToMarkForReview\": 2000,\n \"ignoreThresholdWhenVCTZero\": true,\n \"varianceForIgnore\": 100,\n \"varianceForAccrue\": 100,\n \"variancePercent\": 10,\n \"apConfigToleranceType\": \"Batch\",\n \"payAsBilledNoAccrual\": 1,\n \"payAsBilledAccrueUndercharge\": 2,\n \"shortPayItemsAccrueUndercharge\": 3,\n \"markForReviewUndercharge\": 4,\n \"rejectUndercharge\": 5,\n \"payAsBilledOvercharge\": 1,\n \"shortPayAvalaraCalculated\": 2,\n \"shortPayItemsAccrueOvercharge\": 3,\n \"markForReviewOvercharge\": 4,\n \"rejectOvercharge\": 5,\n \"isActive\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/apconfigsetting", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "apconfigsetting" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this AP config setting object" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"amount\": 1000,\n \"amountToMarkForReview\": 2000,\n \"ignoreThresholdWhenVCTZero\": true,\n \"varianceForIgnore\": 100,\n \"varianceForAccrue\": 100,\n \"variancePercent\": 10,\n \"apConfigToleranceType\": \"Batch\",\n \"payAsBilledNoAccrual\": 1,\n \"payAsBilledAccrueUndercharge\": 2,\n \"shortPayItemsAccrueUndercharge\": 3,\n \"markForReviewUndercharge\": 4,\n \"rejectUndercharge\": 5,\n \"payAsBilledOvercharge\": 1,\n \"shortPayAvalaraCalculated\": 2,\n \"shortPayItemsAccrueOvercharge\": 3,\n \"markForReviewOvercharge\": 4,\n \"rejectOvercharge\": 5,\n \"isActive\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/apconfigsetting", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "apconfigsetting" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this AP config setting object" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Forbidden", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"amount\": 1000,\n \"amountToMarkForReview\": 2000,\n \"ignoreThresholdWhenVCTZero\": true,\n \"varianceForIgnore\": 100,\n \"varianceForAccrue\": 100,\n \"variancePercent\": 10,\n \"apConfigToleranceType\": \"Batch\",\n \"payAsBilledNoAccrual\": 1,\n \"payAsBilledAccrueUndercharge\": 2,\n \"shortPayItemsAccrueUndercharge\": 3,\n \"markForReviewUndercharge\": 4,\n \"rejectUndercharge\": 5,\n \"payAsBilledOvercharge\": 1,\n \"shortPayAvalaraCalculated\": 2,\n \"shortPayItemsAccrueOvercharge\": 3,\n \"markForReviewOvercharge\": 4,\n \"rejectOvercharge\": 5,\n \"isActive\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/apconfigsetting", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "apconfigsetting" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this AP config setting object" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"amount\": 1000,\n \"amountToMarkForReview\": 2000,\n \"ignoreThresholdWhenVCTZero\": true,\n \"varianceForIgnore\": 100,\n \"varianceForAccrue\": 100,\n \"variancePercent\": 10,\n \"apConfigToleranceType\": \"Batch\",\n \"payAsBilledNoAccrual\": 1,\n \"payAsBilledAccrueUndercharge\": 2,\n \"shortPayItemsAccrueUndercharge\": 3,\n \"markForReviewUndercharge\": 4,\n \"rejectUndercharge\": 5,\n \"payAsBilledOvercharge\": 1,\n \"shortPayAvalaraCalculated\": 2,\n \"shortPayItemsAccrueOvercharge\": 3,\n \"markForReviewOvercharge\": 4,\n \"rejectOvercharge\": 5,\n \"isActive\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/apconfigsetting", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "apconfigsetting" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this AP config setting object" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Conflict", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"amount\": 1000,\n \"amountToMarkForReview\": 2000,\n \"ignoreThresholdWhenVCTZero\": true,\n \"varianceForIgnore\": 100,\n \"varianceForAccrue\": 100,\n \"variancePercent\": 10,\n \"apConfigToleranceType\": \"Batch\",\n \"payAsBilledNoAccrual\": 1,\n \"payAsBilledAccrueUndercharge\": 2,\n \"shortPayItemsAccrueUndercharge\": 3,\n \"markForReviewUndercharge\": 4,\n \"rejectUndercharge\": 5,\n \"payAsBilledOvercharge\": 1,\n \"shortPayAvalaraCalculated\": 2,\n \"shortPayItemsAccrueOvercharge\": 3,\n \"markForReviewOvercharge\": 4,\n \"rejectOvercharge\": 5,\n \"isActive\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/apconfigsetting", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "apconfigsetting" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this AP config setting object" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Server Error", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"amount\": 1000,\n \"amountToMarkForReview\": 2000,\n \"ignoreThresholdWhenVCTZero\": true,\n \"varianceForIgnore\": 100,\n \"varianceForAccrue\": 100,\n \"variancePercent\": 10,\n \"apConfigToleranceType\": \"Batch\",\n \"payAsBilledNoAccrual\": 1,\n \"payAsBilledAccrueUndercharge\": 2,\n \"shortPayItemsAccrueUndercharge\": 3,\n \"markForReviewUndercharge\": 4,\n \"rejectUndercharge\": 5,\n \"payAsBilledOvercharge\": 1,\n \"shortPayAvalaraCalculated\": 2,\n \"shortPayItemsAccrueOvercharge\": 3,\n \"markForReviewOvercharge\": 4,\n \"rejectOvercharge\": 5,\n \"isActive\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/apconfigsetting", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "apconfigsetting" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this AP config setting object" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" } ] }, { "name": "Retrieve rule for this company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/apconfigsetting?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "apconfigsetting" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* meta, amount, amountToMarkForReview, ignoreThresholdWhenVCTZero, varianceForIgnore, varianceForAccrue, variancePercent, apConfigToleranceType, payAsBilledNoAccrual, payAsBilledAccrueUndercharge, shortPayItemsAccrueUndercharge, markForReviewUndercharge, rejectUndercharge, payAsBilledOvercharge, shortPayAvalaraCalculated, shortPayItemsAccrueOvercharge, markForReviewOvercharge, rejectOvercharge, isActive" }, { "key": "$include", "value": "string", "description": "A comma separated list of additional data to retrieve." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that defined this rule" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/apconfigsetting?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "apconfigsetting" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* meta, amount, amountToMarkForReview, ignoreThresholdWhenVCTZero, varianceForIgnore, varianceForAccrue, variancePercent, apConfigToleranceType, payAsBilledNoAccrual, payAsBilledAccrueUndercharge, shortPayItemsAccrueUndercharge, markForReviewUndercharge, rejectUndercharge, payAsBilledOvercharge, shortPayAvalaraCalculated, shortPayItemsAccrueOvercharge, markForReviewOvercharge, rejectOvercharge, isActive", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that defined this rule" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 1251,\n \"value\": [\n {\n \"ruleId\": 0,\n \"companyId\": 1,\n \"meta\": {\n \"createdDate\": \"0001-01-01\",\n \"modifiedDate\": \"0001-01-01\"\n },\n \"amount\": 1000,\n \"amountToMarkForReview\": 2000,\n \"ignoreThresholdWhenVCTZero\": true,\n \"varianceForIgnore\": 100,\n \"varianceForAccrue\": 100,\n \"variancePercent\": 10,\n \"apConfigToleranceType\": \"Batch\",\n \"payAsBilledNoAccrual\": 1,\n \"payAsBilledAccrueUndercharge\": 2,\n \"shortPayItemsAccrueUndercharge\": 3,\n \"markForReviewUndercharge\": 4,\n \"rejectUndercharge\": 5,\n \"payAsBilledOvercharge\": 1,\n \"shortPayAvalaraCalculated\": 2,\n \"shortPayItemsAccrueOvercharge\": 3,\n \"markForReviewOvercharge\": 4,\n \"rejectOvercharge\": 5,\n \"isActive\": false\n },\n {\n \"ruleId\": 0,\n \"companyId\": 1,\n \"meta\": {\n \"createdDate\": \"0001-01-01\",\n \"modifiedDate\": \"0001-01-01\"\n },\n \"amount\": 1000,\n \"amountToMarkForReview\": 2000,\n \"ignoreThresholdWhenVCTZero\": true,\n \"varianceForIgnore\": 100,\n \"varianceForAccrue\": 100,\n \"variancePercent\": 10,\n \"apConfigToleranceType\": \"Batch\",\n \"payAsBilledNoAccrual\": 1,\n \"payAsBilledAccrueUndercharge\": 2,\n \"shortPayItemsAccrueUndercharge\": 3,\n \"markForReviewUndercharge\": 4,\n \"rejectUndercharge\": 5,\n \"payAsBilledOvercharge\": 1,\n \"shortPayAvalaraCalculated\": 2,\n \"shortPayItemsAccrueOvercharge\": 3,\n \"markForReviewOvercharge\": 4,\n \"rejectOvercharge\": 5,\n \"isActive\": false\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/apconfigsetting?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "apconfigsetting" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* meta, amount, amountToMarkForReview, ignoreThresholdWhenVCTZero, varianceForIgnore, varianceForAccrue, variancePercent, apConfigToleranceType, payAsBilledNoAccrual, payAsBilledAccrueUndercharge, shortPayItemsAccrueUndercharge, markForReviewUndercharge, rejectUndercharge, payAsBilledOvercharge, shortPayAvalaraCalculated, shortPayItemsAccrueOvercharge, markForReviewOvercharge, rejectOvercharge, isActive", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that defined this rule" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/apconfigsetting?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "apconfigsetting" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* meta, amount, amountToMarkForReview, ignoreThresholdWhenVCTZero, varianceForIgnore, varianceForAccrue, variancePercent, apConfigToleranceType, payAsBilledNoAccrual, payAsBilledAccrueUndercharge, shortPayItemsAccrueUndercharge, markForReviewUndercharge, rejectUndercharge, payAsBilledOvercharge, shortPayAvalaraCalculated, shortPayItemsAccrueOvercharge, markForReviewOvercharge, rejectOvercharge, isActive", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that defined this rule" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/apconfigsetting?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "apconfigsetting" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* meta, amount, amountToMarkForReview, ignoreThresholdWhenVCTZero, varianceForIgnore, varianceForAccrue, variancePercent, apConfigToleranceType, payAsBilledNoAccrual, payAsBilledAccrueUndercharge, shortPayItemsAccrueUndercharge, markForReviewUndercharge, rejectUndercharge, payAsBilledOvercharge, shortPayAvalaraCalculated, shortPayItemsAccrueOvercharge, markForReviewOvercharge, rejectOvercharge, isActive", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that defined this rule" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/apconfigsetting?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "apconfigsetting" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* meta, amount, amountToMarkForReview, ignoreThresholdWhenVCTZero, varianceForIgnore, varianceForAccrue, variancePercent, apConfigToleranceType, payAsBilledNoAccrual, payAsBilledAccrueUndercharge, shortPayItemsAccrueUndercharge, markForReviewUndercharge, rejectUndercharge, payAsBilledOvercharge, shortPayAvalaraCalculated, shortPayItemsAccrueOvercharge, markForReviewOvercharge, rejectOvercharge, isActive", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that defined this rule" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Conflict", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/apconfigsetting?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "apconfigsetting" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* meta, amount, amountToMarkForReview, ignoreThresholdWhenVCTZero, varianceForIgnore, varianceForAccrue, variancePercent, apConfigToleranceType, payAsBilledNoAccrual, payAsBilledAccrueUndercharge, shortPayItemsAccrueUndercharge, markForReviewUndercharge, rejectUndercharge, payAsBilledOvercharge, shortPayAvalaraCalculated, shortPayItemsAccrueOvercharge, markForReviewOvercharge, rejectOvercharge, isActive", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that defined this rule" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/apconfigsetting?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "apconfigsetting" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* meta, amount, amountToMarkForReview, ignoreThresholdWhenVCTZero, varianceForIgnore, varianceForAccrue, variancePercent, apConfigToleranceType, payAsBilledNoAccrual, payAsBilledAccrueUndercharge, shortPayItemsAccrueUndercharge, markForReviewUndercharge, rejectUndercharge, payAsBilledOvercharge, shortPayAvalaraCalculated, shortPayItemsAccrueOvercharge, markForReviewOvercharge, rejectOvercharge, isActive", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that defined this rule" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" } ] } ] }, { "name": "costcenters", "item": [ { "name": "{costcenterid}", "item": [ { "name": "Update a single cost center", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"costCenterCode\": \"CostCenter1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters/:costcenterid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters", ":costcenterid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" }, { "key": "costcenterid", "value": "155", "description": "The primary key of this cost center" } ] }, "description": "Updates a single cost center owned by the company. Use the costcenterId path parameter to identify the cost center to update." }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"costCenterCode\": \"CostCenter1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters/:costcenterid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters", ":costcenterid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" }, { "key": "costcenterid", "value": "155", "description": "The primary key of this cost center" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"costCenterId\": 0,\n \"companyId\": 1,\n \"meta\": {\n \"createdDate\": \"0001-01-01\",\n \"modifiedDate\": \"0001-01-01\"\n },\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"costCenterCode\": \"CostCenter1\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"costCenterCode\": \"CostCenter1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters/:costcenterid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters", ":costcenterid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" }, { "key": "costcenterid", "value": "155", "description": "The primary key of this cost center" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"costCenterCode\": \"CostCenter1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters/:costcenterid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters", ":costcenterid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" }, { "key": "costcenterid", "value": "155", "description": "The primary key of this cost center" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Forbidden", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"costCenterCode\": \"CostCenter1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters/:costcenterid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters", ":costcenterid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" }, { "key": "costcenterid", "value": "155", "description": "The primary key of this cost center" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"costCenterCode\": \"CostCenter1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters/:costcenterid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters", ":costcenterid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" }, { "key": "costcenterid", "value": "155", "description": "The primary key of this cost center" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Conflict", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"costCenterCode\": \"CostCenter1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters/:costcenterid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters", ":costcenterid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" }, { "key": "costcenterid", "value": "155", "description": "The primary key of this cost center" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Server Error", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"costCenterCode\": \"CostCenter1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters/:costcenterid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters", ":costcenterid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" }, { "key": "costcenterid", "value": "155", "description": "The primary key of this cost center" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" } ] }, { "name": "Delete cost center for the given id", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters/:costcenterid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters", ":costcenterid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" }, { "key": "costcenterid", "value": "155", "description": "The primary key of this cost center" } ] }, "description": "Deletes a cost center with the specified costcenterId that belongs to the company." }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters/:costcenterid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters", ":costcenterid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" }, { "key": "costcenterid", "value": "155", "description": "The primary key of this cost center" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters/:costcenterid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters", ":costcenterid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" }, { "key": "costcenterid", "value": "155", "description": "The primary key of this cost center" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters/:costcenterid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters", ":costcenterid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" }, { "key": "costcenterid", "value": "155", "description": "The primary key of this cost center" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Forbidden", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters/:costcenterid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters", ":costcenterid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" }, { "key": "costcenterid", "value": "155", "description": "The primary key of this cost center" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters/:costcenterid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters", ":costcenterid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" }, { "key": "costcenterid", "value": "155", "description": "The primary key of this cost center" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Conflict", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters/:costcenterid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters", ":costcenterid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" }, { "key": "costcenterid", "value": "155", "description": "The primary key of this cost center" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Server Error", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters/:costcenterid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters", ":costcenterid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" }, { "key": "costcenterid", "value": "155", "description": "The primary key of this cost center" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" } ] }, { "name": "Retrieve a single cost center", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters/:costcenterid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters", ":costcenterid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" }, { "key": "costcenterid", "value": "155", "description": "The primary key of this cost center" } ] }, "description": "Retrieves details of a single cost center identified by costcenterId, which is owned by the company." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters/:costcenterid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters", ":costcenterid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" }, { "key": "costcenterid", "value": "155", "description": "The primary key of this cost center" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"costCenterId\": 0,\n \"companyId\": 1,\n \"meta\": {\n \"createdDate\": \"0001-01-01\",\n \"modifiedDate\": \"0001-01-01\"\n },\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"costCenterCode\": \"CostCenter1\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters/:costcenterid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters", ":costcenterid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" }, { "key": "costcenterid", "value": "155", "description": "The primary key of this cost center" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters/:costcenterid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters", ":costcenterid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" }, { "key": "costcenterid", "value": "155", "description": "The primary key of this cost center" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters/:costcenterid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters", ":costcenterid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" }, { "key": "costcenterid", "value": "155", "description": "The primary key of this cost center" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters/:costcenterid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters", ":costcenterid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" }, { "key": "costcenterid", "value": "155", "description": "The primary key of this cost center" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Conflict", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters/:costcenterid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters", ":costcenterid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" }, { "key": "costcenterid", "value": "155", "description": "The primary key of this cost center" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters/:costcenterid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters", ":costcenterid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" }, { "key": "costcenterid", "value": "155", "description": "The primary key of this cost center" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" } ] } ] }, { "name": "$upload", "item": [ { "name": "Bulk upload cost centers", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"costCenters\": [\n {\n \"entityUseCode\": \"A\",\n \"effectiveDate\": \"1900-01-01\",\n \"endDate\": \"9998-12-31\",\n \"defaultItem\": {\n \"identifier\": 0,\n \"displayName\": \"CHIP1041\"\n },\n \"costCenterCode\": \"CC_1\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters/$upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters", "$upload" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" } ] }, "description": "Allows bulk upload of cost centers for the specified company. Use the companyId path parameter to identify the company for which the cost centers should be uploaded." }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"costCenters\": [\n {\n \"entityUseCode\": \"A\",\n \"effectiveDate\": \"1900-01-01\",\n \"endDate\": \"9998-12-31\",\n \"defaultItem\": {\n \"identifier\": 0,\n \"displayName\": \"CHIP1041\"\n },\n \"costCenterCode\": \"CC_1\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters/$upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters", "$upload" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"total\": 35,\n \"failed\": [\n {\n \"rowIndex\": 1,\n \"costCenterCode\": \"CC_1\",\n \"errors\": [\n \"Please provide a unique cost center name.\"\n ]\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"costCenters\": [\n {\n \"entityUseCode\": \"A\",\n \"effectiveDate\": \"1900-01-01\",\n \"endDate\": \"9998-12-31\",\n \"defaultItem\": {\n \"identifier\": 0,\n \"displayName\": \"CHIP1041\"\n },\n \"costCenterCode\": \"CC_1\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters/$upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters", "$upload" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"costCenters\": [\n {\n \"entityUseCode\": \"A\",\n \"effectiveDate\": \"1900-01-01\",\n \"endDate\": \"9998-12-31\",\n \"defaultItem\": {\n \"identifier\": 0,\n \"displayName\": \"CHIP1041\"\n },\n \"costCenterCode\": \"CC_1\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters/$upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters", "$upload" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"costCenters\": [\n {\n \"entityUseCode\": \"A\",\n \"effectiveDate\": \"1900-01-01\",\n \"endDate\": \"9998-12-31\",\n \"defaultItem\": {\n \"identifier\": 0,\n \"displayName\": \"CHIP1041\"\n },\n \"costCenterCode\": \"CC_1\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters/$upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters", "$upload" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"costCenters\": [\n {\n \"entityUseCode\": \"A\",\n \"effectiveDate\": \"1900-01-01\",\n \"endDate\": \"9998-12-31\",\n \"defaultItem\": {\n \"identifier\": 0,\n \"displayName\": \"CHIP1041\"\n },\n \"costCenterCode\": \"CC_1\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters/$upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters", "$upload" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Conflict", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"costCenters\": [\n {\n \"entityUseCode\": \"A\",\n \"effectiveDate\": \"1900-01-01\",\n \"endDate\": \"9998-12-31\",\n \"defaultItem\": {\n \"identifier\": 0,\n \"displayName\": \"CHIP1041\"\n },\n \"costCenterCode\": \"CC_1\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters/$upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters", "$upload" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Server Error", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"costCenters\": [\n {\n \"entityUseCode\": \"A\",\n \"effectiveDate\": \"1900-01-01\",\n \"endDate\": \"9998-12-31\",\n \"defaultItem\": {\n \"identifier\": 0,\n \"displayName\": \"CHIP1041\"\n },\n \"costCenterCode\": \"CC_1\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters/$upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters", "$upload" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" } ] } ] }, { "name": "Create new cost center", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"costCenterCode\": \"CostCenter1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" } ] }, "description": "Creates one or more new item objects attached to this company.\r\n\r\nCostcenter is defined as function or department within a company which is not directly going to generate revenues and profits to the company but is still incurring expenses to the company for its operations." }, "response": [ { "name": "Created", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"costCenterCode\": \"CostCenter1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"costCenterId\": 0,\n \"companyId\": 1,\n \"meta\": {\n \"createdDate\": \"0001-01-01\",\n \"modifiedDate\": \"0001-01-01\"\n },\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"costCenterCode\": \"CostCenter1\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"costCenterCode\": \"CostCenter1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"costCenterCode\": \"CostCenter1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"costCenterCode\": \"CostCenter1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"costCenterCode\": \"CostCenter1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Conflict", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"costCenterCode\": \"CostCenter1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Server Error", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"costCenterCode\": \"CostCenter1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this cost center object" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" } ] }, { "name": "Retrieve cost centers for this company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* companyId, meta, defaultItem" }, { "key": "$include", "value": "string", "description": "A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that defined these cost centers" } ] }, "description": "Retrieves a list of cost centers attached to this company. You can apply filters to retrieve specific records." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* companyId, meta, defaultItem", "key": "$filter", "value": "string" }, { "description": "A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that defined these cost centers" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 5599,\n \"value\": [\n {\n \"costCenterId\": 0,\n \"companyId\": 1,\n \"meta\": {\n \"createdDate\": \"0001-01-01\",\n \"modifiedDate\": \"0001-01-01\"\n },\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"costCenterCode\": \"CostCenter1\"\n },\n {\n \"costCenterId\": 0,\n \"companyId\": 1,\n \"meta\": {\n \"createdDate\": \"0001-01-01\",\n \"modifiedDate\": \"0001-01-01\"\n },\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"costCenterCode\": \"CostCenter1\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* companyId, meta, defaultItem", "key": "$filter", "value": "string" }, { "description": "A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that defined these cost centers" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* companyId, meta, defaultItem", "key": "$filter", "value": "string" }, { "description": "A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that defined these cost centers" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* companyId, meta, defaultItem", "key": "$filter", "value": "string" }, { "description": "A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that defined these cost centers" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* companyId, meta, defaultItem", "key": "$filter", "value": "string" }, { "description": "A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that defined these cost centers" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Conflict", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* companyId, meta, defaultItem", "key": "$filter", "value": "string" }, { "description": "A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that defined these cost centers" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/costcenters?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "costcenters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* companyId, meta, defaultItem", "key": "$filter", "value": "string" }, { "description": "A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that defined these cost centers" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" } ] } ] }, { "name": "glaccounts", "item": [ { "name": "{glaccountid}", "item": [ { "name": "Update a single GL account", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"glAccountCode\": \"GLAccount1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/glaccounts/:glaccountid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "glaccounts", ":glaccountid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this GL Account object" }, { "key": "glaccountid", "value": "155", "description": "The primary key of this GL Account" } ] }, "description": "Updates a single GL account owned by the company. Use the glaccountid path parameter to identify the GL account to update." }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"glAccountCode\": \"GLAccount1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/glaccounts/:glaccountid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "glaccounts", ":glaccountid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this GL Account object" }, { "key": "glaccountid", "value": "155", "description": "The primary key of this GL Account" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"glAccountId\": 0,\n \"companyId\": 1,\n \"meta\": {\n \"createdDate\": \"0001-01-01\",\n \"modifiedDate\": \"0001-01-01\"\n },\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"glAccountCode\": \"GLAccount1\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"glAccountCode\": \"GLAccount1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/glaccounts/:glaccountid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "glaccounts", ":glaccountid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this GL Account object" }, { "key": "glaccountid", "value": "155", "description": "The primary key of this GL Account" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"glAccountCode\": \"GLAccount1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/glaccounts/:glaccountid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "glaccounts", ":glaccountid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this GL Account object" }, { "key": "glaccountid", "value": "155", "description": "The primary key of this GL Account" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Forbidden", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"glAccountCode\": \"GLAccount1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/glaccounts/:glaccountid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "glaccounts", ":glaccountid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this GL Account object" }, { "key": "glaccountid", "value": "155", "description": "The primary key of this GL Account" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"glAccountCode\": \"GLAccount1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/glaccounts/:glaccountid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "glaccounts", ":glaccountid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this GL Account object" }, { "key": "glaccountid", "value": "155", "description": "The primary key of this GL Account" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" } ] }, { "name": "Delete the GL account associated with the given company ID and GL account ID", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/glaccounts/:glaccountid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "glaccounts", ":glaccountid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this GL account object" }, { "key": "glaccountid", "value": "155", "description": "The primary key of this GL account" } ] }, "description": "Deletes the GL account associated with the specified `glaccountid` and `companyid`" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/glaccounts/:glaccountid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "glaccounts", ":glaccountid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this GL account object" }, { "key": "glaccountid", "value": "155", "description": "The primary key of this GL account" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/glaccounts/:glaccountid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "glaccounts", ":glaccountid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this GL account object" }, { "key": "glaccountid", "value": "155", "description": "The primary key of this GL account" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/glaccounts/:glaccountid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "glaccounts", ":glaccountid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this GL account object" }, { "key": "glaccountid", "value": "155", "description": "The primary key of this GL account" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Forbidden", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/glaccounts/:glaccountid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "glaccounts", ":glaccountid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this GL account object" }, { "key": "glaccountid", "value": "155", "description": "The primary key of this GL account" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/glaccounts/:glaccountid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "glaccounts", ":glaccountid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this GL account object" }, { "key": "glaccountid", "value": "155", "description": "The primary key of this GL account" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" } ] }, { "name": "Retrieve a single GL account", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/glaccounts/:glaccountid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "glaccounts", ":glaccountid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this GL account object" }, { "key": "glaccountid", "value": "155", "description": "The primary key of this GL account" } ] }, "description": "Retrieve details of a single GL account identified by its `glaccountid` and `companyid`" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/glaccounts/:glaccountid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "glaccounts", ":glaccountid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this GL account object" }, { "key": "glaccountid", "value": "155", "description": "The primary key of this GL account" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"glAccountId\": 0,\n \"companyId\": 1,\n \"meta\": {\n \"createdDate\": \"0001-01-01\",\n \"modifiedDate\": \"0001-01-01\"\n },\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"glAccountCode\": \"GLAccount1\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/glaccounts/:glaccountid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "glaccounts", ":glaccountid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this GL account object" }, { "key": "glaccountid", "value": "155", "description": "The primary key of this GL account" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/glaccounts/:glaccountid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "glaccounts", ":glaccountid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this GL account object" }, { "key": "glaccountid", "value": "155", "description": "The primary key of this GL account" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/glaccounts/:glaccountid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "glaccounts", ":glaccountid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this GL account object" }, { "key": "glaccountid", "value": "155", "description": "The primary key of this GL account" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/glaccounts/:glaccountid", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "glaccounts", ":glaccountid" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this GL account object" }, { "key": "glaccountid", "value": "155", "description": "The primary key of this GL account" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" } ] } ] }, { "name": "$upload", "item": [ { "name": "Bulk upload GL accounts", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"glAccounts\": [\n {\n \"entityUseCode\": \"B\",\n \"effectiveDate\": \"1900-01-01\",\n \"endDate\": \"9998-12-31\",\n \"defaultItem\": {\n \"identifier\": 0,\n \"displayName\": \"CHIP1041\"\n },\n \"glAccountCode\": \"GLAccount_1\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/glaccounts/$upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "glaccounts", "$upload" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this GL account object" } ] }, "description": "Allows a bulk upload of GL accounts for the specified company. Use the companyid path parameter to identify the company for which the GL accounts should be uploaded." }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"glAccounts\": [\n {\n \"entityUseCode\": \"B\",\n \"effectiveDate\": \"1900-01-01\",\n \"endDate\": \"9998-12-31\",\n \"defaultItem\": {\n \"identifier\": 0,\n \"displayName\": \"CHIP1041\"\n },\n \"glAccountCode\": \"GLAccount_1\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/glaccounts/$upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "glaccounts", "$upload" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this GL account object" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"total\": 35,\n \"failed\": [\n {\n \"rowIndex\": 1,\n \"glAccountCode\": \"GLAccount_1\",\n \"errors\": [\n \"Please provide a unique GL Account code.\"\n ]\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"glAccounts\": [\n {\n \"entityUseCode\": \"B\",\n \"effectiveDate\": \"1900-01-01\",\n \"endDate\": \"9998-12-31\",\n \"defaultItem\": {\n \"identifier\": 0,\n \"displayName\": \"CHIP1041\"\n },\n \"glAccountCode\": \"GLAccount_1\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/glaccounts/$upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "glaccounts", "$upload" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this GL account object" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"glAccounts\": [\n {\n \"entityUseCode\": \"B\",\n \"effectiveDate\": \"1900-01-01\",\n \"endDate\": \"9998-12-31\",\n \"defaultItem\": {\n \"identifier\": 0,\n \"displayName\": \"CHIP1041\"\n },\n \"glAccountCode\": \"GLAccount_1\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/glaccounts/$upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "glaccounts", "$upload" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this GL account object" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"glAccounts\": [\n {\n \"entityUseCode\": \"B\",\n \"effectiveDate\": \"1900-01-01\",\n \"endDate\": \"9998-12-31\",\n \"defaultItem\": {\n \"identifier\": 0,\n \"displayName\": \"CHIP1041\"\n },\n \"glAccountCode\": \"GLAccount_1\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/glaccounts/$upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "glaccounts", "$upload" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this GL account object" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"glAccounts\": [\n {\n \"entityUseCode\": \"B\",\n \"effectiveDate\": \"1900-01-01\",\n \"endDate\": \"9998-12-31\",\n \"defaultItem\": {\n \"identifier\": 0,\n \"displayName\": \"CHIP1041\"\n },\n \"glAccountCode\": \"GLAccount_1\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/glaccounts/$upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "glaccounts", "$upload" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this GL account object" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" } ] } ] }, { "name": "Create a new GL account", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"glAccountCode\": \"GLAccount1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/glaccounts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "glaccounts" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this GL Account object" } ] }, "description": "Creates one or more new GL account objects attached to this company.\r\n\r\nA GL account is a general ledger account that can be passed to transactions at the line level to apply the multiple rules of the transactions, including exemptions, allocations, etc. to a specific general ledger." }, "response": [ { "name": "Created", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"glAccountCode\": \"GLAccount1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/glaccounts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "glaccounts" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this GL Account object" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"glAccountId\": 0,\n \"companyId\": 1,\n \"meta\": {\n \"createdDate\": \"0001-01-01\",\n \"modifiedDate\": \"0001-01-01\"\n },\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"glAccountCode\": \"GLAccount1\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"glAccountCode\": \"GLAccount1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/glaccounts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "glaccounts" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this GL Account object" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"glAccountCode\": \"GLAccount1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/glaccounts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "glaccounts" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this GL Account object" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"glAccountCode\": \"GLAccount1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/glaccounts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "glaccounts" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this GL Account object" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"glAccountCode\": \"GLAccount1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/glaccounts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "glaccounts" ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns this GL Account object" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" } ] }, { "name": "Retrieve GL accounts for this company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/glaccounts?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "glaccounts" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* companyId, meta, defaultItem" }, { "key": "$include", "value": "string", "description": "A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns these GL accounts" } ] }, "description": "Retrieves a list of GL accounts attached to this company. You can apply filters to retrieve specific records." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/glaccounts?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "glaccounts" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* companyId, meta, defaultItem", "key": "$filter", "value": "string" }, { "description": "A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns these GL accounts" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 1718,\n \"value\": [\n {\n \"glAccountId\": 0,\n \"companyId\": 1,\n \"meta\": {\n \"createdDate\": \"0001-01-01\",\n \"modifiedDate\": \"0001-01-01\"\n },\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"glAccountCode\": \"GLAccount1\"\n },\n {\n \"glAccountId\": 0,\n \"companyId\": 1,\n \"meta\": {\n \"createdDate\": \"0001-01-01\",\n \"modifiedDate\": \"0001-01-01\"\n },\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"glAccountCode\": \"GLAccount1\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/glaccounts?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "glaccounts" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* companyId, meta, defaultItem", "key": "$filter", "value": "string" }, { "description": "A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns these GL accounts" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/glaccounts?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "glaccounts" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* companyId, meta, defaultItem", "key": "$filter", "value": "string" }, { "description": "A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns these GL accounts" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/glaccounts?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "glaccounts" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* companyId, meta, defaultItem", "key": "$filter", "value": "string" }, { "description": "A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns these GL accounts" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyid/glaccounts?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyid", "glaccounts" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* companyId, meta, defaultItem", "key": "$filter", "value": "string" }, { "description": "A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyid", "value": "451", "description": "The ID of the company that owns these GL accounts" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" } ] } ] } ] }, { "name": "{companyId}", "item": [ { "name": "batches", "item": [ { "name": "{batchId}", "item": [ { "name": "files", "item": [ { "name": "{id}", "item": [ { "name": "attachment", "item": [ { "name": "Download a single batch file", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches/:batchId/files/:id/attachment", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches", ":batchId", "files", ":id", "attachment" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch" }, { "key": "batchId", "value": "451", "description": "The ID of the batch object" }, { "key": "id", "value": "451", "description": "The primary key of this batch file object" } ] }, "description": "Download a single batch file identified by this URL.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches/:batchId/files/:id/attachment", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches", ":batchId", "files", ":id", "attachment" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch" }, { "key": "batchId", "value": "451", "description": "The ID of the batch object" }, { "key": "id", "value": "451", "description": "The primary key of this batch file object" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "string" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches/:batchId/files/:id/attachment", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches", ":batchId", "files", ":id", "attachment" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch" }, { "key": "batchId", "value": "451", "description": "The ID of the batch object" }, { "key": "id", "value": "451", "description": "The primary key of this batch file object" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches/:batchId/files/:id/attachment", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches", ":batchId", "files", ":id", "attachment" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch" }, { "key": "batchId", "value": "451", "description": "The ID of the batch object" }, { "key": "id", "value": "451", "description": "The primary key of this batch file object" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches/:batchId/files/:id/attachment", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches", ":batchId", "files", ":id", "attachment" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch" }, { "key": "batchId", "value": "451", "description": "The ID of the batch object" }, { "key": "id", "value": "451", "description": "The primary key of this batch file object" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] } ] } ] }, { "name": "{id}", "item": [ { "name": "cancel", "item": [ { "name": "Cancel an in progress batch", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches/:id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches", ":id", "cancel" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch." }, { "key": "id", "value": "451", "description": "The ID of the batch to cancel." } ] }, "description": "Marks the in progress batch identified by this URL as cancelled.\r\n \r\nOnly JSON batches can be cancelled. If you attempt to cancel a file batch, you will receive an error message.\r\n \r\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.\r\nCancelling an in progress batch does not delete any transactions that were created before the cancellation.\r\n \r\nBecause the batch system processes with a degree of concurrency, and\r\nbecause of batch sizes in the queue vary, AvaTax API is unable to accurately\r\npredict when a batch will complete. If high performance processing is\r\nrequired, please use the\r\n[CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches/:id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches", ":id", "cancel" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch." }, { "key": "id", "value": "451", "description": "The ID of the batch to cancel." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"TransactionImport\",\n \"batchAgent\": \"manual\",\n \"name\": \"TestBatch\",\n \"files\": [\n {\n \"name\": \"samplebatch.csv\",\n \"content\": \"UHJvY2Vzc0NvZGUsRG9jQ29kZSxEb2NUeXBlLERvY0RhdGUsQ29tcGFueUNvZGUsQ3VzdG9tZXJDb2RlLEVudGl0eVVzZUNvZGUsTGluZU5vLFRheENvZGUsVGF4RGF0ZSxJdGVtQ29kZSxEZXNjcmlwdGlvbixRdHksQW1vdW50LERpc2NvdW50LFJlZjEsUmVmMixFeGVtcHRpb25ObyxSZXZBY2N0LERlc3RBZGRyZXNzLERlc3RDaXR5LERlc3RSZWdpb24sRGVzdFBvc3RhbENvZGUsRGVzdENvdW50cnksT3JpZ0FkZHJlc3MsT3JpZ0NpdHksT3JpZ1JlZ2lvbixPcmlnUG9zdGFsQ29kZSxPcmlnQ291bnRyeSxMb2NhdGlvbkNvZGUsU2FsZXNQZXJzb25Db2RlLFB1cmNoYXNlT3JkZXJObyxDdXJyZW5jeUNvZGUsRXhjaGFuZ2VSYXRlLEV4Y2hhbmdlUmF0ZUVmZkRhdGUsUGF5bWVudERhdGUsVGF4SW5jbHVkZWQsRGVzdFRheFJlZ2lvbixPcmlnVGF4UmVnaW9uLFRheGFibGUsVGF4VHlwZSxUb3RhbFRheCxDb3VudHJ5TmFtZSxDb3VudHJ5Q29kZSxDb3VudHJ5UmF0ZSxDb3VudHJ5VGF4LFN0YXRlTmFtZSxTdGF0ZUNvZGUsU3RhdGVSYXRlLFN0YXRlVGF4LENvdW50eU5hbWUsQ291bnR5Q29kZSxDb3VudHlSYXRlLENvdW50eVRheCxDaXR5TmFtZSxDaXR5Q29kZSxDaXR5UmF0ZSxDaXR5VGF4LE90aGVyMU5hbWUsT3RoZXIxQ29kZSxPdGhlcjFSYXRlLE90aGVyMVRheCxPdGhlcjJOYW1lLE90aGVyMkNvZGUsT3RoZXIyUmF0ZSxPdGhlcjJUYXgsT3RoZXIzTmFtZSxPdGhlcjNDb2RlLE90aGVyM1JhdGUsT3RoZXIzVGF4LE90aGVyNE5hbWUsT3RoZXI0Q29kZSxPdGhlcjRSYXRlLE90aGVyNFRheCxSZWZlcmVuY2VDb2RlLEJ1eWVyc1ZBVE5vLElzU2VsbGVySW1wb3J0ZXJPZlJlY29yZCxCUkJ1eWVyVHlwZSxCUkJ1eWVyX0lzRXhlbXB0T3JDYW5ub3RXSF9JUlJGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX1BJU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NPRklOU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NTTExSRixCUkJ1eWVyX0lzRXhlbXB0X1BJUyxCUkJ1eWVyX0lzRXhlbXB0X0NPRklOUyxCUkJ1eWVyX0lzRXhlbXB0X0NTTEwsSGVhZGVyX0Rlc2NyaXB0aW9uLEVtYWlsDQozLDlhYzI4MGMzLTNhNTUtNGEzNS1iZWQyLWE4M2RiNTNiMDUxZSwxLDEvMS8yMDE0LERFRkFVTFQsQ3VzdDEsLDEsLCwsLCwxMDAwLCwsLCwsMjM1IEUgNDJuZCBTdCAsTmV3IFlvcmssTlksMTAwMTctNTcwMyAgLFVTLDkwMCBXaW5zbG93IFdheSxCYWluYnJpZGdlIElzbGFuZCxXQSw5ODExMCxVUywsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwNCg==\",\n \"contentLength\": 0,\n \"contentType\": \"text/csv\",\n \"fileExtension\": \".csv\",\n \"filePath\": \"samplebatch.csv\"\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches/:id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches", ":id", "cancel" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch." }, { "key": "id", "value": "451", "description": "The ID of the batch to cancel." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches/:id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches", ":id", "cancel" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch." }, { "key": "id", "value": "451", "description": "The ID of the batch to cancel." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches/:id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches", ":id", "cancel" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch." }, { "key": "id", "value": "451", "description": "The ID of the batch to cancel." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Retrieve a single batch", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch" }, { "key": "id", "value": "451", "description": "The primary key of this batch" } ] }, "description": "Get the batch object identified by this URL. A batch object is a large\r\ncollection of API calls stored in a compact file.\r\n \r\nUse this endpoint to retrieve the results or check the status of a batch.\r\n \r\nWhen a batch is created, it is added to the AvaTax Batch Queue and will be\r\nprocessed as quickly as possible in the order it was received. To check the\r\nstatus of a batch, fetch the batch and retrieve the results of the batch\r\noperation.\r\n \r\nBecause the batch system processes with a degree of concurrency, and\r\nbecause of batch sizes in the queue vary, AvaTax API is unable to accurately\r\npredict when a batch will complete. If high performance processing is\r\nrequired, please use the\r\n[CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch" }, { "key": "id", "value": "451", "description": "The primary key of this batch" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"TransactionImport\",\n \"batchAgent\": \"manual\",\n \"name\": \"TestBatch\",\n \"files\": [\n {\n \"name\": \"samplebatch.csv\",\n \"content\": \"UHJvY2Vzc0NvZGUsRG9jQ29kZSxEb2NUeXBlLERvY0RhdGUsQ29tcGFueUNvZGUsQ3VzdG9tZXJDb2RlLEVudGl0eVVzZUNvZGUsTGluZU5vLFRheENvZGUsVGF4RGF0ZSxJdGVtQ29kZSxEZXNjcmlwdGlvbixRdHksQW1vdW50LERpc2NvdW50LFJlZjEsUmVmMixFeGVtcHRpb25ObyxSZXZBY2N0LERlc3RBZGRyZXNzLERlc3RDaXR5LERlc3RSZWdpb24sRGVzdFBvc3RhbENvZGUsRGVzdENvdW50cnksT3JpZ0FkZHJlc3MsT3JpZ0NpdHksT3JpZ1JlZ2lvbixPcmlnUG9zdGFsQ29kZSxPcmlnQ291bnRyeSxMb2NhdGlvbkNvZGUsU2FsZXNQZXJzb25Db2RlLFB1cmNoYXNlT3JkZXJObyxDdXJyZW5jeUNvZGUsRXhjaGFuZ2VSYXRlLEV4Y2hhbmdlUmF0ZUVmZkRhdGUsUGF5bWVudERhdGUsVGF4SW5jbHVkZWQsRGVzdFRheFJlZ2lvbixPcmlnVGF4UmVnaW9uLFRheGFibGUsVGF4VHlwZSxUb3RhbFRheCxDb3VudHJ5TmFtZSxDb3VudHJ5Q29kZSxDb3VudHJ5UmF0ZSxDb3VudHJ5VGF4LFN0YXRlTmFtZSxTdGF0ZUNvZGUsU3RhdGVSYXRlLFN0YXRlVGF4LENvdW50eU5hbWUsQ291bnR5Q29kZSxDb3VudHlSYXRlLENvdW50eVRheCxDaXR5TmFtZSxDaXR5Q29kZSxDaXR5UmF0ZSxDaXR5VGF4LE90aGVyMU5hbWUsT3RoZXIxQ29kZSxPdGhlcjFSYXRlLE90aGVyMVRheCxPdGhlcjJOYW1lLE90aGVyMkNvZGUsT3RoZXIyUmF0ZSxPdGhlcjJUYXgsT3RoZXIzTmFtZSxPdGhlcjNDb2RlLE90aGVyM1JhdGUsT3RoZXIzVGF4LE90aGVyNE5hbWUsT3RoZXI0Q29kZSxPdGhlcjRSYXRlLE90aGVyNFRheCxSZWZlcmVuY2VDb2RlLEJ1eWVyc1ZBVE5vLElzU2VsbGVySW1wb3J0ZXJPZlJlY29yZCxCUkJ1eWVyVHlwZSxCUkJ1eWVyX0lzRXhlbXB0T3JDYW5ub3RXSF9JUlJGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX1BJU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NPRklOU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NTTExSRixCUkJ1eWVyX0lzRXhlbXB0X1BJUyxCUkJ1eWVyX0lzRXhlbXB0X0NPRklOUyxCUkJ1eWVyX0lzRXhlbXB0X0NTTEwsSGVhZGVyX0Rlc2NyaXB0aW9uLEVtYWlsDQozLDlhYzI4MGMzLTNhNTUtNGEzNS1iZWQyLWE4M2RiNTNiMDUxZSwxLDEvMS8yMDE0LERFRkFVTFQsQ3VzdDEsLDEsLCwsLCwxMDAwLCwsLCwsMjM1IEUgNDJuZCBTdCAsTmV3IFlvcmssTlksMTAwMTctNTcwMyAgLFVTLDkwMCBXaW5zbG93IFdheSxCYWluYnJpZGdlIElzbGFuZCxXQSw5ODExMCxVUywsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwNCg==\",\n \"contentLength\": 0,\n \"contentType\": \"text/csv\",\n \"fileExtension\": \".csv\",\n \"filePath\": \"samplebatch.csv\"\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch" }, { "key": "id", "value": "451", "description": "The primary key of this batch" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch" }, { "key": "id", "value": "451", "description": "The primary key of this batch" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch" }, { "key": "id", "value": "451", "description": "The primary key of this batch" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete a single batch", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch." }, { "key": "id", "value": "451", "description": "The ID of the batch to delete." } ] }, "description": "Marks the batch identified by this URL as deleted.\r\n \r\nIf you attempt to delete a batch that is being processed, you will receive an error message.\r\nDeleting a batch does not delete any transactions that were created by importing the batch.\r\n \r\nBecause the batch system processes with a degree of concurrency, and\r\nbecause of batch sizes in the queue vary, AvaTax API is unable to accurately\r\npredict when a batch will complete. If high performance processing is\r\nrequired, please use the\r\n[CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).\n\n### Security Policies\n\n* This API requires one of the following user roles: BatchServiceAdmin, CSPAdmin, CSPTester, FirmAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch." }, { "key": "id", "value": "451", "description": "The ID of the batch to delete." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch." }, { "key": "id", "value": "451", "description": "The ID of the batch to delete." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch." }, { "key": "id", "value": "451", "description": "The ID of the batch to delete." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch." }, { "key": "id", "value": "451", "description": "The ID of the batch to delete." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "advancedrules", "item": [ { "name": "Create a new Advanced Rules batch", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"TestBatch-639107241051238185\",\n \"replaceExisting\": false,\n \"executions\": [\n {\n \"ruleExecutionId\": \"99498e4dfb94432282d755e4006e3703\",\n \"startDate\": \"2026-04-02T00:00:00Z\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"enabled\": true,\n \"continueOnError\": false,\n \"ruleId\": \"9fd70f962e6848f699d2e88bafac9eee\",\n \"rule\": {\n \"ruleId\": \"63934cfcbd48496082770f126a79846c\",\n \"name\": \"Generic replace rule\",\n \"description\": \"Replaces a target value on the transaction with a replacement value\",\n \"arEntitlementRequired\": false\n },\n \"customerDataId\": \"b4d79d9303244973b23e1c9e2211d0e5\"\n },\n {\n \"ruleExecutionId\": \"bb64ad9cc3064b399855c32d67bced5e\",\n \"startDate\": \"2026-04-02T00:00:00Z\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"enabled\": true,\n \"continueOnError\": false,\n \"ruleId\": \"ed0c95073006462ea86b2d8793f96e5a\",\n \"rule\": {\n \"ruleId\": \"6ab5ef9a24c643929321234bf2454a7a\",\n \"name\": \"Generic replace rule\",\n \"description\": \"Replaces a target value on the transaction with a replacement value\",\n \"arEntitlementRequired\": false\n },\n \"customerDataId\": \"d0df04174794432e833f82e6c3796251\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches/advancedrules", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches", "advancedrules" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch." } ] }, "description": "Create a new Advanced Rules batch objects attached to this company.\r\n \r\nWhen an Advanced Rules batch is created, it is added to the AvaTax Batch v2 Queue and will be\r\nprocessed as quickly as possible in the order it was received. To check the\r\nstatus of a batch, fetch the batch and retrieve the results of the batch\r\noperation.\r\n \r\nThe maximum content length of the request body is limited to 28.6 MB. If this limit\r\nis exceeded, a 404 Not Found status will be returned (possibly with a CORS error if\r\nthe API is called from a browser). In this situation, please split the request into\r\nsmaller batches.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"TestBatch-639107241051238185\",\n \"replaceExisting\": false,\n \"executions\": [\n {\n \"ruleExecutionId\": \"99498e4dfb94432282d755e4006e3703\",\n \"startDate\": \"2026-04-02T00:00:00Z\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"enabled\": true,\n \"continueOnError\": false,\n \"ruleId\": \"9fd70f962e6848f699d2e88bafac9eee\",\n \"rule\": {\n \"ruleId\": \"63934cfcbd48496082770f126a79846c\",\n \"name\": \"Generic replace rule\",\n \"description\": \"Replaces a target value on the transaction with a replacement value\",\n \"arEntitlementRequired\": false\n },\n \"customerDataId\": \"b4d79d9303244973b23e1c9e2211d0e5\"\n },\n {\n \"ruleExecutionId\": \"bb64ad9cc3064b399855c32d67bced5e\",\n \"startDate\": \"2026-04-02T00:00:00Z\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"enabled\": true,\n \"continueOnError\": false,\n \"ruleId\": \"ed0c95073006462ea86b2d8793f96e5a\",\n \"rule\": {\n \"ruleId\": \"6ab5ef9a24c643929321234bf2454a7a\",\n \"name\": \"Generic replace rule\",\n \"description\": \"Replaces a target value on the transaction with a replacement value\",\n \"arEntitlementRequired\": false\n },\n \"customerDataId\": \"d0df04174794432e833f82e6c3796251\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches/advancedrules", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches", "advancedrules" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": \"TestBatch\",\n \"files\": [\n {\n \"name\": \"Input\",\n \"contentLength\": 2393,\n \"contentType\": \"application/json\",\n \"fileExtension\": \"JSON\",\n \"filePath\": \"Input.json\"\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"TestBatch-639107241051238185\",\n \"replaceExisting\": false,\n \"executions\": [\n {\n \"ruleExecutionId\": \"99498e4dfb94432282d755e4006e3703\",\n \"startDate\": \"2026-04-02T00:00:00Z\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"enabled\": true,\n \"continueOnError\": false,\n \"ruleId\": \"9fd70f962e6848f699d2e88bafac9eee\",\n \"rule\": {\n \"ruleId\": \"63934cfcbd48496082770f126a79846c\",\n \"name\": \"Generic replace rule\",\n \"description\": \"Replaces a target value on the transaction with a replacement value\",\n \"arEntitlementRequired\": false\n },\n \"customerDataId\": \"b4d79d9303244973b23e1c9e2211d0e5\"\n },\n {\n \"ruleExecutionId\": \"bb64ad9cc3064b399855c32d67bced5e\",\n \"startDate\": \"2026-04-02T00:00:00Z\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"enabled\": true,\n \"continueOnError\": false,\n \"ruleId\": \"ed0c95073006462ea86b2d8793f96e5a\",\n \"rule\": {\n \"ruleId\": \"6ab5ef9a24c643929321234bf2454a7a\",\n \"name\": \"Generic replace rule\",\n \"description\": \"Replaces a target value on the transaction with a replacement value\",\n \"arEntitlementRequired\": false\n },\n \"customerDataId\": \"d0df04174794432e833f82e6c3796251\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches/advancedrules", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches", "advancedrules" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"TestBatch-639107241051238185\",\n \"replaceExisting\": false,\n \"executions\": [\n {\n \"ruleExecutionId\": \"99498e4dfb94432282d755e4006e3703\",\n \"startDate\": \"2026-04-02T00:00:00Z\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"enabled\": true,\n \"continueOnError\": false,\n \"ruleId\": \"9fd70f962e6848f699d2e88bafac9eee\",\n \"rule\": {\n \"ruleId\": \"63934cfcbd48496082770f126a79846c\",\n \"name\": \"Generic replace rule\",\n \"description\": \"Replaces a target value on the transaction with a replacement value\",\n \"arEntitlementRequired\": false\n },\n \"customerDataId\": \"b4d79d9303244973b23e1c9e2211d0e5\"\n },\n {\n \"ruleExecutionId\": \"bb64ad9cc3064b399855c32d67bced5e\",\n \"startDate\": \"2026-04-02T00:00:00Z\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"enabled\": true,\n \"continueOnError\": false,\n \"ruleId\": \"ed0c95073006462ea86b2d8793f96e5a\",\n \"rule\": {\n \"ruleId\": \"6ab5ef9a24c643929321234bf2454a7a\",\n \"name\": \"Generic replace rule\",\n \"description\": \"Replaces a target value on the transaction with a replacement value\",\n \"arEntitlementRequired\": false\n },\n \"customerDataId\": \"d0df04174794432e833f82e6c3796251\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches/advancedrules", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches", "advancedrules" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"TestBatch-639107241051238185\",\n \"replaceExisting\": false,\n \"executions\": [\n {\n \"ruleExecutionId\": \"99498e4dfb94432282d755e4006e3703\",\n \"startDate\": \"2026-04-02T00:00:00Z\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"enabled\": true,\n \"continueOnError\": false,\n \"ruleId\": \"9fd70f962e6848f699d2e88bafac9eee\",\n \"rule\": {\n \"ruleId\": \"63934cfcbd48496082770f126a79846c\",\n \"name\": \"Generic replace rule\",\n \"description\": \"Replaces a target value on the transaction with a replacement value\",\n \"arEntitlementRequired\": false\n },\n \"customerDataId\": \"b4d79d9303244973b23e1c9e2211d0e5\"\n },\n {\n \"ruleExecutionId\": \"bb64ad9cc3064b399855c32d67bced5e\",\n \"startDate\": \"2026-04-02T00:00:00Z\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"enabled\": true,\n \"continueOnError\": false,\n \"ruleId\": \"ed0c95073006462ea86b2d8793f96e5a\",\n \"rule\": {\n \"ruleId\": \"6ab5ef9a24c643929321234bf2454a7a\",\n \"name\": \"Generic replace rule\",\n \"description\": \"Replaces a target value on the transaction with a replacement value\",\n \"arEntitlementRequired\": false\n },\n \"customerDataId\": \"d0df04174794432e833f82e6c3796251\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches/advancedrules", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches", "advancedrules" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "items", "item": [ { "name": "Create item import batch.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"ItemImportDemo\",\n \"items\": [\n {\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CERMUG\",\n \"taxCode\": \"P0000000\",\n \"description\": \"Ceramic Mug\",\n \"itemGroup\": \"Mugs\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"source\": \"MTCC\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ],\n \"properties\": {\n \"color\": \"white\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches/items", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches", "items" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch." } ] }, "description": "Create a new item import batch objects attached to this company.\r\n \r\nWhen an item import batch is created, it is added to the AvaTax Batch v2 Queue and will be\r\nprocessed in the order it was received. To check the\r\nstatus of a batch, fetch the batch and retrieve the results of the batch\r\noperation.\r\n \r\nThe maximum content length of the request body is limited to 28.6 MB. If this limit\r\nexceeds then a 404 Not Found status is returned (possibly with a CORS error if\r\nthe API is called from a browser). In this situation, please split the request into\r\nsmaller batches.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"ItemImportDemo\",\n \"items\": [\n {\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CERMUG\",\n \"taxCode\": \"P0000000\",\n \"description\": \"Ceramic Mug\",\n \"itemGroup\": \"Mugs\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"source\": \"MTCC\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ],\n \"properties\": {\n \"color\": \"white\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches/items", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches", "items" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": \"ItemImportDemo\",\n \"files\": [\n {\n \"name\": \"Input\",\n \"contentLength\": 2393,\n \"contentType\": \"application/json\",\n \"fileExtension\": \"JSON\",\n \"filePath\": \"Input.json\"\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"ItemImportDemo\",\n \"items\": [\n {\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CERMUG\",\n \"taxCode\": \"P0000000\",\n \"description\": \"Ceramic Mug\",\n \"itemGroup\": \"Mugs\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"source\": \"MTCC\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ],\n \"properties\": {\n \"color\": \"white\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches/items", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches", "items" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"ItemImportDemo\",\n \"items\": [\n {\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CERMUG\",\n \"taxCode\": \"P0000000\",\n \"description\": \"Ceramic Mug\",\n \"itemGroup\": \"Mugs\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"source\": \"MTCC\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ],\n \"properties\": {\n \"color\": \"white\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches/items", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches", "items" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"ItemImportDemo\",\n \"items\": [\n {\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CERMUG\",\n \"taxCode\": \"P0000000\",\n \"description\": \"Ceramic Mug\",\n \"itemGroup\": \"Mugs\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"source\": \"MTCC\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ],\n \"properties\": {\n \"color\": \"white\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches/items", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches", "items" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "transactions", "item": [ { "name": "Create a new transaction batch", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"TestBatch-639107241050791261\",\n \"transactions\": [\n {\n \"createTransactionModel\": {\n \"code\": \"MyTransaction-639107241050791070\",\n \"lines\": [\n {\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 100,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n }\n },\n {\n \"adjustTransactionModel\": {\n \"companyCode\": \"DEFAULT\",\n \"transactionCode\": \"MyTransaction-639107241050791070\",\n \"documentType\": \"SalesInvoice\",\n \"adjustmentReason\": \"PriceAdjusted\",\n \"adjustmentDescription\": \"Price drop before shipping\",\n \"newTransaction\": {\n \"code\": \"MyTransaction-639107241050791070\",\n \"lines\": [\n {\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 90,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n }\n }\n },\n {\n \"createOrAdjustTransactionModel\": {\n \"adjustmentReason\": \"Other\",\n \"adjustmentDescription\": \"Test Description\",\n \"createTransactionModel\": {\n \"code\": \"MyTransaction-639107241050791070\",\n \"lines\": [\n {\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 80,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n }\n }\n },\n {\n \"voidTransactionModel\": {\n \"companyCode\": \"DEFAULT\",\n \"transactionCode\": \"MyTransaction-639107241050791070\",\n \"documentType\": \"SalesInvoice\",\n \"code\": \"DocVoided\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches/transactions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches", "transactions" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch." } ] }, "description": "Create a new transaction batch objects attached to this company.\r\n \r\nWhen a transaction batch is created, it is added to the AvaTax Batch v2 Queue and will be\r\nprocessed as quickly as possible in the order it was received. To check the\r\nstatus of a batch, fetch the batch and retrieve the results of the batch\r\noperation.\r\n \r\nBecause the batch system processes with a degree of concurrency, and\r\nbecause of batch sizes in the queue vary, AvaTax API is unable to accurately\r\npredict when a batch will complete. If high performance processing is\r\nrequired, please use the\r\n[CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).\r\n \r\nThe maximum content length of the request body is limited to 28.6 MB. If this limit\r\nis exceeded, a 404 Not Found status will be returned (possibly with a CORS error if\r\nthe API is called from a browser). In this situation, please split the request into\r\nsmaller batches.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"TestBatch-639107241050791261\",\n \"transactions\": [\n {\n \"createTransactionModel\": {\n \"code\": \"MyTransaction-639107241050791070\",\n \"lines\": [\n {\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 100,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n }\n },\n {\n \"adjustTransactionModel\": {\n \"companyCode\": \"DEFAULT\",\n \"transactionCode\": \"MyTransaction-639107241050791070\",\n \"documentType\": \"SalesInvoice\",\n \"adjustmentReason\": \"PriceAdjusted\",\n \"adjustmentDescription\": \"Price drop before shipping\",\n \"newTransaction\": {\n \"code\": \"MyTransaction-639107241050791070\",\n \"lines\": [\n {\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 90,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n }\n }\n },\n {\n \"createOrAdjustTransactionModel\": {\n \"adjustmentReason\": \"Other\",\n \"adjustmentDescription\": \"Test Description\",\n \"createTransactionModel\": {\n \"code\": \"MyTransaction-639107241050791070\",\n \"lines\": [\n {\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 80,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n }\n }\n },\n {\n \"voidTransactionModel\": {\n \"companyCode\": \"DEFAULT\",\n \"transactionCode\": \"MyTransaction-639107241050791070\",\n \"documentType\": \"SalesInvoice\",\n \"code\": \"DocVoided\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches/transactions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches", "transactions" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": \"TestBatch\",\n \"files\": [\n {\n \"name\": \"Input\",\n \"contentLength\": 2393,\n \"contentType\": \"application/json\",\n \"fileExtension\": \"JSON\",\n \"filePath\": \"Input.json\"\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"TestBatch-639107241050791261\",\n \"transactions\": [\n {\n \"createTransactionModel\": {\n \"code\": \"MyTransaction-639107241050791070\",\n \"lines\": [\n {\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 100,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n }\n },\n {\n \"adjustTransactionModel\": {\n \"companyCode\": \"DEFAULT\",\n \"transactionCode\": \"MyTransaction-639107241050791070\",\n \"documentType\": \"SalesInvoice\",\n \"adjustmentReason\": \"PriceAdjusted\",\n \"adjustmentDescription\": \"Price drop before shipping\",\n \"newTransaction\": {\n \"code\": \"MyTransaction-639107241050791070\",\n \"lines\": [\n {\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 90,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n }\n }\n },\n {\n \"createOrAdjustTransactionModel\": {\n \"adjustmentReason\": \"Other\",\n \"adjustmentDescription\": \"Test Description\",\n \"createTransactionModel\": {\n \"code\": \"MyTransaction-639107241050791070\",\n \"lines\": [\n {\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 80,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n }\n }\n },\n {\n \"voidTransactionModel\": {\n \"companyCode\": \"DEFAULT\",\n \"transactionCode\": \"MyTransaction-639107241050791070\",\n \"documentType\": \"SalesInvoice\",\n \"code\": \"DocVoided\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches/transactions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches", "transactions" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"TestBatch-639107241050791261\",\n \"transactions\": [\n {\n \"createTransactionModel\": {\n \"code\": \"MyTransaction-639107241050791070\",\n \"lines\": [\n {\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 100,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n }\n },\n {\n \"adjustTransactionModel\": {\n \"companyCode\": \"DEFAULT\",\n \"transactionCode\": \"MyTransaction-639107241050791070\",\n \"documentType\": \"SalesInvoice\",\n \"adjustmentReason\": \"PriceAdjusted\",\n \"adjustmentDescription\": \"Price drop before shipping\",\n \"newTransaction\": {\n \"code\": \"MyTransaction-639107241050791070\",\n \"lines\": [\n {\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 90,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n }\n }\n },\n {\n \"createOrAdjustTransactionModel\": {\n \"adjustmentReason\": \"Other\",\n \"adjustmentDescription\": \"Test Description\",\n \"createTransactionModel\": {\n \"code\": \"MyTransaction-639107241050791070\",\n \"lines\": [\n {\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 80,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n }\n }\n },\n {\n \"voidTransactionModel\": {\n \"companyCode\": \"DEFAULT\",\n \"transactionCode\": \"MyTransaction-639107241050791070\",\n \"documentType\": \"SalesInvoice\",\n \"code\": \"DocVoided\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches/transactions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches", "transactions" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"TestBatch-639107241050791261\",\n \"transactions\": [\n {\n \"createTransactionModel\": {\n \"code\": \"MyTransaction-639107241050791070\",\n \"lines\": [\n {\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 100,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n }\n },\n {\n \"adjustTransactionModel\": {\n \"companyCode\": \"DEFAULT\",\n \"transactionCode\": \"MyTransaction-639107241050791070\",\n \"documentType\": \"SalesInvoice\",\n \"adjustmentReason\": \"PriceAdjusted\",\n \"adjustmentDescription\": \"Price drop before shipping\",\n \"newTransaction\": {\n \"code\": \"MyTransaction-639107241050791070\",\n \"lines\": [\n {\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 90,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n }\n }\n },\n {\n \"createOrAdjustTransactionModel\": {\n \"adjustmentReason\": \"Other\",\n \"adjustmentDescription\": \"Test Description\",\n \"createTransactionModel\": {\n \"code\": \"MyTransaction-639107241050791070\",\n \"lines\": [\n {\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 80,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n }\n }\n },\n {\n \"voidTransactionModel\": {\n \"companyCode\": \"DEFAULT\",\n \"transactionCode\": \"MyTransaction-639107241050791070\",\n \"documentType\": \"SalesInvoice\",\n \"code\": \"DocVoided\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches/transactions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches", "transactions" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Retrieve all batches for this company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* files" }, { "key": "$include", "value": "string", "description": "A comma separated list of additional data to retrieve." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these batches" } ] }, "description": "List all batch objects attached to the specified company.\r\n \r\nA batch object is a large collection of API calls stored in a compact file.\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter;\r\nfull documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate results using the `$top`, `$skip`, and `$orderby` parameters.\r\n \r\nUse [GetBatch](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Batches/GetBatch/)\r\nto retrieve the results, or check the status, of an individual batch.\r\n \r\nWhen a batch is created, it is added to the AvaTax Batch Queue and will be\r\nprocessed as quickly as possible in the order it was received. To check the\r\nstatus of a batch, fetch the batch and retrieve the results of the batch\r\noperation.\r\n \r\nBecause the batch system processes with a degree of concurrency, and\r\nbecause of batch sizes in the queue vary, AvaTax API is unable to accurately\r\npredict when a batch will complete. If high performance processing is\r\nrequired, please use the\r\n[CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* files", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these batches" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 733,\n \"value\": [\n {\n \"type\": \"TransactionImport\",\n \"batchAgent\": \"manual\",\n \"name\": \"TestBatch\",\n \"files\": [\n {\n \"name\": \"samplebatch.csv\",\n \"content\": \"UHJvY2Vzc0NvZGUsRG9jQ29kZSxEb2NUeXBlLERvY0RhdGUsQ29tcGFueUNvZGUsQ3VzdG9tZXJDb2RlLEVudGl0eVVzZUNvZGUsTGluZU5vLFRheENvZGUsVGF4RGF0ZSxJdGVtQ29kZSxEZXNjcmlwdGlvbixRdHksQW1vdW50LERpc2NvdW50LFJlZjEsUmVmMixFeGVtcHRpb25ObyxSZXZBY2N0LERlc3RBZGRyZXNzLERlc3RDaXR5LERlc3RSZWdpb24sRGVzdFBvc3RhbENvZGUsRGVzdENvdW50cnksT3JpZ0FkZHJlc3MsT3JpZ0NpdHksT3JpZ1JlZ2lvbixPcmlnUG9zdGFsQ29kZSxPcmlnQ291bnRyeSxMb2NhdGlvbkNvZGUsU2FsZXNQZXJzb25Db2RlLFB1cmNoYXNlT3JkZXJObyxDdXJyZW5jeUNvZGUsRXhjaGFuZ2VSYXRlLEV4Y2hhbmdlUmF0ZUVmZkRhdGUsUGF5bWVudERhdGUsVGF4SW5jbHVkZWQsRGVzdFRheFJlZ2lvbixPcmlnVGF4UmVnaW9uLFRheGFibGUsVGF4VHlwZSxUb3RhbFRheCxDb3VudHJ5TmFtZSxDb3VudHJ5Q29kZSxDb3VudHJ5UmF0ZSxDb3VudHJ5VGF4LFN0YXRlTmFtZSxTdGF0ZUNvZGUsU3RhdGVSYXRlLFN0YXRlVGF4LENvdW50eU5hbWUsQ291bnR5Q29kZSxDb3VudHlSYXRlLENvdW50eVRheCxDaXR5TmFtZSxDaXR5Q29kZSxDaXR5UmF0ZSxDaXR5VGF4LE90aGVyMU5hbWUsT3RoZXIxQ29kZSxPdGhlcjFSYXRlLE90aGVyMVRheCxPdGhlcjJOYW1lLE90aGVyMkNvZGUsT3RoZXIyUmF0ZSxPdGhlcjJUYXgsT3RoZXIzTmFtZSxPdGhlcjNDb2RlLE90aGVyM1JhdGUsT3RoZXIzVGF4LE90aGVyNE5hbWUsT3RoZXI0Q29kZSxPdGhlcjRSYXRlLE90aGVyNFRheCxSZWZlcmVuY2VDb2RlLEJ1eWVyc1ZBVE5vLElzU2VsbGVySW1wb3J0ZXJPZlJlY29yZCxCUkJ1eWVyVHlwZSxCUkJ1eWVyX0lzRXhlbXB0T3JDYW5ub3RXSF9JUlJGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX1BJU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NPRklOU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NTTExSRixCUkJ1eWVyX0lzRXhlbXB0X1BJUyxCUkJ1eWVyX0lzRXhlbXB0X0NPRklOUyxCUkJ1eWVyX0lzRXhlbXB0X0NTTEwsSGVhZGVyX0Rlc2NyaXB0aW9uLEVtYWlsDQozLDlhYzI4MGMzLTNhNTUtNGEzNS1iZWQyLWE4M2RiNTNiMDUxZSwxLDEvMS8yMDE0LERFRkFVTFQsQ3VzdDEsLDEsLCwsLCwxMDAwLCwsLCwsMjM1IEUgNDJuZCBTdCAsTmV3IFlvcmssTlksMTAwMTctNTcwMyAgLFVTLDkwMCBXaW5zbG93IFdheSxCYWluYnJpZGdlIElzbGFuZCxXQSw5ODExMCxVUywsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwNCg==\",\n \"contentLength\": 0,\n \"contentType\": \"text/csv\",\n \"fileExtension\": \".csv\",\n \"filePath\": \"samplebatch.csv\"\n }\n ]\n },\n {\n \"type\": \"TransactionImport\",\n \"batchAgent\": \"manual\",\n \"name\": \"TestBatch\",\n \"files\": [\n {\n \"name\": \"samplebatch.csv\",\n \"content\": \"UHJvY2Vzc0NvZGUsRG9jQ29kZSxEb2NUeXBlLERvY0RhdGUsQ29tcGFueUNvZGUsQ3VzdG9tZXJDb2RlLEVudGl0eVVzZUNvZGUsTGluZU5vLFRheENvZGUsVGF4RGF0ZSxJdGVtQ29kZSxEZXNjcmlwdGlvbixRdHksQW1vdW50LERpc2NvdW50LFJlZjEsUmVmMixFeGVtcHRpb25ObyxSZXZBY2N0LERlc3RBZGRyZXNzLERlc3RDaXR5LERlc3RSZWdpb24sRGVzdFBvc3RhbENvZGUsRGVzdENvdW50cnksT3JpZ0FkZHJlc3MsT3JpZ0NpdHksT3JpZ1JlZ2lvbixPcmlnUG9zdGFsQ29kZSxPcmlnQ291bnRyeSxMb2NhdGlvbkNvZGUsU2FsZXNQZXJzb25Db2RlLFB1cmNoYXNlT3JkZXJObyxDdXJyZW5jeUNvZGUsRXhjaGFuZ2VSYXRlLEV4Y2hhbmdlUmF0ZUVmZkRhdGUsUGF5bWVudERhdGUsVGF4SW5jbHVkZWQsRGVzdFRheFJlZ2lvbixPcmlnVGF4UmVnaW9uLFRheGFibGUsVGF4VHlwZSxUb3RhbFRheCxDb3VudHJ5TmFtZSxDb3VudHJ5Q29kZSxDb3VudHJ5UmF0ZSxDb3VudHJ5VGF4LFN0YXRlTmFtZSxTdGF0ZUNvZGUsU3RhdGVSYXRlLFN0YXRlVGF4LENvdW50eU5hbWUsQ291bnR5Q29kZSxDb3VudHlSYXRlLENvdW50eVRheCxDaXR5TmFtZSxDaXR5Q29kZSxDaXR5UmF0ZSxDaXR5VGF4LE90aGVyMU5hbWUsT3RoZXIxQ29kZSxPdGhlcjFSYXRlLE90aGVyMVRheCxPdGhlcjJOYW1lLE90aGVyMkNvZGUsT3RoZXIyUmF0ZSxPdGhlcjJUYXgsT3RoZXIzTmFtZSxPdGhlcjNDb2RlLE90aGVyM1JhdGUsT3RoZXIzVGF4LE90aGVyNE5hbWUsT3RoZXI0Q29kZSxPdGhlcjRSYXRlLE90aGVyNFRheCxSZWZlcmVuY2VDb2RlLEJ1eWVyc1ZBVE5vLElzU2VsbGVySW1wb3J0ZXJPZlJlY29yZCxCUkJ1eWVyVHlwZSxCUkJ1eWVyX0lzRXhlbXB0T3JDYW5ub3RXSF9JUlJGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX1BJU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NPRklOU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NTTExSRixCUkJ1eWVyX0lzRXhlbXB0X1BJUyxCUkJ1eWVyX0lzRXhlbXB0X0NPRklOUyxCUkJ1eWVyX0lzRXhlbXB0X0NTTEwsSGVhZGVyX0Rlc2NyaXB0aW9uLEVtYWlsDQozLDlhYzI4MGMzLTNhNTUtNGEzNS1iZWQyLWE4M2RiNTNiMDUxZSwxLDEvMS8yMDE0LERFRkFVTFQsQ3VzdDEsLDEsLCwsLCwxMDAwLCwsLCwsMjM1IEUgNDJuZCBTdCAsTmV3IFlvcmssTlksMTAwMTctNTcwMyAgLFVTLDkwMCBXaW5zbG93IFdheSxCYWluYnJpZGdlIElzbGFuZCxXQSw5ODExMCxVUywsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwNCg==\",\n \"contentLength\": 0,\n \"contentType\": \"text/csv\",\n \"fileExtension\": \".csv\",\n \"filePath\": \"samplebatch.csv\"\n }\n ]\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* files", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these batches" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* files", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these batches" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* files", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these batches" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Create a new batch", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"type\": \"TransactionImport\",\n \"batchAgent\": \"manual\",\n \"name\": \"TestBatch\",\n \"files\": [\n {\n \"name\": \"samplebatch.csv\",\n \"content\": \"UHJvY2Vzc0NvZGUsRG9jQ29kZSxEb2NUeXBlLERvY0RhdGUsQ29tcGFueUNvZGUsQ3VzdG9tZXJDb2RlLEVudGl0eVVzZUNvZGUsTGluZU5vLFRheENvZGUsVGF4RGF0ZSxJdGVtQ29kZSxEZXNjcmlwdGlvbixRdHksQW1vdW50LERpc2NvdW50LFJlZjEsUmVmMixFeGVtcHRpb25ObyxSZXZBY2N0LERlc3RBZGRyZXNzLERlc3RDaXR5LERlc3RSZWdpb24sRGVzdFBvc3RhbENvZGUsRGVzdENvdW50cnksT3JpZ0FkZHJlc3MsT3JpZ0NpdHksT3JpZ1JlZ2lvbixPcmlnUG9zdGFsQ29kZSxPcmlnQ291bnRyeSxMb2NhdGlvbkNvZGUsU2FsZXNQZXJzb25Db2RlLFB1cmNoYXNlT3JkZXJObyxDdXJyZW5jeUNvZGUsRXhjaGFuZ2VSYXRlLEV4Y2hhbmdlUmF0ZUVmZkRhdGUsUGF5bWVudERhdGUsVGF4SW5jbHVkZWQsRGVzdFRheFJlZ2lvbixPcmlnVGF4UmVnaW9uLFRheGFibGUsVGF4VHlwZSxUb3RhbFRheCxDb3VudHJ5TmFtZSxDb3VudHJ5Q29kZSxDb3VudHJ5UmF0ZSxDb3VudHJ5VGF4LFN0YXRlTmFtZSxTdGF0ZUNvZGUsU3RhdGVSYXRlLFN0YXRlVGF4LENvdW50eU5hbWUsQ291bnR5Q29kZSxDb3VudHlSYXRlLENvdW50eVRheCxDaXR5TmFtZSxDaXR5Q29kZSxDaXR5UmF0ZSxDaXR5VGF4LE90aGVyMU5hbWUsT3RoZXIxQ29kZSxPdGhlcjFSYXRlLE90aGVyMVRheCxPdGhlcjJOYW1lLE90aGVyMkNvZGUsT3RoZXIyUmF0ZSxPdGhlcjJUYXgsT3RoZXIzTmFtZSxPdGhlcjNDb2RlLE90aGVyM1JhdGUsT3RoZXIzVGF4LE90aGVyNE5hbWUsT3RoZXI0Q29kZSxPdGhlcjRSYXRlLE90aGVyNFRheCxSZWZlcmVuY2VDb2RlLEJ1eWVyc1ZBVE5vLElzU2VsbGVySW1wb3J0ZXJPZlJlY29yZCxCUkJ1eWVyVHlwZSxCUkJ1eWVyX0lzRXhlbXB0T3JDYW5ub3RXSF9JUlJGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX1BJU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NPRklOU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NTTExSRixCUkJ1eWVyX0lzRXhlbXB0X1BJUyxCUkJ1eWVyX0lzRXhlbXB0X0NPRklOUyxCUkJ1eWVyX0lzRXhlbXB0X0NTTEwsSGVhZGVyX0Rlc2NyaXB0aW9uLEVtYWlsDQozLDlhYzI4MGMzLTNhNTUtNGEzNS1iZWQyLWE4M2RiNTNiMDUxZSwxLDEvMS8yMDE0LERFRkFVTFQsQ3VzdDEsLDEsLCwsLCwxMDAwLCwsLCwsMjM1IEUgNDJuZCBTdCAsTmV3IFlvcmssTlksMTAwMTctNTcwMyAgLFVTLDkwMCBXaW5zbG93IFdheSxCYWluYnJpZGdlIElzbGFuZCxXQSw5ODExMCxVUywsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwNCg==\",\n \"contentLength\": 0,\n \"contentType\": \"text/csv\",\n \"fileExtension\": \".csv\",\n \"filePath\": \"samplebatch.csv\"\n }\n ]\n },\n {\n \"type\": \"TransactionImport\",\n \"batchAgent\": \"manual\",\n \"name\": \"TestBatch\",\n \"files\": [\n {\n \"name\": \"samplebatch.csv\",\n \"content\": \"UHJvY2Vzc0NvZGUsRG9jQ29kZSxEb2NUeXBlLERvY0RhdGUsQ29tcGFueUNvZGUsQ3VzdG9tZXJDb2RlLEVudGl0eVVzZUNvZGUsTGluZU5vLFRheENvZGUsVGF4RGF0ZSxJdGVtQ29kZSxEZXNjcmlwdGlvbixRdHksQW1vdW50LERpc2NvdW50LFJlZjEsUmVmMixFeGVtcHRpb25ObyxSZXZBY2N0LERlc3RBZGRyZXNzLERlc3RDaXR5LERlc3RSZWdpb24sRGVzdFBvc3RhbENvZGUsRGVzdENvdW50cnksT3JpZ0FkZHJlc3MsT3JpZ0NpdHksT3JpZ1JlZ2lvbixPcmlnUG9zdGFsQ29kZSxPcmlnQ291bnRyeSxMb2NhdGlvbkNvZGUsU2FsZXNQZXJzb25Db2RlLFB1cmNoYXNlT3JkZXJObyxDdXJyZW5jeUNvZGUsRXhjaGFuZ2VSYXRlLEV4Y2hhbmdlUmF0ZUVmZkRhdGUsUGF5bWVudERhdGUsVGF4SW5jbHVkZWQsRGVzdFRheFJlZ2lvbixPcmlnVGF4UmVnaW9uLFRheGFibGUsVGF4VHlwZSxUb3RhbFRheCxDb3VudHJ5TmFtZSxDb3VudHJ5Q29kZSxDb3VudHJ5UmF0ZSxDb3VudHJ5VGF4LFN0YXRlTmFtZSxTdGF0ZUNvZGUsU3RhdGVSYXRlLFN0YXRlVGF4LENvdW50eU5hbWUsQ291bnR5Q29kZSxDb3VudHlSYXRlLENvdW50eVRheCxDaXR5TmFtZSxDaXR5Q29kZSxDaXR5UmF0ZSxDaXR5VGF4LE90aGVyMU5hbWUsT3RoZXIxQ29kZSxPdGhlcjFSYXRlLE90aGVyMVRheCxPdGhlcjJOYW1lLE90aGVyMkNvZGUsT3RoZXIyUmF0ZSxPdGhlcjJUYXgsT3RoZXIzTmFtZSxPdGhlcjNDb2RlLE90aGVyM1JhdGUsT3RoZXIzVGF4LE90aGVyNE5hbWUsT3RoZXI0Q29kZSxPdGhlcjRSYXRlLE90aGVyNFRheCxSZWZlcmVuY2VDb2RlLEJ1eWVyc1ZBVE5vLElzU2VsbGVySW1wb3J0ZXJPZlJlY29yZCxCUkJ1eWVyVHlwZSxCUkJ1eWVyX0lzRXhlbXB0T3JDYW5ub3RXSF9JUlJGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX1BJU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NPRklOU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NTTExSRixCUkJ1eWVyX0lzRXhlbXB0X1BJUyxCUkJ1eWVyX0lzRXhlbXB0X0NPRklOUyxCUkJ1eWVyX0lzRXhlbXB0X0NTTEwsSGVhZGVyX0Rlc2NyaXB0aW9uLEVtYWlsDQozLDlhYzI4MGMzLTNhNTUtNGEzNS1iZWQyLWE4M2RiNTNiMDUxZSwxLDEvMS8yMDE0LERFRkFVTFQsQ3VzdDEsLDEsLCwsLCwxMDAwLCwsLCwsMjM1IEUgNDJuZCBTdCAsTmV3IFlvcmssTlksMTAwMTctNTcwMyAgLFVTLDkwMCBXaW5zbG93IFdheSxCYWluYnJpZGdlIElzbGFuZCxXQSw5ODExMCxVUywsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwNCg==\",\n \"contentLength\": 0,\n \"contentType\": \"text/csv\",\n \"fileExtension\": \".csv\",\n \"filePath\": \"samplebatch.csv\"\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch." } ] }, "description": "Create one or more new batch objects attached to this company.\r\n \r\nEach batch object may have one or more file objects (currently only one file is supported).\r\n \r\nWhen a batch is created, it is added to the AvaTax Batch Queue and will be\r\nprocessed as quickly as possible in the order it was received. To check the\r\nstatus of a batch, fetch the batch and retrieve the results of the batch\r\noperation.\r\n \r\nBecause the batch system processes with a degree of concurrency, and\r\nbecause of batch sizes in the queue vary, AvaTax API is unable to accurately\r\npredict when a batch will complete. If high performance processing is\r\nrequired, please use the\r\n[CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).\r\n \r\nThe maximum content length of the request body is limited to 28.6 MB. If this limit\r\nis exceeded, a 404 Not Found status will be returned (possibly with a CORS error if\r\nthe API is called from a browser). In this situation, please split the request into\r\nsmaller batches.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"type\": \"TransactionImport\",\n \"batchAgent\": \"manual\",\n \"name\": \"TestBatch\",\n \"files\": [\n {\n \"name\": \"samplebatch.csv\",\n \"content\": \"UHJvY2Vzc0NvZGUsRG9jQ29kZSxEb2NUeXBlLERvY0RhdGUsQ29tcGFueUNvZGUsQ3VzdG9tZXJDb2RlLEVudGl0eVVzZUNvZGUsTGluZU5vLFRheENvZGUsVGF4RGF0ZSxJdGVtQ29kZSxEZXNjcmlwdGlvbixRdHksQW1vdW50LERpc2NvdW50LFJlZjEsUmVmMixFeGVtcHRpb25ObyxSZXZBY2N0LERlc3RBZGRyZXNzLERlc3RDaXR5LERlc3RSZWdpb24sRGVzdFBvc3RhbENvZGUsRGVzdENvdW50cnksT3JpZ0FkZHJlc3MsT3JpZ0NpdHksT3JpZ1JlZ2lvbixPcmlnUG9zdGFsQ29kZSxPcmlnQ291bnRyeSxMb2NhdGlvbkNvZGUsU2FsZXNQZXJzb25Db2RlLFB1cmNoYXNlT3JkZXJObyxDdXJyZW5jeUNvZGUsRXhjaGFuZ2VSYXRlLEV4Y2hhbmdlUmF0ZUVmZkRhdGUsUGF5bWVudERhdGUsVGF4SW5jbHVkZWQsRGVzdFRheFJlZ2lvbixPcmlnVGF4UmVnaW9uLFRheGFibGUsVGF4VHlwZSxUb3RhbFRheCxDb3VudHJ5TmFtZSxDb3VudHJ5Q29kZSxDb3VudHJ5UmF0ZSxDb3VudHJ5VGF4LFN0YXRlTmFtZSxTdGF0ZUNvZGUsU3RhdGVSYXRlLFN0YXRlVGF4LENvdW50eU5hbWUsQ291bnR5Q29kZSxDb3VudHlSYXRlLENvdW50eVRheCxDaXR5TmFtZSxDaXR5Q29kZSxDaXR5UmF0ZSxDaXR5VGF4LE90aGVyMU5hbWUsT3RoZXIxQ29kZSxPdGhlcjFSYXRlLE90aGVyMVRheCxPdGhlcjJOYW1lLE90aGVyMkNvZGUsT3RoZXIyUmF0ZSxPdGhlcjJUYXgsT3RoZXIzTmFtZSxPdGhlcjNDb2RlLE90aGVyM1JhdGUsT3RoZXIzVGF4LE90aGVyNE5hbWUsT3RoZXI0Q29kZSxPdGhlcjRSYXRlLE90aGVyNFRheCxSZWZlcmVuY2VDb2RlLEJ1eWVyc1ZBVE5vLElzU2VsbGVySW1wb3J0ZXJPZlJlY29yZCxCUkJ1eWVyVHlwZSxCUkJ1eWVyX0lzRXhlbXB0T3JDYW5ub3RXSF9JUlJGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX1BJU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NPRklOU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NTTExSRixCUkJ1eWVyX0lzRXhlbXB0X1BJUyxCUkJ1eWVyX0lzRXhlbXB0X0NPRklOUyxCUkJ1eWVyX0lzRXhlbXB0X0NTTEwsSGVhZGVyX0Rlc2NyaXB0aW9uLEVtYWlsDQozLDlhYzI4MGMzLTNhNTUtNGEzNS1iZWQyLWE4M2RiNTNiMDUxZSwxLDEvMS8yMDE0LERFRkFVTFQsQ3VzdDEsLDEsLCwsLCwxMDAwLCwsLCwsMjM1IEUgNDJuZCBTdCAsTmV3IFlvcmssTlksMTAwMTctNTcwMyAgLFVTLDkwMCBXaW5zbG93IFdheSxCYWluYnJpZGdlIElzbGFuZCxXQSw5ODExMCxVUywsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwNCg==\",\n \"contentLength\": 0,\n \"contentType\": \"text/csv\",\n \"fileExtension\": \".csv\",\n \"filePath\": \"samplebatch.csv\"\n }\n ]\n },\n {\n \"type\": \"TransactionImport\",\n \"batchAgent\": \"manual\",\n \"name\": \"TestBatch\",\n \"files\": [\n {\n \"name\": \"samplebatch.csv\",\n \"content\": \"UHJvY2Vzc0NvZGUsRG9jQ29kZSxEb2NUeXBlLERvY0RhdGUsQ29tcGFueUNvZGUsQ3VzdG9tZXJDb2RlLEVudGl0eVVzZUNvZGUsTGluZU5vLFRheENvZGUsVGF4RGF0ZSxJdGVtQ29kZSxEZXNjcmlwdGlvbixRdHksQW1vdW50LERpc2NvdW50LFJlZjEsUmVmMixFeGVtcHRpb25ObyxSZXZBY2N0LERlc3RBZGRyZXNzLERlc3RDaXR5LERlc3RSZWdpb24sRGVzdFBvc3RhbENvZGUsRGVzdENvdW50cnksT3JpZ0FkZHJlc3MsT3JpZ0NpdHksT3JpZ1JlZ2lvbixPcmlnUG9zdGFsQ29kZSxPcmlnQ291bnRyeSxMb2NhdGlvbkNvZGUsU2FsZXNQZXJzb25Db2RlLFB1cmNoYXNlT3JkZXJObyxDdXJyZW5jeUNvZGUsRXhjaGFuZ2VSYXRlLEV4Y2hhbmdlUmF0ZUVmZkRhdGUsUGF5bWVudERhdGUsVGF4SW5jbHVkZWQsRGVzdFRheFJlZ2lvbixPcmlnVGF4UmVnaW9uLFRheGFibGUsVGF4VHlwZSxUb3RhbFRheCxDb3VudHJ5TmFtZSxDb3VudHJ5Q29kZSxDb3VudHJ5UmF0ZSxDb3VudHJ5VGF4LFN0YXRlTmFtZSxTdGF0ZUNvZGUsU3RhdGVSYXRlLFN0YXRlVGF4LENvdW50eU5hbWUsQ291bnR5Q29kZSxDb3VudHlSYXRlLENvdW50eVRheCxDaXR5TmFtZSxDaXR5Q29kZSxDaXR5UmF0ZSxDaXR5VGF4LE90aGVyMU5hbWUsT3RoZXIxQ29kZSxPdGhlcjFSYXRlLE90aGVyMVRheCxPdGhlcjJOYW1lLE90aGVyMkNvZGUsT3RoZXIyUmF0ZSxPdGhlcjJUYXgsT3RoZXIzTmFtZSxPdGhlcjNDb2RlLE90aGVyM1JhdGUsT3RoZXIzVGF4LE90aGVyNE5hbWUsT3RoZXI0Q29kZSxPdGhlcjRSYXRlLE90aGVyNFRheCxSZWZlcmVuY2VDb2RlLEJ1eWVyc1ZBVE5vLElzU2VsbGVySW1wb3J0ZXJPZlJlY29yZCxCUkJ1eWVyVHlwZSxCUkJ1eWVyX0lzRXhlbXB0T3JDYW5ub3RXSF9JUlJGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX1BJU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NPRklOU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NTTExSRixCUkJ1eWVyX0lzRXhlbXB0X1BJUyxCUkJ1eWVyX0lzRXhlbXB0X0NPRklOUyxCUkJ1eWVyX0lzRXhlbXB0X0NTTEwsSGVhZGVyX0Rlc2NyaXB0aW9uLEVtYWlsDQozLDlhYzI4MGMzLTNhNTUtNGEzNS1iZWQyLWE4M2RiNTNiMDUxZSwxLDEvMS8yMDE0LERFRkFVTFQsQ3VzdDEsLDEsLCwsLCwxMDAwLCwsLCwsMjM1IEUgNDJuZCBTdCAsTmV3IFlvcmssTlksMTAwMTctNTcwMyAgLFVTLDkwMCBXaW5zbG93IFdheSxCYWluYnJpZGdlIElzbGFuZCxXQSw5ODExMCxVUywsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwNCg==\",\n \"contentLength\": 0,\n \"contentType\": \"text/csv\",\n \"fileExtension\": \".csv\",\n \"filePath\": \"samplebatch.csv\"\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"type\": \"TransactionImport\",\n \"batchAgent\": \"manual\",\n \"name\": \"TestBatch\",\n \"files\": [\n {\n \"name\": \"samplebatch.csv\",\n \"content\": \"UHJvY2Vzc0NvZGUsRG9jQ29kZSxEb2NUeXBlLERvY0RhdGUsQ29tcGFueUNvZGUsQ3VzdG9tZXJDb2RlLEVudGl0eVVzZUNvZGUsTGluZU5vLFRheENvZGUsVGF4RGF0ZSxJdGVtQ29kZSxEZXNjcmlwdGlvbixRdHksQW1vdW50LERpc2NvdW50LFJlZjEsUmVmMixFeGVtcHRpb25ObyxSZXZBY2N0LERlc3RBZGRyZXNzLERlc3RDaXR5LERlc3RSZWdpb24sRGVzdFBvc3RhbENvZGUsRGVzdENvdW50cnksT3JpZ0FkZHJlc3MsT3JpZ0NpdHksT3JpZ1JlZ2lvbixPcmlnUG9zdGFsQ29kZSxPcmlnQ291bnRyeSxMb2NhdGlvbkNvZGUsU2FsZXNQZXJzb25Db2RlLFB1cmNoYXNlT3JkZXJObyxDdXJyZW5jeUNvZGUsRXhjaGFuZ2VSYXRlLEV4Y2hhbmdlUmF0ZUVmZkRhdGUsUGF5bWVudERhdGUsVGF4SW5jbHVkZWQsRGVzdFRheFJlZ2lvbixPcmlnVGF4UmVnaW9uLFRheGFibGUsVGF4VHlwZSxUb3RhbFRheCxDb3VudHJ5TmFtZSxDb3VudHJ5Q29kZSxDb3VudHJ5UmF0ZSxDb3VudHJ5VGF4LFN0YXRlTmFtZSxTdGF0ZUNvZGUsU3RhdGVSYXRlLFN0YXRlVGF4LENvdW50eU5hbWUsQ291bnR5Q29kZSxDb3VudHlSYXRlLENvdW50eVRheCxDaXR5TmFtZSxDaXR5Q29kZSxDaXR5UmF0ZSxDaXR5VGF4LE90aGVyMU5hbWUsT3RoZXIxQ29kZSxPdGhlcjFSYXRlLE90aGVyMVRheCxPdGhlcjJOYW1lLE90aGVyMkNvZGUsT3RoZXIyUmF0ZSxPdGhlcjJUYXgsT3RoZXIzTmFtZSxPdGhlcjNDb2RlLE90aGVyM1JhdGUsT3RoZXIzVGF4LE90aGVyNE5hbWUsT3RoZXI0Q29kZSxPdGhlcjRSYXRlLE90aGVyNFRheCxSZWZlcmVuY2VDb2RlLEJ1eWVyc1ZBVE5vLElzU2VsbGVySW1wb3J0ZXJPZlJlY29yZCxCUkJ1eWVyVHlwZSxCUkJ1eWVyX0lzRXhlbXB0T3JDYW5ub3RXSF9JUlJGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX1BJU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NPRklOU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NTTExSRixCUkJ1eWVyX0lzRXhlbXB0X1BJUyxCUkJ1eWVyX0lzRXhlbXB0X0NPRklOUyxCUkJ1eWVyX0lzRXhlbXB0X0NTTEwsSGVhZGVyX0Rlc2NyaXB0aW9uLEVtYWlsDQozLDlhYzI4MGMzLTNhNTUtNGEzNS1iZWQyLWE4M2RiNTNiMDUxZSwxLDEvMS8yMDE0LERFRkFVTFQsQ3VzdDEsLDEsLCwsLCwxMDAwLCwsLCwsMjM1IEUgNDJuZCBTdCAsTmV3IFlvcmssTlksMTAwMTctNTcwMyAgLFVTLDkwMCBXaW5zbG93IFdheSxCYWluYnJpZGdlIElzbGFuZCxXQSw5ODExMCxVUywsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwNCg==\",\n \"contentLength\": 0,\n \"contentType\": \"text/csv\",\n \"fileExtension\": \".csv\",\n \"filePath\": \"samplebatch.csv\"\n }\n ]\n },\n {\n \"type\": \"TransactionImport\",\n \"batchAgent\": \"manual\",\n \"name\": \"TestBatch\",\n \"files\": [\n {\n \"name\": \"samplebatch.csv\",\n \"content\": \"UHJvY2Vzc0NvZGUsRG9jQ29kZSxEb2NUeXBlLERvY0RhdGUsQ29tcGFueUNvZGUsQ3VzdG9tZXJDb2RlLEVudGl0eVVzZUNvZGUsTGluZU5vLFRheENvZGUsVGF4RGF0ZSxJdGVtQ29kZSxEZXNjcmlwdGlvbixRdHksQW1vdW50LERpc2NvdW50LFJlZjEsUmVmMixFeGVtcHRpb25ObyxSZXZBY2N0LERlc3RBZGRyZXNzLERlc3RDaXR5LERlc3RSZWdpb24sRGVzdFBvc3RhbENvZGUsRGVzdENvdW50cnksT3JpZ0FkZHJlc3MsT3JpZ0NpdHksT3JpZ1JlZ2lvbixPcmlnUG9zdGFsQ29kZSxPcmlnQ291bnRyeSxMb2NhdGlvbkNvZGUsU2FsZXNQZXJzb25Db2RlLFB1cmNoYXNlT3JkZXJObyxDdXJyZW5jeUNvZGUsRXhjaGFuZ2VSYXRlLEV4Y2hhbmdlUmF0ZUVmZkRhdGUsUGF5bWVudERhdGUsVGF4SW5jbHVkZWQsRGVzdFRheFJlZ2lvbixPcmlnVGF4UmVnaW9uLFRheGFibGUsVGF4VHlwZSxUb3RhbFRheCxDb3VudHJ5TmFtZSxDb3VudHJ5Q29kZSxDb3VudHJ5UmF0ZSxDb3VudHJ5VGF4LFN0YXRlTmFtZSxTdGF0ZUNvZGUsU3RhdGVSYXRlLFN0YXRlVGF4LENvdW50eU5hbWUsQ291bnR5Q29kZSxDb3VudHlSYXRlLENvdW50eVRheCxDaXR5TmFtZSxDaXR5Q29kZSxDaXR5UmF0ZSxDaXR5VGF4LE90aGVyMU5hbWUsT3RoZXIxQ29kZSxPdGhlcjFSYXRlLE90aGVyMVRheCxPdGhlcjJOYW1lLE90aGVyMkNvZGUsT3RoZXIyUmF0ZSxPdGhlcjJUYXgsT3RoZXIzTmFtZSxPdGhlcjNDb2RlLE90aGVyM1JhdGUsT3RoZXIzVGF4LE90aGVyNE5hbWUsT3RoZXI0Q29kZSxPdGhlcjRSYXRlLE90aGVyNFRheCxSZWZlcmVuY2VDb2RlLEJ1eWVyc1ZBVE5vLElzU2VsbGVySW1wb3J0ZXJPZlJlY29yZCxCUkJ1eWVyVHlwZSxCUkJ1eWVyX0lzRXhlbXB0T3JDYW5ub3RXSF9JUlJGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX1BJU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NPRklOU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NTTExSRixCUkJ1eWVyX0lzRXhlbXB0X1BJUyxCUkJ1eWVyX0lzRXhlbXB0X0NPRklOUyxCUkJ1eWVyX0lzRXhlbXB0X0NTTEwsSGVhZGVyX0Rlc2NyaXB0aW9uLEVtYWlsDQozLDlhYzI4MGMzLTNhNTUtNGEzNS1iZWQyLWE4M2RiNTNiMDUxZSwxLDEvMS8yMDE0LERFRkFVTFQsQ3VzdDEsLDEsLCwsLCwxMDAwLCwsLCwsMjM1IEUgNDJuZCBTdCAsTmV3IFlvcmssTlksMTAwMTctNTcwMyAgLFVTLDkwMCBXaW5zbG93IFdheSxCYWluYnJpZGdlIElzbGFuZCxXQSw5ODExMCxVUywsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwNCg==\",\n \"contentLength\": 0,\n \"contentType\": \"text/csv\",\n \"fileExtension\": \".csv\",\n \"filePath\": \"samplebatch.csv\"\n }\n ]\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"type\": \"TransactionImport\",\n \"batchAgent\": \"manual\",\n \"name\": \"TestBatch\",\n \"files\": [\n {\n \"name\": \"samplebatch.csv\",\n \"content\": \"UHJvY2Vzc0NvZGUsRG9jQ29kZSxEb2NUeXBlLERvY0RhdGUsQ29tcGFueUNvZGUsQ3VzdG9tZXJDb2RlLEVudGl0eVVzZUNvZGUsTGluZU5vLFRheENvZGUsVGF4RGF0ZSxJdGVtQ29kZSxEZXNjcmlwdGlvbixRdHksQW1vdW50LERpc2NvdW50LFJlZjEsUmVmMixFeGVtcHRpb25ObyxSZXZBY2N0LERlc3RBZGRyZXNzLERlc3RDaXR5LERlc3RSZWdpb24sRGVzdFBvc3RhbENvZGUsRGVzdENvdW50cnksT3JpZ0FkZHJlc3MsT3JpZ0NpdHksT3JpZ1JlZ2lvbixPcmlnUG9zdGFsQ29kZSxPcmlnQ291bnRyeSxMb2NhdGlvbkNvZGUsU2FsZXNQZXJzb25Db2RlLFB1cmNoYXNlT3JkZXJObyxDdXJyZW5jeUNvZGUsRXhjaGFuZ2VSYXRlLEV4Y2hhbmdlUmF0ZUVmZkRhdGUsUGF5bWVudERhdGUsVGF4SW5jbHVkZWQsRGVzdFRheFJlZ2lvbixPcmlnVGF4UmVnaW9uLFRheGFibGUsVGF4VHlwZSxUb3RhbFRheCxDb3VudHJ5TmFtZSxDb3VudHJ5Q29kZSxDb3VudHJ5UmF0ZSxDb3VudHJ5VGF4LFN0YXRlTmFtZSxTdGF0ZUNvZGUsU3RhdGVSYXRlLFN0YXRlVGF4LENvdW50eU5hbWUsQ291bnR5Q29kZSxDb3VudHlSYXRlLENvdW50eVRheCxDaXR5TmFtZSxDaXR5Q29kZSxDaXR5UmF0ZSxDaXR5VGF4LE90aGVyMU5hbWUsT3RoZXIxQ29kZSxPdGhlcjFSYXRlLE90aGVyMVRheCxPdGhlcjJOYW1lLE90aGVyMkNvZGUsT3RoZXIyUmF0ZSxPdGhlcjJUYXgsT3RoZXIzTmFtZSxPdGhlcjNDb2RlLE90aGVyM1JhdGUsT3RoZXIzVGF4LE90aGVyNE5hbWUsT3RoZXI0Q29kZSxPdGhlcjRSYXRlLE90aGVyNFRheCxSZWZlcmVuY2VDb2RlLEJ1eWVyc1ZBVE5vLElzU2VsbGVySW1wb3J0ZXJPZlJlY29yZCxCUkJ1eWVyVHlwZSxCUkJ1eWVyX0lzRXhlbXB0T3JDYW5ub3RXSF9JUlJGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX1BJU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NPRklOU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NTTExSRixCUkJ1eWVyX0lzRXhlbXB0X1BJUyxCUkJ1eWVyX0lzRXhlbXB0X0NPRklOUyxCUkJ1eWVyX0lzRXhlbXB0X0NTTEwsSGVhZGVyX0Rlc2NyaXB0aW9uLEVtYWlsDQozLDlhYzI4MGMzLTNhNTUtNGEzNS1iZWQyLWE4M2RiNTNiMDUxZSwxLDEvMS8yMDE0LERFRkFVTFQsQ3VzdDEsLDEsLCwsLCwxMDAwLCwsLCwsMjM1IEUgNDJuZCBTdCAsTmV3IFlvcmssTlksMTAwMTctNTcwMyAgLFVTLDkwMCBXaW5zbG93IFdheSxCYWluYnJpZGdlIElzbGFuZCxXQSw5ODExMCxVUywsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwNCg==\",\n \"contentLength\": 0,\n \"contentType\": \"text/csv\",\n \"fileExtension\": \".csv\",\n \"filePath\": \"samplebatch.csv\"\n }\n ]\n },\n {\n \"type\": \"TransactionImport\",\n \"batchAgent\": \"manual\",\n \"name\": \"TestBatch\",\n \"files\": [\n {\n \"name\": \"samplebatch.csv\",\n \"content\": \"UHJvY2Vzc0NvZGUsRG9jQ29kZSxEb2NUeXBlLERvY0RhdGUsQ29tcGFueUNvZGUsQ3VzdG9tZXJDb2RlLEVudGl0eVVzZUNvZGUsTGluZU5vLFRheENvZGUsVGF4RGF0ZSxJdGVtQ29kZSxEZXNjcmlwdGlvbixRdHksQW1vdW50LERpc2NvdW50LFJlZjEsUmVmMixFeGVtcHRpb25ObyxSZXZBY2N0LERlc3RBZGRyZXNzLERlc3RDaXR5LERlc3RSZWdpb24sRGVzdFBvc3RhbENvZGUsRGVzdENvdW50cnksT3JpZ0FkZHJlc3MsT3JpZ0NpdHksT3JpZ1JlZ2lvbixPcmlnUG9zdGFsQ29kZSxPcmlnQ291bnRyeSxMb2NhdGlvbkNvZGUsU2FsZXNQZXJzb25Db2RlLFB1cmNoYXNlT3JkZXJObyxDdXJyZW5jeUNvZGUsRXhjaGFuZ2VSYXRlLEV4Y2hhbmdlUmF0ZUVmZkRhdGUsUGF5bWVudERhdGUsVGF4SW5jbHVkZWQsRGVzdFRheFJlZ2lvbixPcmlnVGF4UmVnaW9uLFRheGFibGUsVGF4VHlwZSxUb3RhbFRheCxDb3VudHJ5TmFtZSxDb3VudHJ5Q29kZSxDb3VudHJ5UmF0ZSxDb3VudHJ5VGF4LFN0YXRlTmFtZSxTdGF0ZUNvZGUsU3RhdGVSYXRlLFN0YXRlVGF4LENvdW50eU5hbWUsQ291bnR5Q29kZSxDb3VudHlSYXRlLENvdW50eVRheCxDaXR5TmFtZSxDaXR5Q29kZSxDaXR5UmF0ZSxDaXR5VGF4LE90aGVyMU5hbWUsT3RoZXIxQ29kZSxPdGhlcjFSYXRlLE90aGVyMVRheCxPdGhlcjJOYW1lLE90aGVyMkNvZGUsT3RoZXIyUmF0ZSxPdGhlcjJUYXgsT3RoZXIzTmFtZSxPdGhlcjNDb2RlLE90aGVyM1JhdGUsT3RoZXIzVGF4LE90aGVyNE5hbWUsT3RoZXI0Q29kZSxPdGhlcjRSYXRlLE90aGVyNFRheCxSZWZlcmVuY2VDb2RlLEJ1eWVyc1ZBVE5vLElzU2VsbGVySW1wb3J0ZXJPZlJlY29yZCxCUkJ1eWVyVHlwZSxCUkJ1eWVyX0lzRXhlbXB0T3JDYW5ub3RXSF9JUlJGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX1BJU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NPRklOU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NTTExSRixCUkJ1eWVyX0lzRXhlbXB0X1BJUyxCUkJ1eWVyX0lzRXhlbXB0X0NPRklOUyxCUkJ1eWVyX0lzRXhlbXB0X0NTTEwsSGVhZGVyX0Rlc2NyaXB0aW9uLEVtYWlsDQozLDlhYzI4MGMzLTNhNTUtNGEzNS1iZWQyLWE4M2RiNTNiMDUxZSwxLDEvMS8yMDE0LERFRkFVTFQsQ3VzdDEsLDEsLCwsLCwxMDAwLCwsLCwsMjM1IEUgNDJuZCBTdCAsTmV3IFlvcmssTlksMTAwMTctNTcwMyAgLFVTLDkwMCBXaW5zbG93IFdheSxCYWluYnJpZGdlIElzbGFuZCxXQSw5ODExMCxVUywsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwNCg==\",\n \"contentLength\": 0,\n \"contentType\": \"text/csv\",\n \"fileExtension\": \".csv\",\n \"filePath\": \"samplebatch.csv\"\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"type\": \"TransactionImport\",\n \"batchAgent\": \"manual\",\n \"name\": \"TestBatch\",\n \"files\": [\n {\n \"name\": \"samplebatch.csv\",\n \"content\": \"UHJvY2Vzc0NvZGUsRG9jQ29kZSxEb2NUeXBlLERvY0RhdGUsQ29tcGFueUNvZGUsQ3VzdG9tZXJDb2RlLEVudGl0eVVzZUNvZGUsTGluZU5vLFRheENvZGUsVGF4RGF0ZSxJdGVtQ29kZSxEZXNjcmlwdGlvbixRdHksQW1vdW50LERpc2NvdW50LFJlZjEsUmVmMixFeGVtcHRpb25ObyxSZXZBY2N0LERlc3RBZGRyZXNzLERlc3RDaXR5LERlc3RSZWdpb24sRGVzdFBvc3RhbENvZGUsRGVzdENvdW50cnksT3JpZ0FkZHJlc3MsT3JpZ0NpdHksT3JpZ1JlZ2lvbixPcmlnUG9zdGFsQ29kZSxPcmlnQ291bnRyeSxMb2NhdGlvbkNvZGUsU2FsZXNQZXJzb25Db2RlLFB1cmNoYXNlT3JkZXJObyxDdXJyZW5jeUNvZGUsRXhjaGFuZ2VSYXRlLEV4Y2hhbmdlUmF0ZUVmZkRhdGUsUGF5bWVudERhdGUsVGF4SW5jbHVkZWQsRGVzdFRheFJlZ2lvbixPcmlnVGF4UmVnaW9uLFRheGFibGUsVGF4VHlwZSxUb3RhbFRheCxDb3VudHJ5TmFtZSxDb3VudHJ5Q29kZSxDb3VudHJ5UmF0ZSxDb3VudHJ5VGF4LFN0YXRlTmFtZSxTdGF0ZUNvZGUsU3RhdGVSYXRlLFN0YXRlVGF4LENvdW50eU5hbWUsQ291bnR5Q29kZSxDb3VudHlSYXRlLENvdW50eVRheCxDaXR5TmFtZSxDaXR5Q29kZSxDaXR5UmF0ZSxDaXR5VGF4LE90aGVyMU5hbWUsT3RoZXIxQ29kZSxPdGhlcjFSYXRlLE90aGVyMVRheCxPdGhlcjJOYW1lLE90aGVyMkNvZGUsT3RoZXIyUmF0ZSxPdGhlcjJUYXgsT3RoZXIzTmFtZSxPdGhlcjNDb2RlLE90aGVyM1JhdGUsT3RoZXIzVGF4LE90aGVyNE5hbWUsT3RoZXI0Q29kZSxPdGhlcjRSYXRlLE90aGVyNFRheCxSZWZlcmVuY2VDb2RlLEJ1eWVyc1ZBVE5vLElzU2VsbGVySW1wb3J0ZXJPZlJlY29yZCxCUkJ1eWVyVHlwZSxCUkJ1eWVyX0lzRXhlbXB0T3JDYW5ub3RXSF9JUlJGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX1BJU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NPRklOU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NTTExSRixCUkJ1eWVyX0lzRXhlbXB0X1BJUyxCUkJ1eWVyX0lzRXhlbXB0X0NPRklOUyxCUkJ1eWVyX0lzRXhlbXB0X0NTTEwsSGVhZGVyX0Rlc2NyaXB0aW9uLEVtYWlsDQozLDlhYzI4MGMzLTNhNTUtNGEzNS1iZWQyLWE4M2RiNTNiMDUxZSwxLDEvMS8yMDE0LERFRkFVTFQsQ3VzdDEsLDEsLCwsLCwxMDAwLCwsLCwsMjM1IEUgNDJuZCBTdCAsTmV3IFlvcmssTlksMTAwMTctNTcwMyAgLFVTLDkwMCBXaW5zbG93IFdheSxCYWluYnJpZGdlIElzbGFuZCxXQSw5ODExMCxVUywsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwNCg==\",\n \"contentLength\": 0,\n \"contentType\": \"text/csv\",\n \"fileExtension\": \".csv\",\n \"filePath\": \"samplebatch.csv\"\n }\n ]\n },\n {\n \"type\": \"TransactionImport\",\n \"batchAgent\": \"manual\",\n \"name\": \"TestBatch\",\n \"files\": [\n {\n \"name\": \"samplebatch.csv\",\n \"content\": \"UHJvY2Vzc0NvZGUsRG9jQ29kZSxEb2NUeXBlLERvY0RhdGUsQ29tcGFueUNvZGUsQ3VzdG9tZXJDb2RlLEVudGl0eVVzZUNvZGUsTGluZU5vLFRheENvZGUsVGF4RGF0ZSxJdGVtQ29kZSxEZXNjcmlwdGlvbixRdHksQW1vdW50LERpc2NvdW50LFJlZjEsUmVmMixFeGVtcHRpb25ObyxSZXZBY2N0LERlc3RBZGRyZXNzLERlc3RDaXR5LERlc3RSZWdpb24sRGVzdFBvc3RhbENvZGUsRGVzdENvdW50cnksT3JpZ0FkZHJlc3MsT3JpZ0NpdHksT3JpZ1JlZ2lvbixPcmlnUG9zdGFsQ29kZSxPcmlnQ291bnRyeSxMb2NhdGlvbkNvZGUsU2FsZXNQZXJzb25Db2RlLFB1cmNoYXNlT3JkZXJObyxDdXJyZW5jeUNvZGUsRXhjaGFuZ2VSYXRlLEV4Y2hhbmdlUmF0ZUVmZkRhdGUsUGF5bWVudERhdGUsVGF4SW5jbHVkZWQsRGVzdFRheFJlZ2lvbixPcmlnVGF4UmVnaW9uLFRheGFibGUsVGF4VHlwZSxUb3RhbFRheCxDb3VudHJ5TmFtZSxDb3VudHJ5Q29kZSxDb3VudHJ5UmF0ZSxDb3VudHJ5VGF4LFN0YXRlTmFtZSxTdGF0ZUNvZGUsU3RhdGVSYXRlLFN0YXRlVGF4LENvdW50eU5hbWUsQ291bnR5Q29kZSxDb3VudHlSYXRlLENvdW50eVRheCxDaXR5TmFtZSxDaXR5Q29kZSxDaXR5UmF0ZSxDaXR5VGF4LE90aGVyMU5hbWUsT3RoZXIxQ29kZSxPdGhlcjFSYXRlLE90aGVyMVRheCxPdGhlcjJOYW1lLE90aGVyMkNvZGUsT3RoZXIyUmF0ZSxPdGhlcjJUYXgsT3RoZXIzTmFtZSxPdGhlcjNDb2RlLE90aGVyM1JhdGUsT3RoZXIzVGF4LE90aGVyNE5hbWUsT3RoZXI0Q29kZSxPdGhlcjRSYXRlLE90aGVyNFRheCxSZWZlcmVuY2VDb2RlLEJ1eWVyc1ZBVE5vLElzU2VsbGVySW1wb3J0ZXJPZlJlY29yZCxCUkJ1eWVyVHlwZSxCUkJ1eWVyX0lzRXhlbXB0T3JDYW5ub3RXSF9JUlJGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX1BJU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NPRklOU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NTTExSRixCUkJ1eWVyX0lzRXhlbXB0X1BJUyxCUkJ1eWVyX0lzRXhlbXB0X0NPRklOUyxCUkJ1eWVyX0lzRXhlbXB0X0NTTEwsSGVhZGVyX0Rlc2NyaXB0aW9uLEVtYWlsDQozLDlhYzI4MGMzLTNhNTUtNGEzNS1iZWQyLWE4M2RiNTNiMDUxZSwxLDEvMS8yMDE0LERFRkFVTFQsQ3VzdDEsLDEsLCwsLCwxMDAwLCwsLCwsMjM1IEUgNDJuZCBTdCAsTmV3IFlvcmssTlksMTAwMTctNTcwMyAgLFVTLDkwMCBXaW5zbG93IFdheSxCYWluYnJpZGdlIElzbGFuZCxXQSw5ODExMCxVUywsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwNCg==\",\n \"contentLength\": 0,\n \"contentType\": \"text/csv\",\n \"fileExtension\": \".csv\",\n \"filePath\": \"samplebatch.csv\"\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"type\": \"TransactionImport\",\n \"batchAgent\": \"manual\",\n \"name\": \"TestBatch\",\n \"files\": [\n {\n \"name\": \"samplebatch.csv\",\n \"content\": \"UHJvY2Vzc0NvZGUsRG9jQ29kZSxEb2NUeXBlLERvY0RhdGUsQ29tcGFueUNvZGUsQ3VzdG9tZXJDb2RlLEVudGl0eVVzZUNvZGUsTGluZU5vLFRheENvZGUsVGF4RGF0ZSxJdGVtQ29kZSxEZXNjcmlwdGlvbixRdHksQW1vdW50LERpc2NvdW50LFJlZjEsUmVmMixFeGVtcHRpb25ObyxSZXZBY2N0LERlc3RBZGRyZXNzLERlc3RDaXR5LERlc3RSZWdpb24sRGVzdFBvc3RhbENvZGUsRGVzdENvdW50cnksT3JpZ0FkZHJlc3MsT3JpZ0NpdHksT3JpZ1JlZ2lvbixPcmlnUG9zdGFsQ29kZSxPcmlnQ291bnRyeSxMb2NhdGlvbkNvZGUsU2FsZXNQZXJzb25Db2RlLFB1cmNoYXNlT3JkZXJObyxDdXJyZW5jeUNvZGUsRXhjaGFuZ2VSYXRlLEV4Y2hhbmdlUmF0ZUVmZkRhdGUsUGF5bWVudERhdGUsVGF4SW5jbHVkZWQsRGVzdFRheFJlZ2lvbixPcmlnVGF4UmVnaW9uLFRheGFibGUsVGF4VHlwZSxUb3RhbFRheCxDb3VudHJ5TmFtZSxDb3VudHJ5Q29kZSxDb3VudHJ5UmF0ZSxDb3VudHJ5VGF4LFN0YXRlTmFtZSxTdGF0ZUNvZGUsU3RhdGVSYXRlLFN0YXRlVGF4LENvdW50eU5hbWUsQ291bnR5Q29kZSxDb3VudHlSYXRlLENvdW50eVRheCxDaXR5TmFtZSxDaXR5Q29kZSxDaXR5UmF0ZSxDaXR5VGF4LE90aGVyMU5hbWUsT3RoZXIxQ29kZSxPdGhlcjFSYXRlLE90aGVyMVRheCxPdGhlcjJOYW1lLE90aGVyMkNvZGUsT3RoZXIyUmF0ZSxPdGhlcjJUYXgsT3RoZXIzTmFtZSxPdGhlcjNDb2RlLE90aGVyM1JhdGUsT3RoZXIzVGF4LE90aGVyNE5hbWUsT3RoZXI0Q29kZSxPdGhlcjRSYXRlLE90aGVyNFRheCxSZWZlcmVuY2VDb2RlLEJ1eWVyc1ZBVE5vLElzU2VsbGVySW1wb3J0ZXJPZlJlY29yZCxCUkJ1eWVyVHlwZSxCUkJ1eWVyX0lzRXhlbXB0T3JDYW5ub3RXSF9JUlJGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX1BJU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NPRklOU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NTTExSRixCUkJ1eWVyX0lzRXhlbXB0X1BJUyxCUkJ1eWVyX0lzRXhlbXB0X0NPRklOUyxCUkJ1eWVyX0lzRXhlbXB0X0NTTEwsSGVhZGVyX0Rlc2NyaXB0aW9uLEVtYWlsDQozLDlhYzI4MGMzLTNhNTUtNGEzNS1iZWQyLWE4M2RiNTNiMDUxZSwxLDEvMS8yMDE0LERFRkFVTFQsQ3VzdDEsLDEsLCwsLCwxMDAwLCwsLCwsMjM1IEUgNDJuZCBTdCAsTmV3IFlvcmssTlksMTAwMTctNTcwMyAgLFVTLDkwMCBXaW5zbG93IFdheSxCYWluYnJpZGdlIElzbGFuZCxXQSw5ODExMCxVUywsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwNCg==\",\n \"contentLength\": 0,\n \"contentType\": \"text/csv\",\n \"fileExtension\": \".csv\",\n \"filePath\": \"samplebatch.csv\"\n }\n ]\n },\n {\n \"type\": \"TransactionImport\",\n \"batchAgent\": \"manual\",\n \"name\": \"TestBatch\",\n \"files\": [\n {\n \"name\": \"samplebatch.csv\",\n \"content\": \"UHJvY2Vzc0NvZGUsRG9jQ29kZSxEb2NUeXBlLERvY0RhdGUsQ29tcGFueUNvZGUsQ3VzdG9tZXJDb2RlLEVudGl0eVVzZUNvZGUsTGluZU5vLFRheENvZGUsVGF4RGF0ZSxJdGVtQ29kZSxEZXNjcmlwdGlvbixRdHksQW1vdW50LERpc2NvdW50LFJlZjEsUmVmMixFeGVtcHRpb25ObyxSZXZBY2N0LERlc3RBZGRyZXNzLERlc3RDaXR5LERlc3RSZWdpb24sRGVzdFBvc3RhbENvZGUsRGVzdENvdW50cnksT3JpZ0FkZHJlc3MsT3JpZ0NpdHksT3JpZ1JlZ2lvbixPcmlnUG9zdGFsQ29kZSxPcmlnQ291bnRyeSxMb2NhdGlvbkNvZGUsU2FsZXNQZXJzb25Db2RlLFB1cmNoYXNlT3JkZXJObyxDdXJyZW5jeUNvZGUsRXhjaGFuZ2VSYXRlLEV4Y2hhbmdlUmF0ZUVmZkRhdGUsUGF5bWVudERhdGUsVGF4SW5jbHVkZWQsRGVzdFRheFJlZ2lvbixPcmlnVGF4UmVnaW9uLFRheGFibGUsVGF4VHlwZSxUb3RhbFRheCxDb3VudHJ5TmFtZSxDb3VudHJ5Q29kZSxDb3VudHJ5UmF0ZSxDb3VudHJ5VGF4LFN0YXRlTmFtZSxTdGF0ZUNvZGUsU3RhdGVSYXRlLFN0YXRlVGF4LENvdW50eU5hbWUsQ291bnR5Q29kZSxDb3VudHlSYXRlLENvdW50eVRheCxDaXR5TmFtZSxDaXR5Q29kZSxDaXR5UmF0ZSxDaXR5VGF4LE90aGVyMU5hbWUsT3RoZXIxQ29kZSxPdGhlcjFSYXRlLE90aGVyMVRheCxPdGhlcjJOYW1lLE90aGVyMkNvZGUsT3RoZXIyUmF0ZSxPdGhlcjJUYXgsT3RoZXIzTmFtZSxPdGhlcjNDb2RlLE90aGVyM1JhdGUsT3RoZXIzVGF4LE90aGVyNE5hbWUsT3RoZXI0Q29kZSxPdGhlcjRSYXRlLE90aGVyNFRheCxSZWZlcmVuY2VDb2RlLEJ1eWVyc1ZBVE5vLElzU2VsbGVySW1wb3J0ZXJPZlJlY29yZCxCUkJ1eWVyVHlwZSxCUkJ1eWVyX0lzRXhlbXB0T3JDYW5ub3RXSF9JUlJGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX1BJU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NPRklOU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NTTExSRixCUkJ1eWVyX0lzRXhlbXB0X1BJUyxCUkJ1eWVyX0lzRXhlbXB0X0NPRklOUyxCUkJ1eWVyX0lzRXhlbXB0X0NTTEwsSGVhZGVyX0Rlc2NyaXB0aW9uLEVtYWlsDQozLDlhYzI4MGMzLTNhNTUtNGEzNS1iZWQyLWE4M2RiNTNiMDUxZSwxLDEvMS8yMDE0LERFRkFVTFQsQ3VzdDEsLDEsLCwsLCwxMDAwLCwsLCwsMjM1IEUgNDJuZCBTdCAsTmV3IFlvcmssTlksMTAwMTctNTcwMyAgLFVTLDkwMCBXaW5zbG93IFdheSxCYWluYnJpZGdlIElzbGFuZCxXQSw5ODExMCxVUywsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwNCg==\",\n \"contentLength\": 0,\n \"contentType\": \"text/csv\",\n \"fileExtension\": \".csv\",\n \"filePath\": \"samplebatch.csv\"\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/batches", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "batches" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this batch." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "certexpressinvites", "item": [ { "name": "List CertExpress invitations", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certexpressinvites?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certexpressinvites" ], "query": [ { "key": "$include", "value": "string", "description": "OPTIONAL: A comma separated list of special fetch options.\r\n \r\n No options are defined at this time." }, { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* companyId, customer, coverLetter, exposureZones, exemptReasons, requestLink" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that issued this invitation" } ] }, "description": "Retrieve CertExpress invitations sent by this company.\r\n \r\nA CertExpression invitation allows a customer to follow a helpful step-by-step guide to provide information\r\nabout their certificates. This step by step guide allows the customer to complete and upload the full\r\ncertificate in a convenient, friendly web browser experience. When the customer completes their certificates,\r\nthey will automatically be recorded to your company and linked to the customer record.\r\n \r\nThe [CertExpress website](https://app.certexpress.com/home) is available for customers to use at any time.\r\nUsing CertExpress with this API will ensure that your certificates are automatically linked correctly into\r\nyour company so that they can be used for tax exemptions.\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certexpressinvites?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certexpressinvites" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options.\r\n \r\n No options are defined at this time.", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* companyId, customer, coverLetter, exposureZones, exemptReasons, requestLink", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that issued this invitation" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 2160,\n \"value\": [\n {\n \"customerCode\": \"ABC\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certexpressinvites?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certexpressinvites" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options.\r\n \r\n No options are defined at this time.", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* companyId, customer, coverLetter, exposureZones, exemptReasons, requestLink", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that issued this invitation" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certexpressinvites?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certexpressinvites" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options.\r\n \r\n No options are defined at this time.", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* companyId, customer, coverLetter, exposureZones, exemptReasons, requestLink", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that issued this invitation" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certexpressinvites?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certexpressinvites" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options.\r\n \r\n No options are defined at this time.", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* companyId, customer, coverLetter, exposureZones, exemptReasons, requestLink", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that issued this invitation" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "customers", "item": [ { "name": "{customerCode}", "item": [ { "name": "certexpressinvites", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a single CertExpress invitation", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certexpressinvites/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certexpressinvites", ":id" ], "query": [ { "key": "$include", "value": "string", "description": "OPTIONAL: A comma separated list of special fetch options. No options are defined at this time." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that issued this invitation" }, { "key": "customerCode", "value": "string", "description": "The number of the customer where the request is sent to" }, { "key": "id", "value": "451", "description": "The unique ID number of this CertExpress invitation" } ] }, "description": "Retrieve an existing CertExpress invitation sent to a customer.\r\n \r\nA CertExpression invitation allows a customer to follow a helpful step-by-step guide to provide information\r\nabout their certificates. This step by step guide allows the customer to complete and upload the full\r\ncertificate in a convenient, friendly web browser experience. When the customer completes their certificates,\r\nthey will automatically be recorded to your company and linked to the customer record.\r\n \r\nThe [CertExpress website](https://app.certexpress.com/home) is available for customers to use at any time.\r\nUsing CertExpress with this API will ensure that your certificates are automatically linked correctly into\r\nyour company so that they can be used for tax exemptions.\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certexpressinvites/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certexpressinvites", ":id" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options. No options are defined at this time.", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that issued this invitation" }, { "key": "customerCode", "value": "string", "description": "The number of the customer where the request is sent to" }, { "key": "id", "value": "451", "description": "The unique ID number of this CertExpress invitation" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"customerCode\": \"ABC\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certexpressinvites/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certexpressinvites", ":id" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options. No options are defined at this time.", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that issued this invitation" }, { "key": "customerCode", "value": "string", "description": "The number of the customer where the request is sent to" }, { "key": "id", "value": "451", "description": "The unique ID number of this CertExpress invitation" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certexpressinvites/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certexpressinvites", ":id" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options. No options are defined at this time.", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that issued this invitation" }, { "key": "customerCode", "value": "string", "description": "The number of the customer where the request is sent to" }, { "key": "id", "value": "451", "description": "The unique ID number of this CertExpress invitation" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certexpressinvites/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certexpressinvites", ":id" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options. No options are defined at this time.", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that issued this invitation" }, { "key": "customerCode", "value": "string", "description": "The number of the customer where the request is sent to" }, { "key": "id", "value": "451", "description": "The unique ID number of this CertExpress invitation" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "Create a CertExpress invitation", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"recipient\": \"bob@example.org\",\n \"coverLetterTitle\": \"STANDARD_REQUEST\",\n \"exposureZones\": [\n 89\n ],\n \"exemptReasons\": [\n 70\n ],\n \"deliveryMethod\": \"Download\"\n },\n {\n \"recipient\": \"bob@example.org\",\n \"coverLetterTitle\": \"STANDARD_REQUEST\",\n \"exposureZones\": [\n 89\n ],\n \"exemptReasons\": [\n 70\n ],\n \"deliveryMethod\": \"Download\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certexpressinvites", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certexpressinvites" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that will record certificates" }, { "key": "customerCode", "value": "string", "description": "The number of the customer where the request is sent to" } ] }, "description": "Creates an invitation for a customer to self-report certificates using the CertExpress website.\r\n \r\nThis invitation is delivered by your choice of method, or you can present a hyperlink to the user\r\ndirectly in your connector. Your customer will be redirected to https://app.certexpress.com/ where\r\nthey can follow a step-by-step guide to enter information about their exemption certificates. The\r\ncertificates entered will be recorded and automatically linked to their customer record.\r\n \r\nThe [CertExpress website](https://app.certexpress.com/home) is available for customers to use at any time.\r\nUsing CertExpress with this API will ensure that your certificates are automatically linked correctly into\r\nyour company so that they can be used for tax exemptions.\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"recipient\": \"bob@example.org\",\n \"coverLetterTitle\": \"STANDARD_REQUEST\",\n \"exposureZones\": [\n 89\n ],\n \"exemptReasons\": [\n 70\n ],\n \"deliveryMethod\": \"Download\"\n },\n {\n \"recipient\": \"bob@example.org\",\n \"coverLetterTitle\": \"STANDARD_REQUEST\",\n \"exposureZones\": [\n 89\n ],\n \"exemptReasons\": [\n 70\n ],\n \"deliveryMethod\": \"Download\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certexpressinvites", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certexpressinvites" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that will record certificates" }, { "key": "customerCode", "value": "string", "description": "The number of the customer where the request is sent to" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"status\": \"InProgress\",\n \"invitation\": {\n \"customerCode\": \"ABC\"\n }\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"recipient\": \"bob@example.org\",\n \"coverLetterTitle\": \"STANDARD_REQUEST\",\n \"exposureZones\": [\n 89\n ],\n \"exemptReasons\": [\n 70\n ],\n \"deliveryMethod\": \"Download\"\n },\n {\n \"recipient\": \"bob@example.org\",\n \"coverLetterTitle\": \"STANDARD_REQUEST\",\n \"exposureZones\": [\n 89\n ],\n \"exemptReasons\": [\n 70\n ],\n \"deliveryMethod\": \"Download\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certexpressinvites", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certexpressinvites" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that will record certificates" }, { "key": "customerCode", "value": "string", "description": "The number of the customer where the request is sent to" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"recipient\": \"bob@example.org\",\n \"coverLetterTitle\": \"STANDARD_REQUEST\",\n \"exposureZones\": [\n 89\n ],\n \"exemptReasons\": [\n 70\n ],\n \"deliveryMethod\": \"Download\"\n },\n {\n \"recipient\": \"bob@example.org\",\n \"coverLetterTitle\": \"STANDARD_REQUEST\",\n \"exposureZones\": [\n 89\n ],\n \"exemptReasons\": [\n 70\n ],\n \"deliveryMethod\": \"Download\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certexpressinvites", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certexpressinvites" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that will record certificates" }, { "key": "customerCode", "value": "string", "description": "The number of the customer where the request is sent to" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "attributes", "item": [ { "name": "link", "item": [ { "name": "Link attributes to a customer", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 1,\n \"name\": \"ADDRESS CHANGE NEEDED\",\n \"description\": \"Customer address change is needed.\",\n \"isSystemCode\": false,\n \"isNonDeliver\": true,\n \"isChangeable\": true\n },\n {\n \"id\": 1,\n \"name\": \"ADDRESS CHANGE NEEDED\",\n \"description\": \"Customer address change is needed.\",\n \"isSystemCode\": false,\n \"isNonDeliver\": true,\n \"isChangeable\": true\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/attributes/link", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "attributes", "link" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded the provided customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing the current customer" } ] }, "description": "Link one or many attributes to a customer.\r\n \r\nA customer may have multiple attributes that control its behavior. You may link or unlink attributes to a\r\ncustomer at any time. The full list of defined attributes may be found using `QueryCompanyCustomerAttributes` API.\r\n \r\nA customer object defines information about a person or business that purchases products from your\r\ncompany. When you create a tax transaction in AvaTax, you can use the `customerCode` from this\r\nrecord in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and\r\nidentify any certificates linked to this customer object. If any certificate applies to the transaction,\r\nAvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 1,\n \"name\": \"ADDRESS CHANGE NEEDED\",\n \"description\": \"Customer address change is needed.\",\n \"isSystemCode\": false,\n \"isNonDeliver\": true,\n \"isChangeable\": true\n },\n {\n \"id\": 1,\n \"name\": \"ADDRESS CHANGE NEEDED\",\n \"description\": \"Customer address change is needed.\",\n \"isSystemCode\": false,\n \"isNonDeliver\": true,\n \"isChangeable\": true\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/attributes/link", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "attributes", "link" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded the provided customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing the current customer" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 9627,\n \"value\": [\n {\n \"id\": 1,\n \"name\": \"ADDRESS CHANGE NEEDED\",\n \"description\": \"Customer address change is needed.\",\n \"isSystemCode\": false,\n \"isNonDeliver\": true,\n \"isChangeable\": true\n },\n {\n \"id\": 1,\n \"name\": \"ADDRESS CHANGE NEEDED\",\n \"description\": \"Customer address change is needed.\",\n \"isSystemCode\": false,\n \"isNonDeliver\": true,\n \"isChangeable\": true\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "unlink", "item": [ { "name": "Unlink attributes from a customer", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 1,\n \"name\": \"ADDRESS CHANGE NEEDED\",\n \"description\": \"Customer address change is needed.\",\n \"isSystemCode\": false,\n \"isNonDeliver\": true,\n \"isChangeable\": true\n },\n {\n \"id\": 1,\n \"name\": \"ADDRESS CHANGE NEEDED\",\n \"description\": \"Customer address change is needed.\",\n \"isSystemCode\": false,\n \"isNonDeliver\": true,\n \"isChangeable\": true\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/attributes/unlink", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "attributes", "unlink" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded the customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing the current customer" } ] }, "description": "Unlink one or many attributes from a customer.\r\n \r\nA customer may have multiple attributes that control its behavior. You may link or unlink attributes to a\r\ncustomer at any time. The full list of defined attributes may be found using `QueryCompanyCustomerAttributes` API.\r\n \r\nA customer object defines information about a person or business that purchases products from your\r\ncompany. When you create a tax transaction in AvaTax, you can use the `customerCode` from this\r\nrecord in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and\r\nidentify any certificates linked to this customer object. If any certificate applies to the transaction,\r\nAvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 1,\n \"name\": \"ADDRESS CHANGE NEEDED\",\n \"description\": \"Customer address change is needed.\",\n \"isSystemCode\": false,\n \"isNonDeliver\": true,\n \"isChangeable\": true\n },\n {\n \"id\": 1,\n \"name\": \"ADDRESS CHANGE NEEDED\",\n \"description\": \"Customer address change is needed.\",\n \"isSystemCode\": false,\n \"isNonDeliver\": true,\n \"isChangeable\": true\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/attributes/unlink", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "attributes", "unlink" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded the customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing the current customer" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 9627,\n \"value\": [\n {\n \"id\": 1,\n \"name\": \"ADDRESS CHANGE NEEDED\",\n \"description\": \"Customer address change is needed.\",\n \"isSystemCode\": false,\n \"isNonDeliver\": true,\n \"isChangeable\": true\n },\n {\n \"id\": 1,\n \"name\": \"ADDRESS CHANGE NEEDED\",\n \"description\": \"Customer address change is needed.\",\n \"isSystemCode\": false,\n \"isNonDeliver\": true,\n \"isChangeable\": true\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "Retrieve a customer's attributes", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/attributes", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "attributes" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded the provided customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing the current customer" } ] }, "description": "Retrieve the attributes linked to the customer identified by this URL.\r\n \r\nA customer may have multiple attributes that control its behavior. You may link or unlink attributes to a\r\ncustomer at any time. The full list of defined attributes may be found using `QueryCompanyCustomerAttributes` API.\r\n \r\nA customer object defines information about a person or business that purchases products from your\r\ncompany. When you create a tax transaction in AvaTax, you can use the `customerCode` from this\r\nrecord in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and\r\nidentify any certificates linked to this customer object. If any certificate applies to the transaction,\r\nAvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/attributes", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "attributes" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded the provided customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing the current customer" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 9627,\n \"value\": [\n {\n \"id\": 1,\n \"name\": \"ADDRESS CHANGE NEEDED\",\n \"description\": \"Customer address change is needed.\",\n \"isSystemCode\": false,\n \"isNonDeliver\": true,\n \"isChangeable\": true\n },\n {\n \"id\": 1,\n \"name\": \"ADDRESS CHANGE NEEDED\",\n \"description\": \"Customer address change is needed.\",\n \"isSystemCode\": false,\n \"isNonDeliver\": true,\n \"isChangeable\": true\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "certificates", "item": [ { "name": "{country}", "item": [ { "name": "{region}", "item": [ { "name": "List valid certificates for a location", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certificates/:country/:region", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certificates", ":country", ":region" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" }, { "key": "country", "value": "string", "description": "Search for certificates matching this country. Uses the ISO 3166 two character country code." }, { "key": "region", "value": "string", "description": "Search for certificates matching this region. Uses the ISO 3166 two or three character state, region, or province code." } ] }, "description": "List valid certificates linked to a customer in a particular country and region.\r\n \r\nThis API is intended to help identify whether a customer has already provided a certificate that\r\napplies to a particular country and region. This API is intended to help you remind a customer\r\nwhen they have or have not provided copies of their exemption certificates to you during the sales\r\norder process.\r\n \r\nIf a customer does not have a certificate on file and they wish to provide one, you should send the customer\r\na CertExpress invitation link so that the customer can upload proof of their exemption certificate. Please\r\nsee the `CreateCertExpressInvitation` API to create an invitation link for this customer.\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certificates/:country/:region", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certificates", ":country", ":region" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" }, { "key": "country", "value": "string", "description": "Search for certificates matching this country. Uses the ISO 3166 two character country code." }, { "key": "region", "value": "string", "description": "Search for certificates matching this region. Uses the ISO 3166 two or three character state, region, or province code." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Exempt\",\n \"certificate\": {\n \"id\": 0,\n \"signedDate\": \"2016-02-01\",\n \"expirationDate\": \"2020-12-31\",\n \"filename\": \"15a0f773-b47c-4a63-8b3c-aed5f50be494\",\n \"documentExists\": false,\n \"valid\": true,\n \"verified\": false,\n \"exemptPercentage\": 0,\n \"isSingleCertificate\": false,\n \"exemptionNumber\": \"Exempt-1234\",\n \"exemptionReason\": {\n \"name\": \"RESALE\"\n },\n \"ecmStatus\": \"None\",\n \"createdDate\": \"2026-04-02T10:55:05.7717312Z\",\n \"modifiedDate\": \"2026-04-02\",\n \"taxNumberType\": \"FEIN\",\n \"businessNumberType\": \"Business Services\",\n \"pageCount\": 0,\n \"customers\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"56149afa-5b15-4909-8c11-60f785b125aa\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n },\n {\n \"companyId\": 0,\n \"customerCode\": \"22d5195f-8cd4-406c-a03d-16229e9c7cab\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"exposureZone\": {\n \"name\": \"Washington\"\n },\n \"exposureZoneName\": \"Washington\"\n }\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certificates/:country/:region", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certificates", ":country", ":region" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" }, { "key": "country", "value": "string", "description": "Search for certificates matching this country. Uses the ISO 3166 two character country code." }, { "key": "region", "value": "string", "description": "Search for certificates matching this region. Uses the ISO 3166 two or three character state, region, or province code." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certificates/:country/:region", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certificates", ":country", ":region" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" }, { "key": "country", "value": "string", "description": "Search for certificates matching this country. Uses the ISO 3166 two character country code." }, { "key": "region", "value": "string", "description": "Search for certificates matching this region. Uses the ISO 3166 two or three character state, region, or province code." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certificates/:country/:region", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certificates", ":country", ":region" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" }, { "key": "country", "value": "string", "description": "Search for certificates matching this country. Uses the ISO 3166 two character country code." }, { "key": "region", "value": "string", "description": "Search for certificates matching this region. Uses the ISO 3166 two or three character state, region, or province code." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] } ] }, { "name": "active", "item": [ { "name": "Retrieves a list of active certificates for a specified customer within a company.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certificates/active", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certificates", "active" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] }, "description": "This API is intended to identify whether a customer has any active certificates.\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certificates/active", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certificates", "active" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Exempt\",\n \"certificate\": {\n \"id\": 0,\n \"signedDate\": \"2016-02-01\",\n \"expirationDate\": \"2020-12-31\",\n \"filename\": \"15a0f773-b47c-4a63-8b3c-aed5f50be494\",\n \"documentExists\": false,\n \"valid\": true,\n \"verified\": false,\n \"exemptPercentage\": 0,\n \"isSingleCertificate\": false,\n \"exemptionNumber\": \"Exempt-1234\",\n \"exemptionReason\": {\n \"name\": \"RESALE\"\n },\n \"ecmStatus\": \"None\",\n \"createdDate\": \"2026-04-02T10:55:05.7717312Z\",\n \"modifiedDate\": \"2026-04-02\",\n \"taxNumberType\": \"FEIN\",\n \"businessNumberType\": \"Business Services\",\n \"pageCount\": 0,\n \"customers\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"56149afa-5b15-4909-8c11-60f785b125aa\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n },\n {\n \"companyId\": 0,\n \"customerCode\": \"22d5195f-8cd4-406c-a03d-16229e9c7cab\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"exposureZone\": {\n \"name\": \"Washington\"\n },\n \"exposureZoneName\": \"Washington\"\n }\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certificates/active", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certificates", "active" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certificates/active", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certificates", "active" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certificates/active", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certificates", "active" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "inactive", "item": [ { "name": "Retrieves a list of inactive certificates for a specified customer within a company.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certificates/inactive", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certificates", "inactive" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] }, "description": "This API is used to retrieve inactive certificates for a customer. Inactive certificates may include expired,\r\nrevoked, or otherwise non-compliant certificates.\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certificates/inactive", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certificates", "inactive" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Exempt\",\n \"certificate\": {\n \"id\": 0,\n \"signedDate\": \"2016-02-01\",\n \"expirationDate\": \"2020-12-31\",\n \"filename\": \"15a0f773-b47c-4a63-8b3c-aed5f50be494\",\n \"documentExists\": false,\n \"valid\": true,\n \"verified\": false,\n \"exemptPercentage\": 0,\n \"isSingleCertificate\": false,\n \"exemptionNumber\": \"Exempt-1234\",\n \"exemptionReason\": {\n \"name\": \"RESALE\"\n },\n \"ecmStatus\": \"None\",\n \"createdDate\": \"2026-04-02T10:55:05.7717312Z\",\n \"modifiedDate\": \"2026-04-02\",\n \"taxNumberType\": \"FEIN\",\n \"businessNumberType\": \"Business Services\",\n \"pageCount\": 0,\n \"customers\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"56149afa-5b15-4909-8c11-60f785b125aa\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n },\n {\n \"companyId\": 0,\n \"customerCode\": \"22d5195f-8cd4-406c-a03d-16229e9c7cab\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"exposureZone\": {\n \"name\": \"Washington\"\n },\n \"exposureZoneName\": \"Washington\"\n }\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certificates/inactive", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certificates", "inactive" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certificates/inactive", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certificates", "inactive" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certificates/inactive", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certificates", "inactive" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "link", "item": [ { "name": "Link certificates to a customer", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"certificates\": [\n 1,\n 3\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certificates/link", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certificates", "link" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] }, "description": "Link one or more certificates to a customer.\r\n \r\nA customer object defines information about a person or business that purchases products from your\r\ncompany. When you create a tax transaction in AvaTax, you can use the `customerCode` from this\r\nrecord in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and\r\nidentify any certificates linked to this `customer` object. If any certificate applies to the transaction,\r\nAvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"certificates\": [\n 1,\n 3\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certificates/link", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certificates", "link" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 3621,\n \"value\": [\n {\n \"id\": 0,\n \"signedDate\": \"2016-02-01\",\n \"expirationDate\": \"2020-12-31\",\n \"filename\": \"e9a180e9-fc5b-4352-96b2-5d6a23ef65ea\",\n \"documentExists\": false,\n \"valid\": true,\n \"verified\": false,\n \"exemptPercentage\": 0,\n \"isSingleCertificate\": false,\n \"exemptionNumber\": \"Exempt-1234\",\n \"exemptionReason\": {\n \"name\": \"RESALE\"\n },\n \"ecmStatus\": \"None\",\n \"createdDate\": \"2026-04-02T10:55:05.4352832Z\",\n \"modifiedDate\": \"2026-04-02\",\n \"taxNumberType\": \"FEIN\",\n \"businessNumberType\": \"Business Services\",\n \"pageCount\": 0,\n \"customers\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"43608837-c303-4b7f-a212-ef39e13f1f5d\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n },\n {\n \"companyId\": 0,\n \"customerCode\": \"714120c6-ae10-4fbf-9305-52f6f11bfde9\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"exposureZone\": {\n \"name\": \"Washington\"\n },\n \"exposureZoneName\": \"Washington\"\n },\n {\n \"id\": 0,\n \"signedDate\": \"2016-02-01\",\n \"expirationDate\": \"2020-12-31\",\n \"filename\": \"e9a180e9-fc5b-4352-96b2-5d6a23ef65ea\",\n \"documentExists\": false,\n \"valid\": true,\n \"verified\": false,\n \"exemptPercentage\": 0,\n \"isSingleCertificate\": false,\n \"exemptionNumber\": \"Exempt-1234\",\n \"exemptionReason\": {\n \"name\": \"RESALE\"\n },\n \"ecmStatus\": \"None\",\n \"createdDate\": \"2026-04-02T10:55:05.4352832Z\",\n \"modifiedDate\": \"2026-04-02\",\n \"taxNumberType\": \"FEIN\",\n \"businessNumberType\": \"Business Services\",\n \"pageCount\": 0,\n \"customers\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"43608837-c303-4b7f-a212-ef39e13f1f5d\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n },\n {\n \"companyId\": 0,\n \"customerCode\": \"714120c6-ae10-4fbf-9305-52f6f11bfde9\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"exposureZone\": {\n \"name\": \"Washington\"\n },\n \"exposureZoneName\": \"Washington\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"certificates\": [\n 1,\n 3\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certificates/link", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certificates", "link" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"certificates\": [\n 1,\n 3\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certificates/link", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certificates", "link" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"certificates\": [\n 1,\n 3\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certificates/link", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certificates", "link" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "unlink", "item": [ { "name": "Unlink certificates from a customer", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"certificates\": [\n 1,\n 3\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certificates/unlink", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certificates", "unlink" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] }, "description": "Remove one or more certificates to a customer.\r\n \r\nA customer object defines information about a person or business that purchases products from your\r\ncompany. When you create a tax transaction in AvaTax, you can use the `customerCode` from this\r\nrecord in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and\r\nidentify any certificates linked to this `customer` object. If any certificate applies to the transaction,\r\nAvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"certificates\": [\n 1,\n 3\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certificates/unlink", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certificates", "unlink" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 3621,\n \"value\": [\n {\n \"id\": 0,\n \"signedDate\": \"2016-02-01\",\n \"expirationDate\": \"2020-12-31\",\n \"filename\": \"e9a180e9-fc5b-4352-96b2-5d6a23ef65ea\",\n \"documentExists\": false,\n \"valid\": true,\n \"verified\": false,\n \"exemptPercentage\": 0,\n \"isSingleCertificate\": false,\n \"exemptionNumber\": \"Exempt-1234\",\n \"exemptionReason\": {\n \"name\": \"RESALE\"\n },\n \"ecmStatus\": \"None\",\n \"createdDate\": \"2026-04-02T10:55:05.4352832Z\",\n \"modifiedDate\": \"2026-04-02\",\n \"taxNumberType\": \"FEIN\",\n \"businessNumberType\": \"Business Services\",\n \"pageCount\": 0,\n \"customers\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"43608837-c303-4b7f-a212-ef39e13f1f5d\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n },\n {\n \"companyId\": 0,\n \"customerCode\": \"714120c6-ae10-4fbf-9305-52f6f11bfde9\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"exposureZone\": {\n \"name\": \"Washington\"\n },\n \"exposureZoneName\": \"Washington\"\n },\n {\n \"id\": 0,\n \"signedDate\": \"2016-02-01\",\n \"expirationDate\": \"2020-12-31\",\n \"filename\": \"e9a180e9-fc5b-4352-96b2-5d6a23ef65ea\",\n \"documentExists\": false,\n \"valid\": true,\n \"verified\": false,\n \"exemptPercentage\": 0,\n \"isSingleCertificate\": false,\n \"exemptionNumber\": \"Exempt-1234\",\n \"exemptionReason\": {\n \"name\": \"RESALE\"\n },\n \"ecmStatus\": \"None\",\n \"createdDate\": \"2026-04-02T10:55:05.4352832Z\",\n \"modifiedDate\": \"2026-04-02\",\n \"taxNumberType\": \"FEIN\",\n \"businessNumberType\": \"Business Services\",\n \"pageCount\": 0,\n \"customers\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"43608837-c303-4b7f-a212-ef39e13f1f5d\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n },\n {\n \"companyId\": 0,\n \"customerCode\": \"714120c6-ae10-4fbf-9305-52f6f11bfde9\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"exposureZone\": {\n \"name\": \"Washington\"\n },\n \"exposureZoneName\": \"Washington\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"certificates\": [\n 1,\n 3\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certificates/unlink", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certificates", "unlink" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"certificates\": [\n 1,\n 3\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certificates/unlink", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certificates", "unlink" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"certificates\": [\n 1,\n 3\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certificates/unlink", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certificates", "unlink" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "List certificates linked to a customer", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certificates?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certificates" ], "query": [ { "key": "$include", "value": "string", "description": "OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:\r\n \r\n * customers - Retrieves the list of customers linked to the certificate.\r\n * po_numbers - Retrieves all PO numbers tied to the certificate.\r\n * attributes - Retrieves all attributes applied to the certificate.\r\n * histories - Retrieves the certificate update history\r\n * jobs - Retrieves the jobs for this certificate\r\n * logs - Retrieves the certificate log\r\n * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid\r\n * custom_fields - Retrieves custom fields set for this certificate" }, { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* exemptionNumber, ecmsId, ecmsStatus, pdf, pages" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] }, "description": "List all certificates linked to a customer.\r\n \r\nA customer object defines information about a person or business that purchases products from your\r\ncompany. When you create a tax transaction in AvaTax, you can use the `customerCode` from this\r\nrecord in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and\r\nidentify any certificates linked to this `customer` object. If any certificate applies to the transaction,\r\nAvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certificates?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certificates" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:\r\n \r\n * customers - Retrieves the list of customers linked to the certificate.\r\n * po_numbers - Retrieves all PO numbers tied to the certificate.\r\n * attributes - Retrieves all attributes applied to the certificate.\r\n * histories - Retrieves the certificate update history\r\n * jobs - Retrieves the jobs for this certificate\r\n * logs - Retrieves the certificate log\r\n * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid\r\n * custom_fields - Retrieves custom fields set for this certificate", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* exemptionNumber, ecmsId, ecmsStatus, pdf, pages", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 3621,\n \"value\": [\n {\n \"id\": 0,\n \"signedDate\": \"2016-02-01\",\n \"expirationDate\": \"2020-12-31\",\n \"filename\": \"e9a180e9-fc5b-4352-96b2-5d6a23ef65ea\",\n \"documentExists\": false,\n \"valid\": true,\n \"verified\": false,\n \"exemptPercentage\": 0,\n \"isSingleCertificate\": false,\n \"exemptionNumber\": \"Exempt-1234\",\n \"exemptionReason\": {\n \"name\": \"RESALE\"\n },\n \"ecmStatus\": \"None\",\n \"createdDate\": \"2026-04-02T10:55:05.4352832Z\",\n \"modifiedDate\": \"2026-04-02\",\n \"taxNumberType\": \"FEIN\",\n \"businessNumberType\": \"Business Services\",\n \"pageCount\": 0,\n \"customers\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"43608837-c303-4b7f-a212-ef39e13f1f5d\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n },\n {\n \"companyId\": 0,\n \"customerCode\": \"714120c6-ae10-4fbf-9305-52f6f11bfde9\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"exposureZone\": {\n \"name\": \"Washington\"\n },\n \"exposureZoneName\": \"Washington\"\n },\n {\n \"id\": 0,\n \"signedDate\": \"2016-02-01\",\n \"expirationDate\": \"2020-12-31\",\n \"filename\": \"e9a180e9-fc5b-4352-96b2-5d6a23ef65ea\",\n \"documentExists\": false,\n \"valid\": true,\n \"verified\": false,\n \"exemptPercentage\": 0,\n \"isSingleCertificate\": false,\n \"exemptionNumber\": \"Exempt-1234\",\n \"exemptionReason\": {\n \"name\": \"RESALE\"\n },\n \"ecmStatus\": \"None\",\n \"createdDate\": \"2026-04-02T10:55:05.4352832Z\",\n \"modifiedDate\": \"2026-04-02\",\n \"taxNumberType\": \"FEIN\",\n \"businessNumberType\": \"Business Services\",\n \"pageCount\": 0,\n \"customers\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"43608837-c303-4b7f-a212-ef39e13f1f5d\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n },\n {\n \"companyId\": 0,\n \"customerCode\": \"714120c6-ae10-4fbf-9305-52f6f11bfde9\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"exposureZone\": {\n \"name\": \"Washington\"\n },\n \"exposureZoneName\": \"Washington\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certificates?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certificates" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:\r\n \r\n * customers - Retrieves the list of customers linked to the certificate.\r\n * po_numbers - Retrieves all PO numbers tied to the certificate.\r\n * attributes - Retrieves all attributes applied to the certificate.\r\n * histories - Retrieves the certificate update history\r\n * jobs - Retrieves the jobs for this certificate\r\n * logs - Retrieves the certificate log\r\n * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid\r\n * custom_fields - Retrieves custom fields set for this certificate", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* exemptionNumber, ecmsId, ecmsStatus, pdf, pages", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certificates?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certificates" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:\r\n \r\n * customers - Retrieves the list of customers linked to the certificate.\r\n * po_numbers - Retrieves all PO numbers tied to the certificate.\r\n * attributes - Retrieves all attributes applied to the certificate.\r\n * histories - Retrieves the certificate update history\r\n * jobs - Retrieves the jobs for this certificate\r\n * logs - Retrieves the certificate log\r\n * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid\r\n * custom_fields - Retrieves custom fields set for this certificate", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* exemptionNumber, ecmsId, ecmsStatus, pdf, pages", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/certificates?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "certificates" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:\r\n \r\n * customers - Retrieves the list of customers linked to the certificate.\r\n * po_numbers - Retrieves all PO numbers tied to the certificate.\r\n * attributes - Retrieves all attributes applied to the certificate.\r\n * histories - Retrieves the certificate update history\r\n * jobs - Retrieves the jobs for this certificate\r\n * logs - Retrieves the certificate log\r\n * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid\r\n * custom_fields - Retrieves custom fields set for this certificate", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* exemptionNumber, ecmsId, ecmsStatus, pdf, pages", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "custom-fields", "item": [ { "name": "Retrieves a list of custom fields for a specified customer within a company.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "custom-fields" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] }, "description": "This API is used to retrieve custom field for a customer.\r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "custom-fields" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Exempt\",\n \"certificate\": {\n \"id\": 0,\n \"signedDate\": \"2016-02-01\",\n \"expirationDate\": \"2020-12-31\",\n \"filename\": \"15a0f773-b47c-4a63-8b3c-aed5f50be494\",\n \"documentExists\": false,\n \"valid\": true,\n \"verified\": false,\n \"exemptPercentage\": 0,\n \"isSingleCertificate\": false,\n \"exemptionNumber\": \"Exempt-1234\",\n \"exemptionReason\": {\n \"name\": \"RESALE\"\n },\n \"ecmStatus\": \"None\",\n \"createdDate\": \"2026-04-02T10:55:05.7717312Z\",\n \"modifiedDate\": \"2026-04-02\",\n \"taxNumberType\": \"FEIN\",\n \"businessNumberType\": \"Business Services\",\n \"pageCount\": 0,\n \"customers\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"56149afa-5b15-4909-8c11-60f785b125aa\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n },\n {\n \"companyId\": 0,\n \"customerCode\": \"22d5195f-8cd4-406c-a03d-16229e9c7cab\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"exposureZone\": {\n \"name\": \"Washington\"\n },\n \"exposureZoneName\": \"Washington\"\n }\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "custom-fields" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "custom-fields" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "custom-fields" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] }, { "name": "Delete custom fields", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 1\n },\n {\n \"id\": 1\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "custom-fields" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] }, "description": "Deletes the value of the custom field.\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 1\n },\n {\n \"id\": 1\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "custom-fields" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 1\n },\n {\n \"id\": 1\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "custom-fields" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 1\n },\n {\n \"id\": 1\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "custom-fields" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 1\n },\n {\n \"id\": 1\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "custom-fields" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] }, { "name": "Update custom fields", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"customFields\": [\n {\n \"id\": 0,\n \"value\": \"test\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "custom-fields" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] }, "description": "Update the value of the custom field.\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"customFields\": [\n {\n \"id\": 0,\n \"value\": \"test\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "custom-fields" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"customFields\": [\n {\n \"id\": 0,\n \"value\": \"test\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "custom-fields" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"customFields\": [\n {\n \"id\": 0,\n \"value\": \"test\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "custom-fields" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"customFields\": [\n {\n \"id\": 0,\n \"value\": \"test\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode", "custom-fields" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "Retrieve a single customer", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode" ], "query": [ { "key": "$include", "value": "string", "description": "Specify optional additional objects to include in this fetch request" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] }, "description": "Retrieve the customer identified by this URL.\r\n \r\nA customer object defines information about a person or business that purchases products from your\r\ncompany. When you create a tax transaction in AvaTax, you can use the `customerCode` from this\r\nrecord in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and\r\nidentify any certificates linked to this customer object. If any certificate applies to the transaction,\r\nAvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.\r\n \r\nYou can use the `$include` parameter to fetch the following additional objects for expansion:\r\n \r\n* certificates - Fetch a list of certificates linked to this customer.\r\n* attributes - Retrieves all attributes applied to the customer.\r\n* active_certificates - Retrieves all the active certificates linked to this customer\r\n* histories - Retrieves the update history for this customer\r\n* logs - Retrieves customer logs\r\n* jobs - Retrieves customer jobs\r\n* billTos - Retrieves bill-tos linked with this customer\r\n* shipTos - Retrieves ship-tos linked with this customer\r\n* shipToStates - Retrieves ship-to states for this customer\r\n* custom_fields - Retrieves custom fields set for this customer\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode" ], "query": [ { "description": "Specify optional additional objects to include in this fetch request", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"companyId\": 0,\n \"customerCode\": \"244c4d10-a236-4468-b443-bd1eaa5dacda\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode" ], "query": [ { "description": "Specify optional additional objects to include in this fetch request", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode" ], "query": [ { "description": "Specify optional additional objects to include in this fetch request", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode" ], "query": [ { "description": "Specify optional additional objects to include in this fetch request", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] }, { "name": "Update a single customer", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"companyId\": 0,\n \"customerCode\": \"244c4d10-a236-4468-b443-bd1eaa5dacda\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] }, "description": "Replace the customer object at this URL with a new record.\r\n \r\nA customer object defines information about a person or business that purchases products from your\r\ncompany. When you create a tax transaction in AvaTax, you can use the `customerCode` from this\r\nrecord in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and\r\nidentify any certificates linked to this `customer` object. If any certificate applies to the transaction,\r\nAvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"companyId\": 0,\n \"customerCode\": \"244c4d10-a236-4468-b443-bd1eaa5dacda\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"companyId\": 0,\n \"customerCode\": \"244c4d10-a236-4468-b443-bd1eaa5dacda\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"companyId\": 0,\n \"customerCode\": \"244c4d10-a236-4468-b443-bd1eaa5dacda\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"companyId\": 0,\n \"customerCode\": \"244c4d10-a236-4468-b443-bd1eaa5dacda\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"companyId\": 0,\n \"customerCode\": \"244c4d10-a236-4468-b443-bd1eaa5dacda\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] }, { "name": "Delete a customer record", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] }, "description": "Deletes the customer object referenced by this URL.\r\n \r\nA customer object defines information about a person or business that purchases products from your\r\ncompany. When you create a tax transaction in AvaTax, you can use the `customerCode` from this\r\nrecord in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and\r\nidentify any certificates linked to this `customer` object. If any certificate applies to the transaction,\r\nAvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/:customerCode", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", ":customerCode" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" }, { "key": "customerCode", "value": "string", "description": "The unique code representing this customer" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "billto", "item": [ { "name": "{code}", "item": [ { "name": "shipto", "item": [ { "name": "link", "item": [ { "name": "Link two customer records together", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"customers\": [\n \"123456789\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/billto/:code/shipto/link", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", "billto", ":code", "shipto", "link" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company defining customers." }, { "key": "code", "value": "string", "description": "The code of the bill-to customer to link." } ] }, "description": "Links a Ship-To customer record with a Bill-To customer record.\r\n \r\nCustomer records represent businesses or individuals who can provide exemption certificates. Some customers\r\nmay have certificates that are linked to their shipping address or their billing address. To group these\r\ncustomer records together, you may link multiple bill-to and ship-to addresses together to represent a single\r\nentity that has multiple different addresses of different kinds.\r\n \r\nIn general, a customer will have only one primary billing address and multiple ship-to addresses, representing\r\nall of the different locations where they receive goods. To facilitate this type of customer, you can send in\r\none bill-to customer code and multiple ship-to customer codes in a single API call.\r\n \r\nNote that you can only link a ship-to customer record to a bill-to customer record. You may not link two customers\r\nof the same kind together.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"customers\": [\n \"123456789\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/billto/:code/shipto/link", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", "billto", ":code", "shipto", "link" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company defining customers." }, { "key": "code", "value": "string", "description": "The code of the bill-to customer to link." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"companyId\": 0,\n \"customerCode\": \"244c4d10-a236-4468-b443-bd1eaa5dacda\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"customers\": [\n \"123456789\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/billto/:code/shipto/link", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", "billto", ":code", "shipto", "link" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company defining customers." }, { "key": "code", "value": "string", "description": "The code of the bill-to customer to link." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"customers\": [\n \"123456789\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/billto/:code/shipto/link", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", "billto", ":code", "shipto", "link" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company defining customers." }, { "key": "code", "value": "string", "description": "The code of the bill-to customer to link." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"customers\": [\n \"123456789\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers/billto/:code/shipto/link", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers", "billto", ":code", "shipto", "link" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company defining customers." }, { "key": "code", "value": "string", "description": "The code of the bill-to customer to link." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] } ] } ] } ] }, { "name": "List all customers for this company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers" ], "query": [ { "key": "$include", "value": "string", "description": "OPTIONAL - You can specify any of the values in `certificates`, `attributes`, `active_certificates`, `histories`, `logs`, `jobs`, `billTos`, `shipTos`, `shipToStates`, and `custom_fields` to fetch additional information for this certificate." }, { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/)." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" } ] }, "description": "List all customers recorded by this company matching the specified criteria.\r\n \r\nA customer object defines information about a person or business that purchases products from your\r\ncompany. When you create a tax transaction in AvaTax, you can use the `customerCode` from this\r\nrecord in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and\r\nidentify any certificates linked to this `customer` object. If any certificate applies to the transaction,\r\nAvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.\r\n \r\nYou can use the `$include` parameter to fetch the following additional objects for expansion:\r\n \r\n* certificates - Fetch a list of certificates linked to this customer.\r\n* attributes - Retrieves all attributes applied to the customer.\r\n* active_certificates - Retrieves all the active certificates linked to this customer\r\n* histories - Retrieves the update history for this customer\r\n* logs - Retrieves customer logs\r\n* jobs - Retrieves customer jobs\r\n* billTos - Retrieves bill-tos linked with this customer\r\n* shipTos - Retrieves ship-tos linked with this customer\r\n* shipToStates - Retrieves ship-to states for this customer\r\n* custom_fields - Retrieves custom fields set for this customer\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers" ], "query": [ { "description": "OPTIONAL - You can specify any of the values in `certificates`, `attributes`, `active_certificates`, `histories`, `logs`, `jobs`, `billTos`, `shipTos`, `shipToStates`, and `custom_fields` to fetch additional information for this certificate.", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 1425,\n \"value\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"244c4d10-a236-4468-b443-bd1eaa5dacda\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers" ], "query": [ { "description": "OPTIONAL - You can specify any of the values in `certificates`, `attributes`, `active_certificates`, `histories`, `logs`, `jobs`, `billTos`, `shipTos`, `shipToStates`, and `custom_fields` to fetch additional information for this certificate.", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers" ], "query": [ { "description": "OPTIONAL - You can specify any of the values in `certificates`, `attributes`, `active_certificates`, `histories`, `logs`, `jobs`, `billTos`, `shipTos`, `shipToStates`, and `custom_fields` to fetch additional information for this certificate.", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers" ], "query": [ { "description": "OPTIONAL - You can specify any of the values in `certificates`, `attributes`, `active_certificates`, `histories`, `logs`, `jobs`, `billTos`, `shipTos`, `shipToStates`, and `custom_fields` to fetch additional information for this certificate.", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] }, { "name": "Create customers for this company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"companyId\": 0,\n \"customerCode\": \"244c4d10-a236-4468-b443-bd1eaa5dacda\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" } ] }, "description": "Create one or more customers for this company.\r\n \r\nA customer object defines information about a person or business that purchases products from your\r\ncompany. When you create a tax transaction in AvaTax, you can use the `customerCode` from this\r\nrecord in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and\r\nidentify any certificates linked to this `customer` object. If any certificate applies to the transaction,\r\nAvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.\r\n \r\nA nested object such as CustomFields could be specified and created along with the customer object. To fetch the\r\nnested object, please call 'GetCustomer' API with appropriate $include parameters.\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"companyId\": 0,\n \"customerCode\": \"244c4d10-a236-4468-b443-bd1eaa5dacda\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"companyId\": 0,\n \"customerCode\": \"244c4d10-a236-4468-b443-bd1eaa5dacda\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"companyId\": 0,\n \"customerCode\": \"244c4d10-a236-4468-b443-bd1eaa5dacda\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"companyId\": 0,\n \"customerCode\": \"244c4d10-a236-4468-b443-bd1eaa5dacda\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"companyId\": 0,\n \"customerCode\": \"244c4d10-a236-4468-b443-bd1eaa5dacda\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/customers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "customers" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this customer" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "certificates", "item": [ { "name": "{id}", "item": [ { "name": "attachment", "item": [ { "name": "Upload an image or PDF attachment for this certificate", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "description": "The exemption certificate file you wanted to upload. Accepted formats are: PDF, JPEG, TIFF, PNG.", "key": "file", "type": "file", "value": null } ] }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/attachment", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "attachment" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] }, "description": "Upload an image or PDF attachment for this certificate.\r\n \r\nImage attachments can be of the format `PDF`, `JPEG`, `TIFF`, or `PNG`. To upload a multi-page image, please\r\nuse the `PDF` data type.\r\n \r\nA certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document\r\ncan contain information about a customer's eligibility for exemption from sales or use taxes based on\r\ncriteria you specify when you store the certificate. To view or manage your certificates directly, please\r\nlog onto the administrative website for the product you purchased.\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "formdata", "formdata": [ { "description": "The exemption certificate file you wanted to upload. Accepted formats are: PDF, JPEG, TIFF, PNG.", "key": "file", "type": "file", "src": [] } ] }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/attachment", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "attachment" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "string" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "formdata", "formdata": [ { "description": "The exemption certificate file you wanted to upload. Accepted formats are: PDF, JPEG, TIFF, PNG.", "key": "file", "type": "file", "src": [] } ] }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/attachment", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "attachment" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "formdata", "formdata": [ { "description": "The exemption certificate file you wanted to upload. Accepted formats are: PDF, JPEG, TIFF, PNG.", "key": "file", "type": "file", "src": [] } ] }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/attachment", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "attachment" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "formdata", "formdata": [ { "description": "The exemption certificate file you wanted to upload. Accepted formats are: PDF, JPEG, TIFF, PNG.", "key": "file", "type": "file", "src": [] } ] }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/attachment", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "attachment" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] }, { "name": "Download an image for this certificate", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/octet-stream" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/attachment?$page=451&$type=Pdf", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "attachment" ], "query": [ { "key": "$page", "value": "451", "description": "If you choose `$type`=`Jpeg`, you must specify which page number to retrieve." }, { "key": "$type", "value": "Pdf", "description": "The data format in which to retrieve the certificate image" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] }, "description": "Download an image or PDF file for this certificate.\r\n \r\nThis API can be used to download either a single-page preview of the certificate or a full PDF document.\r\nTo retrieve a preview image, set the `$type` parameter to `Jpeg` and the `$page` parameter to `1`.\r\n \r\nA certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document\r\ncan contain information about a customer's eligibility for exemption from sales or use taxes based on\r\ncriteria you specify when you store the certificate. To view or manage your certificates directly, please\r\nlog onto the administrative website for the product you purchased.\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/octet-stream" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/attachment?$page=451&$type=Pdf", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "attachment" ], "query": [ { "description": "If you choose `$type`=`Jpeg`, you must specify which page number to retrieve.", "key": "$page", "value": "451" }, { "description": "The data format in which to retrieve the certificate image", "key": "$type", "value": "Pdf" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "string" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/octet-stream" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/attachment?$page=451&$type=Pdf", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "attachment" ], "query": [ { "description": "If you choose `$type`=`Jpeg`, you must specify which page number to retrieve.", "key": "$page", "value": "451" }, { "description": "The data format in which to retrieve the certificate image", "key": "$type", "value": "Pdf" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/octet-stream" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/attachment?$page=451&$type=Pdf", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "attachment" ], "query": [ { "description": "If you choose `$type`=`Jpeg`, you must specify which page number to retrieve.", "key": "$page", "value": "451" }, { "description": "The data format in which to retrieve the certificate image", "key": "$type", "value": "Pdf" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/octet-stream" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/attachment?$page=451&$type=Pdf", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "attachment" ], "query": [ { "description": "If you choose `$type`=`Jpeg`, you must specify which page number to retrieve.", "key": "$page", "value": "451" }, { "description": "The data format in which to retrieve the certificate image", "key": "$type", "value": "Pdf" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "attributes", "item": [ { "name": "link", "item": [ { "name": "Link attributes to a certificate", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"DIRECT PAY\",\n \"isSystemCode\": false\n },\n {\n \"id\": 0,\n \"name\": \"DIRECT PAY\",\n \"isSystemCode\": false\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/attributes/link", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "attributes", "link" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] }, "description": "Link one or many attributes to a certificate.\r\n \r\nA certificate may have multiple attributes that control its behavior. You may link or unlink attributes to a\r\ncertificate at any time. The full list of defined attributes may be found using `ListCertificateAttributes`.\r\n \r\nA certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document\r\ncan contain information about a customer's eligibility for exemption from sales or use taxes based on\r\ncriteria you specify when you store the certificate. To view or manage your certificates directly, please\r\nlog onto the administrative website for the product you purchased.\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"DIRECT PAY\",\n \"isSystemCode\": false\n },\n {\n \"id\": 0,\n \"name\": \"DIRECT PAY\",\n \"isSystemCode\": false\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/attributes/link", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "attributes", "link" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 8388,\n \"value\": [\n {\n \"id\": 0,\n \"name\": \"DIRECT PAY\",\n \"isSystemCode\": false\n },\n {\n \"id\": 0,\n \"name\": \"DIRECT PAY\",\n \"isSystemCode\": false\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"DIRECT PAY\",\n \"isSystemCode\": false\n },\n {\n \"id\": 0,\n \"name\": \"DIRECT PAY\",\n \"isSystemCode\": false\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/attributes/link", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "attributes", "link" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"DIRECT PAY\",\n \"isSystemCode\": false\n },\n {\n \"id\": 0,\n \"name\": \"DIRECT PAY\",\n \"isSystemCode\": false\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/attributes/link", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "attributes", "link" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"DIRECT PAY\",\n \"isSystemCode\": false\n },\n {\n \"id\": 0,\n \"name\": \"DIRECT PAY\",\n \"isSystemCode\": false\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/attributes/link", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "attributes", "link" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "unlink", "item": [ { "name": "Unlink attributes from a certificate", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"DIRECT PAY\",\n \"isSystemCode\": false\n },\n {\n \"id\": 0,\n \"name\": \"DIRECT PAY\",\n \"isSystemCode\": false\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/attributes/unlink", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "attributes", "unlink" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] }, "description": "Unlink one or many attributes from a certificate.\r\n \r\nA certificate may have multiple attributes that control its behavior. You may link or unlink attributes to a\r\ncertificate at any time. The full list of defined attributes may be found using `ListCertificateAttributes`.\r\n \r\nA certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document\r\ncan contain information about a customer's eligibility for exemption from sales or use taxes based on\r\ncriteria you specify when you store the certificate. To view or manage your certificates directly, please\r\nlog onto the administrative website for the product you purchased.\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"DIRECT PAY\",\n \"isSystemCode\": false\n },\n {\n \"id\": 0,\n \"name\": \"DIRECT PAY\",\n \"isSystemCode\": false\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/attributes/unlink", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "attributes", "unlink" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 8388,\n \"value\": [\n {\n \"id\": 0,\n \"name\": \"DIRECT PAY\",\n \"isSystemCode\": false\n },\n {\n \"id\": 0,\n \"name\": \"DIRECT PAY\",\n \"isSystemCode\": false\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"DIRECT PAY\",\n \"isSystemCode\": false\n },\n {\n \"id\": 0,\n \"name\": \"DIRECT PAY\",\n \"isSystemCode\": false\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/attributes/unlink", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "attributes", "unlink" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"DIRECT PAY\",\n \"isSystemCode\": false\n },\n {\n \"id\": 0,\n \"name\": \"DIRECT PAY\",\n \"isSystemCode\": false\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/attributes/unlink", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "attributes", "unlink" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"DIRECT PAY\",\n \"isSystemCode\": false\n },\n {\n \"id\": 0,\n \"name\": \"DIRECT PAY\",\n \"isSystemCode\": false\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/attributes/unlink", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "attributes", "unlink" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "List all attributes applied to this certificate", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/attributes", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "attributes" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] }, "description": "Retrieve the list of attributes that are linked to this certificate.\r\n \r\nA certificate may have multiple attributes that control its behavior. You may link or unlink attributes to a\r\ncertificate at any time. The full list of defined attributes may be found using [ListCertificateAttributes](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListCertificateAttributes/) API.\r\n \r\nA certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document\r\ncan contain information about a customer's eligibility for exemption from sales or use taxes based on\r\ncriteria you specify when you store the certificate. To view or manage your certificates directly, please\r\nlog onto the administrative website for the product you purchased.\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/attributes", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "attributes" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 8388,\n \"value\": [\n {\n \"id\": 0,\n \"name\": \"DIRECT PAY\",\n \"isSystemCode\": false\n },\n {\n \"id\": 0,\n \"name\": \"DIRECT PAY\",\n \"isSystemCode\": false\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/attributes", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "attributes" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/attributes", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "attributes" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/attributes", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "attributes" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "custom-fields", "item": [ { "name": "Retrieve Certificate Custom Fields", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "custom-fields" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] }, "description": "This API is used to retrieve custom fields for a certificate.\r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "custom-fields" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Exempt\",\n \"certificate\": {\n \"id\": 0,\n \"signedDate\": \"2016-02-01\",\n \"expirationDate\": \"2020-12-31\",\n \"filename\": \"15a0f773-b47c-4a63-8b3c-aed5f50be494\",\n \"documentExists\": false,\n \"valid\": true,\n \"verified\": false,\n \"exemptPercentage\": 0,\n \"isSingleCertificate\": false,\n \"exemptionNumber\": \"Exempt-1234\",\n \"exemptionReason\": {\n \"name\": \"RESALE\"\n },\n \"ecmStatus\": \"None\",\n \"createdDate\": \"2026-04-02T10:55:05.7717312Z\",\n \"modifiedDate\": \"2026-04-02\",\n \"taxNumberType\": \"FEIN\",\n \"businessNumberType\": \"Business Services\",\n \"pageCount\": 0,\n \"customers\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"56149afa-5b15-4909-8c11-60f785b125aa\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n },\n {\n \"companyId\": 0,\n \"customerCode\": \"22d5195f-8cd4-406c-a03d-16229e9c7cab\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"exposureZone\": {\n \"name\": \"Washington\"\n },\n \"exposureZoneName\": \"Washington\"\n }\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "custom-fields" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "custom-fields" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "custom-fields" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] }, { "name": "Update Certificate Custom Fields", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"customFields\": [\n {\n \"id\": 0,\n \"value\": \"test\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "custom-fields" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] }, "description": "Updates the values of custom fields for a certificate\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"customFields\": [\n {\n \"id\": 0,\n \"value\": \"test\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "custom-fields" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"customFields\": [\n {\n \"id\": 0,\n \"value\": \"test\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "custom-fields" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"customFields\": [\n {\n \"id\": 0,\n \"value\": \"test\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "custom-fields" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"customFields\": [\n {\n \"id\": 0,\n \"value\": \"test\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "custom-fields" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] }, { "name": "Delete Certificate Custom Fields", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 1\n },\n {\n \"id\": 1\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "custom-fields" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] }, "description": "Deletes custom fields for a specified certificate.\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 1\n },\n {\n \"id\": 1\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "custom-fields" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 1\n },\n {\n \"id\": 1\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "custom-fields" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 1\n },\n {\n \"id\": 1\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "custom-fields" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 1\n },\n {\n \"id\": 1\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "custom-fields" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "customers", "item": [ { "name": "link", "item": [ { "name": "Link customers to a certificate", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"customers\": [\n \"123456789\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/customers/link", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "customers", "link" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] }, "description": "Link one or more customers to an existing certificate.\r\n \r\nCustomers and certificates must be linked before a customer can make use of a certificate to obtain\r\na tax exemption in AvaTax. Since some certificates may cover more than one business entity, a certificate\r\ncan be connected to multiple customer records using the `LinkCustomersToCertificate` API.\r\n \r\nA certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document\r\ncan contain information about a customer's eligibility for exemption from sales or use taxes based on\r\ncriteria you specify when you store the certificate. To view or manage your certificates directly, please\r\nlog onto the administrative website for the product you purchased.\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"customers\": [\n \"123456789\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/customers/link", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "customers", "link" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 1425,\n \"value\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"244c4d10-a236-4468-b443-bd1eaa5dacda\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"customers\": [\n \"123456789\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/customers/link", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "customers", "link" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"customers\": [\n \"123456789\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/customers/link", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "customers", "link" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"customers\": [\n \"123456789\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/customers/link", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "customers", "link" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "unlink", "item": [ { "name": "Unlink customers from a certificate", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"customers\": [\n \"123456789\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/customers/unlink", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "customers", "unlink" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] }, "description": "Unlinks one or more customers from a certificate.\r\n \r\nUnlinking a certificate from a customer will prevent the certificate from being used to generate\r\ntax exemptions for the customer in the future. If any previous transactions for this customer had\r\nused this linked certificate, those transactions will be unchanged and will still have a link to the\r\nexemption certificate in question.\r\n \r\nA certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document\r\ncan contain information about a customer's eligibility for exemption from sales or use taxes based on\r\ncriteria you specify when you store the certificate. To view or manage your certificates directly, please\r\nlog onto the administrative website for the product you purchased.\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"customers\": [\n \"123456789\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/customers/unlink", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "customers", "unlink" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 1425,\n \"value\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"244c4d10-a236-4468-b443-bd1eaa5dacda\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"customers\": [\n \"123456789\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/customers/unlink", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "customers", "unlink" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"customers\": [\n \"123456789\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/customers/unlink", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "customers", "unlink" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"customers\": [\n \"123456789\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/customers/unlink", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "customers", "unlink" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "List customers linked to this certificate", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/customers?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "customers" ], "query": [ { "key": "$include", "value": "string", "description": "OPTIONAL: A comma separated list of special fetch options.\r\n No options are currently available when fetching customers." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] }, "description": "List all customers linked to this certificate.\r\n \r\nCustomers must be linked to a certificate in order to make use of its tax exemption features. You\r\ncan link or unlink customers to a certificate at any time.\r\n \r\nA certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document\r\ncan contain information about a customer's eligibility for exemption from sales or use taxes based on\r\ncriteria you specify when you store the certificate. To view or manage your certificates directly, please\r\nlog onto the administrative website for the product you purchased.\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/customers?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "customers" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options.\r\n No options are currently available when fetching customers.", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 1425,\n \"value\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"244c4d10-a236-4468-b443-bd1eaa5dacda\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/customers?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "customers" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options.\r\n No options are currently available when fetching customers.", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/customers?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "customers" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options.\r\n No options are currently available when fetching customers.", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id/customers?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id", "customers" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options.\r\n No options are currently available when fetching customers.", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "Retrieve a single certificate", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id" ], "query": [ { "key": "$include", "value": "string", "description": "OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:\r\n \r\n * customers - Retrieves the list of customers linked to the certificate.\r\n * po_numbers - Retrieves all PO numbers tied to the certificate.\r\n * attributes - Retrieves all attributes applied to the certificate.\r\n * histories - Retrieves the certificate update history\r\n * jobs - Retrieves the jobs for this certificate\r\n * logs - Retrieves the certificate log\r\n * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid\r\n * custom_fields - Retrieves custom fields set for this certificate" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] }, "description": "Get the current certificate identified by this URL.\r\n \r\nA certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document\r\ncan contain information about a customer's eligibility for exemption from sales or use taxes based on\r\ncriteria you specify when you store the certificate. To view or manage your certificates directly, please\r\nlog onto the administrative website for the product you purchased.\r\n \r\nYou can use the `$include` parameter to fetch the following additional objects for expansion:\r\n \r\n* customers - Retrieves the list of customers linked to the certificate.\r\n* po_numbers - Retrieves all PO numbers tied to the certificate.\r\n* attributes - Retrieves all attributes applied to the certificate.\r\n* histories - Retrieves the certificate update history\r\n* jobs - Retrieves the jobs for this certificate\r\n* logs - Retrieves the certificate log\r\n* invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid\r\n* custom_fields - Retrieves custom fields set for this certificate\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:\r\n \r\n * customers - Retrieves the list of customers linked to the certificate.\r\n * po_numbers - Retrieves all PO numbers tied to the certificate.\r\n * attributes - Retrieves all attributes applied to the certificate.\r\n * histories - Retrieves the certificate update history\r\n * jobs - Retrieves the jobs for this certificate\r\n * logs - Retrieves the certificate log\r\n * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid\r\n * custom_fields - Retrieves custom fields set for this certificate", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 0,\n \"signedDate\": \"2016-02-01\",\n \"expirationDate\": \"2020-12-31\",\n \"filename\": \"e9a180e9-fc5b-4352-96b2-5d6a23ef65ea\",\n \"documentExists\": false,\n \"valid\": true,\n \"verified\": false,\n \"exemptPercentage\": 0,\n \"isSingleCertificate\": false,\n \"exemptionNumber\": \"Exempt-1234\",\n \"exemptionReason\": {\n \"name\": \"RESALE\"\n },\n \"ecmStatus\": \"None\",\n \"createdDate\": \"2026-04-02T10:55:05.4352832Z\",\n \"modifiedDate\": \"2026-04-02\",\n \"taxNumberType\": \"FEIN\",\n \"businessNumberType\": \"Business Services\",\n \"pageCount\": 0,\n \"customers\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"43608837-c303-4b7f-a212-ef39e13f1f5d\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n },\n {\n \"companyId\": 0,\n \"customerCode\": \"714120c6-ae10-4fbf-9305-52f6f11bfde9\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"exposureZone\": {\n \"name\": \"Washington\"\n },\n \"exposureZoneName\": \"Washington\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:\r\n \r\n * customers - Retrieves the list of customers linked to the certificate.\r\n * po_numbers - Retrieves all PO numbers tied to the certificate.\r\n * attributes - Retrieves all attributes applied to the certificate.\r\n * histories - Retrieves the certificate update history\r\n * jobs - Retrieves the jobs for this certificate\r\n * logs - Retrieves the certificate log\r\n * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid\r\n * custom_fields - Retrieves custom fields set for this certificate", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:\r\n \r\n * customers - Retrieves the list of customers linked to the certificate.\r\n * po_numbers - Retrieves all PO numbers tied to the certificate.\r\n * attributes - Retrieves all attributes applied to the certificate.\r\n * histories - Retrieves the certificate update history\r\n * jobs - Retrieves the jobs for this certificate\r\n * logs - Retrieves the certificate log\r\n * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid\r\n * custom_fields - Retrieves custom fields set for this certificate", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:\r\n \r\n * customers - Retrieves the list of customers linked to the certificate.\r\n * po_numbers - Retrieves all PO numbers tied to the certificate.\r\n * attributes - Retrieves all attributes applied to the certificate.\r\n * histories - Retrieves the certificate update history\r\n * jobs - Retrieves the jobs for this certificate\r\n * logs - Retrieves the certificate log\r\n * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid\r\n * custom_fields - Retrieves custom fields set for this certificate", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] }, { "name": "Update a single certificate", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"signedDate\": \"2016-02-01\",\n \"expirationDate\": \"2020-12-31\",\n \"filename\": \"e9a180e9-fc5b-4352-96b2-5d6a23ef65ea\",\n \"documentExists\": false,\n \"valid\": true,\n \"verified\": false,\n \"exemptPercentage\": 0,\n \"isSingleCertificate\": false,\n \"exemptionNumber\": \"Exempt-1234\",\n \"exemptionReason\": {\n \"name\": \"RESALE\"\n },\n \"ecmStatus\": \"None\",\n \"createdDate\": \"2026-04-02T10:55:05.4352832Z\",\n \"modifiedDate\": \"2026-04-02\",\n \"taxNumberType\": \"FEIN\",\n \"businessNumberType\": \"Business Services\",\n \"pageCount\": 0,\n \"customers\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"43608837-c303-4b7f-a212-ef39e13f1f5d\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n },\n {\n \"companyId\": 0,\n \"customerCode\": \"714120c6-ae10-4fbf-9305-52f6f11bfde9\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"exposureZone\": {\n \"name\": \"Washington\"\n },\n \"exposureZoneName\": \"Washington\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] }, "description": "Replace the certificate identified by this URL with a new one.\r\n \r\nA certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document\r\ncan contain information about a customer's eligibility for exemption from sales or use taxes based on\r\ncriteria you specify when you store the certificate. To view or manage your certificates directly, please\r\nlog onto the administrative website for the product you purchased.\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"signedDate\": \"2016-02-01\",\n \"expirationDate\": \"2020-12-31\",\n \"filename\": \"e9a180e9-fc5b-4352-96b2-5d6a23ef65ea\",\n \"documentExists\": false,\n \"valid\": true,\n \"verified\": false,\n \"exemptPercentage\": 0,\n \"isSingleCertificate\": false,\n \"exemptionNumber\": \"Exempt-1234\",\n \"exemptionReason\": {\n \"name\": \"RESALE\"\n },\n \"ecmStatus\": \"None\",\n \"createdDate\": \"2026-04-02T10:55:05.4352832Z\",\n \"modifiedDate\": \"2026-04-02\",\n \"taxNumberType\": \"FEIN\",\n \"businessNumberType\": \"Business Services\",\n \"pageCount\": 0,\n \"customers\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"43608837-c303-4b7f-a212-ef39e13f1f5d\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n },\n {\n \"companyId\": 0,\n \"customerCode\": \"714120c6-ae10-4fbf-9305-52f6f11bfde9\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"exposureZone\": {\n \"name\": \"Washington\"\n },\n \"exposureZoneName\": \"Washington\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 0,\n \"signedDate\": \"2016-02-01\",\n \"expirationDate\": \"2020-12-31\",\n \"filename\": \"e9a180e9-fc5b-4352-96b2-5d6a23ef65ea\",\n \"documentExists\": false,\n \"valid\": true,\n \"verified\": false,\n \"exemptPercentage\": 0,\n \"isSingleCertificate\": false,\n \"exemptionNumber\": \"Exempt-1234\",\n \"exemptionReason\": {\n \"name\": \"RESALE\"\n },\n \"ecmStatus\": \"None\",\n \"createdDate\": \"2026-04-02T10:55:05.4352832Z\",\n \"modifiedDate\": \"2026-04-02\",\n \"taxNumberType\": \"FEIN\",\n \"businessNumberType\": \"Business Services\",\n \"pageCount\": 0,\n \"customers\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"43608837-c303-4b7f-a212-ef39e13f1f5d\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n },\n {\n \"companyId\": 0,\n \"customerCode\": \"714120c6-ae10-4fbf-9305-52f6f11bfde9\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"exposureZone\": {\n \"name\": \"Washington\"\n },\n \"exposureZoneName\": \"Washington\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"signedDate\": \"2016-02-01\",\n \"expirationDate\": \"2020-12-31\",\n \"filename\": \"e9a180e9-fc5b-4352-96b2-5d6a23ef65ea\",\n \"documentExists\": false,\n \"valid\": true,\n \"verified\": false,\n \"exemptPercentage\": 0,\n \"isSingleCertificate\": false,\n \"exemptionNumber\": \"Exempt-1234\",\n \"exemptionReason\": {\n \"name\": \"RESALE\"\n },\n \"ecmStatus\": \"None\",\n \"createdDate\": \"2026-04-02T10:55:05.4352832Z\",\n \"modifiedDate\": \"2026-04-02\",\n \"taxNumberType\": \"FEIN\",\n \"businessNumberType\": \"Business Services\",\n \"pageCount\": 0,\n \"customers\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"43608837-c303-4b7f-a212-ef39e13f1f5d\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n },\n {\n \"companyId\": 0,\n \"customerCode\": \"714120c6-ae10-4fbf-9305-52f6f11bfde9\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"exposureZone\": {\n \"name\": \"Washington\"\n },\n \"exposureZoneName\": \"Washington\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"signedDate\": \"2016-02-01\",\n \"expirationDate\": \"2020-12-31\",\n \"filename\": \"e9a180e9-fc5b-4352-96b2-5d6a23ef65ea\",\n \"documentExists\": false,\n \"valid\": true,\n \"verified\": false,\n \"exemptPercentage\": 0,\n \"isSingleCertificate\": false,\n \"exemptionNumber\": \"Exempt-1234\",\n \"exemptionReason\": {\n \"name\": \"RESALE\"\n },\n \"ecmStatus\": \"None\",\n \"createdDate\": \"2026-04-02T10:55:05.4352832Z\",\n \"modifiedDate\": \"2026-04-02\",\n \"taxNumberType\": \"FEIN\",\n \"businessNumberType\": \"Business Services\",\n \"pageCount\": 0,\n \"customers\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"43608837-c303-4b7f-a212-ef39e13f1f5d\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n },\n {\n \"companyId\": 0,\n \"customerCode\": \"714120c6-ae10-4fbf-9305-52f6f11bfde9\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"exposureZone\": {\n \"name\": \"Washington\"\n },\n \"exposureZoneName\": \"Washington\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"signedDate\": \"2016-02-01\",\n \"expirationDate\": \"2020-12-31\",\n \"filename\": \"e9a180e9-fc5b-4352-96b2-5d6a23ef65ea\",\n \"documentExists\": false,\n \"valid\": true,\n \"verified\": false,\n \"exemptPercentage\": 0,\n \"isSingleCertificate\": false,\n \"exemptionNumber\": \"Exempt-1234\",\n \"exemptionReason\": {\n \"name\": \"RESALE\"\n },\n \"ecmStatus\": \"None\",\n \"createdDate\": \"2026-04-02T10:55:05.4352832Z\",\n \"modifiedDate\": \"2026-04-02\",\n \"taxNumberType\": \"FEIN\",\n \"businessNumberType\": \"Business Services\",\n \"pageCount\": 0,\n \"customers\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"43608837-c303-4b7f-a212-ef39e13f1f5d\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n },\n {\n \"companyId\": 0,\n \"customerCode\": \"714120c6-ae10-4fbf-9305-52f6f11bfde9\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"exposureZone\": {\n \"name\": \"Washington\"\n },\n \"exposureZoneName\": \"Washington\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] }, { "name": "Revoke and delete a certificate", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] }, "description": "Revoke the certificate identified by this URL, then delete it.\r\n \r\nA certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document\r\ncan contain information about a customer's eligibility for exemption from sales or use taxes based on\r\ncriteria you specify when you store the certificate. To view or manage your certificates directly, please\r\nlog onto the administrative website for the product you purchased.\r\n \r\nRevoked certificates can no longer be used.\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this certificate" }, { "key": "id", "value": "451", "description": "The unique ID number of this certificate" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "setup", "item": [ { "name": "Check a company's exemption certificate status.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/setup", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", "setup" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company ID to check" } ] }, "description": "Checks whether this company is configured to use exemption certificates in AvaTax.\r\n \r\nExemption certificates are tracked through a different auditable data store than the one that\r\nholds AvaTax transactions. To use the AvaTax exemption certificate document store, please call\r\n`GetCertificateSetup` to see if your company is configured to use the exemption certificate\r\ndocument store. To request setup, please call `RequestCertificateSetup` and your company will\r\nbe configured with data storage in the auditable certificate system.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/setup", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", "setup" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company ID to check" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Provisioned\",\n \"accountId\": 12345,\n \"companyId\": 6789\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/setup", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", "setup" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company ID to check" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/setup", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", "setup" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company ID to check" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/setup", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", "setup" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company ID to check" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] }, { "name": "Request setup of exemption certificates for this company.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/setup", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", "setup" ], "variable": [ { "key": "companyId", "value": "451" } ] }, "description": "Requests the setup of exemption certificates for this company.\r\n \r\nExemption certificates are tracked through a different auditable data store than the one that\r\nholds AvaTax transactions. To use the AvaTax exemption certificate document store, please call\r\n`GetCertificateSetup` to see if your company is configured to use the exemption certificate\r\ndocument store. To request setup, please call `RequestCertificateSetup` and your company will\r\nbe configured with data storage in the auditable certificate system.\r\n \r\nThis API will return the current status of exemption certificate setup for this company.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/setup", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", "setup" ], "variable": [ { "key": "companyId", "value": "451" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Provisioned\",\n \"accountId\": 12345,\n \"companyId\": 6789\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/setup", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", "setup" ], "variable": [ { "key": "companyId", "value": "451" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/setup", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", "setup" ], "variable": [ { "key": "companyId", "value": "451" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates/setup", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates", "setup" ], "variable": [ { "key": "companyId", "value": "451" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "List all certificates for a company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates" ], "query": [ { "key": "$include", "value": "string", "description": "OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:\r\n \r\n * customers - Retrieves the list of customers linked to the certificate.\r\n * po_numbers - Retrieves all PO numbers tied to the certificate.\r\n * attributes - Retrieves all attributes applied to the certificate.\r\n * histories - Retrieves the certificate update history\r\n * jobs - Retrieves the jobs for this certificate\r\n * logs - Retrieves the certificate log\r\n * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid\r\n * custom_fields - Retrieves custom fields set for this certificate" }, { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* exemptionNumber, ecmsId, ecmsStatus, pdf, pages" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company to search" } ] }, "description": "List all certificates recorded by a company\r\n \r\nA certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document\r\ncan contain information about a customer's eligibility for exemption from sales or use taxes based on\r\ncriteria you specify when you store the certificate. To view or manage your certificates directly, please\r\nlog onto the administrative website for the product you purchased.\r\n \r\nYou can use the `$include` parameter to fetch the following additional objects for expansion:\r\n \r\n* customers - Retrieves the list of customers linked to the certificate.\r\n* po_numbers - Retrieves all PO numbers tied to the certificate.\r\n* attributes - Retrieves all attributes applied to the certificate.\r\n* histories - Retrieves the certificate update history\r\n* jobs - Retrieves the jobs for this certificate\r\n* logs - Retrieves the certificate log\r\n* invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid\r\n* custom_fields - Retrieves custom fields set for this certificate\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:\r\n \r\n * customers - Retrieves the list of customers linked to the certificate.\r\n * po_numbers - Retrieves all PO numbers tied to the certificate.\r\n * attributes - Retrieves all attributes applied to the certificate.\r\n * histories - Retrieves the certificate update history\r\n * jobs - Retrieves the jobs for this certificate\r\n * logs - Retrieves the certificate log\r\n * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid\r\n * custom_fields - Retrieves custom fields set for this certificate", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* exemptionNumber, ecmsId, ecmsStatus, pdf, pages", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company to search" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 3621,\n \"value\": [\n {\n \"id\": 0,\n \"signedDate\": \"2016-02-01\",\n \"expirationDate\": \"2020-12-31\",\n \"filename\": \"e9a180e9-fc5b-4352-96b2-5d6a23ef65ea\",\n \"documentExists\": false,\n \"valid\": true,\n \"verified\": false,\n \"exemptPercentage\": 0,\n \"isSingleCertificate\": false,\n \"exemptionNumber\": \"Exempt-1234\",\n \"exemptionReason\": {\n \"name\": \"RESALE\"\n },\n \"ecmStatus\": \"None\",\n \"createdDate\": \"2026-04-02T10:55:05.4352832Z\",\n \"modifiedDate\": \"2026-04-02\",\n \"taxNumberType\": \"FEIN\",\n \"businessNumberType\": \"Business Services\",\n \"pageCount\": 0,\n \"customers\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"43608837-c303-4b7f-a212-ef39e13f1f5d\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n },\n {\n \"companyId\": 0,\n \"customerCode\": \"714120c6-ae10-4fbf-9305-52f6f11bfde9\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"exposureZone\": {\n \"name\": \"Washington\"\n },\n \"exposureZoneName\": \"Washington\"\n },\n {\n \"id\": 0,\n \"signedDate\": \"2016-02-01\",\n \"expirationDate\": \"2020-12-31\",\n \"filename\": \"e9a180e9-fc5b-4352-96b2-5d6a23ef65ea\",\n \"documentExists\": false,\n \"valid\": true,\n \"verified\": false,\n \"exemptPercentage\": 0,\n \"isSingleCertificate\": false,\n \"exemptionNumber\": \"Exempt-1234\",\n \"exemptionReason\": {\n \"name\": \"RESALE\"\n },\n \"ecmStatus\": \"None\",\n \"createdDate\": \"2026-04-02T10:55:05.4352832Z\",\n \"modifiedDate\": \"2026-04-02\",\n \"taxNumberType\": \"FEIN\",\n \"businessNumberType\": \"Business Services\",\n \"pageCount\": 0,\n \"customers\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"43608837-c303-4b7f-a212-ef39e13f1f5d\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n },\n {\n \"companyId\": 0,\n \"customerCode\": \"714120c6-ae10-4fbf-9305-52f6f11bfde9\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"exposureZone\": {\n \"name\": \"Washington\"\n },\n \"exposureZoneName\": \"Washington\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:\r\n \r\n * customers - Retrieves the list of customers linked to the certificate.\r\n * po_numbers - Retrieves all PO numbers tied to the certificate.\r\n * attributes - Retrieves all attributes applied to the certificate.\r\n * histories - Retrieves the certificate update history\r\n * jobs - Retrieves the jobs for this certificate\r\n * logs - Retrieves the certificate log\r\n * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid\r\n * custom_fields - Retrieves custom fields set for this certificate", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* exemptionNumber, ecmsId, ecmsStatus, pdf, pages", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company to search" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:\r\n \r\n * customers - Retrieves the list of customers linked to the certificate.\r\n * po_numbers - Retrieves all PO numbers tied to the certificate.\r\n * attributes - Retrieves all attributes applied to the certificate.\r\n * histories - Retrieves the certificate update history\r\n * jobs - Retrieves the jobs for this certificate\r\n * logs - Retrieves the certificate log\r\n * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid\r\n * custom_fields - Retrieves custom fields set for this certificate", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* exemptionNumber, ecmsId, ecmsStatus, pdf, pages", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company to search" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:\r\n \r\n * customers - Retrieves the list of customers linked to the certificate.\r\n * po_numbers - Retrieves all PO numbers tied to the certificate.\r\n * attributes - Retrieves all attributes applied to the certificate.\r\n * histories - Retrieves the certificate update history\r\n * jobs - Retrieves the jobs for this certificate\r\n * logs - Retrieves the certificate log\r\n * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid\r\n * custom_fields - Retrieves custom fields set for this certificate", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* exemptionNumber, ecmsId, ecmsStatus, pdf, pages", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company to search" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] }, { "name": "Create certificates for this company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"signedDate\": \"2016-02-01\",\n \"expirationDate\": \"2020-12-31\",\n \"filename\": \"e9a180e9-fc5b-4352-96b2-5d6a23ef65ea\",\n \"documentExists\": false,\n \"valid\": true,\n \"verified\": false,\n \"exemptPercentage\": 0,\n \"isSingleCertificate\": false,\n \"exemptionNumber\": \"Exempt-1234\",\n \"exemptionReason\": {\n \"name\": \"RESALE\"\n },\n \"ecmStatus\": \"None\",\n \"createdDate\": \"2026-04-02T10:55:05.4352832Z\",\n \"modifiedDate\": \"2026-04-02\",\n \"taxNumberType\": \"FEIN\",\n \"businessNumberType\": \"Business Services\",\n \"pageCount\": 0,\n \"customers\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"43608837-c303-4b7f-a212-ef39e13f1f5d\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n },\n {\n \"companyId\": 0,\n \"customerCode\": \"714120c6-ae10-4fbf-9305-52f6f11bfde9\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"exposureZone\": {\n \"name\": \"Washington\"\n },\n \"exposureZoneName\": \"Washington\"\n },\n {\n \"id\": 0,\n \"signedDate\": \"2016-02-01\",\n \"expirationDate\": \"2020-12-31\",\n \"filename\": \"e9a180e9-fc5b-4352-96b2-5d6a23ef65ea\",\n \"documentExists\": false,\n \"valid\": true,\n \"verified\": false,\n \"exemptPercentage\": 0,\n \"isSingleCertificate\": false,\n \"exemptionNumber\": \"Exempt-1234\",\n \"exemptionReason\": {\n \"name\": \"RESALE\"\n },\n \"ecmStatus\": \"None\",\n \"createdDate\": \"2026-04-02T10:55:05.4352832Z\",\n \"modifiedDate\": \"2026-04-02\",\n \"taxNumberType\": \"FEIN\",\n \"businessNumberType\": \"Business Services\",\n \"pageCount\": 0,\n \"customers\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"43608837-c303-4b7f-a212-ef39e13f1f5d\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n },\n {\n \"companyId\": 0,\n \"customerCode\": \"714120c6-ae10-4fbf-9305-52f6f11bfde9\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"exposureZone\": {\n \"name\": \"Washington\"\n },\n \"exposureZoneName\": \"Washington\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates?$preValidatedExemptionReason=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates" ], "query": [ { "key": "$preValidatedExemptionReason", "value": "true", "description": "If set to true, the certificate will bypass the human verification process." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company recording this certificate" } ] }, "description": "Record one or more certificates document for this company.\r\n \r\nA certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document\r\ncan contain information about a customer's eligibility for exemption from sales or use taxes based on\r\ncriteria you specify when you store the certificate. To view or manage your certificates directly, please\r\nlog onto the administrative website for the product you purchased.\r\n \r\nWhen you create a certificate, it will be processed by Avalara and will become available for use in\r\ncalculating tax exemptions when processing is complete. For a certificate to be used in calculating exemptions,\r\nit must have the following:\r\n \r\n* An exposure zone indicating where the certificate is valid\r\n* A link to the customer that is allowed to use this certificate\r\n* Your tax transaction must contain the correct customer code\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\r\n \r\nIf the users specified in the certificates do not exist, the API will create the user and link them to the certificate\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"signedDate\": \"2016-02-01\",\n \"expirationDate\": \"2020-12-31\",\n \"filename\": \"e9a180e9-fc5b-4352-96b2-5d6a23ef65ea\",\n \"documentExists\": false,\n \"valid\": true,\n \"verified\": false,\n \"exemptPercentage\": 0,\n \"isSingleCertificate\": false,\n \"exemptionNumber\": \"Exempt-1234\",\n \"exemptionReason\": {\n \"name\": \"RESALE\"\n },\n \"ecmStatus\": \"None\",\n \"createdDate\": \"2026-04-02T10:55:05.4352832Z\",\n \"modifiedDate\": \"2026-04-02\",\n \"taxNumberType\": \"FEIN\",\n \"businessNumberType\": \"Business Services\",\n \"pageCount\": 0,\n \"customers\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"43608837-c303-4b7f-a212-ef39e13f1f5d\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n },\n {\n \"companyId\": 0,\n \"customerCode\": \"714120c6-ae10-4fbf-9305-52f6f11bfde9\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"exposureZone\": {\n \"name\": \"Washington\"\n },\n \"exposureZoneName\": \"Washington\"\n },\n {\n \"id\": 0,\n \"signedDate\": \"2016-02-01\",\n \"expirationDate\": \"2020-12-31\",\n \"filename\": \"e9a180e9-fc5b-4352-96b2-5d6a23ef65ea\",\n \"documentExists\": false,\n \"valid\": true,\n \"verified\": false,\n \"exemptPercentage\": 0,\n \"isSingleCertificate\": false,\n \"exemptionNumber\": \"Exempt-1234\",\n \"exemptionReason\": {\n \"name\": \"RESALE\"\n },\n \"ecmStatus\": \"None\",\n \"createdDate\": \"2026-04-02T10:55:05.4352832Z\",\n \"modifiedDate\": \"2026-04-02\",\n \"taxNumberType\": \"FEIN\",\n \"businessNumberType\": \"Business Services\",\n \"pageCount\": 0,\n \"customers\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"43608837-c303-4b7f-a212-ef39e13f1f5d\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n },\n {\n \"companyId\": 0,\n \"customerCode\": \"714120c6-ae10-4fbf-9305-52f6f11bfde9\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"exposureZone\": {\n \"name\": \"Washington\"\n },\n \"exposureZoneName\": \"Washington\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates?$preValidatedExemptionReason=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates" ], "query": [ { "description": "If set to true, the certificate will bypass the human verification process.", "key": "$preValidatedExemptionReason", "value": "true" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company recording this certificate" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": 0,\n \"signedDate\": \"2016-02-01\",\n \"expirationDate\": \"2020-12-31\",\n \"filename\": \"e9a180e9-fc5b-4352-96b2-5d6a23ef65ea\",\n \"documentExists\": false,\n \"valid\": true,\n \"verified\": false,\n \"exemptPercentage\": 0,\n \"isSingleCertificate\": false,\n \"exemptionNumber\": \"Exempt-1234\",\n \"exemptionReason\": {\n \"name\": \"RESALE\"\n },\n \"ecmStatus\": \"None\",\n \"createdDate\": \"2026-04-02T10:55:05.4352832Z\",\n \"modifiedDate\": \"2026-04-02\",\n \"taxNumberType\": \"FEIN\",\n \"businessNumberType\": \"Business Services\",\n \"pageCount\": 0,\n \"customers\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"43608837-c303-4b7f-a212-ef39e13f1f5d\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n },\n {\n \"companyId\": 0,\n \"customerCode\": \"714120c6-ae10-4fbf-9305-52f6f11bfde9\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"exposureZone\": {\n \"name\": \"Washington\"\n },\n \"exposureZoneName\": \"Washington\"\n },\n {\n \"id\": 0,\n \"signedDate\": \"2016-02-01\",\n \"expirationDate\": \"2020-12-31\",\n \"filename\": \"e9a180e9-fc5b-4352-96b2-5d6a23ef65ea\",\n \"documentExists\": false,\n \"valid\": true,\n \"verified\": false,\n \"exemptPercentage\": 0,\n \"isSingleCertificate\": false,\n \"exemptionNumber\": \"Exempt-1234\",\n \"exemptionReason\": {\n \"name\": \"RESALE\"\n },\n \"ecmStatus\": \"None\",\n \"createdDate\": \"2026-04-02T10:55:05.4352832Z\",\n \"modifiedDate\": \"2026-04-02\",\n \"taxNumberType\": \"FEIN\",\n \"businessNumberType\": \"Business Services\",\n \"pageCount\": 0,\n \"customers\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"43608837-c303-4b7f-a212-ef39e13f1f5d\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n },\n {\n \"companyId\": 0,\n \"customerCode\": \"714120c6-ae10-4fbf-9305-52f6f11bfde9\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"exposureZone\": {\n \"name\": \"Washington\"\n },\n \"exposureZoneName\": \"Washington\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"signedDate\": \"2016-02-01\",\n \"expirationDate\": \"2020-12-31\",\n \"filename\": \"e9a180e9-fc5b-4352-96b2-5d6a23ef65ea\",\n \"documentExists\": false,\n \"valid\": true,\n \"verified\": false,\n \"exemptPercentage\": 0,\n \"isSingleCertificate\": false,\n \"exemptionNumber\": \"Exempt-1234\",\n \"exemptionReason\": {\n \"name\": \"RESALE\"\n },\n \"ecmStatus\": \"None\",\n \"createdDate\": \"2026-04-02T10:55:05.4352832Z\",\n \"modifiedDate\": \"2026-04-02\",\n \"taxNumberType\": \"FEIN\",\n \"businessNumberType\": \"Business Services\",\n \"pageCount\": 0,\n \"customers\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"43608837-c303-4b7f-a212-ef39e13f1f5d\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n },\n {\n \"companyId\": 0,\n \"customerCode\": \"714120c6-ae10-4fbf-9305-52f6f11bfde9\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"exposureZone\": {\n \"name\": \"Washington\"\n },\n \"exposureZoneName\": \"Washington\"\n },\n {\n \"id\": 0,\n \"signedDate\": \"2016-02-01\",\n \"expirationDate\": \"2020-12-31\",\n \"filename\": \"e9a180e9-fc5b-4352-96b2-5d6a23ef65ea\",\n \"documentExists\": false,\n \"valid\": true,\n \"verified\": false,\n \"exemptPercentage\": 0,\n \"isSingleCertificate\": false,\n \"exemptionNumber\": \"Exempt-1234\",\n \"exemptionReason\": {\n \"name\": \"RESALE\"\n },\n \"ecmStatus\": \"None\",\n \"createdDate\": \"2026-04-02T10:55:05.4352832Z\",\n \"modifiedDate\": \"2026-04-02\",\n \"taxNumberType\": \"FEIN\",\n \"businessNumberType\": \"Business Services\",\n \"pageCount\": 0,\n \"customers\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"43608837-c303-4b7f-a212-ef39e13f1f5d\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n },\n {\n \"companyId\": 0,\n \"customerCode\": \"714120c6-ae10-4fbf-9305-52f6f11bfde9\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"exposureZone\": {\n \"name\": \"Washington\"\n },\n \"exposureZoneName\": \"Washington\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates?$preValidatedExemptionReason=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates" ], "query": [ { "description": "If set to true, the certificate will bypass the human verification process.", "key": "$preValidatedExemptionReason", "value": "true" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company recording this certificate" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"signedDate\": \"2016-02-01\",\n \"expirationDate\": \"2020-12-31\",\n \"filename\": \"e9a180e9-fc5b-4352-96b2-5d6a23ef65ea\",\n \"documentExists\": false,\n \"valid\": true,\n \"verified\": false,\n \"exemptPercentage\": 0,\n \"isSingleCertificate\": false,\n \"exemptionNumber\": \"Exempt-1234\",\n \"exemptionReason\": {\n \"name\": \"RESALE\"\n },\n \"ecmStatus\": \"None\",\n \"createdDate\": \"2026-04-02T10:55:05.4352832Z\",\n \"modifiedDate\": \"2026-04-02\",\n \"taxNumberType\": \"FEIN\",\n \"businessNumberType\": \"Business Services\",\n \"pageCount\": 0,\n \"customers\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"43608837-c303-4b7f-a212-ef39e13f1f5d\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n },\n {\n \"companyId\": 0,\n \"customerCode\": \"714120c6-ae10-4fbf-9305-52f6f11bfde9\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"exposureZone\": {\n \"name\": \"Washington\"\n },\n \"exposureZoneName\": \"Washington\"\n },\n {\n \"id\": 0,\n \"signedDate\": \"2016-02-01\",\n \"expirationDate\": \"2020-12-31\",\n \"filename\": \"e9a180e9-fc5b-4352-96b2-5d6a23ef65ea\",\n \"documentExists\": false,\n \"valid\": true,\n \"verified\": false,\n \"exemptPercentage\": 0,\n \"isSingleCertificate\": false,\n \"exemptionNumber\": \"Exempt-1234\",\n \"exemptionReason\": {\n \"name\": \"RESALE\"\n },\n \"ecmStatus\": \"None\",\n \"createdDate\": \"2026-04-02T10:55:05.4352832Z\",\n \"modifiedDate\": \"2026-04-02\",\n \"taxNumberType\": \"FEIN\",\n \"businessNumberType\": \"Business Services\",\n \"pageCount\": 0,\n \"customers\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"43608837-c303-4b7f-a212-ef39e13f1f5d\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n },\n {\n \"companyId\": 0,\n \"customerCode\": \"714120c6-ae10-4fbf-9305-52f6f11bfde9\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"exposureZone\": {\n \"name\": \"Washington\"\n },\n \"exposureZoneName\": \"Washington\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates?$preValidatedExemptionReason=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates" ], "query": [ { "description": "If set to true, the certificate will bypass the human verification process.", "key": "$preValidatedExemptionReason", "value": "true" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company recording this certificate" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"signedDate\": \"2016-02-01\",\n \"expirationDate\": \"2020-12-31\",\n \"filename\": \"e9a180e9-fc5b-4352-96b2-5d6a23ef65ea\",\n \"documentExists\": false,\n \"valid\": true,\n \"verified\": false,\n \"exemptPercentage\": 0,\n \"isSingleCertificate\": false,\n \"exemptionNumber\": \"Exempt-1234\",\n \"exemptionReason\": {\n \"name\": \"RESALE\"\n },\n \"ecmStatus\": \"None\",\n \"createdDate\": \"2026-04-02T10:55:05.4352832Z\",\n \"modifiedDate\": \"2026-04-02\",\n \"taxNumberType\": \"FEIN\",\n \"businessNumberType\": \"Business Services\",\n \"pageCount\": 0,\n \"customers\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"43608837-c303-4b7f-a212-ef39e13f1f5d\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n },\n {\n \"companyId\": 0,\n \"customerCode\": \"714120c6-ae10-4fbf-9305-52f6f11bfde9\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"exposureZone\": {\n \"name\": \"Washington\"\n },\n \"exposureZoneName\": \"Washington\"\n },\n {\n \"id\": 0,\n \"signedDate\": \"2016-02-01\",\n \"expirationDate\": \"2020-12-31\",\n \"filename\": \"e9a180e9-fc5b-4352-96b2-5d6a23ef65ea\",\n \"documentExists\": false,\n \"valid\": true,\n \"verified\": false,\n \"exemptPercentage\": 0,\n \"isSingleCertificate\": false,\n \"exemptionNumber\": \"Exempt-1234\",\n \"exemptionReason\": {\n \"name\": \"RESALE\"\n },\n \"ecmStatus\": \"None\",\n \"createdDate\": \"2026-04-02T10:55:05.4352832Z\",\n \"modifiedDate\": \"2026-04-02\",\n \"taxNumberType\": \"FEIN\",\n \"businessNumberType\": \"Business Services\",\n \"pageCount\": 0,\n \"customers\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"43608837-c303-4b7f-a212-ef39e13f1f5d\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n },\n {\n \"companyId\": 0,\n \"customerCode\": \"714120c6-ae10-4fbf-9305-52f6f11bfde9\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"exposureZone\": {\n \"name\": \"Washington\"\n },\n \"exposureZoneName\": \"Washington\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/certificates?$preValidatedExemptionReason=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "certificates" ], "query": [ { "description": "If set to true, the certificate will bypass the human verification process.", "key": "$preValidatedExemptionReason", "value": "true" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company recording this certificate" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "funding", "item": [ { "name": "configuration", "item": [ { "name": "Check the funding configuration of a company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/funding/configuration", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "funding", "configuration" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique identifier of the company" } ] }, "description": "This API is available by invitation only.\r\nRequires a subscription to Avalara Managed Returns or SST Certified Service Provider.\r\nReturns the funding configuration of the requested company.\r\n.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n* This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/funding/configuration", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "funding", "configuration" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique identifier of the company" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"companyId\": 2793,\n \"systemType\": \"AvaTax15\",\n \"currency\": \"USD\",\n \"isFundingSetup\": true,\n \"fundingMethod\": \"ACH Pull\",\n \"lastUpdated\": \"2026-04-02T10:55:06.1069641Z\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/funding/configuration", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "funding", "configuration" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique identifier of the company" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/funding/configuration", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "funding", "configuration" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique identifier of the company" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/funding/configuration", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "funding", "configuration" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique identifier of the company" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "configurations", "item": [ { "name": "Check the funding configuration of a company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/funding/configurations?currency=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "funding", "configurations" ], "query": [ { "key": "currency", "value": "string", "description": "The currency of the funding. USD and CAD are the only valid currencies" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique identifier of the company" } ] }, "description": "This API is available by invitation only.\r\nRequires a subscription to Avalara Managed Returns or SST Certified Service Provider.\r\nReturns the funding configuration of the requested company.\r\n.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n* This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/funding/configurations?currency=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "funding", "configurations" ], "query": [ { "description": "The currency of the funding. USD and CAD are the only valid currencies", "key": "currency", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique identifier of the company" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"companyId\": 2793,\n \"systemType\": \"AvaTax15\",\n \"currency\": \"USD\",\n \"isFundingSetup\": true,\n \"fundingMethod\": \"ACH Pull\",\n \"lastUpdated\": \"2026-04-02T10:55:06.1069641Z\"\n },\n {\n \"companyId\": 2793,\n \"systemType\": \"AvaTax15\",\n \"currency\": \"USD\",\n \"isFundingSetup\": true,\n \"fundingMethod\": \"ACH Pull\",\n \"lastUpdated\": \"2026-04-02T10:55:06.1069641Z\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/funding/configurations?currency=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "funding", "configurations" ], "query": [ { "description": "The currency of the funding. USD and CAD are the only valid currencies", "key": "currency", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique identifier of the company" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/funding/configurations?currency=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "funding", "configurations" ], "query": [ { "description": "The currency of the funding. USD and CAD are the only valid currencies", "key": "currency", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique identifier of the company" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/funding/configurations?currency=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "funding", "configurations" ], "query": [ { "description": "The currency of the funding. USD and CAD are the only valid currencies", "key": "currency", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique identifier of the company" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] } ] }, { "name": "parameters", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a single company parameter", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451" }, { "key": "id", "value": "451" } ] }, "description": "Retrieves a single parameter of a company.\r\n \r\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\".\r\n \r\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.\r\n \r\nA company location parameter specified on a transaction line will override a company parameter if they share the same parameter name.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451" }, { "key": "id", "value": "451" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 0,\n \"companyId\": 0,\n \"name\": \"IsPrimaryAddress\",\n \"value\": \"true\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451" }, { "key": "id", "value": "451" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451" }, { "key": "id", "value": "451" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451" }, { "key": "id", "value": "451" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Update a company parameter", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"companyId\": 0,\n \"name\": \"IsPrimaryAddress\",\n \"value\": \"true\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "id", "value": "155", "description": "The company parameter id" } ] }, "description": "Update a parameter of a company.\r\n \r\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\".\r\n \r\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.\r\n \r\nA company location parameter specified on a transaction line will override a company parameter if they share the same parameter name.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"companyId\": 0,\n \"name\": \"IsPrimaryAddress\",\n \"value\": \"true\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "id", "value": "155", "description": "The company parameter id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 0,\n \"companyId\": 0,\n \"name\": \"IsPrimaryAddress\",\n \"value\": \"true\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"companyId\": 0,\n \"name\": \"IsPrimaryAddress\",\n \"value\": \"true\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "id", "value": "155", "description": "The company parameter id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"companyId\": 0,\n \"name\": \"IsPrimaryAddress\",\n \"value\": \"true\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "id", "value": "155", "description": "The company parameter id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"companyId\": 0,\n \"name\": \"IsPrimaryAddress\",\n \"value\": \"true\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "id", "value": "155", "description": "The company parameter id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete a single company parameter", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "id", "value": "155", "description": "The parameter id" } ] }, "description": "Delete a parameter of a company.\r\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\".\r\n \r\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.\r\n \r\nA company location parameter specified on a transaction line will override a company parameter if they share the same parameter name.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "id", "value": "155", "description": "The parameter id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "id", "value": "155", "description": "The parameter id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "id", "value": "155", "description": "The parameter id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "id", "value": "155", "description": "The parameter id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Add parameters to a company.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"companyId\": 0,\n \"name\": \"IsPrimaryAddress\",\n \"value\": \"true\"\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"name\": \"IsPrimaryAddress\",\n \"value\": \"true\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this company parameter." } ] }, "description": "Add parameters to a company.\r\n \r\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\".\r\n \r\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.\r\n \r\nA company location parameter specified on a transaction line will override a company parameter if they share the same parameter name.\r\n \r\nTo see available parameters for this company, call `/api/v2/definitions/parameters?$filter=attributeType eq Company`\r\n \r\nSome 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.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Created", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"companyId\": 0,\n \"name\": \"IsPrimaryAddress\",\n \"value\": \"true\"\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"name\": \"IsPrimaryAddress\",\n \"value\": \"true\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this company parameter." } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": 0,\n \"companyId\": 0,\n \"name\": \"IsPrimaryAddress\",\n \"value\": \"true\"\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"name\": \"IsPrimaryAddress\",\n \"value\": \"true\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"companyId\": 0,\n \"name\": \"IsPrimaryAddress\",\n \"value\": \"true\"\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"name\": \"IsPrimaryAddress\",\n \"value\": \"true\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this company parameter." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"companyId\": 0,\n \"name\": \"IsPrimaryAddress\",\n \"value\": \"true\"\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"name\": \"IsPrimaryAddress\",\n \"value\": \"true\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this company parameter." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"companyId\": 0,\n \"name\": \"IsPrimaryAddress\",\n \"value\": \"true\"\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"name\": \"IsPrimaryAddress\",\n \"value\": \"true\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this company parameter." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Retrieve parameters for a company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/parameters?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "parameters" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* name, unit" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" } ] }, "description": "Retrieve all parameters of a company.\r\n \r\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\".\r\n \r\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.\r\n \r\nA company location parameter specified on a transaction line will override a company parameter if they share the same parameter name.\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/parameters?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "parameters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* name, unit", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 2027,\n \"value\": [\n {\n \"id\": 0,\n \"companyId\": 0,\n \"name\": \"IsPrimaryAddress\",\n \"value\": \"true\"\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"name\": \"IsPrimaryAddress\",\n \"value\": \"true\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/parameters?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "parameters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* name, unit", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/parameters?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "parameters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* name, unit", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/parameters?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "parameters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* name, unit", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "supplierandcustomers", "item": [ { "name": "withcountryparams", "item": [ { "name": "Retrieve all customers and suppliers with their country parameters for a company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/supplierandcustomers/withcountryparams?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "supplierandcustomers", "withcountryparams" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* CustomerId, CompanyId, CustomerTypeId, CustomerSupplierCountryParamId, Country, IsEstablished, IsRegisteredThroughFiscalRep, VatNumberStatus" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "companyId", "value": "451", "description": "Company Id" } ] }, "description": "Retrieves all customers and suppliers for a company along with their country parameters. Records without country parameters will still be returned with null country parameter fields (LEFT JOIN behavior).\r\nResults are ordered by CustomerTypeId, CustomerCode, and Country.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/supplierandcustomers/withcountryparams?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "supplierandcustomers", "withcountryparams" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* CustomerId, CompanyId, CustomerTypeId, CustomerSupplierCountryParamId, Country, IsEstablished, IsRegisteredThroughFiscalRep, VatNumberStatus", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "Company Id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 4233,\n \"value\": [\n {\n \"customerId\": 12345,\n \"customerCode\": \"CUST001\",\n \"companyId\": 1,\n \"customerTypeId\": 1,\n \"customerSupplierCountryParamId\": 67890,\n \"country\": \"US\",\n \"isEstablished\": true,\n \"businessIdentificationNo\": \"123456789\",\n \"isRegisteredThroughFiscalRep\": false,\n \"vatNumber\": \"US123456789\",\n \"vatNumberStatus\": 1\n },\n {\n \"customerId\": 12345,\n \"customerCode\": \"CUST001\",\n \"companyId\": 1,\n \"customerTypeId\": 1,\n \"customerSupplierCountryParamId\": 67890,\n \"country\": \"US\",\n \"isEstablished\": true,\n \"businessIdentificationNo\": \"123456789\",\n \"isRegisteredThroughFiscalRep\": false,\n \"vatNumber\": \"US123456789\",\n \"vatNumberStatus\": 1\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/supplierandcustomers/withcountryparams?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "supplierandcustomers", "withcountryparams" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* CustomerId, CompanyId, CustomerTypeId, CustomerSupplierCountryParamId, Country, IsEstablished, IsRegisteredThroughFiscalRep, VatNumberStatus", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "Company Id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/supplierandcustomers/withcountryparams?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "supplierandcustomers", "withcountryparams" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* CustomerId, CompanyId, CustomerTypeId, CustomerSupplierCountryParamId, Country, IsEstablished, IsRegisteredThroughFiscalRep, VatNumberStatus", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "Company Id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/supplierandcustomers/withcountryparams?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "supplierandcustomers", "withcountryparams" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* CustomerId, CompanyId, CustomerTypeId, CustomerSupplierCountryParamId, Country, IsEstablished, IsRegisteredThroughFiscalRep, VatNumberStatus", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "Company Id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "contacts", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a single contact", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "contacts", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company for this contact" }, { "key": "id", "value": "451", "description": "The primary key of this contact" } ] }, "description": "Get the contact object identified by this URL.\r\nA 'contact' is a person associated with a company who is designated to handle certain responsibilities of\r\na tax collecting and filing entity.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "contacts", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company for this contact" }, { "key": "id", "value": "451", "description": "The primary key of this contact" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 56789,\n \"companyId\": 12345,\n \"contactCode\": \"TestContact9cc59ad213e545\",\n \"firstName\": \"Bob\",\n \"lastName\": \"McExample\",\n \"title\": \"Owner\",\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"email\": \"bob@example.org\",\n \"phone\": \"714 555-1212\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "contacts", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company for this contact" }, { "key": "id", "value": "451", "description": "The primary key of this contact" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "contacts", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company for this contact" }, { "key": "id", "value": "451", "description": "The primary key of this contact" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "contacts", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company for this contact" }, { "key": "id", "value": "451", "description": "The primary key of this contact" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Update a single contact", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 56789,\n \"companyId\": 12345,\n \"contactCode\": \"TestContact9cc59ad213e545\",\n \"firstName\": \"Bob\",\n \"lastName\": \"McExample\",\n \"title\": \"Owner\",\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"email\": \"bob@example.org\",\n \"phone\": \"714 555-1212\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "contacts", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this contact belongs to." }, { "key": "id", "value": "451", "description": "The ID of the contact you wish to update" } ] }, "description": "Replace the existing contact object at this URL with an updated object.\r\nA 'contact' is a person associated with a company who is designated to handle certain responsibilities of\r\na tax collecting and filing entity.\r\nAll data from the existing object will be replaced with data in the object you PUT.\r\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.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 56789,\n \"companyId\": 12345,\n \"contactCode\": \"TestContact9cc59ad213e545\",\n \"firstName\": \"Bob\",\n \"lastName\": \"McExample\",\n \"title\": \"Owner\",\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"email\": \"bob@example.org\",\n \"phone\": \"714 555-1212\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "contacts", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this contact belongs to." }, { "key": "id", "value": "451", "description": "The ID of the contact you wish to update" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 56789,\n \"companyId\": 12345,\n \"contactCode\": \"TestContact9cc59ad213e545\",\n \"firstName\": \"Bob\",\n \"lastName\": \"McExample\",\n \"title\": \"Owner\",\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"email\": \"bob@example.org\",\n \"phone\": \"714 555-1212\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 56789,\n \"companyId\": 12345,\n \"contactCode\": \"TestContact9cc59ad213e545\",\n \"firstName\": \"Bob\",\n \"lastName\": \"McExample\",\n \"title\": \"Owner\",\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"email\": \"bob@example.org\",\n \"phone\": \"714 555-1212\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "contacts", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this contact belongs to." }, { "key": "id", "value": "451", "description": "The ID of the contact you wish to update" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 56789,\n \"companyId\": 12345,\n \"contactCode\": \"TestContact9cc59ad213e545\",\n \"firstName\": \"Bob\",\n \"lastName\": \"McExample\",\n \"title\": \"Owner\",\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"email\": \"bob@example.org\",\n \"phone\": \"714 555-1212\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "contacts", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this contact belongs to." }, { "key": "id", "value": "451", "description": "The ID of the contact you wish to update" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 56789,\n \"companyId\": 12345,\n \"contactCode\": \"TestContact9cc59ad213e545\",\n \"firstName\": \"Bob\",\n \"lastName\": \"McExample\",\n \"title\": \"Owner\",\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"email\": \"bob@example.org\",\n \"phone\": \"714 555-1212\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "contacts", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this contact belongs to." }, { "key": "id", "value": "451", "description": "The ID of the contact you wish to update" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete a single contact", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "contacts", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this contact." }, { "key": "id", "value": "451", "description": "The ID of the contact you wish to delete." } ] }, "description": "Mark the existing contact object at this URL as deleted.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "contacts", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this contact." }, { "key": "id", "value": "451", "description": "The ID of the contact you wish to delete." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "contacts", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this contact." }, { "key": "id", "value": "451", "description": "The ID of the contact you wish to delete." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "contacts", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this contact." }, { "key": "id", "value": "451", "description": "The ID of the contact you wish to delete." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "contacts", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this contact." }, { "key": "id", "value": "451", "description": "The ID of the contact you wish to delete." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Create a new contact", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"contactCode\": \"TestContact9cc59ad213e545\",\n \"firstName\": \"Bob\",\n \"lastName\": \"McExample\",\n \"title\": \"Owner\",\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"email\": \"bob@example.org\",\n \"phone\": \"714 555-1212\"\n },\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"contactCode\": \"TestContact9cc59ad213e545\",\n \"firstName\": \"Bob\",\n \"lastName\": \"McExample\",\n \"title\": \"Owner\",\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"email\": \"bob@example.org\",\n \"phone\": \"714 555-1212\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/contacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "contacts" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this contact." } ] }, "description": "Create one or more new contact objects.\r\nA 'contact' is a person associated with a company who is designated to handle certain responsibilities of\r\na tax collecting and filing entity.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"contactCode\": \"TestContact9cc59ad213e545\",\n \"firstName\": \"Bob\",\n \"lastName\": \"McExample\",\n \"title\": \"Owner\",\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"email\": \"bob@example.org\",\n \"phone\": \"714 555-1212\"\n },\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"contactCode\": \"TestContact9cc59ad213e545\",\n \"firstName\": \"Bob\",\n \"lastName\": \"McExample\",\n \"title\": \"Owner\",\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"email\": \"bob@example.org\",\n \"phone\": \"714 555-1212\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/contacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "contacts" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this contact." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"contactCode\": \"TestContact9cc59ad213e545\",\n \"firstName\": \"Bob\",\n \"lastName\": \"McExample\",\n \"title\": \"Owner\",\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"email\": \"bob@example.org\",\n \"phone\": \"714 555-1212\"\n },\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"contactCode\": \"TestContact9cc59ad213e545\",\n \"firstName\": \"Bob\",\n \"lastName\": \"McExample\",\n \"title\": \"Owner\",\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"email\": \"bob@example.org\",\n \"phone\": \"714 555-1212\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"contactCode\": \"TestContact9cc59ad213e545\",\n \"firstName\": \"Bob\",\n \"lastName\": \"McExample\",\n \"title\": \"Owner\",\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"email\": \"bob@example.org\",\n \"phone\": \"714 555-1212\"\n },\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"contactCode\": \"TestContact9cc59ad213e545\",\n \"firstName\": \"Bob\",\n \"lastName\": \"McExample\",\n \"title\": \"Owner\",\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"email\": \"bob@example.org\",\n \"phone\": \"714 555-1212\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/contacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "contacts" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this contact." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"contactCode\": \"TestContact9cc59ad213e545\",\n \"firstName\": \"Bob\",\n \"lastName\": \"McExample\",\n \"title\": \"Owner\",\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"email\": \"bob@example.org\",\n \"phone\": \"714 555-1212\"\n },\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"contactCode\": \"TestContact9cc59ad213e545\",\n \"firstName\": \"Bob\",\n \"lastName\": \"McExample\",\n \"title\": \"Owner\",\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"email\": \"bob@example.org\",\n \"phone\": \"714 555-1212\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/contacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "contacts" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this contact." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"contactCode\": \"TestContact9cc59ad213e545\",\n \"firstName\": \"Bob\",\n \"lastName\": \"McExample\",\n \"title\": \"Owner\",\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"email\": \"bob@example.org\",\n \"phone\": \"714 555-1212\"\n },\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"contactCode\": \"TestContact9cc59ad213e545\",\n \"firstName\": \"Bob\",\n \"lastName\": \"McExample\",\n \"title\": \"Owner\",\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"email\": \"bob@example.org\",\n \"phone\": \"714 555-1212\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/contacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "contacts" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this contact." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Retrieve contacts for this company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/contacts?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "contacts" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* scsContactId" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these contacts" } ] }, "description": "List all contact objects assigned to this company.\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/contacts?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "contacts" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* scsContactId", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these contacts" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 211,\n \"value\": [\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"contactCode\": \"TestContact9cc59ad213e545\",\n \"firstName\": \"Bob\",\n \"lastName\": \"McExample\",\n \"title\": \"Owner\",\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"email\": \"bob@example.org\",\n \"phone\": \"714 555-1212\"\n },\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"contactCode\": \"TestContact9cc59ad213e545\",\n \"firstName\": \"Bob\",\n \"lastName\": \"McExample\",\n \"title\": \"Owner\",\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"email\": \"bob@example.org\",\n \"phone\": \"714 555-1212\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/contacts?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "contacts" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* scsContactId", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these contacts" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/contacts?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "contacts" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* scsContactId", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these contacts" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/contacts?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "contacts" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* scsContactId", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these contacts" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "datasources", "item": [ { "name": "{id}", "item": [ { "name": "Get data source by data source id", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/datasources/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "datasources", ":id" ], "variable": [ { "key": "companyId", "value": "451" }, { "key": "id", "value": "451", "description": "data source id" } ] }, "description": "Retrieve the data source by its unique ID number.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/datasources/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "datasources", ":id" ], "variable": [ { "key": "companyId", "value": "451" }, { "key": "id", "value": "451", "description": "data source id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 1,\n \"companyId\": 12345,\n \"source\": \"Amazon v2 Extractor\",\n \"instance\": \"2713cc25-0bce-42f8-b443-68301aff1b66\",\n \"isEnabled\": false,\n \"isSynced\": false,\n \"isAuthorized\": false,\n \"createdUserId\": 123,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 12,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"name\": \"TestName\",\n \"externalState\": \"Test Path\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/datasources/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "datasources", ":id" ], "variable": [ { "key": "companyId", "value": "451" }, { "key": "id", "value": "451", "description": "data source id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/datasources/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "datasources", ":id" ], "variable": [ { "key": "companyId", "value": "451" }, { "key": "id", "value": "451", "description": "data source id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/datasources/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "datasources", ":id" ], "variable": [ { "key": "companyId", "value": "451" }, { "key": "id", "value": "451", "description": "data source id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Update a datasource identified by id for a company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 1,\n \"companyId\": 12345,\n \"source\": \"Amazon v2 Extractor\",\n \"instance\": \"2713cc25-0bce-42f8-b443-68301aff1b66\",\n \"isEnabled\": false,\n \"isSynced\": false,\n \"isAuthorized\": false,\n \"createdUserId\": 123,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 12,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"name\": \"TestName\",\n \"externalState\": \"Test Path\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/datasources/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "datasources", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The id of the company the datasource belongs to." }, { "key": "id", "value": "451", "description": "The id of the datasource you wish to delete." } ] }, "description": "Updates a datasource for a company.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 1,\n \"companyId\": 12345,\n \"source\": \"Amazon v2 Extractor\",\n \"instance\": \"2713cc25-0bce-42f8-b443-68301aff1b66\",\n \"isEnabled\": false,\n \"isSynced\": false,\n \"isAuthorized\": false,\n \"createdUserId\": 123,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 12,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"name\": \"TestName\",\n \"externalState\": \"Test Path\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/datasources/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "datasources", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The id of the company the datasource belongs to." }, { "key": "id", "value": "451", "description": "The id of the datasource you wish to delete." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 1,\n \"companyId\": 12345,\n \"source\": \"Amazon v2 Extractor\",\n \"instance\": \"2713cc25-0bce-42f8-b443-68301aff1b66\",\n \"isEnabled\": false,\n \"isSynced\": false,\n \"isAuthorized\": false,\n \"createdUserId\": 123,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 12,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"name\": \"TestName\",\n \"externalState\": \"Test Path\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 1,\n \"companyId\": 12345,\n \"source\": \"Amazon v2 Extractor\",\n \"instance\": \"2713cc25-0bce-42f8-b443-68301aff1b66\",\n \"isEnabled\": false,\n \"isSynced\": false,\n \"isAuthorized\": false,\n \"createdUserId\": 123,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 12,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"name\": \"TestName\",\n \"externalState\": \"Test Path\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/datasources/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "datasources", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The id of the company the datasource belongs to." }, { "key": "id", "value": "451", "description": "The id of the datasource you wish to delete." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 1,\n \"companyId\": 12345,\n \"source\": \"Amazon v2 Extractor\",\n \"instance\": \"2713cc25-0bce-42f8-b443-68301aff1b66\",\n \"isEnabled\": false,\n \"isSynced\": false,\n \"isAuthorized\": false,\n \"createdUserId\": 123,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 12,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"name\": \"TestName\",\n \"externalState\": \"Test Path\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/datasources/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "datasources", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The id of the company the datasource belongs to." }, { "key": "id", "value": "451", "description": "The id of the datasource you wish to delete." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 1,\n \"companyId\": 12345,\n \"source\": \"Amazon v2 Extractor\",\n \"instance\": \"2713cc25-0bce-42f8-b443-68301aff1b66\",\n \"isEnabled\": false,\n \"isSynced\": false,\n \"isAuthorized\": false,\n \"createdUserId\": 123,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 12,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"name\": \"TestName\",\n \"externalState\": \"Test Path\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/datasources/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "datasources", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The id of the company the datasource belongs to." }, { "key": "id", "value": "451", "description": "The id of the datasource you wish to delete." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete a datasource by datasource id for a company.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/datasources/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "datasources", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The id of the company the datasource belongs to." }, { "key": "id", "value": "451", "description": "The id of the datasource you wish to delete." } ] }, "description": "Marks the existing datasource for a company as deleted.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/datasources/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "datasources", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The id of the company the datasource belongs to." }, { "key": "id", "value": "451", "description": "The id of the datasource you wish to delete." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/datasources/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "datasources", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The id of the company the datasource belongs to." }, { "key": "id", "value": "451", "description": "The id of the datasource you wish to delete." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/datasources/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "datasources", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The id of the company the datasource belongs to." }, { "key": "id", "value": "451", "description": "The id of the datasource you wish to delete." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/datasources/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "datasources", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The id of the company the datasource belongs to." }, { "key": "id", "value": "451", "description": "The id of the datasource you wish to delete." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Create and store new datasources for the respective companies.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 1,\n \"companyId\": 12345,\n \"source\": \"Amazon v2 Extractor\",\n \"instance\": \"2713cc25-0bce-42f8-b443-68301aff1b66\",\n \"isEnabled\": false,\n \"isSynced\": false,\n \"isAuthorized\": false,\n \"createdUserId\": 123,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 12,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"name\": \"TestName\",\n \"externalState\": \"Test Path\"\n },\n {\n \"id\": 1,\n \"companyId\": 12345,\n \"source\": \"Amazon v2 Extractor\",\n \"instance\": \"2713cc25-0bce-42f8-b443-68301aff1b66\",\n \"isEnabled\": false,\n \"isSynced\": false,\n \"isAuthorized\": false,\n \"createdUserId\": 123,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 12,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"name\": \"TestName\",\n \"externalState\": \"Test Path\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/datasources", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "datasources" ], "variable": [ { "key": "companyId", "value": "451", "description": "The id of the company you which to create the datasources" } ] }, "description": "Create one or more datasource objects.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 1,\n \"companyId\": 12345,\n \"source\": \"Amazon v2 Extractor\",\n \"instance\": \"2713cc25-0bce-42f8-b443-68301aff1b66\",\n \"isEnabled\": false,\n \"isSynced\": false,\n \"isAuthorized\": false,\n \"createdUserId\": 123,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 12,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"name\": \"TestName\",\n \"externalState\": \"Test Path\"\n },\n {\n \"id\": 1,\n \"companyId\": 12345,\n \"source\": \"Amazon v2 Extractor\",\n \"instance\": \"2713cc25-0bce-42f8-b443-68301aff1b66\",\n \"isEnabled\": false,\n \"isSynced\": false,\n \"isAuthorized\": false,\n \"createdUserId\": 123,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 12,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"name\": \"TestName\",\n \"externalState\": \"Test Path\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/datasources", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "datasources" ], "variable": [ { "key": "companyId", "value": "451", "description": "The id of the company you which to create the datasources" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": 1,\n \"companyId\": 12345,\n \"source\": \"Amazon v2 Extractor\",\n \"instance\": \"2713cc25-0bce-42f8-b443-68301aff1b66\",\n \"isEnabled\": false,\n \"isSynced\": false,\n \"isAuthorized\": false,\n \"createdUserId\": 123,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 12,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"name\": \"TestName\",\n \"externalState\": \"Test Path\"\n },\n {\n \"id\": 1,\n \"companyId\": 12345,\n \"source\": \"Amazon v2 Extractor\",\n \"instance\": \"2713cc25-0bce-42f8-b443-68301aff1b66\",\n \"isEnabled\": false,\n \"isSynced\": false,\n \"isAuthorized\": false,\n \"createdUserId\": 123,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 12,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"name\": \"TestName\",\n \"externalState\": \"Test Path\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 1,\n \"companyId\": 12345,\n \"source\": \"Amazon v2 Extractor\",\n \"instance\": \"2713cc25-0bce-42f8-b443-68301aff1b66\",\n \"isEnabled\": false,\n \"isSynced\": false,\n \"isAuthorized\": false,\n \"createdUserId\": 123,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 12,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"name\": \"TestName\",\n \"externalState\": \"Test Path\"\n },\n {\n \"id\": 1,\n \"companyId\": 12345,\n \"source\": \"Amazon v2 Extractor\",\n \"instance\": \"2713cc25-0bce-42f8-b443-68301aff1b66\",\n \"isEnabled\": false,\n \"isSynced\": false,\n \"isAuthorized\": false,\n \"createdUserId\": 123,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 12,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"name\": \"TestName\",\n \"externalState\": \"Test Path\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/datasources", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "datasources" ], "variable": [ { "key": "companyId", "value": "451", "description": "The id of the company you which to create the datasources" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 1,\n \"companyId\": 12345,\n \"source\": \"Amazon v2 Extractor\",\n \"instance\": \"2713cc25-0bce-42f8-b443-68301aff1b66\",\n \"isEnabled\": false,\n \"isSynced\": false,\n \"isAuthorized\": false,\n \"createdUserId\": 123,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 12,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"name\": \"TestName\",\n \"externalState\": \"Test Path\"\n },\n {\n \"id\": 1,\n \"companyId\": 12345,\n \"source\": \"Amazon v2 Extractor\",\n \"instance\": \"2713cc25-0bce-42f8-b443-68301aff1b66\",\n \"isEnabled\": false,\n \"isSynced\": false,\n \"isAuthorized\": false,\n \"createdUserId\": 123,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 12,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"name\": \"TestName\",\n \"externalState\": \"Test Path\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/datasources", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "datasources" ], "variable": [ { "key": "companyId", "value": "451", "description": "The id of the company you which to create the datasources" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 1,\n \"companyId\": 12345,\n \"source\": \"Amazon v2 Extractor\",\n \"instance\": \"2713cc25-0bce-42f8-b443-68301aff1b66\",\n \"isEnabled\": false,\n \"isSynced\": false,\n \"isAuthorized\": false,\n \"createdUserId\": 123,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 12,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"name\": \"TestName\",\n \"externalState\": \"Test Path\"\n },\n {\n \"id\": 1,\n \"companyId\": 12345,\n \"source\": \"Amazon v2 Extractor\",\n \"instance\": \"2713cc25-0bce-42f8-b443-68301aff1b66\",\n \"isEnabled\": false,\n \"isSynced\": false,\n \"isAuthorized\": false,\n \"createdUserId\": 123,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 12,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"name\": \"TestName\",\n \"externalState\": \"Test Path\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/datasources", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "datasources" ], "variable": [ { "key": "companyId", "value": "451", "description": "The id of the company you which to create the datasources" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Retrieve all datasources for this company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/datasources?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "datasources" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* isEnabled, isSynced, isAuthorized, name, externalState" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The id of the company you wish to retrieve the datasources." } ] }, "description": "Gets multiple datasource objects for a given company.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/datasources?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "datasources" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* isEnabled, isSynced, isAuthorized, name, externalState", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The id of the company you wish to retrieve the datasources." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 1664,\n \"value\": [\n {\n \"id\": 1,\n \"companyId\": 12345,\n \"source\": \"Amazon v2 Extractor\",\n \"instance\": \"2713cc25-0bce-42f8-b443-68301aff1b66\",\n \"isEnabled\": false,\n \"isSynced\": false,\n \"isAuthorized\": false,\n \"createdUserId\": 123,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 12,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"name\": \"TestName\",\n \"externalState\": \"Test Path\"\n },\n {\n \"id\": 1,\n \"companyId\": 12345,\n \"source\": \"Amazon v2 Extractor\",\n \"instance\": \"2713cc25-0bce-42f8-b443-68301aff1b66\",\n \"isEnabled\": false,\n \"isSynced\": false,\n \"isAuthorized\": false,\n \"createdUserId\": 123,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 12,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"name\": \"TestName\",\n \"externalState\": \"Test Path\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/datasources?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "datasources" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* isEnabled, isSynced, isAuthorized, name, externalState", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The id of the company you wish to retrieve the datasources." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/datasources?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "datasources" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* isEnabled, isSynced, isAuthorized, name, externalState", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The id of the company you wish to retrieve the datasources." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/datasources?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "datasources" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* isEnabled, isSynced, isAuthorized, name, externalState", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The id of the company you wish to retrieve the datasources." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "distancethresholds", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a single DistanceThreshold", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/distancethresholds/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "distancethresholds", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this DistanceThreshold object" }, { "key": "id", "value": "155", "description": "The unique ID number referring to this DistanceThreshold object" } ] }, "description": "Retrieves a single DistanceThreshold object defined by this URL.\r\n \r\nA company-distance-threshold model indicates the distance between a company\r\nand the taxing borders of various countries. Distance thresholds are necessary\r\nto correctly calculate some value-added taxes.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/distancethresholds/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "distancethresholds", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this DistanceThreshold object" }, { "key": "id", "value": "155", "description": "The unique ID number referring to this DistanceThreshold object" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 0,\n \"companyId\": 0,\n \"originCountry\": \"FR\",\n \"destinationCountry\": \"BR\",\n \"thresholdExceeded\": false,\n \"type\": \"Sale\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/distancethresholds/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "distancethresholds", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this DistanceThreshold object" }, { "key": "id", "value": "155", "description": "The unique ID number referring to this DistanceThreshold object" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/distancethresholds/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "distancethresholds", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this DistanceThreshold object" }, { "key": "id", "value": "155", "description": "The unique ID number referring to this DistanceThreshold object" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/distancethresholds/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "distancethresholds", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this DistanceThreshold object" }, { "key": "id", "value": "155", "description": "The unique ID number referring to this DistanceThreshold object" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Update a DistanceThreshold object", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"companyId\": 0,\n \"originCountry\": \"FR\",\n \"destinationCountry\": \"BR\",\n \"thresholdExceeded\": false,\n \"type\": \"Sale\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/distancethresholds/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "distancethresholds", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that owns this DistanceThreshold object." }, { "key": "id", "value": "155", "description": "The unique ID number of the DistanceThreshold object to replace." } ] }, "description": "Replace the existing DistanceThreshold object at this URL with an updated object.\r\n \r\nA company-distance-threshold model indicates the distance between a company\r\nand the taxing borders of various countries. Distance thresholds are necessary\r\nto correctly calculate some value-added taxes.\r\n \r\nAll data from the existing object will be replaced with data in the object you PUT.\r\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.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"companyId\": 0,\n \"originCountry\": \"FR\",\n \"destinationCountry\": \"BR\",\n \"thresholdExceeded\": false,\n \"type\": \"Sale\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/distancethresholds/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "distancethresholds", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that owns this DistanceThreshold object." }, { "key": "id", "value": "155", "description": "The unique ID number of the DistanceThreshold object to replace." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 0,\n \"companyId\": 0,\n \"originCountry\": \"FR\",\n \"destinationCountry\": \"BR\",\n \"thresholdExceeded\": false,\n \"type\": \"Sale\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"companyId\": 0,\n \"originCountry\": \"FR\",\n \"destinationCountry\": \"BR\",\n \"thresholdExceeded\": false,\n \"type\": \"Sale\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/distancethresholds/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "distancethresholds", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that owns this DistanceThreshold object." }, { "key": "id", "value": "155", "description": "The unique ID number of the DistanceThreshold object to replace." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"companyId\": 0,\n \"originCountry\": \"FR\",\n \"destinationCountry\": \"BR\",\n \"thresholdExceeded\": false,\n \"type\": \"Sale\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/distancethresholds/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "distancethresholds", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that owns this DistanceThreshold object." }, { "key": "id", "value": "155", "description": "The unique ID number of the DistanceThreshold object to replace." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"companyId\": 0,\n \"originCountry\": \"FR\",\n \"destinationCountry\": \"BR\",\n \"thresholdExceeded\": false,\n \"type\": \"Sale\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/distancethresholds/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "distancethresholds", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that owns this DistanceThreshold object." }, { "key": "id", "value": "155", "description": "The unique ID number of the DistanceThreshold object to replace." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete a single DistanceThreshold object", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/distancethresholds/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "distancethresholds", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that owns this DistanceThreshold" }, { "key": "id", "value": "155", "description": "The unique ID number of the DistanceThreshold object you wish to delete." } ] }, "description": "Marks the DistanceThreshold object identified by this URL as deleted.\r\n \r\nA company-distance-threshold model indicates the distance between a company\r\nand the taxing borders of various countries. Distance thresholds are necessary\r\nto correctly calculate some value-added taxes.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/distancethresholds/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "distancethresholds", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that owns this DistanceThreshold" }, { "key": "id", "value": "155", "description": "The unique ID number of the DistanceThreshold object you wish to delete." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/distancethresholds/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "distancethresholds", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that owns this DistanceThreshold" }, { "key": "id", "value": "155", "description": "The unique ID number of the DistanceThreshold object you wish to delete." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/distancethresholds/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "distancethresholds", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that owns this DistanceThreshold" }, { "key": "id", "value": "155", "description": "The unique ID number of the DistanceThreshold object you wish to delete." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/distancethresholds/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "distancethresholds", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that owns this DistanceThreshold" }, { "key": "id", "value": "155", "description": "The unique ID number of the DistanceThreshold object you wish to delete." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Retrieve all DistanceThresholds for this company.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/distancethresholds?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "distancethresholds" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/)." }, { "key": "$include", "value": "string", "description": "A comma separated list of additional data to retrieve." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company whose DistanceThreshold objects you wish to list." } ] }, "description": "Lists all DistanceThreshold objects that belong to this company.\r\n \r\nA company-distance-threshold model indicates the distance between a company\r\nand the taxing borders of various countries. Distance thresholds are necessary\r\nto correctly calculate some value-added taxes.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/distancethresholds?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "distancethresholds" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company whose DistanceThreshold objects you wish to list." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 2482,\n \"value\": [\n {\n \"id\": 0,\n \"companyId\": 0,\n \"originCountry\": \"FR\",\n \"destinationCountry\": \"BR\",\n \"thresholdExceeded\": false,\n \"type\": \"Sale\"\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"originCountry\": \"FR\",\n \"destinationCountry\": \"BR\",\n \"thresholdExceeded\": false,\n \"type\": \"Sale\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/distancethresholds?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "distancethresholds" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company whose DistanceThreshold objects you wish to list." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/distancethresholds?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "distancethresholds" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company whose DistanceThreshold objects you wish to list." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/distancethresholds?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "distancethresholds" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company whose DistanceThreshold objects you wish to list." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Create one or more DistanceThreshold objects", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"companyId\": 0,\n \"originCountry\": \"FR\",\n \"destinationCountry\": \"BR\",\n \"thresholdExceeded\": false,\n \"type\": \"Sale\"\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"originCountry\": \"FR\",\n \"destinationCountry\": \"BR\",\n \"thresholdExceeded\": false,\n \"type\": \"Sale\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/distancethresholds", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "distancethresholds" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that owns this DistanceThreshold" } ] }, "description": "Create one or more DistanceThreshold objects for this company.\r\n \r\nA company-distance-threshold model indicates the distance between a company\r\nand the taxing borders of various countries. Distance thresholds are necessary\r\nto correctly calculate some value-added taxes.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"companyId\": 0,\n \"originCountry\": \"FR\",\n \"destinationCountry\": \"BR\",\n \"thresholdExceeded\": false,\n \"type\": \"Sale\"\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"originCountry\": \"FR\",\n \"destinationCountry\": \"BR\",\n \"thresholdExceeded\": false,\n \"type\": \"Sale\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/distancethresholds", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "distancethresholds" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that owns this DistanceThreshold" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": 0,\n \"companyId\": 0,\n \"originCountry\": \"FR\",\n \"destinationCountry\": \"BR\",\n \"thresholdExceeded\": false,\n \"type\": \"Sale\"\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"originCountry\": \"FR\",\n \"destinationCountry\": \"BR\",\n \"thresholdExceeded\": false,\n \"type\": \"Sale\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"companyId\": 0,\n \"originCountry\": \"FR\",\n \"destinationCountry\": \"BR\",\n \"thresholdExceeded\": false,\n \"type\": \"Sale\"\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"originCountry\": \"FR\",\n \"destinationCountry\": \"BR\",\n \"thresholdExceeded\": false,\n \"type\": \"Sale\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/distancethresholds", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "distancethresholds" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that owns this DistanceThreshold" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"companyId\": 0,\n \"originCountry\": \"FR\",\n \"destinationCountry\": \"BR\",\n \"thresholdExceeded\": false,\n \"type\": \"Sale\"\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"originCountry\": \"FR\",\n \"destinationCountry\": \"BR\",\n \"thresholdExceeded\": false,\n \"type\": \"Sale\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/distancethresholds", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "distancethresholds" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that owns this DistanceThreshold" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"companyId\": 0,\n \"originCountry\": \"FR\",\n \"destinationCountry\": \"BR\",\n \"thresholdExceeded\": false,\n \"type\": \"Sale\"\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"originCountry\": \"FR\",\n \"destinationCountry\": \"BR\",\n \"thresholdExceeded\": false,\n \"type\": \"Sale\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/distancethresholds", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "distancethresholds" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that owns this DistanceThreshold" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "ecommercetokens", "item": [ { "name": "Create a new ecommerce token.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"customerNumber\": \"1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/ecommercetokens", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "ecommercetokens" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company ID that will be issued this certificate." } ] }, "description": "Creates a new ecommerce token.\r\n \r\nThis API is used to create a new ecommerce token. An ecommerce token is required in order to launch the ECM/CertCapture ecommerce plugin. Create a separate token for each of your ECM/CertCapture customers.\r\n\r\nUse the SDK to embed ECM’s document submission form into your ecommerce platform or online store. Once the token is created, place the returned token value for that customer record in the token field in your ecommerce SDK code. This allows customers to manage their exemption certificates before or after making the purchase. More information is available in the [ECM/CertCapture integration guide](https://developer.avalara.com/document-management/set-up-ecm-for-ecommerce/ecm-in-ecom-environments/).\r\n\r\nYou can also use the [ecommerce Plugin Demo](https://developer.avalara.com/certcapture/cert-demo/) on developer.avalara.com to test generating a token. Using your AvaTax username and password, try generating the token and combining it with various parameters.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"customerNumber\": \"1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/ecommercetokens", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "ecommercetokens" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company ID that will be issued this certificate." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"token\": \"jwt token for gencert utility\",\n \"clientIds\": [\n 1,\n 2,\n 3\n ],\n \"createdDate\": \"2000-01-01T00:00:00\",\n \"expirationDate\": \"2000-01-01T00:00:00\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"customerNumber\": \"1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/ecommercetokens", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "ecommercetokens" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company ID that will be issued this certificate." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"customerNumber\": \"1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/ecommercetokens", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "ecommercetokens" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company ID that will be issued this certificate." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Server Error", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"customerNumber\": \"1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/ecommercetokens", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "ecommercetokens" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company ID that will be issued this certificate." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Refresh an eCommerce token.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token\": \"jwt token for gencert utility\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/ecommercetokens", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "ecommercetokens" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company ID that the refreshed certificate belongs to." } ] }, "description": "Refresh an eCommerce token.\r\n \r\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.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"token\": \"jwt token for gencert utility\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/ecommercetokens", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "ecommercetokens" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company ID that the refreshed certificate belongs to." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 6124,\n \"value\": [\n {\n \"token\": \"jwt token for gencert utility\",\n \"clientIds\": [\n 1,\n 2,\n 3\n ],\n \"createdDate\": \"2000-01-01T00:00:00\",\n \"expirationDate\": \"2000-01-01T00:00:00\"\n },\n {\n \"token\": \"jwt token for gencert utility\",\n \"clientIds\": [\n 1,\n 2,\n 3\n ],\n \"createdDate\": \"2000-01-01T00:00:00\",\n \"expirationDate\": \"2000-01-01T00:00:00\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"token\": \"jwt token for gencert utility\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/ecommercetokens", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "ecommercetokens" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company ID that the refreshed certificate belongs to." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"token\": \"jwt token for gencert utility\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/ecommercetokens", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "ecommercetokens" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company ID that the refreshed certificate belongs to." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Server Error", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"token\": \"jwt token for gencert utility\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/ecommercetokens", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "ecommercetokens" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company ID that the refreshed certificate belongs to." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "$taxcode-recommendations", "item": [ { "name": "Get the real-time tax code recommendations for the specified items without saving item data.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"description\": \"Ceramic Mug\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"itemType\": \"Physical\",\n \"upc\": \"123456789012\",\n \"summary\": \"A beautiful ceramic mug for hot beverages\"\n },\n {\n \"description\": \"Ceramic Mug\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"itemType\": \"Physical\",\n \"upc\": \"123456789012\",\n \"summary\": \"A beautiful ceramic mug for hot beverages\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/$taxcode-recommendations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "$taxcode-recommendations" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID of the company." } ] }, "description": "Provides immediate tax code recommendations for item details submitted in the request. Item data is processed only for recommendation purposes and is not persisted.\r\n \r\nMaximum items per request: 50 (subject to change).\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"description\": \"Ceramic Mug\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"itemType\": \"Physical\",\n \"upc\": \"123456789012\",\n \"summary\": \"A beautiful ceramic mug for hot beverages\"\n },\n {\n \"description\": \"Ceramic Mug\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"itemType\": \"Physical\",\n \"upc\": \"123456789012\",\n \"summary\": \"A beautiful ceramic mug for hot beverages\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/$taxcode-recommendations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "$taxcode-recommendations" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID of the company." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"description\": \"Ceramic Mug\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"itemType\": \"Physical\",\n \"upc\": \"123456789012\",\n \"summary\": \"A beautiful ceramic mug for hot beverages\",\n \"taxCodeRecommendations\": [\n {\n \"taxCode\": \"SW110000\",\n \"level\": \"H\"\n },\n {\n \"taxCode\": \"SW117202\",\n \"level\": \"H\"\n },\n {\n \"taxCode\": \"SW117210\",\n \"level\": \"L\"\n }\n ]\n },\n {\n \"description\": \"Ceramic Mug\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"itemType\": \"Physical\",\n \"upc\": \"123456789012\",\n \"summary\": \"A beautiful ceramic mug for hot beverages\",\n \"taxCodeRecommendations\": [\n {\n \"taxCode\": \"SW110000\",\n \"level\": \"H\"\n },\n {\n \"taxCode\": \"SW117202\",\n \"level\": \"H\"\n },\n {\n \"taxCode\": \"SW117210\",\n \"level\": \"L\"\n }\n ]\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"description\": \"Ceramic Mug\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"itemType\": \"Physical\",\n \"upc\": \"123456789012\",\n \"summary\": \"A beautiful ceramic mug for hot beverages\"\n },\n {\n \"description\": \"Ceramic Mug\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"itemType\": \"Physical\",\n \"upc\": \"123456789012\",\n \"summary\": \"A beautiful ceramic mug for hot beverages\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/$taxcode-recommendations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "$taxcode-recommendations" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID of the company." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"description\": \"Ceramic Mug\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"itemType\": \"Physical\",\n \"upc\": \"123456789012\",\n \"summary\": \"A beautiful ceramic mug for hot beverages\"\n },\n {\n \"description\": \"Ceramic Mug\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"itemType\": \"Physical\",\n \"upc\": \"123456789012\",\n \"summary\": \"A beautiful ceramic mug for hot beverages\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/$taxcode-recommendations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "$taxcode-recommendations" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID of the company." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"description\": \"Ceramic Mug\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"itemType\": \"Physical\",\n \"upc\": \"123456789012\",\n \"summary\": \"A beautiful ceramic mug for hot beverages\"\n },\n {\n \"description\": \"Ceramic Mug\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"itemType\": \"Physical\",\n \"upc\": \"123456789012\",\n \"summary\": \"A beautiful ceramic mug for hot beverages\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/$taxcode-recommendations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "$taxcode-recommendations" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID of the company." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Server Error", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"description\": \"Ceramic Mug\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"itemType\": \"Physical\",\n \"upc\": \"123456789012\",\n \"summary\": \"A beautiful ceramic mug for hot beverages\"\n },\n {\n \"description\": \"Ceramic Mug\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"itemType\": \"Physical\",\n \"upc\": \"123456789012\",\n \"summary\": \"A beautiful ceramic mug for hot beverages\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/$taxcode-recommendations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "$taxcode-recommendations" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID of the company." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Server Error", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"description\": \"Ceramic Mug\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"itemType\": \"Physical\",\n \"upc\": \"123456789012\",\n \"summary\": \"A beautiful ceramic mug for hot beverages\"\n },\n {\n \"description\": \"Ceramic Mug\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"itemType\": \"Physical\",\n \"upc\": \"123456789012\",\n \"summary\": \"A beautiful ceramic mug for hot beverages\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/$taxcode-recommendations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "$taxcode-recommendations" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID of the company." } ] } }, "status": "Gateway Timeout", "code": 504, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "classificationrequests", "item": [ { "name": "taxcode", "item": [ { "name": "Create a new tax code classification request", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"itemIds\": [\n 987654,\n 876543,\n 765432\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/classificationrequests/taxcode", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "classificationrequests", "taxcode" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that creates this request." } ] }, "description": "Creates a new tax code classification request.\r\n \r\nAvalara AvaTax system tax codes represent various goods and services classified by industry or consumer categories and\r\nmajor physical similarities. Taxability rules are associated with tax codes. Customers can map their Items to tax codes\r\nallowing them to take advantage of thousands of tax rules in the AvaTax engine resulting in accurate taxability determinations.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Created", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"itemIds\": [\n 987654,\n 876543,\n 765432\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/classificationrequests/taxcode", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "classificationrequests", "taxcode" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that creates this request." } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"requestId\": 1,\n \"companyId\": 7755785,\n \"status\": \"Waiting\",\n \"requestType\": \"INDIX\",\n \"createdUserId\": 836447,\n \"createdDate\": \"0001-01-01T00:00:00\",\n \"modifiedDate\": \"0001-01-01T00:00:00\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"itemIds\": [\n 987654,\n 876543,\n 765432\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/classificationrequests/taxcode", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "classificationrequests", "taxcode" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that creates this request." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"itemIds\": [\n 987654,\n 876543,\n 765432\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/classificationrequests/taxcode", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "classificationrequests", "taxcode" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that creates this request." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"itemIds\": [\n 987654,\n 876543,\n 765432\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/classificationrequests/taxcode", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "classificationrequests", "taxcode" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that creates this request." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] } ] }, { "name": "itemcatalogue", "item": [ { "name": "{itemCode}", "item": [ { "name": "Delete a single item", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/itemcatalogue/:itemCode", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "itemcatalogue", ":itemCode" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item." }, { "key": "itemCode", "value": "string", "description": "The code of the item you want to delete." } ] }, "description": "Deletes the item object at this URL.\r\n \r\nItems are a way of separating your tax calculation process from your tax configuration details.\r\nUse this endpoint to delete an existing item with item code.\r\n \r\nDeleting an item will also delete the parameters, classifications, and product categories associated with that item.\r\n \r\nNOTE: If your item code contains any of these characters /, +, ? or a space, please use the following encoding before making a request:\r\n* Replace '/' with '\\_-ava2f-\\_' For example: 'Item/Code' becomes 'Item_-ava2f-_Code'\r\n* Replace '+' with '\\_-ava2b-\\_' For example: 'Item+Code' becomes 'Item_-ava2b-_Code'\r\n* Replace '?' with '\\_-ava3f-\\_' For example: 'Item?Code' becomes 'Item_-ava3f-_Code'\r\n* Replace '%' with '\\_-ava25-\\_' For example: 'Item%Code' becomes 'Item_-ava25-_Code'\r\n* Replace '#' with '\\_-ava23-\\_' For example: 'Item#Code' becomes 'Item_-ava23-_Code'\r\n* Replace ''' with '\\_-ava27-\\_' For example: 'Item'Code' becomes 'Item_-ava27-_Code'\r\n* Replace '\"' with '\\_-ava22-\\_' For example: 'Item\"Code' becomes 'Item_-ava22-_Code'\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/itemcatalogue/:itemCode", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "itemcatalogue", ":itemCode" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item." }, { "key": "itemCode", "value": "string", "description": "The code of the item you want to delete." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"ObjectDeleted\",\n \"number\": 2660,\n \"message\": \"The object has been deleted successfully.\",\n \"description\": \"The object has been deleted successfully.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/ObjectDeleted\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"ObjectDeleted\",\n \"number\": 2660,\n \"message\": \"The object has been deleted successfully.\",\n \"description\": \"The object has been deleted successfully.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/ObjectDeleted\",\n \"severity\": \"Success\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/itemcatalogue/:itemCode", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "itemcatalogue", ":itemCode" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item." }, { "key": "itemCode", "value": "string", "description": "The code of the item you want to delete." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/itemcatalogue/:itemCode", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "itemcatalogue", ":itemCode" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item." }, { "key": "itemCode", "value": "string", "description": "The code of the item you want to delete." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/itemcatalogue/:itemCode", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "itemcatalogue", ":itemCode" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item." }, { "key": "itemCode", "value": "string", "description": "The code of the item you want to delete." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Create or update items from a product catalog.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"itemId\": 0,\n \"itemCode\": \"Item 1\",\n \"description\": \"Concord Grape Alpha\",\n \"taxCode\": \"P0000000\",\n \"itemGroup\": \"Drinks\",\n \"category\": \"beverages - vinegar - drink\",\n \"source\": \"QBO\",\n \"sourceEntityId\": \"QBO_1234\",\n \"properties\": {\n \"color\": \"white\"\n },\n \"classifications\": [\n {\n \"id\": 0,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"Inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ]\n },\n {\n \"itemId\": 0,\n \"itemCode\": \"Item 1\",\n \"description\": \"Concord Grape Alpha\",\n \"taxCode\": \"P0000000\",\n \"itemGroup\": \"Drinks\",\n \"category\": \"beverages - vinegar - drink\",\n \"source\": \"QBO\",\n \"sourceEntityId\": \"QBO_1234\",\n \"properties\": {\n \"color\": \"white\"\n },\n \"classifications\": [\n {\n \"id\": 0,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"Inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/itemcatalogue", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "itemcatalogue" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item." } ] }, "description": "Creates/updates one or more item objects with additional properties and the AvaTax category attached to this company.\r\n \r\nRecommended number of items to create/update in a single call is upto 100.\r\n \r\nCurrently, the maximum number of items that can be created/updated in a single call is 1000 (This limit is subject to change).\r\n \r\nItems are a way of separating your tax calculation process from your tax configuration details. Use this endpoint to create\r\na new or update an existing item. This can be used to sync the items with Avalara. For example, an accounting software\r\nsystem can use this to sync all their items from an ERP with Avalara.\r\n \r\nParameters and Classifications can be added with the Item.\r\n \r\nPlease provide all the countries parameter values as a valid two letter ISO-3166 country code.\r\nRefer to 'ListCountries' api to get valid country code for any country if needed.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"itemId\": 0,\n \"itemCode\": \"Item 1\",\n \"description\": \"Concord Grape Alpha\",\n \"taxCode\": \"P0000000\",\n \"itemGroup\": \"Drinks\",\n \"category\": \"beverages - vinegar - drink\",\n \"source\": \"QBO\",\n \"sourceEntityId\": \"QBO_1234\",\n \"properties\": {\n \"color\": \"white\"\n },\n \"classifications\": [\n {\n \"id\": 0,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"Inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ]\n },\n {\n \"itemId\": 0,\n \"itemCode\": \"Item 1\",\n \"description\": \"Concord Grape Alpha\",\n \"taxCode\": \"P0000000\",\n \"itemGroup\": \"Drinks\",\n \"category\": \"beverages - vinegar - drink\",\n \"source\": \"QBO\",\n \"sourceEntityId\": \"QBO_1234\",\n \"properties\": {\n \"color\": \"white\"\n },\n \"classifications\": [\n {\n \"id\": 0,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"Inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/itemcatalogue", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "itemcatalogue" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"total\": 1,\n \"result\": [\n {\n \"itemId\": 1001,\n \"itemCode\": \"Item 1\",\n \"sourceEntityId\": \"QBO_1234\",\n \"itemEvent\": \"ItemCreated\"\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"itemId\": 0,\n \"itemCode\": \"Item 1\",\n \"description\": \"Concord Grape Alpha\",\n \"taxCode\": \"P0000000\",\n \"itemGroup\": \"Drinks\",\n \"category\": \"beverages - vinegar - drink\",\n \"source\": \"QBO\",\n \"sourceEntityId\": \"QBO_1234\",\n \"properties\": {\n \"color\": \"white\"\n },\n \"classifications\": [\n {\n \"id\": 0,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"Inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ]\n },\n {\n \"itemId\": 0,\n \"itemCode\": \"Item 1\",\n \"description\": \"Concord Grape Alpha\",\n \"taxCode\": \"P0000000\",\n \"itemGroup\": \"Drinks\",\n \"category\": \"beverages - vinegar - drink\",\n \"source\": \"QBO\",\n \"sourceEntityId\": \"QBO_1234\",\n \"properties\": {\n \"color\": \"white\"\n },\n \"classifications\": [\n {\n \"id\": 0,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"Inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/itemcatalogue", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "itemcatalogue" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"itemId\": 0,\n \"itemCode\": \"Item 1\",\n \"description\": \"Concord Grape Alpha\",\n \"taxCode\": \"P0000000\",\n \"itemGroup\": \"Drinks\",\n \"category\": \"beverages - vinegar - drink\",\n \"source\": \"QBO\",\n \"sourceEntityId\": \"QBO_1234\",\n \"properties\": {\n \"color\": \"white\"\n },\n \"classifications\": [\n {\n \"id\": 0,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"Inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ]\n },\n {\n \"itemId\": 0,\n \"itemCode\": \"Item 1\",\n \"description\": \"Concord Grape Alpha\",\n \"taxCode\": \"P0000000\",\n \"itemGroup\": \"Drinks\",\n \"category\": \"beverages - vinegar - drink\",\n \"source\": \"QBO\",\n \"sourceEntityId\": \"QBO_1234\",\n \"properties\": {\n \"color\": \"white\"\n },\n \"classifications\": [\n {\n \"id\": 0,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"Inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/itemcatalogue", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "itemcatalogue" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"itemId\": 0,\n \"itemCode\": \"Item 1\",\n \"description\": \"Concord Grape Alpha\",\n \"taxCode\": \"P0000000\",\n \"itemGroup\": \"Drinks\",\n \"category\": \"beverages - vinegar - drink\",\n \"source\": \"QBO\",\n \"sourceEntityId\": \"QBO_1234\",\n \"properties\": {\n \"color\": \"white\"\n },\n \"classifications\": [\n {\n \"id\": 0,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"Inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ]\n },\n {\n \"itemId\": 0,\n \"itemCode\": \"Item 1\",\n \"description\": \"Concord Grape Alpha\",\n \"taxCode\": \"P0000000\",\n \"itemGroup\": \"Drinks\",\n \"category\": \"beverages - vinegar - drink\",\n \"source\": \"QBO\",\n \"sourceEntityId\": \"QBO_1234\",\n \"properties\": {\n \"color\": \"white\"\n },\n \"classifications\": [\n {\n \"id\": 0,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"Inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/itemcatalogue", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "itemcatalogue" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "items", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a single item", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":id" ], "query": [ { "key": "$include", "value": "string", "description": "A comma separated list of additional data to retrieve." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item object" }, { "key": "id", "value": "155", "description": "The primary key of this item" } ] }, "description": "Get the `Item` object identified by this URL.\r\n \r\nItems are a way of separating your tax calculation process from your tax configuration details. If you choose, you\r\ncan provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions,\r\nand other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters\r\nfrom the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance\r\nteam can manage your item catalog and adjust the tax behavior of items without having to modify your software.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":id" ], "query": [ { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item object" }, { "key": "id", "value": "155", "description": "The primary key of this item" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CERMUG\",\n \"taxCode\": \"P0000000\",\n \"description\": \"Ceramic Mug\",\n \"itemGroup\": \"Mugs\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"source\": \"MTCC\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ],\n \"properties\": {\n \"color\": \"white\"\n }\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":id" ], "query": [ { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item object" }, { "key": "id", "value": "155", "description": "The primary key of this item" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":id" ], "query": [ { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item object" }, { "key": "id", "value": "155", "description": "The primary key of this item" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":id" ], "query": [ { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item object" }, { "key": "id", "value": "155", "description": "The primary key of this item" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Update a single item", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CERMUG\",\n \"taxCode\": \"P0000000\",\n \"description\": \"Ceramic Mug\",\n \"itemGroup\": \"Mugs\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"source\": \"MTCC\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ],\n \"properties\": {\n \"color\": \"white\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:id?isRecommendationSelected=false&isRecommendationRejected=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":id" ], "query": [ { "key": "isRecommendationSelected", "value": "false", "description": "If true then Set recommendation status to RecommendationSelected" }, { "key": "isRecommendationRejected", "value": "false", "description": "If true then Set recommendation status to RecommendationRejected, When the taxCode recommendation status is RecommendationAvailable. Else will be thrown as error" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this item belongs to." }, { "key": "id", "value": "155", "description": "The ID of the item you wish to update" } ] }, "description": "Replace the existing `Item` object at this URL with an updated object.\r\n \r\nItems are a way of separating your tax calculation process from your tax configuration details. If you choose, you\r\ncan provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions,\r\nand other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters\r\nfrom the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance\r\nteam can manage your item catalog and adjust the tax behavior of items without having to modify your software.\r\n \r\nAll data from the existing object will be replaced with data in the object you PUT. To set a field's value to null,\r\nyou may either set its value to null or omit that field from the object you post.\r\n \r\nThe tax code takes precedence over the tax code id if both are provided.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CERMUG\",\n \"taxCode\": \"P0000000\",\n \"description\": \"Ceramic Mug\",\n \"itemGroup\": \"Mugs\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"source\": \"MTCC\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ],\n \"properties\": {\n \"color\": \"white\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:id?isRecommendationSelected=false&isRecommendationRejected=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":id" ], "query": [ { "description": "If true then Set recommendation status to RecommendationSelected", "key": "isRecommendationSelected", "value": "false" }, { "description": "If true then Set recommendation status to RecommendationRejected, When the taxCode recommendation status is RecommendationAvailable. Else will be thrown as error", "key": "isRecommendationRejected", "value": "false" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this item belongs to." }, { "key": "id", "value": "155", "description": "The ID of the item you wish to update" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CERMUG\",\n \"taxCode\": \"P0000000\",\n \"description\": \"Ceramic Mug\",\n \"itemGroup\": \"Mugs\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"source\": \"MTCC\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ],\n \"properties\": {\n \"color\": \"white\"\n }\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CERMUG\",\n \"taxCode\": \"P0000000\",\n \"description\": \"Ceramic Mug\",\n \"itemGroup\": \"Mugs\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"source\": \"MTCC\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ],\n \"properties\": {\n \"color\": \"white\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:id?isRecommendationSelected=false&isRecommendationRejected=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":id" ], "query": [ { "description": "If true then Set recommendation status to RecommendationSelected", "key": "isRecommendationSelected", "value": "false" }, { "description": "If true then Set recommendation status to RecommendationRejected, When the taxCode recommendation status is RecommendationAvailable. Else will be thrown as error", "key": "isRecommendationRejected", "value": "false" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this item belongs to." }, { "key": "id", "value": "155", "description": "The ID of the item you wish to update" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CERMUG\",\n \"taxCode\": \"P0000000\",\n \"description\": \"Ceramic Mug\",\n \"itemGroup\": \"Mugs\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"source\": \"MTCC\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ],\n \"properties\": {\n \"color\": \"white\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:id?isRecommendationSelected=false&isRecommendationRejected=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":id" ], "query": [ { "description": "If true then Set recommendation status to RecommendationSelected", "key": "isRecommendationSelected", "value": "false" }, { "description": "If true then Set recommendation status to RecommendationRejected, When the taxCode recommendation status is RecommendationAvailable. Else will be thrown as error", "key": "isRecommendationRejected", "value": "false" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this item belongs to." }, { "key": "id", "value": "155", "description": "The ID of the item you wish to update" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CERMUG\",\n \"taxCode\": \"P0000000\",\n \"description\": \"Ceramic Mug\",\n \"itemGroup\": \"Mugs\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"source\": \"MTCC\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ],\n \"properties\": {\n \"color\": \"white\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:id?isRecommendationSelected=false&isRecommendationRejected=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":id" ], "query": [ { "description": "If true then Set recommendation status to RecommendationSelected", "key": "isRecommendationSelected", "value": "false" }, { "description": "If true then Set recommendation status to RecommendationRejected, When the taxCode recommendation status is RecommendationAvailable. Else will be thrown as error", "key": "isRecommendationRejected", "value": "false" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this item belongs to." }, { "key": "id", "value": "155", "description": "The ID of the item you wish to update" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete a single item", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item." }, { "key": "id", "value": "155", "description": "The ID of the item you wish to delete." } ] }, "description": "Deletes the item object at this URL.\r\n \r\nItems are a way of separating your tax calculation process from your tax configuration details. If you choose, you\r\ncan provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions,\r\nand other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters\r\nfrom the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance\r\nteam can manage your item catalog and adjust the tax behavior of items without having to modify your software.\r\n \r\nDeleting an item will also delete the parameters and classifications associated with that item.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item." }, { "key": "id", "value": "155", "description": "The ID of the item you wish to delete." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"ObjectDeleted\",\n \"number\": 2660,\n \"message\": \"The object has been deleted successfully.\",\n \"description\": \"The object has been deleted successfully.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/ObjectDeleted\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"ObjectDeleted\",\n \"number\": 2660,\n \"message\": \"The object has been deleted successfully.\",\n \"description\": \"The object has been deleted successfully.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/ObjectDeleted\",\n \"severity\": \"Success\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item." }, { "key": "id", "value": "155", "description": "The ID of the item you wish to delete." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item." }, { "key": "id", "value": "155", "description": "The ID of the item you wish to delete." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item." }, { "key": "id", "value": "155", "description": "The ID of the item you wish to delete." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Patch a single item", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json-patch+json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"value\": {},\n \"path\": \"string\",\n \"op\": \"string\",\n \"from\": \"string\"\n },\n {\n \"value\": {},\n \"path\": \"string\",\n \"op\": \"string\",\n \"from\": \"string\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this item belongs to." }, { "key": "id", "value": "155", "description": "The ID of the item you want to update." } ] }, "description": "Update the existing item object at this URL with the specified patch changes.\r\n \r\nItems are a way of separating your tax calculation process from your tax configuration details. If you choose, you\r\ncan provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions,\r\nand other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters\r\nfrom the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance\r\nteam can manage your item catalog and adjust the tax behavior of items without having to modify your software.\r\n \r\nOnly specified fields in the existing object will be updated with the data you provide via PATCH.\r\nTo set a field's value to null, you can either set the field to null explicitly or omit it from the PATCH request.\r\n \r\nThe tax code takes precedence over the tax code ID if both are provided.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "PATCH", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json-patch+json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"value\": {},\n \"path\": \"string\",\n \"op\": \"string\",\n \"from\": \"string\"\n },\n {\n \"value\": {},\n \"path\": \"string\",\n \"op\": \"string\",\n \"from\": \"string\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this item belongs to." }, { "key": "id", "value": "155", "description": "The ID of the item you want to update." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CERMUG\",\n \"taxCode\": \"P0000000\",\n \"description\": \"Ceramic Mug\",\n \"itemGroup\": \"Mugs\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"source\": \"MTCC\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ],\n \"properties\": {\n \"color\": \"white\"\n }\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PATCH", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json-patch+json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"value\": {},\n \"path\": \"string\",\n \"op\": \"string\",\n \"from\": \"string\"\n },\n {\n \"value\": {},\n \"path\": \"string\",\n \"op\": \"string\",\n \"from\": \"string\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this item belongs to." }, { "key": "id", "value": "155", "description": "The ID of the item you want to update." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "PATCH", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json-patch+json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"value\": {},\n \"path\": \"string\",\n \"op\": \"string\",\n \"from\": \"string\"\n },\n {\n \"value\": {},\n \"path\": \"string\",\n \"op\": \"string\",\n \"from\": \"string\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this item belongs to." }, { "key": "id", "value": "155", "description": "The ID of the item you want to update." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "PATCH", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json-patch+json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"value\": {},\n \"path\": \"string\",\n \"op\": \"string\",\n \"from\": \"string\"\n },\n {\n \"value\": {},\n \"path\": \"string\",\n \"op\": \"string\",\n \"from\": \"string\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this item belongs to." }, { "key": "id", "value": "155", "description": "The ID of the item you want to update." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "{itemCode}", "item": [ { "name": "premiumClassification", "item": [ { "name": "{systemCode}", "item": [ { "name": "Retrieve premium classification for a company's item based on its ItemCode and SystemCode.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemCode/premiumClassification/:systemCode?country=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemCode", "premiumClassification", ":systemCode" ], "query": [ { "key": "country", "value": "string", "description": "Optional: Provide the country for which you want to retrieve the premium classification." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item object" }, { "key": "itemCode", "value": "string", "description": "The ItemCode of the item for which you want to retrieve premium classification" }, { "key": "systemCode", "value": "string", "description": "The SystemCode for which you want to retrieve premium classification" } ] }, "description": "Retrieves the premium classification for an ItemCode and SystemCode.\r\n \r\nNOTE: If your item code contains any of these characters /, +, ?,\",' ,% or #, please use the following encoding before making a request:\r\n* Replace '/' with '\\_-ava2f-\\_' For example: 'Item/Code' becomes 'Item_-ava2f-_Code'\r\n* Replace '+' with '\\_-ava2b-\\_' For example: 'Item+Code' becomes 'Item_-ava2b-_Code'\r\n* Replace '?' with '\\_-ava3f-\\_' For example: 'Item?Code' becomes 'Item_-ava3f-_Code'\r\n* Replace '%' with '\\_-ava25-\\_' For example: 'Item%Code' becomes 'Item_-ava25-_Code'\r\n* Replace '#' with '\\_-ava23-\\_' For example: 'Item#Code' becomes 'Item_-ava23-_Code'\r\n* Replace ''' with '\\_-ava27-\\_' For example: 'Item'Code' becomes 'Item_-ava27-_Code'\r\n* Replace '\"' with '\\_-ava22-\\_' For example: 'Item\"Code' becomes 'Item_-ava22-_Code'\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemCode/premiumClassification/:systemCode?country=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemCode", "premiumClassification", ":systemCode" ], "query": [ { "description": "Optional: Provide the country for which you want to retrieve the premium classification.", "key": "country", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item object" }, { "key": "itemCode", "value": "string", "description": "The ItemCode of the item for which you want to retrieve premium classification" }, { "key": "systemCode", "value": "string", "description": "The SystemCode for which you want to retrieve premium classification" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"itemCode\": \"ADP101\",\n \"companyId\": 12345,\n \"hsCode\": \"8528620000\",\n \"systemCode\": \"HTS\",\n \"justification\": \"This projector is directly connected with ADP machine;(ITBTI2020-0052M-135100) BTI Reference ,(N293311) ruling.\",\n \"createdDate\": \"2026-04-02T10:55:14.2030312Z\",\n \"createdUserId\": 12345,\n \"country\": \"US\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemCode/premiumClassification/:systemCode?country=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemCode", "premiumClassification", ":systemCode" ], "query": [ { "description": "Optional: Provide the country for which you want to retrieve the premium classification.", "key": "country", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item object" }, { "key": "itemCode", "value": "string", "description": "The ItemCode of the item for which you want to retrieve premium classification" }, { "key": "systemCode", "value": "string", "description": "The SystemCode for which you want to retrieve premium classification" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemCode/premiumClassification/:systemCode?country=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemCode", "premiumClassification", ":systemCode" ], "query": [ { "description": "Optional: Provide the country for which you want to retrieve the premium classification.", "key": "country", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item object" }, { "key": "itemCode", "value": "string", "description": "The ItemCode of the item for which you want to retrieve premium classification" }, { "key": "systemCode", "value": "string", "description": "The SystemCode for which you want to retrieve premium classification" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemCode/premiumClassification/:systemCode?country=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemCode", "premiumClassification", ":systemCode" ], "query": [ { "description": "Optional: Provide the country for which you want to retrieve the premium classification.", "key": "country", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item object" }, { "key": "itemCode", "value": "string", "description": "The ItemCode of the item for which you want to retrieve premium classification" }, { "key": "systemCode", "value": "string", "description": "The SystemCode for which you want to retrieve premium classification" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "premiumClassifications", "item": [ { "name": "Retrieve premium classification for an item based on its `companyId` and `itemCode`.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemCode/premiumClassifications?$filter=string&$skip=451&$orderBy=string&$top=451", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemCode", "premiumClassifications" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* HsCode, justification, createdDate, createdUserId" }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item object." }, { "key": "itemCode", "value": "string", "description": "The item code of the item for which you want to retrieve premium classification." } ] }, "description": "Retrieve the premium classification for an Item based on its `itemCode` and `companyId`.\r\n \r\nNOTE: If your item code contains any of these characters /, +, ?,\",' ,% or #, please use the following encoding before making a request:\r\n* Replace '/' with '\\_-ava2f-\\_' For example: 'Item/Code' becomes 'Item_-ava2f-_Code'\r\n* Replace '+' with '\\_-ava2b-\\_' For example: 'Item+Code' becomes 'Item_-ava2b-_Code'\r\n* Replace '?' with '\\_-ava3f-\\_' For example: 'Item?Code' becomes 'Item_-ava3f-_Code'\r\n* Replace '%' with '\\_-ava25-\\_' For example: 'Item%Code' becomes 'Item_-ava25-_Code'\r\n* Replace '#' with '\\_-ava23-\\_' For example: 'Item#Code' becomes 'Item_-ava23-_Code'\r\n* Replace ''' with '\\_-ava27-\\_' For example: 'Item'Code' becomes 'Item_-ava27-_Code'\r\n* Replace '\"' with '\\_-ava22-\\_' For example: 'Item\"Code' becomes 'Item_-ava22-_Code'\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemCode/premiumClassifications?$filter=string&$skip=451&$orderBy=string&$top=451", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemCode", "premiumClassifications" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* HsCode, justification, createdDate, createdUserId", "key": "$filter", "value": "string" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item object." }, { "key": "itemCode", "value": "string", "description": "The item code of the item for which you want to retrieve premium classification." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 5841,\n \"value\": [\n {\n \"itemCode\": \"ADP101\",\n \"companyId\": 12345,\n \"hsCode\": \"8528620000\",\n \"systemCode\": \"HTS\",\n \"justification\": \"This projector is directly connected with ADP machine;(ITBTI2020-0052M-135100) BTI Reference ,(N293311) ruling.\",\n \"createdDate\": \"2026-04-02T10:55:14.2030312Z\",\n \"createdUserId\": 12345,\n \"country\": \"US\"\n },\n {\n \"itemCode\": \"ADP101\",\n \"companyId\": 12345,\n \"hsCode\": \"8528620000\",\n \"systemCode\": \"HTS\",\n \"justification\": \"This projector is directly connected with ADP machine;(ITBTI2020-0052M-135100) BTI Reference ,(N293311) ruling.\",\n \"createdDate\": \"2026-04-02T10:55:14.2030312Z\",\n \"createdUserId\": 12345,\n \"country\": \"US\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemCode/premiumClassifications?$filter=string&$skip=451&$orderBy=string&$top=451", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemCode", "premiumClassifications" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* HsCode, justification, createdDate, createdUserId", "key": "$filter", "value": "string" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item object." }, { "key": "itemCode", "value": "string", "description": "The item code of the item for which you want to retrieve premium classification." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemCode/premiumClassifications?$filter=string&$skip=451&$orderBy=string&$top=451", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemCode", "premiumClassifications" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* HsCode, justification, createdDate, createdUserId", "key": "$filter", "value": "string" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item object." }, { "key": "itemCode", "value": "string", "description": "The item code of the item for which you want to retrieve premium classification." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemCode/premiumClassifications?$filter=string&$skip=451&$orderBy=string&$top=451", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemCode", "premiumClassifications" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* HsCode, justification, createdDate, createdUserId", "key": "$filter", "value": "string" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item object." }, { "key": "itemCode", "value": "string", "description": "The item code of the item for which you want to retrieve premium classification." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "restrictions", "item": [ { "name": "import", "item": [ { "name": "{countryOfImport}", "item": [ { "name": "Retrieve Restrictions for Item by CountryOfImport", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemCode/restrictions/import/:countryOfImport?$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemCode", "restrictions", "import", ":countryOfImport" ], "query": [ { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item object" }, { "key": "itemCode", "value": "string", "description": "ItemCode for the item" }, { "key": "countryOfImport", "value": "string", "description": "Country for which you want the restrictions for the Item." } ] }, "description": "Retrieve Restrictions for Item by CountryOfImport. This API will only return import restriction for the countryOfImport.\r\n \r\nNOTE: If your item code contains any of these characters /, +, ? or a space, please use the following encoding before making a request:\r\n* Replace '/' with '\\_-ava2f-\\_' For example: 'Item/Code' becomes 'Item_-ava2f-_Code'\r\n* Replace '+' with '\\_-ava2b-\\_' For example: 'Item+Code' becomes 'Item_-ava2b-_Code'\r\n* Replace '?' with '\\_-ava3f-\\_' For example: 'Item?Code' becomes 'Item_-ava3f-_Code'\r\n* Replace '%' with '\\_-ava25-\\_' For example: 'Item%Code' becomes 'Item_-ava25-_Code'\r\n* Replace '#' with '\\_-ava23-\\_' For example: 'Item#Code' becomes 'Item_-ava23-_Code'\r\n* Replace ''' with '\\_-ava27-\\_' For example: 'Item'Code' becomes 'Item_-ava27-_Code'\r\n* Replace '\"' with '\\_-ava22-\\_' For example: 'Item\"Code' becomes 'Item_-ava22-_Code'\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemCode/restrictions/import/:countryOfImport?$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemCode", "restrictions", "import", ":countryOfImport" ], "query": [ { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item object" }, { "key": "itemCode", "value": "string", "description": "ItemCode for the item" }, { "key": "countryOfImport", "value": "string", "description": "Country for which you want the restrictions for the Item." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 9780,\n \"value\": [\n {\n \"countryOfImport\": \"ES\",\n \"countryOfExport\": \"ALL\",\n \"countryOfManufacture\": \"ALL\",\n \"hsCode\": \"0101210000\",\n \"itemCode\": \"abc\",\n \"companyId\": 12345,\n \"restrictionType\": \"IMPORT\",\n \"regulation\": \"RESTRICTED\",\n \"governmentAgency\": \"European Commission\",\n \"complianceMessage\": \"Import of Goods from the list of luxury goods referred to in Article 10 of Regulation (EU) 2017/1509 are restrictred.\",\n \"createdDate\": \"2026-04-02T10:55:14.5741574Z\",\n \"createdUserId\": 12345\n },\n {\n \"countryOfImport\": \"ES\",\n \"countryOfExport\": \"ALL\",\n \"countryOfManufacture\": \"ALL\",\n \"hsCode\": \"0101210000\",\n \"itemCode\": \"abc\",\n \"companyId\": 12345,\n \"restrictionType\": \"IMPORT\",\n \"regulation\": \"RESTRICTED\",\n \"governmentAgency\": \"European Commission\",\n \"complianceMessage\": \"Import of Goods from the list of luxury goods referred to in Article 10 of Regulation (EU) 2017/1509 are restrictred.\",\n \"createdDate\": \"2026-04-02T10:55:14.5741574Z\",\n \"createdUserId\": 12345\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemCode/restrictions/import/:countryOfImport?$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemCode", "restrictions", "import", ":countryOfImport" ], "query": [ { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item object" }, { "key": "itemCode", "value": "string", "description": "ItemCode for the item" }, { "key": "countryOfImport", "value": "string", "description": "Country for which you want the restrictions for the Item." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemCode/restrictions/import/:countryOfImport?$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemCode", "restrictions", "import", ":countryOfImport" ], "query": [ { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item object" }, { "key": "itemCode", "value": "string", "description": "ItemCode for the item" }, { "key": "countryOfImport", "value": "string", "description": "Country for which you want the restrictions for the Item." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemCode/restrictions/import/:countryOfImport?$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemCode", "restrictions", "import", ":countryOfImport" ], "query": [ { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item object" }, { "key": "itemCode", "value": "string", "description": "ItemCode for the item" }, { "key": "countryOfImport", "value": "string", "description": "Country for which you want the restrictions for the Item." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] } ] } ] }, { "name": "{itemId}", "item": [ { "name": "classifications", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a single item classification.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/classifications/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "classifications", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id." }, { "key": "id", "value": "155", "description": "The item classification id." } ] }, "description": "Retrieve a single item classification.\r\n \r\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.\r\n \r\nWhen an item is used in a transaction, the applicable classification will be used to determine the appropriate tax rate.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/classifications/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "classifications", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id." }, { "key": "id", "value": "155", "description": "The item classification id." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 791,\n \"itemId\": 891267,\n \"systemId\": 1,\n \"productCode\": \"001048015838\",\n \"systemCode\": \"HTS\",\n \"country\": \"US\",\n \"isPremium\": false,\n \"classificationEvent\": \"ItemClassificationsUpdated\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/classifications/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "classifications", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id." }, { "key": "id", "value": "155", "description": "The item classification id." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/classifications/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "classifications", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id." }, { "key": "id", "value": "155", "description": "The item classification id." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/classifications/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "classifications", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id." }, { "key": "id", "value": "155", "description": "The item classification id." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Update an item classification.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/classifications/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "classifications", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id." }, { "key": "id", "value": "155", "description": "The item classification id." } ] }, "description": "Update an item classification.\r\n \r\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.\r\n \r\nWhen an item is used in a transaction, the applicable classification will be used to determine the appropriate tax rate.\r\n \r\nAn item may only have one classification per tax system.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/classifications/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "classifications", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id." }, { "key": "id", "value": "155", "description": "The item classification id." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 791,\n \"itemId\": 891267,\n \"systemId\": 1,\n \"productCode\": \"001048015838\",\n \"systemCode\": \"HTS\",\n \"country\": \"US\",\n \"isPremium\": false,\n \"classificationEvent\": \"ItemClassificationsUpdated\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/classifications/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "classifications", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id." }, { "key": "id", "value": "155", "description": "The item classification id." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/classifications/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "classifications", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id." }, { "key": "id", "value": "155", "description": "The item classification id." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/classifications/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "classifications", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id." }, { "key": "id", "value": "155", "description": "The item classification id." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete a single item classification.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/classifications/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "classifications", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id." }, { "key": "id", "value": "155", "description": "The item classification id." } ] }, "description": "Delete a single item classification.\r\n \r\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.\r\n \r\nWhen an item is used in a transaction, the applicable classification will be used to determine the appropriate tax rate.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/classifications/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "classifications", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id." }, { "key": "id", "value": "155", "description": "The item classification id." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"ObjectDeleted\",\n \"number\": 2660,\n \"message\": \"The object has been deleted successfully.\",\n \"description\": \"The object has been deleted successfully.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/ObjectDeleted\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"ObjectDeleted\",\n \"number\": 2660,\n \"message\": \"The object has been deleted successfully.\",\n \"description\": \"The object has been deleted successfully.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/ObjectDeleted\",\n \"severity\": \"Success\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/classifications/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "classifications", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id." }, { "key": "id", "value": "155", "description": "The item classification id." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/classifications/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "classifications", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id." }, { "key": "id", "value": "155", "description": "The item classification id." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/classifications/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "classifications", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id." }, { "key": "id", "value": "155", "description": "The item classification id." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Add classifications to an item.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\"\n },\n {\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/classifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "classifications" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id." } ] }, "description": "Add classifications to an item.\r\n \r\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.\r\n \r\nWhen an item is used in a transaction, the applicable classification will be used to determine the appropriate tax rate.\r\n \r\nAn item may only have one classification per tax system.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Created", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\"\n },\n {\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/classifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "classifications" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id." } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": 791,\n \"itemId\": 891267,\n \"systemId\": 1,\n \"productCode\": \"001048015838\",\n \"systemCode\": \"HTS\",\n \"country\": \"US\",\n \"isPremium\": false,\n \"classificationEvent\": \"ItemClassificationsUpdated\"\n },\n {\n \"id\": 791,\n \"itemId\": 891267,\n \"systemId\": 1,\n \"productCode\": \"001048015838\",\n \"systemCode\": \"HTS\",\n \"country\": \"US\",\n \"isPremium\": false,\n \"classificationEvent\": \"ItemClassificationsUpdated\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\"\n },\n {\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/classifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "classifications" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\"\n },\n {\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/classifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "classifications" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\"\n },\n {\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/classifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "classifications" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Retrieve classifications for an item.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/classifications?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "classifications" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* productCode, systemCode, country, IsPremium, ClassificationEvent" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id." } ] }, "description": "List classifications for an item.\r\n \r\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.\r\n \r\nWhen an item is used in a transaction, the applicable classification will be used to determine the appropriate tax rate.\r\n \r\nSearch for specific objects using the criteria in the `$filter` classification; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`, and `$orderby` classifications.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/classifications?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "classifications" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* productCode, systemCode, country, IsPremium, ClassificationEvent", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 6327,\n \"value\": [\n {\n \"id\": 791,\n \"itemId\": 891267,\n \"systemId\": 1,\n \"productCode\": \"001048015838\",\n \"systemCode\": \"HTS\",\n \"country\": \"US\",\n \"isPremium\": false,\n \"classificationEvent\": \"ItemClassificationsUpdated\"\n },\n {\n \"id\": 791,\n \"itemId\": 891267,\n \"systemId\": 1,\n \"productCode\": \"001048015838\",\n \"systemCode\": \"HTS\",\n \"country\": \"US\",\n \"isPremium\": false,\n \"classificationEvent\": \"ItemClassificationsUpdated\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/classifications?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "classifications" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* productCode, systemCode, country, IsPremium, ClassificationEvent", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/classifications?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "classifications" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* productCode, systemCode, country, IsPremium, ClassificationEvent", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/classifications?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "classifications" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* productCode, systemCode, country, IsPremium, ClassificationEvent", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Add/update item classifications.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\"\n },\n {\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/classifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "classifications" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company ID." }, { "key": "itemId", "value": "155", "description": "The item ID." } ] }, "description": "Add/update classifications to an item.\r\n \r\nA classification is the code for a product in a particular tax system. Classifications enable an item to be used in multiple tax systems that may have different tax rates for a product.\r\n \r\nWhen an item is used in a transaction, the applicable classification will be used to determine the appropriate tax rate.\r\n \r\nAn item may only have one classification per tax system per country.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Created", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\"\n },\n {\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/classifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "classifications" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company ID." }, { "key": "itemId", "value": "155", "description": "The item ID." } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": 791,\n \"itemId\": 891267,\n \"systemId\": 1,\n \"productCode\": \"001048015838\",\n \"systemCode\": \"HTS\",\n \"country\": \"US\",\n \"isPremium\": false,\n \"classificationEvent\": \"ItemClassificationsUpdated\"\n },\n {\n \"id\": 791,\n \"itemId\": 891267,\n \"systemId\": 1,\n \"productCode\": \"001048015838\",\n \"systemCode\": \"HTS\",\n \"country\": \"US\",\n \"isPremium\": false,\n \"classificationEvent\": \"ItemClassificationsUpdated\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\"\n },\n {\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/classifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "classifications" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company ID." }, { "key": "itemId", "value": "155", "description": "The item ID." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\"\n },\n {\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/classifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "classifications" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company ID." }, { "key": "itemId", "value": "155", "description": "The item ID." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\"\n },\n {\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/classifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "classifications" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company ID." }, { "key": "itemId", "value": "155", "description": "The item ID." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete all classifications for an item", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/classifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "classifications" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item." }, { "key": "itemId", "value": "155", "description": "The ID of the item you wish to delete the classifications." } ] }, "description": "Delete all the classifications for a given item.\r\n \r\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.\r\n \r\nWhen an item is used in a transaction, the applicable classification will be used to determine the appropriate tax rate.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/classifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "classifications" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item." }, { "key": "itemId", "value": "155", "description": "The ID of the item you wish to delete the classifications." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"AssociatedObjectsDeleted\",\n \"number\": 2661,\n \"message\": \"Associated objects have been deleted successfully.\",\n \"description\": \"Associated objects have been deleted successfully.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/AssociatedObjectsDeleted\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"AssociatedObjectsDeleted\",\n \"number\": 2661,\n \"message\": \"Associated objects have been deleted successfully.\",\n \"description\": \"Associated objects have been deleted successfully.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/AssociatedObjectsDeleted\",\n \"severity\": \"Success\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/classifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "classifications" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item." }, { "key": "itemId", "value": "155", "description": "The ID of the item you wish to delete the classifications." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/classifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "classifications" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item." }, { "key": "itemId", "value": "155", "description": "The ID of the item you wish to delete the classifications." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/classifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "classifications" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item." }, { "key": "itemId", "value": "155", "description": "The ID of the item you wish to delete the classifications." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "custom-parameters", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a single item custom parameter", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/custom-parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "custom-parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "itemId", "value": "155", "description": "The item id" }, { "key": "id", "value": "155", "description": "The custom parameter id" } ] }, "description": "Retrieve a single item custom parameter.\r\n \r\nCustom parameters provide extra information about an item that can be used for various business purposes.\r\nThese parameters are stored as key-value pairs where the parameter name is the key and the value is the corresponding data.\r\n \r\nCustom parameters can be used to store custom attributes, metadata, or any other supplementary information\r\nthat doesn't fit into the standard item fields.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/custom-parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "custom-parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "itemId", "value": "155", "description": "The item id" }, { "key": "id", "value": "155", "description": "The custom parameter id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/custom-parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "custom-parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "itemId", "value": "155", "description": "The item id" }, { "key": "id", "value": "155", "description": "The custom parameter id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/custom-parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "custom-parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "itemId", "value": "155", "description": "The item id" }, { "key": "id", "value": "155", "description": "The custom parameter id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/custom-parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "custom-parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "itemId", "value": "155", "description": "The item id" }, { "key": "id", "value": "155", "description": "The custom parameter id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] }, { "name": "Update an item custom parameter", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/custom-parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "custom-parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id" }, { "key": "id", "value": "155", "description": "The item custom parameter id" } ] }, "description": "Update an item custom parameter.\r\n \r\nCustom parameters provide extra information about an item that can be used for various business purposes.\r\nThese parameters are stored as key-value pairs where the parameter name is the key and the value is the corresponding data.\r\n \r\nCustom parameters can be used to store custom attributes, metadata, or any other supplementary information\r\nthat doesn't fit into the standard item fields.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/custom-parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "custom-parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id" }, { "key": "id", "value": "155", "description": "The item custom parameter id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/custom-parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "custom-parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id" }, { "key": "id", "value": "155", "description": "The item custom parameter id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/custom-parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "custom-parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id" }, { "key": "id", "value": "155", "description": "The item custom parameter id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/custom-parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "custom-parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id" }, { "key": "id", "value": "155", "description": "The item custom parameter id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] }, { "name": "Delete a single item custom parameter", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/custom-parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "custom-parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "itemId", "value": "155", "description": "The item id" }, { "key": "id", "value": "155", "description": "The custom parameter id" } ] }, "description": "Delete a single item custom parameter.\r\n \r\nCustom parameters provide extra information about an item that can be used for various business purposes.\r\nThese parameters are stored as key-value pairs where the parameter name is the key and the value is the corresponding data.\r\n \r\nCustom parameters can be used to store custom attributes, metadata, or any other supplementary information\r\nthat doesn't fit into the standard item fields.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/custom-parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "custom-parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "itemId", "value": "155", "description": "The item id" }, { "key": "id", "value": "155", "description": "The custom parameter id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"ObjectDeleted\",\n \"number\": 2660,\n \"message\": \"The object has been deleted successfully.\",\n \"description\": \"The object has been deleted successfully.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/ObjectDeleted\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"ObjectDeleted\",\n \"number\": 2660,\n \"message\": \"The object has been deleted successfully.\",\n \"description\": \"The object has been deleted successfully.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/ObjectDeleted\",\n \"severity\": \"Success\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/custom-parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "custom-parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "itemId", "value": "155", "description": "The item id" }, { "key": "id", "value": "155", "description": "The custom parameter id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/custom-parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "custom-parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "itemId", "value": "155", "description": "The item id" }, { "key": "id", "value": "155", "description": "The custom parameter id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/custom-parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "custom-parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "itemId", "value": "155", "description": "The item id" }, { "key": "id", "value": "155", "description": "The custom parameter id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "Add custom parameters to an item.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n },\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/custom-parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "custom-parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item custom parameter." }, { "key": "itemId", "value": "155", "description": "The item id." } ] }, "description": "Add custom parameters to an item.\r\n \r\nCustom parameters provide extra information about an item that can be used for various business purposes.\r\nThese parameters are stored as key-value pairs where the parameter name is the key and the value is the corresponding data.\r\n \r\nCustom parameters can be used to store custom attributes, metadata, or any other supplementary information\r\nthat doesn't fit into the standard item fields.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Created", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n },\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/custom-parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "custom-parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item custom parameter." }, { "key": "itemId", "value": "155", "description": "The item id." } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n },\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n },\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/custom-parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "custom-parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item custom parameter." }, { "key": "itemId", "value": "155", "description": "The item id." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n },\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/custom-parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "custom-parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item custom parameter." }, { "key": "itemId", "value": "155", "description": "The item id." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n },\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/custom-parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "custom-parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item custom parameter." }, { "key": "itemId", "value": "155", "description": "The item id." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] }, { "name": "Retrieve custom parameters for an item", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/custom-parameters?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "custom-parameters" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* id, name, value" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "itemId", "value": "155", "description": "The item id" } ] }, "description": "List custom parameters for an item.\r\n \r\nCustom parameters provide extra information about an item that can be used for various business purposes.\r\nThese parameters are stored as key-value pairs where the parameter name is the key and the value is the corresponding data.\r\n \r\nCustom parameters can be used to store custom attributes, metadata, or any other supplementary information\r\nthat doesn't fit into the standard item fields.\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/custom-parameters?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "custom-parameters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* id, name, value", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "itemId", "value": "155", "description": "The item id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 4558,\n \"value\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n },\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/custom-parameters?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "custom-parameters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* id, name, value", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "itemId", "value": "155", "description": "The item id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/custom-parameters?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "custom-parameters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* id, name, value", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "itemId", "value": "155", "description": "The item id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/custom-parameters?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "custom-parameters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* id, name, value", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "itemId", "value": "155", "description": "The item id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] }, { "name": "Delete all custom parameters for an item", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/custom-parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "custom-parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item." }, { "key": "itemId", "value": "155", "description": "The ID of the item you wish to delete the custom parameters." } ] }, "description": "Delete all the custom parameters for a given item.\r\n \r\nCustom parameters provide extra information about an item that can be used for various business purposes.\r\nThese parameters are stored as key-value pairs where the parameter name is the key and the value is the corresponding data.\r\n \r\nCustom parameters can be used to store custom attributes, metadata, or any other supplementary information\r\nthat doesn't fit into the standard item fields.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/custom-parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "custom-parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item." }, { "key": "itemId", "value": "155", "description": "The ID of the item you wish to delete the custom parameters." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"AssociatedObjectsDeleted\",\n \"number\": 2661,\n \"message\": \"Associated objects have been deleted successfully.\",\n \"description\": \"Associated objects have been deleted successfully.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/AssociatedObjectsDeleted\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"AssociatedObjectsDeleted\",\n \"number\": 2661,\n \"message\": \"Associated objects have been deleted successfully.\",\n \"description\": \"Associated objects have been deleted successfully.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/AssociatedObjectsDeleted\",\n \"severity\": \"Success\"\n }\n]" } ] }, { "name": "Add/update an item custom parameter", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n },\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/custom-parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "custom-parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id" } ] }, "description": "Add/update an item custom parameter.\r\n \r\nCustom parameters provide extra information about an item that can be used for various business purposes.\r\nThese parameters are stored as key-value pairs where the parameter name is the key and the value is the corresponding data.\r\n \r\nCustom parameters can be used to store custom attributes, metadata, or any other supplementary information\r\nthat doesn't fit into the standard item fields.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Created", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n },\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/custom-parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "custom-parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n },\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n },\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/custom-parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "custom-parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n },\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/custom-parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "custom-parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n },\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/custom-parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "custom-parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "hscode-classifications-status", "item": [ { "name": "$dismiss", "item": [ { "name": "Dismiss the `Status` and `Details` values of the given ItemHSCodeClassificationStatus.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "text/plain" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/hscode-classifications-status/$dismiss?country=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "hscode-classifications-status", "$dismiss" ], "query": [ { "key": "country", "value": "string", "description": "The country of the HS code classification request status record that is to be updated." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company to which this item belongs." }, { "key": "itemId", "value": "155", "description": "The ID of the item whose classification status you want to update." } ] }, "description": "Dismiss the existing `Status` and `Details` of the ItemHSCodeClassificationStatus object at this URL with an updated object.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "text/plain" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/hscode-classifications-status/$dismiss?country=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "hscode-classifications-status", "$dismiss" ], "query": [ { "description": "The country of the HS code classification request status record that is to be updated.", "key": "country", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company to which this item belongs." }, { "key": "itemId", "value": "155", "description": "The ID of the item whose classification status you want to update." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"companyId\": 1,\n \"itemId\": 1,\n \"country\": \"US\",\n \"status\": \"ClassificationRequestCreated\",\n \"details\": \"Code details\",\n \"createdAt\": \"0001-01-01T00:00:00\",\n \"createdUserId\": 1234,\n \"modifiedAt\": \"0001-01-01T00:00:00\",\n \"modifiedUserId\": 5678,\n \"completedAt\": \"0001-01-01T00:00:00\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "text/plain" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/hscode-classifications-status/$dismiss?country=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "hscode-classifications-status", "$dismiss" ], "query": [ { "description": "The country of the HS code classification request status record that is to be updated.", "key": "country", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company to which this item belongs." }, { "key": "itemId", "value": "155", "description": "The ID of the item whose classification status you want to update." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "text/plain" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/hscode-classifications-status/$dismiss?country=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "hscode-classifications-status", "$dismiss" ], "query": [ { "description": "The country of the HS code classification request status record that is to be updated.", "key": "country", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company to which this item belongs." }, { "key": "itemId", "value": "155", "description": "The ID of the item whose classification status you want to update." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "text/plain" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/hscode-classifications-status/$dismiss?country=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "hscode-classifications-status", "$dismiss" ], "query": [ { "description": "The country of the HS code classification request status record that is to be updated.", "key": "country", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company to which this item belongs." }, { "key": "itemId", "value": "155", "description": "The ID of the item whose classification status you want to update." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] } ] }, { "name": "hsdutydetails", "item": [ { "name": "$fetch-additional-hsdutydetails", "item": [ { "name": "Fetch Additional HS Duty Details for items", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"itemId\": 12345677890,\n \"companyId\": 9855676,\n \"countryOfImport\": \"IN\",\n \"countryOfExport\": \"DE\",\n \"countryOfOrigin\": \"GB\",\n \"manufacturerName\": \"ABC Manufacturing\",\n \"hscode\": \"9011900000\",\n \"isAdditionalDuty\": false\n },\n {\n \"itemId\": 12345677890,\n \"companyId\": 9855676,\n \"countryOfImport\": \"IN\",\n \"countryOfExport\": \"DE\",\n \"countryOfOrigin\": \"GB\",\n \"manufacturerName\": \"ABC Manufacturing\",\n \"hscode\": \"9011900000\",\n \"isAdditionalDuty\": false\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/hsdutydetails/$fetch-additional-hsdutydetails", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "hsdutydetails", "$fetch-additional-hsdutydetails" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company for which you want to get additional HS Duty Details." }, { "key": "itemId", "value": "155", "description": "The unique ID of the item for which you want to get additional HS Duty Details." } ] }, "description": "\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Created", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"itemId\": 12345677890,\n \"companyId\": 9855676,\n \"countryOfImport\": \"IN\",\n \"countryOfExport\": \"DE\",\n \"countryOfOrigin\": \"GB\",\n \"manufacturerName\": \"ABC Manufacturing\",\n \"hscode\": \"9011900000\",\n \"isAdditionalDuty\": false\n },\n {\n \"itemId\": 12345677890,\n \"companyId\": 9855676,\n \"countryOfImport\": \"IN\",\n \"countryOfExport\": \"DE\",\n \"countryOfOrigin\": \"GB\",\n \"manufacturerName\": \"ABC Manufacturing\",\n \"hscode\": \"9011900000\",\n \"isAdditionalDuty\": false\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/hsdutydetails/$fetch-additional-hsdutydetails", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "hsdutydetails", "$fetch-additional-hsdutydetails" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company for which you want to get additional HS Duty Details." }, { "key": "itemId", "value": "155", "description": "The unique ID of the item for which you want to get additional HS Duty Details." } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": 0,\n \"itemId\": 12345677892,\n \"companyId\": 630666,\n \"countryOfImport\": \"US\",\n \"countryOfExport\": \"CA\",\n \"countryOfOrigin\": \"CN\",\n \"manufacturerName\": \"ABC Manufacturing\",\n \"mfnRate\": \"5.5\",\n \"uom\": \"percentage\",\n \"createdDate\": \"0001-01-01T00:00:00\",\n \"createdUserId\": 0,\n \"ftaDetails\": [\n {\n \"name\": \"USMCA\",\n \"rate\": \"3.0\",\n \"uom\": \"percentage\"\n }\n ],\n \"cvdAddDetails\": [\n {\n \"type\": \"cvd\",\n \"rate\": \"3.0\",\n \"uom\": \"percentage\"\n },\n {\n \"type\": \"add\",\n \"rate\": \"8.0\",\n \"uom\": \"percentage\"\n }\n ],\n \"punitiveRateDetails\": [\n {\n \"rate\": \"6.5\",\n \"uom\": \"percentage\",\n \"isStackable\": true,\n \"isTaxOnTax\": false\n }\n ],\n \"restrictionDetails\": [\n {\n \"type\": \"Import\",\n \"regulation\": \"Prohibited\",\n \"name\": \"Prohibited Chemical\",\n \"summary\": \"Restricted due to safety\",\n \"governmentAgency\": \"EPA\",\n \"complianceTitle\": \"Environmental violation\",\n \"complianceMessage\": \"Violation of environmental law\",\n \"complianceCitation\": \"https://www.epa.gov/tsca-import-export-requirements/tsca-requirements-importing-chemicals\"\n }\n ]\n },\n {\n \"id\": 0,\n \"itemId\": 12345677892,\n \"companyId\": 630666,\n \"countryOfImport\": \"US\",\n \"countryOfExport\": \"CA\",\n \"countryOfOrigin\": \"CN\",\n \"manufacturerName\": \"ABC Manufacturing\",\n \"mfnRate\": \"5.5\",\n \"uom\": \"percentage\",\n \"createdDate\": \"0001-01-01T00:00:00\",\n \"createdUserId\": 0,\n \"ftaDetails\": [\n {\n \"name\": \"USMCA\",\n \"rate\": \"3.0\",\n \"uom\": \"percentage\"\n }\n ],\n \"cvdAddDetails\": [\n {\n \"type\": \"cvd\",\n \"rate\": \"3.0\",\n \"uom\": \"percentage\"\n },\n {\n \"type\": \"add\",\n \"rate\": \"8.0\",\n \"uom\": \"percentage\"\n }\n ],\n \"punitiveRateDetails\": [\n {\n \"rate\": \"6.5\",\n \"uom\": \"percentage\",\n \"isStackable\": true,\n \"isTaxOnTax\": false\n }\n ],\n \"restrictionDetails\": [\n {\n \"type\": \"Import\",\n \"regulation\": \"Prohibited\",\n \"name\": \"Prohibited Chemical\",\n \"summary\": \"Restricted due to safety\",\n \"governmentAgency\": \"EPA\",\n \"complianceTitle\": \"Environmental violation\",\n \"complianceMessage\": \"Violation of environmental law\",\n \"complianceCitation\": \"https://www.epa.gov/tsca-import-export-requirements/tsca-requirements-importing-chemicals\"\n }\n ]\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"itemId\": 12345677890,\n \"companyId\": 9855676,\n \"countryOfImport\": \"IN\",\n \"countryOfExport\": \"DE\",\n \"countryOfOrigin\": \"GB\",\n \"manufacturerName\": \"ABC Manufacturing\",\n \"hscode\": \"9011900000\",\n \"isAdditionalDuty\": false\n },\n {\n \"itemId\": 12345677890,\n \"companyId\": 9855676,\n \"countryOfImport\": \"IN\",\n \"countryOfExport\": \"DE\",\n \"countryOfOrigin\": \"GB\",\n \"manufacturerName\": \"ABC Manufacturing\",\n \"hscode\": \"9011900000\",\n \"isAdditionalDuty\": false\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/hsdutydetails/$fetch-additional-hsdutydetails", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "hsdutydetails", "$fetch-additional-hsdutydetails" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company for which you want to get additional HS Duty Details." }, { "key": "itemId", "value": "155", "description": "The unique ID of the item for which you want to get additional HS Duty Details." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"itemId\": 12345677890,\n \"companyId\": 9855676,\n \"countryOfImport\": \"IN\",\n \"countryOfExport\": \"DE\",\n \"countryOfOrigin\": \"GB\",\n \"manufacturerName\": \"ABC Manufacturing\",\n \"hscode\": \"9011900000\",\n \"isAdditionalDuty\": false\n },\n {\n \"itemId\": 12345677890,\n \"companyId\": 9855676,\n \"countryOfImport\": \"IN\",\n \"countryOfExport\": \"DE\",\n \"countryOfOrigin\": \"GB\",\n \"manufacturerName\": \"ABC Manufacturing\",\n \"hscode\": \"9011900000\",\n \"isAdditionalDuty\": false\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/hsdutydetails/$fetch-additional-hsdutydetails", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "hsdutydetails", "$fetch-additional-hsdutydetails" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company for which you want to get additional HS Duty Details." }, { "key": "itemId", "value": "155", "description": "The unique ID of the item for which you want to get additional HS Duty Details." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"itemId\": 12345677890,\n \"companyId\": 9855676,\n \"countryOfImport\": \"IN\",\n \"countryOfExport\": \"DE\",\n \"countryOfOrigin\": \"GB\",\n \"manufacturerName\": \"ABC Manufacturing\",\n \"hscode\": \"9011900000\",\n \"isAdditionalDuty\": false\n },\n {\n \"itemId\": 12345677890,\n \"companyId\": 9855676,\n \"countryOfImport\": \"IN\",\n \"countryOfExport\": \"DE\",\n \"countryOfOrigin\": \"GB\",\n \"manufacturerName\": \"ABC Manufacturing\",\n \"hscode\": \"9011900000\",\n \"isAdditionalDuty\": false\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/hsdutydetails/$fetch-additional-hsdutydetails", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "hsdutydetails", "$fetch-additional-hsdutydetails" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company for which you want to get additional HS Duty Details." }, { "key": "itemId", "value": "155", "description": "The unique ID of the item for which you want to get additional HS Duty Details." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] } ] }, { "name": "images", "item": [ { "name": "{imageId}", "item": [ { "name": "Update an existing image for an item.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "imageFile", "type": "file", "value": null } ] }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/images/:imageId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "images", ":imageId" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID of the company." }, { "key": "itemId", "value": "155", "description": "The unique ID of the item." }, { "key": "imageId", "value": "0077a5d4-2af0-0754-3de2-74cfd89b98e8", "description": "The unique ID of the image to update." } ] }, "description": "This endpoint allows users to update the existing image associated with a specific item by uploading a new image file.\r\n \r\nThe updated image serves as the item's visual representation and will be used for tax code recommendation purposes.\r\n \r\nRestrictions:\r\n- Supported formats: JPEG, GIF, PNG\r\n- Maximum file size: 10MB\r\n- Maximum file name length allowed: 200 characters" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "formdata", "formdata": [ { "key": "imageFile", "type": "file", "src": [] } ] }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/images/:imageId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "images", ":imageId" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID of the company." }, { "key": "itemId", "value": "155", "description": "The unique ID of the item." }, { "key": "imageId", "value": "0077a5d4-2af0-0754-3de2-74cfd89b98e8", "description": "The unique ID of the image to update." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"itemImageId\": \"3abaedf4-4b5c-4a80-9c96-4486ed9995b7\",\n \"itemImageDetailId\": 0,\n \"companyId\": 61699,\n \"itemId\": 12345,\n \"createdAt\": \"2026-04-02T10:55:03.6425351Z\",\n \"createdUserId\": 1001,\n \"modifiedAt\": \"2026-04-02T10:55:03.6425355Z\",\n \"modifiedUserId\": 1002\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "formdata", "formdata": [ { "key": "imageFile", "type": "file", "src": [] } ] }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/images/:imageId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "images", ":imageId" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID of the company." }, { "key": "itemId", "value": "155", "description": "The unique ID of the item." }, { "key": "imageId", "value": "0077a5d4-2af0-0754-3de2-74cfd89b98e8", "description": "The unique ID of the image to update." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "formdata", "formdata": [ { "key": "imageFile", "type": "file", "src": [] } ] }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/images/:imageId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "images", ":imageId" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID of the company." }, { "key": "itemId", "value": "155", "description": "The unique ID of the item." }, { "key": "imageId", "value": "0077a5d4-2af0-0754-3de2-74cfd89b98e8", "description": "The unique ID of the image to update." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Client Error", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "formdata", "formdata": [ { "key": "imageFile", "type": "file", "src": [] } ] }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/images/:imageId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "images", ":imageId" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID of the company." }, { "key": "itemId", "value": "155", "description": "The unique ID of the item." }, { "key": "imageId", "value": "0077a5d4-2af0-0754-3de2-74cfd89b98e8", "description": "The unique ID of the image to update." } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Server Error", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "formdata", "formdata": [ { "key": "imageFile", "type": "file", "src": [] } ] }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/images/:imageId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "images", ":imageId" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID of the company." }, { "key": "itemId", "value": "155", "description": "The unique ID of the item." }, { "key": "imageId", "value": "0077a5d4-2af0-0754-3de2-74cfd89b98e8", "description": "The unique ID of the image to update." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Get the image associated with an item.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/images/:imageId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "images", ":imageId" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID of the company." }, { "key": "itemId", "value": "155", "description": "The unique ID of the item." }, { "key": "imageId", "value": "0077a5d4-2af0-0754-3de2-74cfd89b98e8", "description": "The unique ID of the image to retrieve." } ] }, "description": "Get the image file for the specified image ID linked to the item.\r\n \r\nThis endpoint allows users to retrieve and display product images in user interfaces or to verify the current\r\nimage associated with a specific item.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/images/:imageId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "images", ":imageId" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID of the company." }, { "key": "itemId", "value": "155", "description": "The unique ID of the item." }, { "key": "imageId", "value": "0077a5d4-2af0-0754-3de2-74cfd89b98e8", "description": "The unique ID of the image to retrieve." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"imageUrl\": \"string\",\n \"itemImageId\": \"3abaedf4-4b5c-4a80-9c96-4486ed9995b7\",\n \"itemImageDetailId\": 0,\n \"companyId\": 61699,\n \"itemId\": 12345,\n \"createdAt\": \"0001-01-01T00:00:00\",\n \"createdUserId\": 12345,\n \"modifiedAt\": \"0001-01-01T00:00:00\",\n \"modifiedUserId\": 12345\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/images/:imageId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "images", ":imageId" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID of the company." }, { "key": "itemId", "value": "155", "description": "The unique ID of the item." }, { "key": "imageId", "value": "0077a5d4-2af0-0754-3de2-74cfd89b98e8", "description": "The unique ID of the image to retrieve." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/images/:imageId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "images", ":imageId" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID of the company." }, { "key": "itemId", "value": "155", "description": "The unique ID of the item." }, { "key": "imageId", "value": "0077a5d4-2af0-0754-3de2-74cfd89b98e8", "description": "The unique ID of the image to retrieve." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/images/:imageId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "images", ":imageId" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID of the company." }, { "key": "itemId", "value": "155", "description": "The unique ID of the item." }, { "key": "imageId", "value": "0077a5d4-2af0-0754-3de2-74cfd89b98e8", "description": "The unique ID of the image to retrieve." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] }, { "name": "Delete the image associated with an item.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/images/:imageId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "images", ":imageId" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID of the company." }, { "key": "itemId", "value": "155", "description": "The unique ID of the item." }, { "key": "imageId", "value": "0077a5d4-2af0-0754-3de2-74cfd89b98e8", "description": "The unique ID of the image to delete." } ] }, "description": "Delete the image associated with an item.\r\n \r\nPermanently deletes both the image and its association with the specified item.\r\nThis endpoint allows users to manage product visual representations by removing outdated or incorrect images,\r\nand cleaning up unused resources in the system.\r\nOnce deleted, the image association cannot be recovered. To use the image again, it must be re-uploaded and\r\nre-linked with the item.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/images/:imageId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "images", ":imageId" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID of the company." }, { "key": "itemId", "value": "155", "description": "The unique ID of the item." }, { "key": "imageId", "value": "0077a5d4-2af0-0754-3de2-74cfd89b98e8", "description": "The unique ID of the image to delete." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"AssociatedObjectsDeleted\",\n \"number\": 2661,\n \"message\": \"Associated objects have been deleted successfully.\",\n \"description\": \"Associated objects have been deleted successfully.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/AssociatedObjectsDeleted\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"AssociatedObjectsDeleted\",\n \"number\": 2661,\n \"message\": \"Associated objects have been deleted successfully.\",\n \"description\": \"Associated objects have been deleted successfully.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/AssociatedObjectsDeleted\",\n \"severity\": \"Success\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/images/:imageId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "images", ":imageId" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID of the company." }, { "key": "itemId", "value": "155", "description": "The unique ID of the item." }, { "key": "imageId", "value": "0077a5d4-2af0-0754-3de2-74cfd89b98e8", "description": "The unique ID of the image to delete." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/images/:imageId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "images", ":imageId" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID of the company." }, { "key": "itemId", "value": "155", "description": "The unique ID of the item." }, { "key": "imageId", "value": "0077a5d4-2af0-0754-3de2-74cfd89b98e8", "description": "The unique ID of the image to delete." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Server Error", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/images/:imageId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "images", ":imageId" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID of the company." }, { "key": "itemId", "value": "155", "description": "The unique ID of the item." }, { "key": "imageId", "value": "0077a5d4-2af0-0754-3de2-74cfd89b98e8", "description": "The unique ID of the image to delete." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Upload an image for an item.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "imageFile", "type": "file", "value": null } ] }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/images", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "images" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID of the company." }, { "key": "itemId", "value": "155", "description": "The unique ID of the item." } ] }, "description": "This endpoint allows users to upload an image file for a specific item.\r\n \r\nThe uploaded image serves as the item's visual representation and will be used for tax code recommendation purposes.\r\n \r\nRestrictions:\r\n- Supported formats: JPEG, GIF, PNG\r\n- Maximum file size: 10MB\r\n- Maximum file name length allowed: 200 characters" }, "response": [ { "name": "Created", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "formdata", "formdata": [ { "key": "imageFile", "type": "file", "src": [] } ] }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/images", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "images" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID of the company." }, { "key": "itemId", "value": "155", "description": "The unique ID of the item." } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"itemImageId\": \"3abaedf4-4b5c-4a80-9c96-4486ed9995b7\",\n \"itemImageDetailId\": 0,\n \"companyId\": 61699,\n \"itemId\": 12345,\n \"createdAt\": \"2026-04-02T10:55:03.6425351Z\",\n \"createdUserId\": 1001,\n \"modifiedAt\": \"2026-04-02T10:55:03.6425355Z\",\n \"modifiedUserId\": 1002\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "formdata", "formdata": [ { "key": "imageFile", "type": "file", "src": [] } ] }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/images", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "images" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID of the company." }, { "key": "itemId", "value": "155", "description": "The unique ID of the item." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Client Error", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "formdata", "formdata": [ { "key": "imageFile", "type": "file", "src": [] } ] }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/images", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "images" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID of the company." }, { "key": "itemId", "value": "155", "description": "The unique ID of the item." } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Server Error", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "formdata", "formdata": [ { "key": "imageFile", "type": "file", "src": [] } ] }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/images", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "images" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID of the company." }, { "key": "itemId", "value": "155", "description": "The unique ID of the item." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "parameters", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a single item parameter", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "itemId", "value": "155", "description": "The item id" }, { "key": "id", "value": "155", "description": "The parameter id" } ] }, "description": "Retrieve a single item parameter.\r\n \r\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\".\r\n \r\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 .\r\n \r\nA parameter specified on a transaction line will override an item parameter if they share the same parameter name.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "itemId", "value": "155", "description": "The item id" }, { "key": "id", "value": "155", "description": "The parameter id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "itemId", "value": "155", "description": "The item id" }, { "key": "id", "value": "155", "description": "The parameter id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "itemId", "value": "155", "description": "The item id" }, { "key": "id", "value": "155", "description": "The parameter id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "itemId", "value": "155", "description": "The item id" }, { "key": "id", "value": "155", "description": "The parameter id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Update an item parameter", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id" }, { "key": "id", "value": "155", "description": "The item parameter id" } ] }, "description": "Update an item parameter.\r\n \r\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\".\r\n \r\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 .\r\n \r\nA parameter specified on a transaction line will override an item parameter if they share the same parameter name.\r\n \r\nPlease provide all the countries parameter values as a valid two letter ISO-3166 country code.\r\nRefer to 'ListCountries' api to get valid country code for any country if needed.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id" }, { "key": "id", "value": "155", "description": "The item parameter id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id" }, { "key": "id", "value": "155", "description": "The item parameter id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id" }, { "key": "id", "value": "155", "description": "The item parameter id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "itemId", "value": "155", "description": "The item id" }, { "key": "id", "value": "155", "description": "The item parameter id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete a single item parameter", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "itemId", "value": "155", "description": "The item id" }, { "key": "id", "value": "155", "description": "The parameter id" } ] }, "description": "Delete a single item parameter.\r\n \r\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\".\r\n \r\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 .\r\n \r\nA parameter specified on a transaction line will override an item parameter if they share the same parameter name.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "itemId", "value": "155", "description": "The item id" }, { "key": "id", "value": "155", "description": "The parameter id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"ObjectDeleted\",\n \"number\": 2660,\n \"message\": \"The object has been deleted successfully.\",\n \"description\": \"The object has been deleted successfully.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/ObjectDeleted\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"ObjectDeleted\",\n \"number\": 2660,\n \"message\": \"The object has been deleted successfully.\",\n \"description\": \"The object has been deleted successfully.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/ObjectDeleted\",\n \"severity\": \"Success\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "itemId", "value": "155", "description": "The item id" }, { "key": "id", "value": "155", "description": "The parameter id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "itemId", "value": "155", "description": "The item id" }, { "key": "id", "value": "155", "description": "The parameter id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "itemId", "value": "155", "description": "The item id" }, { "key": "id", "value": "155", "description": "The parameter id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Add parameters to an item.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item parameter." }, { "key": "itemId", "value": "155", "description": "The item id." } ] }, "description": "Add parameters to an item.\r\n \r\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\".\r\n \r\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 .\r\n \r\nA parameter specified on a transaction line will override an item parameter if they share the same parameter name.\r\n \r\nTo see available parameters for this item, call `/api/v2/definitions/parameters?$filter=attributeType eq Product`\r\n \r\nSome 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.\r\nPlease provide all the countries parameter values as a valid two letter ISO-3166 country code.\r\nRefer to 'ListCountries' api to get valid country code for any country if needed.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Created", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item parameter." }, { "key": "itemId", "value": "155", "description": "The item id." } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item parameter." }, { "key": "itemId", "value": "155", "description": "The item id." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item parameter." }, { "key": "itemId", "value": "155", "description": "The item id." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item parameter." }, { "key": "itemId", "value": "155", "description": "The item id." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Retrieve parameters for an item", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/parameters?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "parameters" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* name, unit, isNeededForCalculation, isNeededForReturns, isNeededForClassification" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "itemId", "value": "155", "description": "The item id" } ] }, "description": "List parameters for an item.\r\n \r\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\".\r\n \r\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 .\r\n \r\nA parameter specified on a transaction line will override an item parameter if they share the same parameter name.\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/parameters?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "parameters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* name, unit, isNeededForCalculation, isNeededForReturns, isNeededForClassification", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "itemId", "value": "155", "description": "The item id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 1953,\n \"value\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/parameters?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "parameters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* name, unit, isNeededForCalculation, isNeededForReturns, isNeededForClassification", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "itemId", "value": "155", "description": "The item id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/parameters?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "parameters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* name, unit, isNeededForCalculation, isNeededForReturns, isNeededForClassification", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "itemId", "value": "155", "description": "The item id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/parameters?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "parameters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* name, unit, isNeededForCalculation, isNeededForReturns, isNeededForClassification", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "itemId", "value": "155", "description": "The item id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete all parameters for an item", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item." }, { "key": "itemId", "value": "155", "description": "The ID of the item you wish to delete the parameters." } ] }, "description": "Delete all the parameters for a given item.\r\n \r\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\".\r\n \r\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 .\r\n \r\nA parameter specified on a transaction line will override an item parameter if they share the same parameter name.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item." }, { "key": "itemId", "value": "155", "description": "The ID of the item you wish to delete the parameters." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"AssociatedObjectsDeleted\",\n \"number\": 2661,\n \"message\": \"Associated objects have been deleted successfully.\",\n \"description\": \"Associated objects have been deleted successfully.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/AssociatedObjectsDeleted\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"AssociatedObjectsDeleted\",\n \"number\": 2661,\n \"message\": \"Associated objects have been deleted successfully.\",\n \"description\": \"Associated objects have been deleted successfully.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/AssociatedObjectsDeleted\",\n \"severity\": \"Success\"\n }\n]" } ] }, { "name": "Add/update an item parameter.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this item belongs to." }, { "key": "itemId", "value": "155", "description": "The ID of the item you want to update." } ] }, "description": "Add/update an item parameter.\r\n \r\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\".\r\n \r\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 .\r\n \r\nA parameter specified on a transaction line will override an item parameter if they share the same parameter name.\r\n \r\nPlease provide all the countries parameter values as a valid two letter ISO-3166 country code.\r\nRefer to 'ListCountries' api to get valid country code for any country if needed.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Created", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this item belongs to." }, { "key": "itemId", "value": "155", "description": "The ID of the item you want to update." } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this item belongs to." }, { "key": "itemId", "value": "155", "description": "The ID of the item you want to update." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this item belongs to." }, { "key": "itemId", "value": "155", "description": "The ID of the item you want to update." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this item belongs to." }, { "key": "itemId", "value": "155", "description": "The ID of the item you want to update." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "tags", "item": [ { "name": "{itemTagDetailId}", "item": [ { "name": "Delete item tag by id", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/tags/:itemTagDetailId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "tags", ":itemTagDetailId" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that defined these items" }, { "key": "itemId", "value": "155", "description": "The ID of the item as defined by the company that owns this tag." }, { "key": "itemTagDetailId", "value": "451", "description": "The ID of the item tag detail you wish to delete." } ] }, "description": "Deletes the `Tag` object of an Item at this URL.\r\n \r\nItem tags puts multiple labels for an item. So that item can be easily grouped by these tags.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/tags/:itemTagDetailId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "tags", ":itemTagDetailId" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that defined these items" }, { "key": "itemId", "value": "155", "description": "The ID of the item as defined by the company that owns this tag." }, { "key": "itemTagDetailId", "value": "451", "description": "The ID of the item tag detail you wish to delete." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"ObjectDeleted\",\n \"number\": 2660,\n \"message\": \"The object has been deleted successfully.\",\n \"description\": \"The object has been deleted successfully.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/ObjectDeleted\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"ObjectDeleted\",\n \"number\": 2660,\n \"message\": \"The object has been deleted successfully.\",\n \"description\": \"The object has been deleted successfully.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/ObjectDeleted\",\n \"severity\": \"Success\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/tags/:itemTagDetailId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "tags", ":itemTagDetailId" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that defined these items" }, { "key": "itemId", "value": "155", "description": "The ID of the item as defined by the company that owns this tag." }, { "key": "itemTagDetailId", "value": "451", "description": "The ID of the item tag detail you wish to delete." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/tags/:itemTagDetailId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "tags", ":itemTagDetailId" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that defined these items" }, { "key": "itemId", "value": "155", "description": "The ID of the item as defined by the company that owns this tag." }, { "key": "itemTagDetailId", "value": "451", "description": "The ID of the item tag detail you wish to delete." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/tags/:itemTagDetailId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "tags", ":itemTagDetailId" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that defined these items" }, { "key": "itemId", "value": "155", "description": "The ID of the item as defined by the company that owns this tag." }, { "key": "itemTagDetailId", "value": "451", "description": "The ID of the item tag detail you wish to delete." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Retrieve tags for an item", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/tags?$filter=string&$top=451&$skip=451", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "tags" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* tagName" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that defined these items" }, { "key": "itemId", "value": "155", "description": "The ID of the item as defined by the company that owns this tag." } ] }, "description": "Get the `Tag` objects of an Item identified by this URL.\r\n \r\nItem tags puts multiple labels for an item. So that item can be easily grouped by these tags.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/tags?$filter=string&$top=451&$skip=451", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "tags" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* tagName", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that defined these items" }, { "key": "itemId", "value": "155", "description": "The ID of the item as defined by the company that owns this tag." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 8389,\n \"value\": [\n {\n \"tagName\": \"Import_Restricted\",\n \"itemId\": 151284220,\n \"companyId\": 8010687,\n \"itemTagDetailId\": 51,\n \"tagId\": 6,\n \"createdDate\": \"2026-04-02T10:55:14.677\"\n },\n {\n \"tagName\": \"Import_Restricted\",\n \"itemId\": 151284220,\n \"companyId\": 8010687,\n \"itemTagDetailId\": 51,\n \"tagId\": 6,\n \"createdDate\": \"2026-04-02T10:55:14.677\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/tags?$filter=string&$top=451&$skip=451", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "tags" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* tagName", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that defined these items" }, { "key": "itemId", "value": "155", "description": "The ID of the item as defined by the company that owns this tag." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/tags?$filter=string&$top=451&$skip=451", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "tags" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* tagName", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that defined these items" }, { "key": "itemId", "value": "155", "description": "The ID of the item as defined by the company that owns this tag." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/tags?$filter=string&$top=451&$skip=451", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "tags" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* tagName", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that defined these items" }, { "key": "itemId", "value": "155", "description": "The ID of the item as defined by the company that owns this tag." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Create tags for a item", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"tagName\": \"Import_Restricted\",\n \"itemId\": 151284220,\n \"companyId\": 8010687\n },\n {\n \"tagName\": \"Import_Restricted\",\n \"itemId\": 151284220,\n \"companyId\": 8010687\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "tags" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that defined these items" }, { "key": "itemId", "value": "155", "description": "The ID of the item as defined by the company that owns this tag." } ] }, "description": "Creates one or more new `Tag` objects attached to this Item.\r\n \r\nItem tags puts multiple labels for an item. So that item can be easily grouped by these tags.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Created", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"tagName\": \"Import_Restricted\",\n \"itemId\": 151284220,\n \"companyId\": 8010687\n },\n {\n \"tagName\": \"Import_Restricted\",\n \"itemId\": 151284220,\n \"companyId\": 8010687\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "tags" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that defined these items" }, { "key": "itemId", "value": "155", "description": "The ID of the item as defined by the company that owns this tag." } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"tagName\": \"Import_Restricted\",\n \"itemId\": 151284220,\n \"companyId\": 8010687,\n \"itemTagDetailId\": 51,\n \"tagId\": 6,\n \"createdDate\": \"2026-04-02T10:55:14.677\"\n },\n {\n \"tagName\": \"Import_Restricted\",\n \"itemId\": 151284220,\n \"companyId\": 8010687,\n \"itemTagDetailId\": 51,\n \"tagId\": 6,\n \"createdDate\": \"2026-04-02T10:55:14.677\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"tagName\": \"Import_Restricted\",\n \"itemId\": 151284220,\n \"companyId\": 8010687\n },\n {\n \"tagName\": \"Import_Restricted\",\n \"itemId\": 151284220,\n \"companyId\": 8010687\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "tags" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that defined these items" }, { "key": "itemId", "value": "155", "description": "The ID of the item as defined by the company that owns this tag." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"tagName\": \"Import_Restricted\",\n \"itemId\": 151284220,\n \"companyId\": 8010687\n },\n {\n \"tagName\": \"Import_Restricted\",\n \"itemId\": 151284220,\n \"companyId\": 8010687\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "tags" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that defined these items" }, { "key": "itemId", "value": "155", "description": "The ID of the item as defined by the company that owns this tag." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"tagName\": \"Import_Restricted\",\n \"itemId\": 151284220,\n \"companyId\": 8010687\n },\n {\n \"tagName\": \"Import_Restricted\",\n \"itemId\": 151284220,\n \"companyId\": 8010687\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "tags" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that defined these items" }, { "key": "itemId", "value": "155", "description": "The ID of the item as defined by the company that owns this tag." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete all item tags", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "tags" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that defined these items." }, { "key": "itemId", "value": "155", "description": "The ID of the item as defined by the company that owns this tag." } ] }, "description": "Deletes all `Tags` objects of an Item at this URL.\r\n \r\nItem tags puts multiple labels for an item. So that item can be easily grouped by these tags.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "tags" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that defined these items." }, { "key": "itemId", "value": "155", "description": "The ID of the item as defined by the company that owns this tag." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"AssociatedObjectsDeleted\",\n \"number\": 2661,\n \"message\": \"Associated objects have been deleted successfully.\",\n \"description\": \"Associated objects have been deleted successfully.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/AssociatedObjectsDeleted\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"AssociatedObjectsDeleted\",\n \"number\": 2661,\n \"message\": \"Associated objects have been deleted successfully.\",\n \"description\": \"Associated objects have been deleted successfully.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/AssociatedObjectsDeleted\",\n \"severity\": \"Success\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "tags" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that defined these items." }, { "key": "itemId", "value": "155", "description": "The ID of the item as defined by the company that owns this tag." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "tags" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that defined these items." }, { "key": "itemId", "value": "155", "description": "The ID of the item as defined by the company that owns this tag." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/tags", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "tags" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that defined these items." }, { "key": "itemId", "value": "155", "description": "The ID of the item as defined by the company that owns this tag." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "taxcoderecommendations", "item": [ { "name": "Get Item TaxCode Recommendations", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/taxcoderecommendations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "taxcoderecommendations" ], "variable": [ { "key": "companyId", "value": "451" }, { "key": "itemId", "value": "155" } ] }, "description": "Provides at least three tax-code recommendations for the given company ID and item ID\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/taxcoderecommendations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "taxcoderecommendations" ], "variable": [ { "key": "companyId", "value": "451" }, { "key": "itemId", "value": "155" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"taxCode\": \"PA2020100\",\n \"level\": \"H\"\n },\n {\n \"taxCode\": \"PA2020100\",\n \"level\": \"H\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/taxcoderecommendations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "taxcoderecommendations" ], "variable": [ { "key": "companyId", "value": "451" }, { "key": "itemId", "value": "155" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/taxcoderecommendations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "taxcoderecommendations" ], "variable": [ { "key": "companyId", "value": "451" }, { "key": "itemId", "value": "155" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/:itemId/taxcoderecommendations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", ":itemId", "taxcoderecommendations" ], "variable": [ { "key": "companyId", "value": "451" }, { "key": "itemId", "value": "155" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] } ] }, { "name": "$initiate-hscode-classification", "item": [ { "name": "Create an HS code classification request.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "text/plain" } ], "body": { "mode": "raw", "raw": "[\n {\n \"itemId\": 12345677890,\n \"countryOfDestinations\": [\n \"US\",\n \"CA\",\n \"BR\"\n ],\n \"isPremiumClassification\": false,\n \"isReclassification\": false,\n \"isDisputed\": false,\n \"isPriority\": false,\n \"isExport\": false,\n \"isExportControl\": false,\n \"isCompliance\": false,\n \"instructions\": \"Sample instructions.\",\n \"language\": \"en-us\"\n },\n {\n \"itemId\": 12345677890,\n \"countryOfDestinations\": [\n \"US\",\n \"CA\",\n \"BR\"\n ],\n \"isPremiumClassification\": false,\n \"isReclassification\": false,\n \"isDisputed\": false,\n \"isPriority\": false,\n \"isExport\": false,\n \"isExportControl\": false,\n \"isCompliance\": false,\n \"instructions\": \"Sample instructions.\",\n \"language\": \"en-us\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/$initiate-hscode-classification", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", "$initiate-hscode-classification" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company for which you want to create this HS code classification request." } ] }, "description": "\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Created", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "text/plain" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"itemId\": 12345677890,\n \"countryOfDestinations\": [\n \"US\",\n \"CA\",\n \"BR\"\n ],\n \"isPremiumClassification\": false,\n \"isReclassification\": false,\n \"isDisputed\": false,\n \"isPriority\": false,\n \"isExport\": false,\n \"isExportControl\": false,\n \"isCompliance\": false,\n \"instructions\": \"Sample instructions.\",\n \"language\": \"en-us\"\n },\n {\n \"itemId\": 12345677890,\n \"countryOfDestinations\": [\n \"US\",\n \"CA\",\n \"BR\"\n ],\n \"isPremiumClassification\": false,\n \"isReclassification\": false,\n \"isDisputed\": false,\n \"isPriority\": false,\n \"isExport\": false,\n \"isExportControl\": false,\n \"isCompliance\": false,\n \"instructions\": \"Sample instructions.\",\n \"language\": \"en-us\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/$initiate-hscode-classification", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", "$initiate-hscode-classification" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company for which you want to create this HS code classification request." } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"total\": 5,\n \"failed\": [\n {\n \"itemId\": 123456789,\n \"errors\": [\n {\n \"code\": \"ERR001\",\n \"message\": \"Invalid HS Code format\",\n \"target\": \"hs_code\",\n \"faultCode\": \"FORMAT_ERROR\"\n },\n {\n \"code\": \"ERR002\",\n \"message\": \"Item not found in system\",\n \"target\": \"item_id\",\n \"faultCode\": \"NOT_FOUND\"\n }\n ]\n }\n ]\n },\n {\n \"total\": 5,\n \"failed\": [\n {\n \"itemId\": 123456789,\n \"errors\": [\n {\n \"code\": \"ERR001\",\n \"message\": \"Invalid HS Code format\",\n \"target\": \"hs_code\",\n \"faultCode\": \"FORMAT_ERROR\"\n },\n {\n \"code\": \"ERR002\",\n \"message\": \"Item not found in system\",\n \"target\": \"item_id\",\n \"faultCode\": \"NOT_FOUND\"\n }\n ]\n }\n ]\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "text/plain" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"itemId\": 12345677890,\n \"countryOfDestinations\": [\n \"US\",\n \"CA\",\n \"BR\"\n ],\n \"isPremiumClassification\": false,\n \"isReclassification\": false,\n \"isDisputed\": false,\n \"isPriority\": false,\n \"isExport\": false,\n \"isExportControl\": false,\n \"isCompliance\": false,\n \"instructions\": \"Sample instructions.\",\n \"language\": \"en-us\"\n },\n {\n \"itemId\": 12345677890,\n \"countryOfDestinations\": [\n \"US\",\n \"CA\",\n \"BR\"\n ],\n \"isPremiumClassification\": false,\n \"isReclassification\": false,\n \"isDisputed\": false,\n \"isPriority\": false,\n \"isExport\": false,\n \"isExportControl\": false,\n \"isCompliance\": false,\n \"instructions\": \"Sample instructions.\",\n \"language\": \"en-us\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/$initiate-hscode-classification", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", "$initiate-hscode-classification" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company for which you want to create this HS code classification request." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "text/plain" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"itemId\": 12345677890,\n \"countryOfDestinations\": [\n \"US\",\n \"CA\",\n \"BR\"\n ],\n \"isPremiumClassification\": false,\n \"isReclassification\": false,\n \"isDisputed\": false,\n \"isPriority\": false,\n \"isExport\": false,\n \"isExportControl\": false,\n \"isCompliance\": false,\n \"instructions\": \"Sample instructions.\",\n \"language\": \"en-us\"\n },\n {\n \"itemId\": 12345677890,\n \"countryOfDestinations\": [\n \"US\",\n \"CA\",\n \"BR\"\n ],\n \"isPremiumClassification\": false,\n \"isReclassification\": false,\n \"isDisputed\": false,\n \"isPriority\": false,\n \"isExport\": false,\n \"isExportControl\": false,\n \"isCompliance\": false,\n \"instructions\": \"Sample instructions.\",\n \"language\": \"en-us\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/$initiate-hscode-classification", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", "$initiate-hscode-classification" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company for which you want to create this HS code classification request." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "text/plain" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"itemId\": 12345677890,\n \"countryOfDestinations\": [\n \"US\",\n \"CA\",\n \"BR\"\n ],\n \"isPremiumClassification\": false,\n \"isReclassification\": false,\n \"isDisputed\": false,\n \"isPriority\": false,\n \"isExport\": false,\n \"isExportControl\": false,\n \"isCompliance\": false,\n \"instructions\": \"Sample instructions.\",\n \"language\": \"en-us\"\n },\n {\n \"itemId\": 12345677890,\n \"countryOfDestinations\": [\n \"US\",\n \"CA\",\n \"BR\"\n ],\n \"isPremiumClassification\": false,\n \"isReclassification\": false,\n \"isDisputed\": false,\n \"isPriority\": false,\n \"isExport\": false,\n \"isExportControl\": false,\n \"isCompliance\": false,\n \"instructions\": \"Sample instructions.\",\n \"language\": \"en-us\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/$initiate-hscode-classification", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", "$initiate-hscode-classification" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company for which you want to create this HS code classification request." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "bytags", "item": [ { "name": "{tag}", "item": [ { "name": "Retrieve all items associated with given tag", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/bytags/:tag?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", "bytags", ":tag" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, customParameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations, taxCodeDetails, hsCodeClassificationStatus, image" }, { "key": "$include", "value": "string", "description": "A comma separated list of additional data to retrieve." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that defined these items." }, { "key": "tag", "value": "string", "description": "The master tag to be associated with item." } ] }, "description": "Get multiple item objects associated with given tag.\r\n \r\nItems are a way of separating your tax calculation process from your tax configuration details. If you choose, you\r\ncan provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions,\r\nand other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters\r\nfrom the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance\r\nteam can manage your item catalog and adjust the tax behavior of items without having to modify your software.\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\n \r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/bytags/:tag?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", "bytags", ":tag" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, customParameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations, taxCodeDetails, hsCodeClassificationStatus, image", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that defined these items." }, { "key": "tag", "value": "string", "description": "The master tag to be associated with item." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 16,\n \"value\": [\n {\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CERMUG\",\n \"taxCode\": \"P0000000\",\n \"description\": \"Ceramic Mug\",\n \"itemGroup\": \"Mugs\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"source\": \"MTCC\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ],\n \"properties\": {\n \"color\": \"white\"\n }\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CERMUG\",\n \"taxCode\": \"P0000000\",\n \"description\": \"Ceramic Mug\",\n \"itemGroup\": \"Mugs\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"source\": \"MTCC\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ],\n \"properties\": {\n \"color\": \"white\"\n }\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/bytags/:tag?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", "bytags", ":tag" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, customParameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations, taxCodeDetails, hsCodeClassificationStatus, image", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that defined these items." }, { "key": "tag", "value": "string", "description": "The master tag to be associated with item." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/bytags/:tag?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", "bytags", ":tag" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, customParameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations, taxCodeDetails, hsCodeClassificationStatus, image", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that defined these items." }, { "key": "tag", "value": "string", "description": "The master tag to be associated with item." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "hscode-classification", "item": [ { "name": "$get-sla", "item": [ { "name": "Retrieve the HS code classification SLA details for a company.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/hscode-classification/$get-sla", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", "hscode-classification", "$get-sla" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company for which to retrieve the SLA details." } ] }, "description": "This endpoint returns the SLA details for HS code classification for the\r\nspecified company. The response includes information about processing times,\r\nservice commitments, and other relevant SLA terms.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/hscode-classification/$get-sla", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", "hscode-classification", "$get-sla" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company for which to retrieve the SLA details." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"slaInHours\": 72\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/hscode-classification/$get-sla", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", "hscode-classification", "$get-sla" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company for which to retrieve the SLA details." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/hscode-classification/$get-sla", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", "hscode-classification", "$get-sla" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company for which to retrieve the SLA details." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Client Error", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/hscode-classification/$get-sla", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", "hscode-classification", "$get-sla" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company for which to retrieve the SLA details." } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/hscode-classification/$get-sla", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", "hscode-classification", "$get-sla" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company for which to retrieve the SLA details." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "internal", "item": [ { "name": "bySystemCode", "item": [ { "name": "{systemCode}", "item": [ { "name": "Retrieve items for this company based on System Code and filter criteria(optional) provided", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"filter\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/internal/bySystemCode/:systemCode?$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", "internal", "bySystemCode", ":systemCode" ], "query": [ { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that defined these items" }, { "key": "systemCode", "value": "string", "description": "System code on the basis of which you want to filter Items" } ] }, "description": "Retrieve items based on System Code\r\n \r\nItems are a way of separating your tax calculation process from your tax configuration details. If you choose, you\r\ncan provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions,\r\nand other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters\r\nfrom the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance\r\nteam can manage your item catalog and adjust the tax behavior of items without having to modify your software.\r\n \r\nSearch for specific objects by passing the `$filter` criteria in the body; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\n \r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"filter\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/internal/bySystemCode/:systemCode?$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", "internal", "bySystemCode", ":systemCode" ], "query": [ { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that defined these items" }, { "key": "systemCode", "value": "string", "description": "System code on the basis of which you want to filter Items" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 16,\n \"value\": [\n {\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CERMUG\",\n \"taxCode\": \"P0000000\",\n \"description\": \"Ceramic Mug\",\n \"itemGroup\": \"Mugs\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"source\": \"MTCC\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ],\n \"properties\": {\n \"color\": \"white\"\n }\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CERMUG\",\n \"taxCode\": \"P0000000\",\n \"description\": \"Ceramic Mug\",\n \"itemGroup\": \"Mugs\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"source\": \"MTCC\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ],\n \"properties\": {\n \"color\": \"white\"\n }\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"filter\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/internal/bySystemCode/:systemCode?$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", "internal", "bySystemCode", ":systemCode" ], "query": [ { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that defined these items" }, { "key": "systemCode", "value": "string", "description": "System code on the basis of which you want to filter Items" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"filter\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/internal/bySystemCode/:systemCode?$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", "internal", "bySystemCode", ":systemCode" ], "query": [ { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that defined these items" }, { "key": "systemCode", "value": "string", "description": "System code on the basis of which you want to filter Items" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"filter\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/internal/bySystemCode/:systemCode?$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", "internal", "bySystemCode", ":systemCode" ], "query": [ { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that defined these items" }, { "key": "systemCode", "value": "string", "description": "System code on the basis of which you want to filter Items" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] } ] }, { "name": "nlq", "item": [ { "name": "$parse", "item": [ { "name": "Parse natural language query into structured filters", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"query\": \"give me items created in last 1 week which are having status complete\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/nlq/$parse", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", "nlq", "$parse" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these items" } ] }, "description": "Parse natural language queries into structured API filters. This endpoint forwards the query to NLQ (Natural Language Query)\r\nservice for interpretation and returns only the intent and structured filters.\r\n \r\nExample queries:\r\n- \"give me items created in last 1 week which are having status complete\"\r\n- \"show me all items with item code CERMUG\"\r\n- \"find items containing 'mug' in description\"\r\n \r\nResponse format:\r\n{\r\n \"intent\": \"GET\",\r\n \"filters\": {\r\n \"createdDate\": { \"value\": \"from: 2025-09-12 to: 2025-09-19\" },\r\n \"itemStatus\": { \"value\": [\"Complete\"] }\r\n }\r\n}\r\n \r\nRaw NLQ responses are logged for debugging purposes.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"query\": \"give me items created in last 1 week which are having status complete\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/nlq/$parse", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", "nlq", "$parse" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these items" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"intent\": \"GET\",\n \"filters\": {\n \"createdDate\": {\n \"value\": \"from: 2025-09-12 to: 2025-09-19\"\n },\n \"itemStatus\": {\n \"value\": [\n \"Complete\"\n ]\n }\n }\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"query\": \"give me items created in last 1 week which are having status complete\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/nlq/$parse", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", "nlq", "$parse" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these items" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": {\n \"code\": \"DuplicateCompanyCode\",\n \"message\": \"The company code 'DEFAULT' has already been defined. Please select a different company code.\",\n \"target\": \"HttpRequest\",\n \"details\": [\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n }\n ]\n }\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"query\": \"give me items created in last 1 week which are having status complete\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/nlq/$parse", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", "nlq", "$parse" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these items" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"query\": \"give me items created in last 1 week which are having status complete\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/nlq/$parse", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", "nlq", "$parse" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these items" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Server Error", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"query\": \"give me items created in last 1 week which are having status complete\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/nlq/$parse", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", "nlq", "$parse" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these items" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "sync", "item": [ { "name": "Sync items from a product catalog", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"itemCode\": \"CHIP1041\",\n \"description\": \"Potato Chips\",\n \"itemGroup\": \"Packaged Food\",\n \"taxCode\": \"PF051578\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/sync", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", "sync" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item." } ] }, "description": "Syncs a list of items with AvaTax without waiting for them to be created. It is ideal for syncing large product catalogs\r\nwith AvaTax.\r\n \r\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.\r\n \r\nThis API is currently limited to 500 items per call (the limit is subject to change).\r\n \r\nItems are a way of separating your tax calculation process from your tax configuration details. If you choose, you\r\ncan provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions,\r\nand other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters\r\nfrom the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance\r\nteam can manage your item catalog and adjust the tax behavior of items without having to modify your software.\r\n \r\nPlease provide all the countries of destination values as a valid two letter ISO-3166 country code.\r\nRefer to 'ListCountries' api to get valid country code for any country if needed.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Accepted", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"itemCode\": \"CHIP1041\",\n \"description\": \"Potato Chips\",\n \"itemGroup\": \"Packaged Food\",\n \"taxCode\": \"PF051578\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/sync", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", "sync" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item." } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"Accepted\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"itemCode\": \"CHIP1041\",\n \"description\": \"Potato Chips\",\n \"itemGroup\": \"Packaged Food\",\n \"taxCode\": \"PF051578\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/sync", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", "sync" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"itemCode\": \"CHIP1041\",\n \"description\": \"Potato Chips\",\n \"itemGroup\": \"Packaged Food\",\n \"taxCode\": \"PF051578\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/sync", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", "sync" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "upload", "item": [ { "name": "Bulk upload items from a product catalog", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CHIP1041\",\n \"taxCode\": \"PF051578\",\n \"description\": \"Potato Chips\",\n \"itemGroup\": \"Packaged Food\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", "upload" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this items." } ] }, "description": "Create/Update one or more item objects attached to this company.\r\n \r\nRecommended number of items to create/update in a single call is upto 100.\r\n \r\nCurrently, the maximum number of items that can be created/updated in a single call is 500 (This limit is subject to change).\r\n \r\nItems are a way of separating your tax calculation process from your tax configuration details. If you choose, you\r\ncan provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions,\r\nand other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters\r\nfrom the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance\r\nteam can manage your item catalog and adjust the tax behavior of items without having to modify your software.\r\n \r\nThe tax code takes precedence over the tax code id if both are provided.\r\n \r\nPlease provide all the countries of destination values as a valid two letter ISO-3166 country code.\r\nRefer to 'ListCountries' api to get valid country code for any country if needed.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CHIP1041\",\n \"taxCode\": \"PF051578\",\n \"description\": \"Potato Chips\",\n \"itemGroup\": \"Packaged Food\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", "upload" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this items." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"total\": 35,\n \"failed\": [\n {\n \"rowIndex\": 5,\n \"itemCode\": \"Item 4\",\n \"errors\": [\n \"Please provide a value for field description.\"\n ]\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CHIP1041\",\n \"taxCode\": \"PF051578\",\n \"description\": \"Potato Chips\",\n \"itemGroup\": \"Packaged Food\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", "upload" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this items." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CHIP1041\",\n \"taxCode\": \"PF051578\",\n \"description\": \"Potato Chips\",\n \"itemGroup\": \"Packaged Food\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", "upload" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this items." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CHIP1041\",\n \"taxCode\": \"PF051578\",\n \"description\": \"Potato Chips\",\n \"itemGroup\": \"Packaged Food\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items/upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items", "upload" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this items." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Retrieve items for this company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string&tagName=string&itemStatus=string&taxCodeRecommendationStatus=string&hsCodeClassificationStatus=string&hsCodeExistsInCountries=string&hsCodeDoesNotExistsInCountries=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, customParameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations, taxCodeDetails, hsCodeClassificationStatus, image" }, { "key": "$include", "value": "string", "description": "A comma separated list of additional data to retrieve." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." }, { "key": "tagName", "value": "string", "description": "Tag Name on the basis of which you want to filter Items" }, { "key": "itemStatus", "value": "string", "description": "A comma separated list of item status on the basis of which you want to filter Items" }, { "key": "taxCodeRecommendationStatus", "value": "string", "description": "Tax code recommendation status on the basis of which you want to filter Items" }, { "key": "hsCodeClassificationStatus", "value": "string", "description": "HS code classification status on the basis of which you want to filter items." }, { "key": "hsCodeExistsInCountries", "value": "string", "description": "A comma-separated list of countries for which the HS code is assigned and based on which you want to filter the items." }, { "key": "hsCodeDoesNotExistsInCountries", "value": "string", "description": "A comma-separated list of countries for which the HS code is not assigned and based on which you want to filter the items." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that defined these items" } ] }, "description": "List all items defined for the current company.\r\n \r\nItems are a way of separating your tax calculation process from your tax configuration details. If you choose, you\r\ncan provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions,\r\nand other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters\r\nfrom the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance\r\nteam can manage your item catalog and adjust the tax behavior of items without having to modify your software.\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\n \r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\r\n \r\nYou may specify Tag Name in the `tagName` query parameter if you want to filter items on the basis of tagName\r\n \r\nYou may specify comma seperated item status in the `itemStatus` query parameter if you want to filter items on the basis of item status\r\n \r\nYou may specify Tax Code recommendation status in the `taxCodeRecommendationStatus` query parameter if you want to filter items on the basis of tax code recommendation status\r\n \r\nYou can specify an HS code classification status in the `hsCodeClassificationStatus` query parameter if you want to filter items based on an HS code classification status.\r\n \r\nYou can specify a comma-separated list of countries in the `hsCodeExistsInCountries` query parameter if you want to filter items based on whether an HS code exists for the provided countries.\r\n \r\nYou can specify a comma-separated list of countries in the `hsCodeDoesNotExistsInCountries` query parameter if you want to filter items on the basis of whether an HS code does not exist for the provided countries.\r\n \r\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:\r\n \r\n* Parameters\r\n* Classifications\r\n* Tags\r\n* Properties\r\n* TaxCodeRecommendationStatus\r\n* HsCodeClassificationStatus\r\n* TaxCodeDetails\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string&tagName=string&itemStatus=string&taxCodeRecommendationStatus=string&hsCodeClassificationStatus=string&hsCodeExistsInCountries=string&hsCodeDoesNotExistsInCountries=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, customParameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations, taxCodeDetails, hsCodeClassificationStatus, image", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" }, { "description": "Tag Name on the basis of which you want to filter Items", "key": "tagName", "value": "string" }, { "description": "A comma separated list of item status on the basis of which you want to filter Items", "key": "itemStatus", "value": "string" }, { "description": "Tax code recommendation status on the basis of which you want to filter Items", "key": "taxCodeRecommendationStatus", "value": "string" }, { "description": "HS code classification status on the basis of which you want to filter items.", "key": "hsCodeClassificationStatus", "value": "string" }, { "description": "A comma-separated list of countries for which the HS code is assigned and based on which you want to filter the items.", "key": "hsCodeExistsInCountries", "value": "string" }, { "description": "A comma-separated list of countries for which the HS code is not assigned and based on which you want to filter the items.", "key": "hsCodeDoesNotExistsInCountries", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that defined these items" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 16,\n \"value\": [\n {\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CERMUG\",\n \"taxCode\": \"P0000000\",\n \"description\": \"Ceramic Mug\",\n \"itemGroup\": \"Mugs\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"source\": \"MTCC\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ],\n \"properties\": {\n \"color\": \"white\"\n }\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CERMUG\",\n \"taxCode\": \"P0000000\",\n \"description\": \"Ceramic Mug\",\n \"itemGroup\": \"Mugs\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"source\": \"MTCC\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ],\n \"properties\": {\n \"color\": \"white\"\n }\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string&tagName=string&itemStatus=string&taxCodeRecommendationStatus=string&hsCodeClassificationStatus=string&hsCodeExistsInCountries=string&hsCodeDoesNotExistsInCountries=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, customParameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations, taxCodeDetails, hsCodeClassificationStatus, image", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" }, { "description": "Tag Name on the basis of which you want to filter Items", "key": "tagName", "value": "string" }, { "description": "A comma separated list of item status on the basis of which you want to filter Items", "key": "itemStatus", "value": "string" }, { "description": "Tax code recommendation status on the basis of which you want to filter Items", "key": "taxCodeRecommendationStatus", "value": "string" }, { "description": "HS code classification status on the basis of which you want to filter items.", "key": "hsCodeClassificationStatus", "value": "string" }, { "description": "A comma-separated list of countries for which the HS code is assigned and based on which you want to filter the items.", "key": "hsCodeExistsInCountries", "value": "string" }, { "description": "A comma-separated list of countries for which the HS code is not assigned and based on which you want to filter the items.", "key": "hsCodeDoesNotExistsInCountries", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that defined these items" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string&tagName=string&itemStatus=string&taxCodeRecommendationStatus=string&hsCodeClassificationStatus=string&hsCodeExistsInCountries=string&hsCodeDoesNotExistsInCountries=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, customParameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations, taxCodeDetails, hsCodeClassificationStatus, image", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" }, { "description": "Tag Name on the basis of which you want to filter Items", "key": "tagName", "value": "string" }, { "description": "A comma separated list of item status on the basis of which you want to filter Items", "key": "itemStatus", "value": "string" }, { "description": "Tax code recommendation status on the basis of which you want to filter Items", "key": "taxCodeRecommendationStatus", "value": "string" }, { "description": "HS code classification status on the basis of which you want to filter items.", "key": "hsCodeClassificationStatus", "value": "string" }, { "description": "A comma-separated list of countries for which the HS code is assigned and based on which you want to filter the items.", "key": "hsCodeExistsInCountries", "value": "string" }, { "description": "A comma-separated list of countries for which the HS code is not assigned and based on which you want to filter the items.", "key": "hsCodeDoesNotExistsInCountries", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that defined these items" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string&tagName=string&itemStatus=string&taxCodeRecommendationStatus=string&hsCodeClassificationStatus=string&hsCodeExistsInCountries=string&hsCodeDoesNotExistsInCountries=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, customParameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations, taxCodeDetails, hsCodeClassificationStatus, image", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" }, { "description": "Tag Name on the basis of which you want to filter Items", "key": "tagName", "value": "string" }, { "description": "A comma separated list of item status on the basis of which you want to filter Items", "key": "itemStatus", "value": "string" }, { "description": "Tax code recommendation status on the basis of which you want to filter Items", "key": "taxCodeRecommendationStatus", "value": "string" }, { "description": "HS code classification status on the basis of which you want to filter items.", "key": "hsCodeClassificationStatus", "value": "string" }, { "description": "A comma-separated list of countries for which the HS code is assigned and based on which you want to filter the items.", "key": "hsCodeExistsInCountries", "value": "string" }, { "description": "A comma-separated list of countries for which the HS code is not assigned and based on which you want to filter the items.", "key": "hsCodeDoesNotExistsInCountries", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that defined these items" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Create a new item", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CERMUG\",\n \"taxCode\": \"P0000000\",\n \"description\": \"Ceramic Mug\",\n \"itemGroup\": \"Mugs\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"source\": \"MTCC\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ],\n \"properties\": {\n \"color\": \"white\"\n }\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CERMUG\",\n \"taxCode\": \"P0000000\",\n \"description\": \"Ceramic Mug\",\n \"itemGroup\": \"Mugs\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"source\": \"MTCC\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ],\n \"properties\": {\n \"color\": \"white\"\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items?processRecommendationsSynchronously=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items" ], "query": [ { "key": "processRecommendationsSynchronously", "value": "false", "description": "If true then Indix api will be called synchronously to get tax code recommendations." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item." } ] }, "description": "Creates one or more new item objects attached to this company.\r\n \r\nRecommended number of items to create in a single call is upto 50.\r\n \r\nCurrently, the maximum number of items that can be created in a single call is 500 (This limit is subject to change).\r\n \r\nItems are a way of separating your tax calculation process from your tax configuration details. If you choose, you\r\ncan provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions,\r\nand other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters\r\nfrom the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance\r\nteam can manage your item catalog and adjust the tax behavior of items without having to modify your software.\r\n \r\nPlease provide all the countries of destination values as a valid two letter ISO-3166 country code.\r\nRefer to 'ListCountries' api to get valid country code for any country if needed.\r\n \r\nThe tax code takes precedence over the tax code id if both are provided.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Created", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CERMUG\",\n \"taxCode\": \"P0000000\",\n \"description\": \"Ceramic Mug\",\n \"itemGroup\": \"Mugs\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"source\": \"MTCC\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ],\n \"properties\": {\n \"color\": \"white\"\n }\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CERMUG\",\n \"taxCode\": \"P0000000\",\n \"description\": \"Ceramic Mug\",\n \"itemGroup\": \"Mugs\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"source\": \"MTCC\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ],\n \"properties\": {\n \"color\": \"white\"\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items?processRecommendationsSynchronously=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items" ], "query": [ { "description": "If true then Indix api will be called synchronously to get tax code recommendations.", "key": "processRecommendationsSynchronously", "value": "false" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item." } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CERMUG\",\n \"taxCode\": \"P0000000\",\n \"description\": \"Ceramic Mug\",\n \"itemGroup\": \"Mugs\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"source\": \"MTCC\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ],\n \"properties\": {\n \"color\": \"white\"\n }\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CERMUG\",\n \"taxCode\": \"P0000000\",\n \"description\": \"Ceramic Mug\",\n \"itemGroup\": \"Mugs\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"source\": \"MTCC\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ],\n \"properties\": {\n \"color\": \"white\"\n }\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CERMUG\",\n \"taxCode\": \"P0000000\",\n \"description\": \"Ceramic Mug\",\n \"itemGroup\": \"Mugs\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"source\": \"MTCC\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ],\n \"properties\": {\n \"color\": \"white\"\n }\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CERMUG\",\n \"taxCode\": \"P0000000\",\n \"description\": \"Ceramic Mug\",\n \"itemGroup\": \"Mugs\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"source\": \"MTCC\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ],\n \"properties\": {\n \"color\": \"white\"\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items?processRecommendationsSynchronously=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items" ], "query": [ { "description": "If true then Indix api will be called synchronously to get tax code recommendations.", "key": "processRecommendationsSynchronously", "value": "false" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CERMUG\",\n \"taxCode\": \"P0000000\",\n \"description\": \"Ceramic Mug\",\n \"itemGroup\": \"Mugs\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"source\": \"MTCC\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ],\n \"properties\": {\n \"color\": \"white\"\n }\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CERMUG\",\n \"taxCode\": \"P0000000\",\n \"description\": \"Ceramic Mug\",\n \"itemGroup\": \"Mugs\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"source\": \"MTCC\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ],\n \"properties\": {\n \"color\": \"white\"\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items?processRecommendationsSynchronously=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items" ], "query": [ { "description": "If true then Indix api will be called synchronously to get tax code recommendations.", "key": "processRecommendationsSynchronously", "value": "false" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CERMUG\",\n \"taxCode\": \"P0000000\",\n \"description\": \"Ceramic Mug\",\n \"itemGroup\": \"Mugs\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"source\": \"MTCC\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ],\n \"properties\": {\n \"color\": \"white\"\n }\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CERMUG\",\n \"taxCode\": \"P0000000\",\n \"description\": \"Ceramic Mug\",\n \"itemGroup\": \"Mugs\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"source\": \"MTCC\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ],\n \"properties\": {\n \"color\": \"white\"\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/items?processRecommendationsSynchronously=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "items" ], "query": [ { "description": "If true then Indix api will be called synchronously to get tax code recommendations.", "key": "processRecommendationsSynchronously", "value": "false" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this item." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "locations", "item": [ { "name": "{id}", "item": [ { "name": "validate", "item": [ { "name": "Validate the location against local requirements", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:id/validate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":id", "validate" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this location" }, { "key": "id", "value": "451", "description": "The primary key of this location" } ] }, "description": "Returns validation information for this location.\r\nThis API call is intended to compare this location against the currently known taxing authority rules and regulations,\r\nand provide information about what additional work is required to completely setup this location.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:id/validate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":id", "validate" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this location" }, { "key": "id", "value": "451", "description": "The primary key of this location" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"settingsValidated\": true,\n \"requiredSettings\": [\n {\n \"id\": 1,\n \"question\": \"State Assigned Code\",\n \"description\": \"\",\n \"jurisdictionType\": \"Country\",\n \"required\": false,\n \"unique\": false\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:id/validate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":id", "validate" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this location" }, { "key": "id", "value": "451", "description": "The primary key of this location" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:id/validate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":id", "validate" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this location" }, { "key": "id", "value": "451", "description": "The primary key of this location" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:id/validate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":id", "validate" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this location" }, { "key": "id", "value": "451", "description": "The primary key of this location" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "pointofsaledata", "item": [ { "name": "Build a tax content file for a single location", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:id/pointofsaledata?date=1998-02-12T20:23:10.405Z&format=Json&partnerId=AX7&includeJurisCodes=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":id", "pointofsaledata" ], "query": [ { "key": "date", "value": "1998-02-12T20:23:10.405Z", "description": "The date for which point-of-sale data would be calculated (today by default)" }, { "key": "format", "value": "Json", "description": "The format of the file (JSON by default)" }, { "key": "partnerId", "value": "AX7", "description": "If specified, requests a custom partner-formatted version of the file." }, { "key": "includeJurisCodes", "value": "true", "description": "When true, the file will include jurisdiction codes in the result." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company that owns this location." }, { "key": "id", "value": "451", "description": "The ID number of the location to retrieve point-of-sale data." } ] }, "description": "Builds a tax content file containing information useful for a retail point-of-sale solution.\r\n \r\nSince tax rates may change based on decisions made by a variety of tax authorities, we recommend\r\nthat users of this tax content API download new data every day. Many tax authorities may finalize\r\ndecisions on tax changes at unexpected times and may make changes in response to legal issues or\r\ngovernmental priorities. Any tax content downloaded for future time periods is subject to change\r\nif tax rates or tax laws change.\r\n \r\nA TaxContent file contains a matrix of the taxes that would be charged when you sell any of your\r\nItems at any of your Locations. To create items, use `CreateItems()`. To create locations, use\r\n`CreateLocations()`. The file is built by looking up the tax profile for your location and your\r\nitem and calculating taxes for each in turn. To include a custom `TaxCode` in this tax content\r\nfile, first create the custom tax code using `CreateTaxCodes()` to create the custom tax code,\r\nthen use `CreateItems()` to create an item that uses the custom tax code.\r\n \r\nThis data file can be customized for specific partner devices and usage conditions.\r\n \r\nThe result of this API is the file you requested in the format you requested using the `responseType` field.\r\n \r\nThis API builds the file on demand, and is limited to files with no more than 7500 scenarios. To build a tax content\r\nfile for a multiple locations in a single file, please use `BuildTaxContentFile`.\r\n \r\nNOTE: This API does not work for sales tax holiday scenarios.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro.\n" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:id/pointofsaledata?date=1998-02-12T20:23:10.405Z&format=Json&partnerId=AX7&includeJurisCodes=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":id", "pointofsaledata" ], "query": [ { "description": "The date for which point-of-sale data would be calculated (today by default)", "key": "date", "value": "1998-02-12T20:23:10.405Z" }, { "description": "The format of the file (JSON by default)", "key": "format", "value": "Json" }, { "description": "If specified, requests a custom partner-formatted version of the file.", "key": "partnerId", "value": "AX7" }, { "description": "When true, the file will include jurisdiction codes in the result.", "key": "includeJurisCodes", "value": "true" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company that owns this location." }, { "key": "id", "value": "451", "description": "The ID number of the location to retrieve point-of-sale data." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "string" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:id/pointofsaledata?date=1998-02-12T20:23:10.405Z&format=Json&partnerId=AX7&includeJurisCodes=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":id", "pointofsaledata" ], "query": [ { "description": "The date for which point-of-sale data would be calculated (today by default)", "key": "date", "value": "1998-02-12T20:23:10.405Z" }, { "description": "The format of the file (JSON by default)", "key": "format", "value": "Json" }, { "description": "If specified, requests a custom partner-formatted version of the file.", "key": "partnerId", "value": "AX7" }, { "description": "When true, the file will include jurisdiction codes in the result.", "key": "includeJurisCodes", "value": "true" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company that owns this location." }, { "key": "id", "value": "451", "description": "The ID number of the location to retrieve point-of-sale data." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:id/pointofsaledata?date=1998-02-12T20:23:10.405Z&format=Json&partnerId=AX7&includeJurisCodes=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":id", "pointofsaledata" ], "query": [ { "description": "The date for which point-of-sale data would be calculated (today by default)", "key": "date", "value": "1998-02-12T20:23:10.405Z" }, { "description": "The format of the file (JSON by default)", "key": "format", "value": "Json" }, { "description": "If specified, requests a custom partner-formatted version of the file.", "key": "partnerId", "value": "AX7" }, { "description": "When true, the file will include jurisdiction codes in the result.", "key": "includeJurisCodes", "value": "true" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company that owns this location." }, { "key": "id", "value": "451", "description": "The ID number of the location to retrieve point-of-sale data." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:id/pointofsaledata?date=1998-02-12T20:23:10.405Z&format=Json&partnerId=AX7&includeJurisCodes=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":id", "pointofsaledata" ], "query": [ { "description": "The date for which point-of-sale data would be calculated (today by default)", "key": "date", "value": "1998-02-12T20:23:10.405Z" }, { "description": "The format of the file (JSON by default)", "key": "format", "value": "Json" }, { "description": "If specified, requests a custom partner-formatted version of the file.", "key": "partnerId", "value": "AX7" }, { "description": "When true, the file will include jurisdiction codes in the result.", "key": "includeJurisCodes", "value": "true" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company that owns this location." }, { "key": "id", "value": "451", "description": "The ID number of the location to retrieve point-of-sale data." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Retrieve a single location", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":id" ], "query": [ { "key": "$include", "value": "string", "description": "A comma separated list of additional data to retrieve." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this location" }, { "key": "id", "value": "451", "description": "The primary key of this location" } ] }, "description": "Get the location object identified by this URL.\r\nAn 'Location' represents a physical address where a company does business.\r\nMany taxing authorities require that you define a list of all locations where your company does business.\r\nThese locations may require additional custom configuration or tax registration with these authorities.\r\nFor more information on metadata requirements, see the '/api/v2/definitions/locationquestions' API.\r\n \r\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:\r\n \r\n* LocationSettings\r\n* parameters\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":id" ], "query": [ { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this location" }, { "key": "id", "value": "451", "description": "The primary key of this location" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 56789,\n \"companyId\": 12345,\n \"locationCode\": \"DEFAULT\",\n \"description\": \"Bob's Artisan Pottery\",\n \"addressTypeId\": \"Location\",\n \"addressCategoryId\": \"MainOffice\",\n \"isMarketplaceOutsideUsa\": false,\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"county\": \"Orange\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"latitude\": 33.6846,\n \"longitude\": -117.8265,\n \"isDefault\": true,\n \"isRegistered\": true,\n \"dbaName\": \"Bob's Artisan Pottery\",\n \"outletName\": \"Main Office\",\n \"registeredDate\": \"2015-01-01T00:00:00\",\n \"settings\": [\n {\n \"questionId\": 17,\n \"value\": \"abcdefghij\"\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":id" ], "query": [ { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this location" }, { "key": "id", "value": "451", "description": "The primary key of this location" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":id" ], "query": [ { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this location" }, { "key": "id", "value": "451", "description": "The primary key of this location" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":id" ], "query": [ { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this location" }, { "key": "id", "value": "451", "description": "The primary key of this location" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Update a single location", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 56789,\n \"companyId\": 12345,\n \"locationCode\": \"DEFAULT\",\n \"description\": \"Bob's Artisan Pottery\",\n \"addressTypeId\": \"Location\",\n \"addressCategoryId\": \"MainOffice\",\n \"isMarketplaceOutsideUsa\": false,\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"county\": \"Orange\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"latitude\": 33.6846,\n \"longitude\": -117.8265,\n \"isDefault\": true,\n \"isRegistered\": true,\n \"dbaName\": \"Bob's Artisan Pottery\",\n \"outletName\": \"Main Office\",\n \"registeredDate\": \"2015-01-01T00:00:00\",\n \"settings\": [\n {\n \"questionId\": 17,\n \"value\": \"abcdefghij\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this location belongs to." }, { "key": "id", "value": "451", "description": "The ID of the location you wish to update" } ] }, "description": "Replace the existing location object at this URL with an updated object.\r\nAll data from the existing object will be replaced with data in the object you PUT.\r\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.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 56789,\n \"companyId\": 12345,\n \"locationCode\": \"DEFAULT\",\n \"description\": \"Bob's Artisan Pottery\",\n \"addressTypeId\": \"Location\",\n \"addressCategoryId\": \"MainOffice\",\n \"isMarketplaceOutsideUsa\": false,\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"county\": \"Orange\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"latitude\": 33.6846,\n \"longitude\": -117.8265,\n \"isDefault\": true,\n \"isRegistered\": true,\n \"dbaName\": \"Bob's Artisan Pottery\",\n \"outletName\": \"Main Office\",\n \"registeredDate\": \"2015-01-01T00:00:00\",\n \"settings\": [\n {\n \"questionId\": 17,\n \"value\": \"abcdefghij\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this location belongs to." }, { "key": "id", "value": "451", "description": "The ID of the location you wish to update" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 56789,\n \"companyId\": 12345,\n \"locationCode\": \"DEFAULT\",\n \"description\": \"Bob's Artisan Pottery\",\n \"addressTypeId\": \"Location\",\n \"addressCategoryId\": \"MainOffice\",\n \"isMarketplaceOutsideUsa\": false,\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"county\": \"Orange\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"latitude\": 33.6846,\n \"longitude\": -117.8265,\n \"isDefault\": true,\n \"isRegistered\": true,\n \"dbaName\": \"Bob's Artisan Pottery\",\n \"outletName\": \"Main Office\",\n \"registeredDate\": \"2015-01-01T00:00:00\",\n \"settings\": [\n {\n \"questionId\": 17,\n \"value\": \"abcdefghij\"\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 56789,\n \"companyId\": 12345,\n \"locationCode\": \"DEFAULT\",\n \"description\": \"Bob's Artisan Pottery\",\n \"addressTypeId\": \"Location\",\n \"addressCategoryId\": \"MainOffice\",\n \"isMarketplaceOutsideUsa\": false,\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"county\": \"Orange\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"latitude\": 33.6846,\n \"longitude\": -117.8265,\n \"isDefault\": true,\n \"isRegistered\": true,\n \"dbaName\": \"Bob's Artisan Pottery\",\n \"outletName\": \"Main Office\",\n \"registeredDate\": \"2015-01-01T00:00:00\",\n \"settings\": [\n {\n \"questionId\": 17,\n \"value\": \"abcdefghij\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this location belongs to." }, { "key": "id", "value": "451", "description": "The ID of the location you wish to update" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 56789,\n \"companyId\": 12345,\n \"locationCode\": \"DEFAULT\",\n \"description\": \"Bob's Artisan Pottery\",\n \"addressTypeId\": \"Location\",\n \"addressCategoryId\": \"MainOffice\",\n \"isMarketplaceOutsideUsa\": false,\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"county\": \"Orange\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"latitude\": 33.6846,\n \"longitude\": -117.8265,\n \"isDefault\": true,\n \"isRegistered\": true,\n \"dbaName\": \"Bob's Artisan Pottery\",\n \"outletName\": \"Main Office\",\n \"registeredDate\": \"2015-01-01T00:00:00\",\n \"settings\": [\n {\n \"questionId\": 17,\n \"value\": \"abcdefghij\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this location belongs to." }, { "key": "id", "value": "451", "description": "The ID of the location you wish to update" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 56789,\n \"companyId\": 12345,\n \"locationCode\": \"DEFAULT\",\n \"description\": \"Bob's Artisan Pottery\",\n \"addressTypeId\": \"Location\",\n \"addressCategoryId\": \"MainOffice\",\n \"isMarketplaceOutsideUsa\": false,\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"county\": \"Orange\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"latitude\": 33.6846,\n \"longitude\": -117.8265,\n \"isDefault\": true,\n \"isRegistered\": true,\n \"dbaName\": \"Bob's Artisan Pottery\",\n \"outletName\": \"Main Office\",\n \"registeredDate\": \"2015-01-01T00:00:00\",\n \"settings\": [\n {\n \"questionId\": 17,\n \"value\": \"abcdefghij\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this location belongs to." }, { "key": "id", "value": "451", "description": "The ID of the location you wish to update" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete a single location", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this location." }, { "key": "id", "value": "451", "description": "The ID of the location you wish to delete." } ] }, "description": "Mark the location object at this URL as deleted.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this location." }, { "key": "id", "value": "451", "description": "The ID of the location you wish to delete." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this location." }, { "key": "id", "value": "451", "description": "The ID of the location you wish to delete." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this location." }, { "key": "id", "value": "451", "description": "The ID of the location you wish to delete." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this location." }, { "key": "id", "value": "451", "description": "The ID of the location you wish to delete." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "{locationId}", "item": [ { "name": "parameters", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a single company location parameter", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:locationId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":locationId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "locationId", "value": "451", "description": "The location id" }, { "key": "id", "value": "155", "description": "The parameter id" } ] }, "description": "Retrieve a single location parameter.\r\n \r\nSome locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called \"parameters\".\r\n \r\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.\r\n \r\nA parameter specified on a transaction line will override a location parameter if they share the same parameter name.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:locationId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":locationId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "locationId", "value": "451", "description": "The location id" }, { "key": "id", "value": "155", "description": "The parameter id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 0,\n \"name\": \"NumberOfUnitsForRent\",\n \"unit\": \"Count\",\n \"value\": \"10\",\n \"locationId\": 12345\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:locationId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":locationId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "locationId", "value": "451", "description": "The location id" }, { "key": "id", "value": "155", "description": "The parameter id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:locationId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":locationId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "locationId", "value": "451", "description": "The location id" }, { "key": "id", "value": "155", "description": "The parameter id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:locationId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":locationId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "locationId", "value": "451", "description": "The location id" }, { "key": "id", "value": "155", "description": "The parameter id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Update a location parameter", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"name\": \"NumberOfUnitsForRent\",\n \"unit\": \"Count\",\n \"value\": \"10\",\n \"locationId\": 12345\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:locationId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":locationId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "locationId", "value": "451", "description": "The location id" }, { "key": "id", "value": "155", "description": "The location parameter id" } ] }, "description": "Update a location parameter.\r\n \r\nSome locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called \"parameters\".\r\n \r\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.\r\n \r\nA parameter specified on a transaction line will override a location parameter if they share the same parameter name.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"name\": \"NumberOfUnitsForRent\",\n \"unit\": \"Count\",\n \"value\": \"10\",\n \"locationId\": 12345\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:locationId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":locationId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "locationId", "value": "451", "description": "The location id" }, { "key": "id", "value": "155", "description": "The location parameter id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 0,\n \"name\": \"NumberOfUnitsForRent\",\n \"unit\": \"Count\",\n \"value\": \"10\",\n \"locationId\": 12345\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"name\": \"NumberOfUnitsForRent\",\n \"unit\": \"Count\",\n \"value\": \"10\",\n \"locationId\": 12345\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:locationId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":locationId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "locationId", "value": "451", "description": "The location id" }, { "key": "id", "value": "155", "description": "The location parameter id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"name\": \"NumberOfUnitsForRent\",\n \"unit\": \"Count\",\n \"value\": \"10\",\n \"locationId\": 12345\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:locationId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":locationId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "locationId", "value": "451", "description": "The location id" }, { "key": "id", "value": "155", "description": "The location parameter id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"name\": \"NumberOfUnitsForRent\",\n \"unit\": \"Count\",\n \"value\": \"10\",\n \"locationId\": 12345\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:locationId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":locationId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "locationId", "value": "451", "description": "The location id" }, { "key": "id", "value": "155", "description": "The location parameter id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete a single location parameter", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:locationId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":locationId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "locationId", "value": "451", "description": "The location id" }, { "key": "id", "value": "155", "description": "The parameter id" } ] }, "description": "Delete a single location parameter.\r\n \r\nSome locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called \"parameters\".\r\n \r\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.\r\n \r\nA parameter specified on a transaction line will override a location parameter if they share the same parameter name.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:locationId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":locationId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "locationId", "value": "451", "description": "The location id" }, { "key": "id", "value": "155", "description": "The parameter id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:locationId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":locationId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "locationId", "value": "451", "description": "The location id" }, { "key": "id", "value": "155", "description": "The parameter id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:locationId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":locationId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "locationId", "value": "451", "description": "The location id" }, { "key": "id", "value": "155", "description": "The parameter id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:locationId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":locationId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "locationId", "value": "451", "description": "The location id" }, { "key": "id", "value": "155", "description": "The parameter id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Add parameters to a location.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"NumberOfUnitsForRent\",\n \"unit\": \"Count\",\n \"value\": \"10\",\n \"locationId\": 12345\n },\n {\n \"id\": 0,\n \"name\": \"NumberOfUnitsForRent\",\n \"unit\": \"Count\",\n \"value\": \"10\",\n \"locationId\": 12345\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:locationId/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":locationId", "parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this location parameter." }, { "key": "locationId", "value": "451", "description": "The location id." } ] }, "description": "Add parameters to a location.\r\n \r\nSome locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called \"parameters\".\r\n \r\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.\r\n \r\nA parameter specified on a transaction line will override a location parameter if they share the same parameter name.\r\n \r\nTo see available parameters for this location, call `/api/v2/definitions/parameters?$filter=attributeType eq Company`\r\n \r\nSome 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.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Created", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"NumberOfUnitsForRent\",\n \"unit\": \"Count\",\n \"value\": \"10\",\n \"locationId\": 12345\n },\n {\n \"id\": 0,\n \"name\": \"NumberOfUnitsForRent\",\n \"unit\": \"Count\",\n \"value\": \"10\",\n \"locationId\": 12345\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:locationId/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":locationId", "parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this location parameter." }, { "key": "locationId", "value": "451", "description": "The location id." } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": 0,\n \"name\": \"NumberOfUnitsForRent\",\n \"unit\": \"Count\",\n \"value\": \"10\",\n \"locationId\": 12345\n },\n {\n \"id\": 0,\n \"name\": \"NumberOfUnitsForRent\",\n \"unit\": \"Count\",\n \"value\": \"10\",\n \"locationId\": 12345\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"NumberOfUnitsForRent\",\n \"unit\": \"Count\",\n \"value\": \"10\",\n \"locationId\": 12345\n },\n {\n \"id\": 0,\n \"name\": \"NumberOfUnitsForRent\",\n \"unit\": \"Count\",\n \"value\": \"10\",\n \"locationId\": 12345\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:locationId/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":locationId", "parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this location parameter." }, { "key": "locationId", "value": "451", "description": "The location id." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"NumberOfUnitsForRent\",\n \"unit\": \"Count\",\n \"value\": \"10\",\n \"locationId\": 12345\n },\n {\n \"id\": 0,\n \"name\": \"NumberOfUnitsForRent\",\n \"unit\": \"Count\",\n \"value\": \"10\",\n \"locationId\": 12345\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:locationId/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":locationId", "parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this location parameter." }, { "key": "locationId", "value": "451", "description": "The location id." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"NumberOfUnitsForRent\",\n \"unit\": \"Count\",\n \"value\": \"10\",\n \"locationId\": 12345\n },\n {\n \"id\": 0,\n \"name\": \"NumberOfUnitsForRent\",\n \"unit\": \"Count\",\n \"value\": \"10\",\n \"locationId\": 12345\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:locationId/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":locationId", "parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this location parameter." }, { "key": "locationId", "value": "451", "description": "The location id." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Retrieve parameters for a location", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:locationId/parameters?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":locationId", "parameters" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* name, unit" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "locationId", "value": "451", "description": "The ID of the location" } ] }, "description": "List parameters for a location.\r\n \r\nSome locations can be taxed differently depending on the properties of that location. In AvaTax, these tax-affecting properties are called \"parameters\".\r\n \r\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.\r\n \r\nA parameter specified on a transaction line will override a location parameter if they share the same parameter name.\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:locationId/parameters?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":locationId", "parameters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* name, unit", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "locationId", "value": "451", "description": "The ID of the location" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 9368,\n \"value\": [\n {\n \"id\": 0,\n \"name\": \"NumberOfUnitsForRent\",\n \"unit\": \"Count\",\n \"value\": \"10\",\n \"locationId\": 12345\n },\n {\n \"id\": 0,\n \"name\": \"NumberOfUnitsForRent\",\n \"unit\": \"Count\",\n \"value\": \"10\",\n \"locationId\": 12345\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:locationId/parameters?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":locationId", "parameters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* name, unit", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "locationId", "value": "451", "description": "The ID of the location" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:locationId/parameters?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":locationId", "parameters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* name, unit", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "locationId", "value": "451", "description": "The ID of the location" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations/:locationId/parameters?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations", ":locationId", "parameters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* name, unit", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "locationId", "value": "451", "description": "The ID of the location" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "Retrieve locations for this company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* isMarketplaceOutsideUsa, settings, parameters" }, { "key": "$include", "value": "string", "description": "A comma separated list of additional data to retrieve." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these locations" } ] }, "description": "List all location objects defined for this company.\r\nAn 'Location' represents a physical address where a company does business.\r\nMany taxing authorities require that you define a list of all locations where your company does business.\r\nThese locations may require additional custom configuration or tax registration with these authorities.\r\nFor more information on metadata requirements, see the '/api/v2/definitions/locationquestions' API.\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\r\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:\r\n \r\n* LocationSettings\r\n* parameters\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* isMarketplaceOutsideUsa, settings, parameters", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these locations" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 6355,\n \"value\": [\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"locationCode\": \"DEFAULT\",\n \"description\": \"Bob's Artisan Pottery\",\n \"addressTypeId\": \"Location\",\n \"addressCategoryId\": \"MainOffice\",\n \"isMarketplaceOutsideUsa\": false,\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"county\": \"Orange\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"latitude\": 33.6846,\n \"longitude\": -117.8265,\n \"isDefault\": true,\n \"isRegistered\": true,\n \"dbaName\": \"Bob's Artisan Pottery\",\n \"outletName\": \"Main Office\",\n \"registeredDate\": \"2015-01-01T00:00:00\",\n \"settings\": [\n {\n \"questionId\": 17,\n \"value\": \"abcdefghij\"\n }\n ]\n },\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"locationCode\": \"DEFAULT\",\n \"description\": \"Bob's Artisan Pottery\",\n \"addressTypeId\": \"Location\",\n \"addressCategoryId\": \"MainOffice\",\n \"isMarketplaceOutsideUsa\": false,\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"county\": \"Orange\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"latitude\": 33.6846,\n \"longitude\": -117.8265,\n \"isDefault\": true,\n \"isRegistered\": true,\n \"dbaName\": \"Bob's Artisan Pottery\",\n \"outletName\": \"Main Office\",\n \"registeredDate\": \"2015-01-01T00:00:00\",\n \"settings\": [\n {\n \"questionId\": 17,\n \"value\": \"abcdefghij\"\n }\n ]\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* isMarketplaceOutsideUsa, settings, parameters", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these locations" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* isMarketplaceOutsideUsa, settings, parameters", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these locations" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* isMarketplaceOutsideUsa, settings, parameters", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these locations" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Create a new location", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"locationCode\": \"DEFAULT\",\n \"description\": \"Bob's Artisan Pottery\",\n \"addressTypeId\": \"Location\",\n \"addressCategoryId\": \"MainOffice\",\n \"isMarketplaceOutsideUsa\": false,\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"county\": \"Orange\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"latitude\": 33.6846,\n \"longitude\": -117.8265,\n \"isDefault\": true,\n \"isRegistered\": true,\n \"dbaName\": \"Bob's Artisan Pottery\",\n \"outletName\": \"Main Office\",\n \"registeredDate\": \"2015-01-01T00:00:00\",\n \"settings\": [\n {\n \"questionId\": 17,\n \"value\": \"abcdefghij\"\n }\n ]\n },\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"locationCode\": \"DEFAULT\",\n \"description\": \"Bob's Artisan Pottery\",\n \"addressTypeId\": \"Location\",\n \"addressCategoryId\": \"MainOffice\",\n \"isMarketplaceOutsideUsa\": false,\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"county\": \"Orange\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"latitude\": 33.6846,\n \"longitude\": -117.8265,\n \"isDefault\": true,\n \"isRegistered\": true,\n \"dbaName\": \"Bob's Artisan Pottery\",\n \"outletName\": \"Main Office\",\n \"registeredDate\": \"2015-01-01T00:00:00\",\n \"settings\": [\n {\n \"questionId\": 17,\n \"value\": \"abcdefghij\"\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this location." } ] }, "description": "Create one or more new location objects attached to this company.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"locationCode\": \"DEFAULT\",\n \"description\": \"Bob's Artisan Pottery\",\n \"addressTypeId\": \"Location\",\n \"addressCategoryId\": \"MainOffice\",\n \"isMarketplaceOutsideUsa\": false,\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"county\": \"Orange\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"latitude\": 33.6846,\n \"longitude\": -117.8265,\n \"isDefault\": true,\n \"isRegistered\": true,\n \"dbaName\": \"Bob's Artisan Pottery\",\n \"outletName\": \"Main Office\",\n \"registeredDate\": \"2015-01-01T00:00:00\",\n \"settings\": [\n {\n \"questionId\": 17,\n \"value\": \"abcdefghij\"\n }\n ]\n },\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"locationCode\": \"DEFAULT\",\n \"description\": \"Bob's Artisan Pottery\",\n \"addressTypeId\": \"Location\",\n \"addressCategoryId\": \"MainOffice\",\n \"isMarketplaceOutsideUsa\": false,\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"county\": \"Orange\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"latitude\": 33.6846,\n \"longitude\": -117.8265,\n \"isDefault\": true,\n \"isRegistered\": true,\n \"dbaName\": \"Bob's Artisan Pottery\",\n \"outletName\": \"Main Office\",\n \"registeredDate\": \"2015-01-01T00:00:00\",\n \"settings\": [\n {\n \"questionId\": 17,\n \"value\": \"abcdefghij\"\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this location." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"locationCode\": \"DEFAULT\",\n \"description\": \"Bob's Artisan Pottery\",\n \"addressTypeId\": \"Location\",\n \"addressCategoryId\": \"MainOffice\",\n \"isMarketplaceOutsideUsa\": false,\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"county\": \"Orange\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"latitude\": 33.6846,\n \"longitude\": -117.8265,\n \"isDefault\": true,\n \"isRegistered\": true,\n \"dbaName\": \"Bob's Artisan Pottery\",\n \"outletName\": \"Main Office\",\n \"registeredDate\": \"2015-01-01T00:00:00\",\n \"settings\": [\n {\n \"questionId\": 17,\n \"value\": \"abcdefghij\"\n }\n ]\n },\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"locationCode\": \"DEFAULT\",\n \"description\": \"Bob's Artisan Pottery\",\n \"addressTypeId\": \"Location\",\n \"addressCategoryId\": \"MainOffice\",\n \"isMarketplaceOutsideUsa\": false,\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"county\": \"Orange\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"latitude\": 33.6846,\n \"longitude\": -117.8265,\n \"isDefault\": true,\n \"isRegistered\": true,\n \"dbaName\": \"Bob's Artisan Pottery\",\n \"outletName\": \"Main Office\",\n \"registeredDate\": \"2015-01-01T00:00:00\",\n \"settings\": [\n {\n \"questionId\": 17,\n \"value\": \"abcdefghij\"\n }\n ]\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"locationCode\": \"DEFAULT\",\n \"description\": \"Bob's Artisan Pottery\",\n \"addressTypeId\": \"Location\",\n \"addressCategoryId\": \"MainOffice\",\n \"isMarketplaceOutsideUsa\": false,\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"county\": \"Orange\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"latitude\": 33.6846,\n \"longitude\": -117.8265,\n \"isDefault\": true,\n \"isRegistered\": true,\n \"dbaName\": \"Bob's Artisan Pottery\",\n \"outletName\": \"Main Office\",\n \"registeredDate\": \"2015-01-01T00:00:00\",\n \"settings\": [\n {\n \"questionId\": 17,\n \"value\": \"abcdefghij\"\n }\n ]\n },\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"locationCode\": \"DEFAULT\",\n \"description\": \"Bob's Artisan Pottery\",\n \"addressTypeId\": \"Location\",\n \"addressCategoryId\": \"MainOffice\",\n \"isMarketplaceOutsideUsa\": false,\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"county\": \"Orange\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"latitude\": 33.6846,\n \"longitude\": -117.8265,\n \"isDefault\": true,\n \"isRegistered\": true,\n \"dbaName\": \"Bob's Artisan Pottery\",\n \"outletName\": \"Main Office\",\n \"registeredDate\": \"2015-01-01T00:00:00\",\n \"settings\": [\n {\n \"questionId\": 17,\n \"value\": \"abcdefghij\"\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this location." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"locationCode\": \"DEFAULT\",\n \"description\": \"Bob's Artisan Pottery\",\n \"addressTypeId\": \"Location\",\n \"addressCategoryId\": \"MainOffice\",\n \"isMarketplaceOutsideUsa\": false,\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"county\": \"Orange\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"latitude\": 33.6846,\n \"longitude\": -117.8265,\n \"isDefault\": true,\n \"isRegistered\": true,\n \"dbaName\": \"Bob's Artisan Pottery\",\n \"outletName\": \"Main Office\",\n \"registeredDate\": \"2015-01-01T00:00:00\",\n \"settings\": [\n {\n \"questionId\": 17,\n \"value\": \"abcdefghij\"\n }\n ]\n },\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"locationCode\": \"DEFAULT\",\n \"description\": \"Bob's Artisan Pottery\",\n \"addressTypeId\": \"Location\",\n \"addressCategoryId\": \"MainOffice\",\n \"isMarketplaceOutsideUsa\": false,\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"county\": \"Orange\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"latitude\": 33.6846,\n \"longitude\": -117.8265,\n \"isDefault\": true,\n \"isRegistered\": true,\n \"dbaName\": \"Bob's Artisan Pottery\",\n \"outletName\": \"Main Office\",\n \"registeredDate\": \"2015-01-01T00:00:00\",\n \"settings\": [\n {\n \"questionId\": 17,\n \"value\": \"abcdefghij\"\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this location." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"locationCode\": \"DEFAULT\",\n \"description\": \"Bob's Artisan Pottery\",\n \"addressTypeId\": \"Location\",\n \"addressCategoryId\": \"MainOffice\",\n \"isMarketplaceOutsideUsa\": false,\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"county\": \"Orange\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"latitude\": 33.6846,\n \"longitude\": -117.8265,\n \"isDefault\": true,\n \"isRegistered\": true,\n \"dbaName\": \"Bob's Artisan Pottery\",\n \"outletName\": \"Main Office\",\n \"registeredDate\": \"2015-01-01T00:00:00\",\n \"settings\": [\n {\n \"questionId\": 17,\n \"value\": \"abcdefghij\"\n }\n ]\n },\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"locationCode\": \"DEFAULT\",\n \"description\": \"Bob's Artisan Pottery\",\n \"addressTypeId\": \"Location\",\n \"addressCategoryId\": \"MainOffice\",\n \"isMarketplaceOutsideUsa\": false,\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"county\": \"Orange\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"latitude\": 33.6846,\n \"longitude\": -117.8265,\n \"isDefault\": true,\n \"isRegistered\": true,\n \"dbaName\": \"Bob's Artisan Pottery\",\n \"outletName\": \"Main Office\",\n \"registeredDate\": \"2015-01-01T00:00:00\",\n \"settings\": [\n {\n \"questionId\": 17,\n \"value\": \"abcdefghij\"\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/locations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "locations" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this location." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "nexus", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a single nexus", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":id" ], "query": [ { "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this nexus object" }, { "key": "id", "value": "451", "description": "The primary key of this nexus" } ] }, "description": "Get the nexus object identified by this URL.\r\n \r\nThe concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional\r\ntaxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your\r\naccountant or lawyer prior to declaring nexus.\r\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:\r\n \r\n * Parameters\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":id" ], "query": [ { "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this nexus object" }, { "key": "id", "value": "451", "description": "The primary key of this nexus" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 0,\n \"companyId\": 0,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"State\",\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"effectiveDate\": \"2017-04-01\",\n \"endDate\": \"2017-03-31\",\n \"shortName\": \"CALIFORNIA\",\n \"signatureCode\": \"\",\n \"stateAssignedNo\": \"\",\n \"nexusTypeId\": \"SalesOrSellersUseTax\",\n \"sourcing\": \"Destination\",\n \"hasLocalNexus\": false,\n \"hasPermanentEstablishment\": true,\n \"streamlinedSalesTax\": false,\n \"isSSTActive\": false,\n \"createdDate\": \"2017-06-30T05:14:06.003\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2022-04-20T01:34:46.39\",\n \"modifiedUserId\": 0,\n \"taxTypeGroup\": \"EWaste\",\n \"nexusTaxTypeGroup\": \"SalesAndUse\",\n \"isSellerImporterOfRecord\": false,\n \"taxName\": \"Tire Fee\",\n \"taxableNexus\": true\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":id" ], "query": [ { "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this nexus object" }, { "key": "id", "value": "451", "description": "The primary key of this nexus" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":id" ], "query": [ { "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this nexus object" }, { "key": "id", "value": "451", "description": "The primary key of this nexus" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":id" ], "query": [ { "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this nexus object" }, { "key": "id", "value": "451", "description": "The primary key of this nexus" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] }, { "name": "Update a single nexus", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"companyId\": 0,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"State\",\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"effectiveDate\": \"2017-04-01\",\n \"endDate\": \"2017-03-31\",\n \"shortName\": \"CALIFORNIA\",\n \"signatureCode\": \"\",\n \"stateAssignedNo\": \"\",\n \"nexusTypeId\": \"SalesOrSellersUseTax\",\n \"sourcing\": \"Destination\",\n \"hasLocalNexus\": false,\n \"hasPermanentEstablishment\": true,\n \"streamlinedSalesTax\": false,\n \"isSSTActive\": false,\n \"createdDate\": \"2017-06-30T05:14:06.003\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2022-04-20T01:34:46.39\",\n \"modifiedUserId\": 0,\n \"taxTypeGroup\": \"EWaste\",\n \"nexusTaxTypeGroup\": \"SalesAndUse\",\n \"isSellerImporterOfRecord\": false,\n \"taxName\": \"Tire Fee\",\n \"taxableNexus\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this nexus belongs to." }, { "key": "id", "value": "451", "description": "The ID of the nexus you wish to update" } ] }, "description": "Replace the existing nexus declaration object at this URL with an updated object.\r\n \r\nThe concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional\r\ntaxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your\r\naccountant or lawyer prior to declaring nexus.\r\n \r\nTo create a nexus declaration for your company, you must first call the Definitions API `ListNexus` to obtain a\r\nlist of Avalara-defined nexus. Once you have determined which nexus you wish to declare, you should customize\r\nonly the user-selectable fields in this object.\r\n \r\nThe user selectable fields for the nexus object are `companyId`, `effectiveDate`, `endDate`, `localNexusTypeId`,\r\n`taxId`, `nexusTypeId`, `hasPermanentEstablishment`, and `isSellerImporterOfRecord`.\r\n \r\nWhen calling `CreateNexus` or `UpdateNexus`, all values in your nexus object except for the user-selectable fields\r\nmust match an Avalara-defined system nexus object. You can retrieve a list of Avalara-defined system nexus objects\r\nby calling `ListNexus`. If any data does not match, AvaTax may not recognize your nexus declaration.\r\n \r\nPlease note that nexus changes may not take effect immediately and you should plan to update your nexus settings in advance\r\nof calculating tax for a location.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"companyId\": 0,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"State\",\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"effectiveDate\": \"2017-04-01\",\n \"endDate\": \"2017-03-31\",\n \"shortName\": \"CALIFORNIA\",\n \"signatureCode\": \"\",\n \"stateAssignedNo\": \"\",\n \"nexusTypeId\": \"SalesOrSellersUseTax\",\n \"sourcing\": \"Destination\",\n \"hasLocalNexus\": false,\n \"hasPermanentEstablishment\": true,\n \"streamlinedSalesTax\": false,\n \"isSSTActive\": false,\n \"createdDate\": \"2017-06-30T05:14:06.003\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2022-04-20T01:34:46.39\",\n \"modifiedUserId\": 0,\n \"taxTypeGroup\": \"EWaste\",\n \"nexusTaxTypeGroup\": \"SalesAndUse\",\n \"isSellerImporterOfRecord\": false,\n \"taxName\": \"Tire Fee\",\n \"taxableNexus\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this nexus belongs to." }, { "key": "id", "value": "451", "description": "The ID of the nexus you wish to update" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 0,\n \"companyId\": 0,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"State\",\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"effectiveDate\": \"2017-04-01\",\n \"endDate\": \"2017-03-31\",\n \"shortName\": \"CALIFORNIA\",\n \"signatureCode\": \"\",\n \"stateAssignedNo\": \"\",\n \"nexusTypeId\": \"SalesOrSellersUseTax\",\n \"sourcing\": \"Destination\",\n \"hasLocalNexus\": false,\n \"hasPermanentEstablishment\": true,\n \"streamlinedSalesTax\": false,\n \"isSSTActive\": false,\n \"createdDate\": \"2017-06-30T05:14:06.003\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2022-04-20T01:34:46.39\",\n \"modifiedUserId\": 0,\n \"taxTypeGroup\": \"EWaste\",\n \"nexusTaxTypeGroup\": \"SalesAndUse\",\n \"isSellerImporterOfRecord\": false,\n \"taxName\": \"Tire Fee\",\n \"taxableNexus\": true\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"companyId\": 0,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"State\",\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"effectiveDate\": \"2017-04-01\",\n \"endDate\": \"2017-03-31\",\n \"shortName\": \"CALIFORNIA\",\n \"signatureCode\": \"\",\n \"stateAssignedNo\": \"\",\n \"nexusTypeId\": \"SalesOrSellersUseTax\",\n \"sourcing\": \"Destination\",\n \"hasLocalNexus\": false,\n \"hasPermanentEstablishment\": true,\n \"streamlinedSalesTax\": false,\n \"isSSTActive\": false,\n \"createdDate\": \"2017-06-30T05:14:06.003\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2022-04-20T01:34:46.39\",\n \"modifiedUserId\": 0,\n \"taxTypeGroup\": \"EWaste\",\n \"nexusTaxTypeGroup\": \"SalesAndUse\",\n \"isSellerImporterOfRecord\": false,\n \"taxName\": \"Tire Fee\",\n \"taxableNexus\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this nexus belongs to." }, { "key": "id", "value": "451", "description": "The ID of the nexus you wish to update" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"companyId\": 0,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"State\",\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"effectiveDate\": \"2017-04-01\",\n \"endDate\": \"2017-03-31\",\n \"shortName\": \"CALIFORNIA\",\n \"signatureCode\": \"\",\n \"stateAssignedNo\": \"\",\n \"nexusTypeId\": \"SalesOrSellersUseTax\",\n \"sourcing\": \"Destination\",\n \"hasLocalNexus\": false,\n \"hasPermanentEstablishment\": true,\n \"streamlinedSalesTax\": false,\n \"isSSTActive\": false,\n \"createdDate\": \"2017-06-30T05:14:06.003\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2022-04-20T01:34:46.39\",\n \"modifiedUserId\": 0,\n \"taxTypeGroup\": \"EWaste\",\n \"nexusTaxTypeGroup\": \"SalesAndUse\",\n \"isSellerImporterOfRecord\": false,\n \"taxName\": \"Tire Fee\",\n \"taxableNexus\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this nexus belongs to." }, { "key": "id", "value": "451", "description": "The ID of the nexus you wish to update" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"companyId\": 0,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"State\",\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"effectiveDate\": \"2017-04-01\",\n \"endDate\": \"2017-03-31\",\n \"shortName\": \"CALIFORNIA\",\n \"signatureCode\": \"\",\n \"stateAssignedNo\": \"\",\n \"nexusTypeId\": \"SalesOrSellersUseTax\",\n \"sourcing\": \"Destination\",\n \"hasLocalNexus\": false,\n \"hasPermanentEstablishment\": true,\n \"streamlinedSalesTax\": false,\n \"isSSTActive\": false,\n \"createdDate\": \"2017-06-30T05:14:06.003\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2022-04-20T01:34:46.39\",\n \"modifiedUserId\": 0,\n \"taxTypeGroup\": \"EWaste\",\n \"nexusTaxTypeGroup\": \"SalesAndUse\",\n \"isSellerImporterOfRecord\": false,\n \"taxName\": \"Tire Fee\",\n \"taxableNexus\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this nexus belongs to." }, { "key": "id", "value": "451", "description": "The ID of the nexus you wish to update" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] }, { "name": "Delete a single nexus", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:id?cascadeDelete=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":id" ], "query": [ { "key": "cascadeDelete", "value": "true", "description": "If true, deletes all the child nexus if they exist along with parent nexus" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this nexus." }, { "key": "id", "value": "451", "description": "The ID of the nexus you wish to delete." } ] }, "description": "Marks the existing nexus object at this URL as deleted.\r\n \r\nThe concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional\r\ntaxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your\r\naccountant or lawyer prior to declaring nexus.\r\n \r\nPlease note that nexus changes may not take effect immediately and you should plan to update your nexus settings in advance\r\nof calculating tax for a location.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:id?cascadeDelete=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":id" ], "query": [ { "description": "If true, deletes all the child nexus if they exist along with parent nexus", "key": "cascadeDelete", "value": "true" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this nexus." }, { "key": "id", "value": "451", "description": "The ID of the nexus you wish to delete." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:id?cascadeDelete=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":id" ], "query": [ { "description": "If true, deletes all the child nexus if they exist along with parent nexus", "key": "cascadeDelete", "value": "true" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this nexus." }, { "key": "id", "value": "451", "description": "The ID of the nexus you wish to delete." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:id?cascadeDelete=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":id" ], "query": [ { "description": "If true, deletes all the child nexus if they exist along with parent nexus", "key": "cascadeDelete", "value": "true" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this nexus." }, { "key": "id", "value": "451", "description": "The ID of the nexus you wish to delete." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:id?cascadeDelete=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":id" ], "query": [ { "description": "If true, deletes all the child nexus if they exist along with parent nexus", "key": "cascadeDelete", "value": "true" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this nexus." }, { "key": "id", "value": "451", "description": "The ID of the nexus you wish to delete." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "{nexusId}", "item": [ { "name": "parameters", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a single nexus parameter", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:nexusId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":nexusId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "nexusId", "value": "451", "description": "The nexus id" }, { "key": "id", "value": "155", "description": "The parameter id" } ] }, "description": "Retrieve a single nexus parameter.\r\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\".\r\n \r\nA parameter added to a nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus.\r\n \r\nA parameter specified on a transaction line will override a nexus parameter if they share the same parameter name.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:nexusId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":nexusId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "nexusId", "value": "451", "description": "The nexus id" }, { "key": "id", "value": "155", "description": "The parameter id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 0,\n \"name\": \"IsRemoteSeller\",\n \"value\": \"true\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:nexusId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":nexusId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "nexusId", "value": "451", "description": "The nexus id" }, { "key": "id", "value": "155", "description": "The parameter id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:nexusId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":nexusId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "nexusId", "value": "451", "description": "The nexus id" }, { "key": "id", "value": "155", "description": "The parameter id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:nexusId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":nexusId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "nexusId", "value": "451", "description": "The nexus id" }, { "key": "id", "value": "155", "description": "The parameter id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Update a nexus parameter", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"name\": \"IsRemoteSeller\",\n \"value\": \"true\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:nexusId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":nexusId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "nexusId", "value": "451", "description": "The nexus id" }, { "key": "id", "value": "155", "description": "The nexus parameter id" } ] }, "description": "Update a nexus parameter.\r\n \r\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\".\r\n \r\nA parameter added to a nexus will be used in tax calculation based on the locationcode and parameter value provided to the transaction.\r\n \r\nA parameter specified on a transaction line will override a nexus parameter if they share the same parameter name.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"name\": \"IsRemoteSeller\",\n \"value\": \"true\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:nexusId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":nexusId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "nexusId", "value": "451", "description": "The nexus id" }, { "key": "id", "value": "155", "description": "The nexus parameter id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 0,\n \"name\": \"IsRemoteSeller\",\n \"value\": \"true\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"name\": \"IsRemoteSeller\",\n \"value\": \"true\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:nexusId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":nexusId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "nexusId", "value": "451", "description": "The nexus id" }, { "key": "id", "value": "155", "description": "The nexus parameter id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"name\": \"IsRemoteSeller\",\n \"value\": \"true\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:nexusId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":nexusId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "nexusId", "value": "451", "description": "The nexus id" }, { "key": "id", "value": "155", "description": "The nexus parameter id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 0,\n \"name\": \"IsRemoteSeller\",\n \"value\": \"true\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:nexusId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":nexusId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id." }, { "key": "nexusId", "value": "451", "description": "The nexus id" }, { "key": "id", "value": "155", "description": "The nexus parameter id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete a single nexus parameter", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:nexusId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":nexusId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "nexusId", "value": "451", "description": "The nexus id" }, { "key": "id", "value": "155", "description": "The parameter id" } ] }, "description": "Delete a single nexus parameter.\r\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\".\r\n \r\nA parameter added to a nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus.\r\n \r\nA parameter specified on a transaction line will override a nexus parameter if they share the same parameter name.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:nexusId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":nexusId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "nexusId", "value": "451", "description": "The nexus id" }, { "key": "id", "value": "155", "description": "The parameter id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:nexusId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":nexusId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "nexusId", "value": "451", "description": "The nexus id" }, { "key": "id", "value": "155", "description": "The parameter id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:nexusId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":nexusId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "nexusId", "value": "451", "description": "The nexus id" }, { "key": "id", "value": "155", "description": "The parameter id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:nexusId/parameters/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":nexusId", "parameters", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "nexusId", "value": "451", "description": "The nexus id" }, { "key": "id", "value": "155", "description": "The parameter id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Add parameters to a nexus.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"IsRemoteSeller\",\n \"value\": \"true\"\n },\n {\n \"id\": 0,\n \"name\": \"IsRemoteSeller\",\n \"value\": \"true\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:nexusId/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":nexusId", "parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this nexus parameter." }, { "key": "nexusId", "value": "451", "description": "The nexus id." } ] }, "description": "Add parameters to the nexus.\r\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\".\r\n \r\nA parameter added to a nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus.\r\n \r\nA parameter specified on a transaction line will override a nexus parameter if they share the same parameter name.\r\n \r\nTo see available parameters for this item, call `/api/v2/definitions/parameters?$filter=attributeType eq Nexus`\r\n \r\nSome 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.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Created", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"IsRemoteSeller\",\n \"value\": \"true\"\n },\n {\n \"id\": 0,\n \"name\": \"IsRemoteSeller\",\n \"value\": \"true\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:nexusId/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":nexusId", "parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this nexus parameter." }, { "key": "nexusId", "value": "451", "description": "The nexus id." } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": 0,\n \"name\": \"IsRemoteSeller\",\n \"value\": \"true\"\n },\n {\n \"id\": 0,\n \"name\": \"IsRemoteSeller\",\n \"value\": \"true\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"IsRemoteSeller\",\n \"value\": \"true\"\n },\n {\n \"id\": 0,\n \"name\": \"IsRemoteSeller\",\n \"value\": \"true\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:nexusId/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":nexusId", "parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this nexus parameter." }, { "key": "nexusId", "value": "451", "description": "The nexus id." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"IsRemoteSeller\",\n \"value\": \"true\"\n },\n {\n \"id\": 0,\n \"name\": \"IsRemoteSeller\",\n \"value\": \"true\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:nexusId/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":nexusId", "parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this nexus parameter." }, { "key": "nexusId", "value": "451", "description": "The nexus id." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"name\": \"IsRemoteSeller\",\n \"value\": \"true\"\n },\n {\n \"id\": 0,\n \"name\": \"IsRemoteSeller\",\n \"value\": \"true\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:nexusId/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":nexusId", "parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this nexus parameter." }, { "key": "nexusId", "value": "451", "description": "The nexus id." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Retrieve parameters for a nexus", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:nexusId/parameters?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":nexusId", "parameters" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* name, unit" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "nexusId", "value": "451", "description": "The nexus id" } ] }, "description": "List parameters for a nexus.\r\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\".\r\n \r\nA parameter added to a nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus.\r\n \r\nA parameter specified on a transaction line will override a nexus parameter if they share the same parameter name.\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:nexusId/parameters?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":nexusId", "parameters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* name, unit", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "nexusId", "value": "451", "description": "The nexus id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 3981,\n \"value\": [\n {\n \"id\": 0,\n \"name\": \"IsRemoteSeller\",\n \"value\": \"true\"\n },\n {\n \"id\": 0,\n \"name\": \"IsRemoteSeller\",\n \"value\": \"true\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:nexusId/parameters?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":nexusId", "parameters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* name, unit", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "nexusId", "value": "451", "description": "The nexus id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:nexusId/parameters?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":nexusId", "parameters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* name, unit", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "nexusId", "value": "451", "description": "The nexus id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:nexusId/parameters?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":nexusId", "parameters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* name, unit", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The company id" }, { "key": "nexusId", "value": "451", "description": "The nexus id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete all parameters for a nexus", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:nexusId/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":nexusId", "parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this nexus." }, { "key": "nexusId", "value": "451", "description": "The ID of the nexus you wish to delete the parameters." } ] }, "description": "Delete all the parameters for a given nexus.\r\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\".\r\n \r\nA parameter added to a nexus will be used by default in tax calculation but will not show on the transaction line referencing the nexus.\r\n \r\nA parameter specified on a transaction line will override a nexus parameter if they share the same parameter name.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/:nexusId/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", ":nexusId", "parameters" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this nexus." }, { "key": "nexusId", "value": "451", "description": "The ID of the nexus you wish to delete the parameters." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n }\n]" } ] } ] } ] }, { "name": "byaddress", "item": [ { "name": "Creates nexus for a list of addresses.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"effectiveDate\": \"2018-01-01T00:00:00\",\n \"endDate\": \"2020-12-31T00:00:00\",\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n },\n {\n \"effectiveDate\": \"2018-01-01T00:00:00\",\n \"endDate\": \"2020-12-31T00:00:00\",\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/byaddress", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", "byaddress" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that will own this nexus." } ] }, "description": "This call is intended to simplify adding all applicable nexus to a company, for an address or addresses. Calling this\r\nAPI declares nexus for this company, for the list of addresses provided,\r\nfor the date range provided. You may also use this API to extend effective date on an already-declared nexus.\r\n \r\nThe concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional\r\ntaxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your\r\naccountant or lawyer prior to declaring nexus.\r\n \r\nNote that not all fields within a nexus can be updated; Avalara publishes a list of all defined nexus at the\r\n'/api/v2/definitions/nexus' endpoint.\r\n \r\nYou may only define nexus matching the official list of declared nexus.\r\n \r\nPlease note that nexus changes may not take effect immediately and you should plan to update your nexus settings in advance\r\nof calculating tax for a location.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"effectiveDate\": \"2018-01-01T00:00:00\",\n \"endDate\": \"2020-12-31T00:00:00\",\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n },\n {\n \"effectiveDate\": \"2018-01-01T00:00:00\",\n \"endDate\": \"2020-12-31T00:00:00\",\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/byaddress", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", "byaddress" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that will own this nexus." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"address\": {\n \"effectiveDate\": \"2018-01-01T00:00:00\",\n \"endDate\": \"2020-12-31T00:00:00\",\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n },\n \"declaredNexus\": [\n {\n \"id\": 0,\n \"companyId\": 0,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"State\",\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"effectiveDate\": \"2017-04-01\",\n \"endDate\": \"2017-03-31\",\n \"shortName\": \"CALIFORNIA\",\n \"signatureCode\": \"\",\n \"stateAssignedNo\": \"\",\n \"nexusTypeId\": \"SalesOrSellersUseTax\",\n \"sourcing\": \"Destination\",\n \"hasLocalNexus\": false,\n \"hasPermanentEstablishment\": true,\n \"streamlinedSalesTax\": false,\n \"isSSTActive\": false,\n \"createdDate\": \"2017-06-30T05:14:06.003\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2022-04-20T01:34:46.39\",\n \"modifiedUserId\": 0,\n \"taxTypeGroup\": \"EWaste\",\n \"nexusTaxTypeGroup\": \"SalesAndUse\",\n \"isSellerImporterOfRecord\": false,\n \"taxName\": \"Tire Fee\",\n \"taxableNexus\": true\n }\n ]\n },\n {\n \"address\": {\n \"effectiveDate\": \"2018-01-01T00:00:00\",\n \"endDate\": \"2020-12-31T00:00:00\",\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n },\n \"declaredNexus\": [\n {\n \"id\": 0,\n \"companyId\": 0,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"State\",\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"effectiveDate\": \"2017-04-01\",\n \"endDate\": \"2017-03-31\",\n \"shortName\": \"CALIFORNIA\",\n \"signatureCode\": \"\",\n \"stateAssignedNo\": \"\",\n \"nexusTypeId\": \"SalesOrSellersUseTax\",\n \"sourcing\": \"Destination\",\n \"hasLocalNexus\": false,\n \"hasPermanentEstablishment\": true,\n \"streamlinedSalesTax\": false,\n \"isSSTActive\": false,\n \"createdDate\": \"2017-06-30T05:14:06.003\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2022-04-20T01:34:46.39\",\n \"modifiedUserId\": 0,\n \"taxTypeGroup\": \"EWaste\",\n \"nexusTaxTypeGroup\": \"SalesAndUse\",\n \"isSellerImporterOfRecord\": false,\n \"taxName\": \"Tire Fee\",\n \"taxableNexus\": true\n }\n ]\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"effectiveDate\": \"2018-01-01T00:00:00\",\n \"endDate\": \"2020-12-31T00:00:00\",\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n },\n {\n \"effectiveDate\": \"2018-01-01T00:00:00\",\n \"endDate\": \"2020-12-31T00:00:00\",\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/byaddress", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", "byaddress" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that will own this nexus." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"effectiveDate\": \"2018-01-01T00:00:00\",\n \"endDate\": \"2020-12-31T00:00:00\",\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n },\n {\n \"effectiveDate\": \"2018-01-01T00:00:00\",\n \"endDate\": \"2020-12-31T00:00:00\",\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/byaddress", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", "byaddress" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that will own this nexus." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"effectiveDate\": \"2018-01-01T00:00:00\",\n \"endDate\": \"2020-12-31T00:00:00\",\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n },\n {\n \"effectiveDate\": \"2018-01-01T00:00:00\",\n \"endDate\": \"2020-12-31T00:00:00\",\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/byaddress", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", "byaddress" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that will own this nexus." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "byform", "item": [ { "name": "{formCode}", "item": [ { "name": "List company nexus related to a tax form", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/byform/:formCode?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", "byform", ":formCode" ], "query": [ { "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this nexus object" }, { "key": "formCode", "value": "string", "description": "The form code that we are looking up the nexus for" } ] }, "description": "Retrieves a list of nexus related to a tax form.\r\n \r\nThe concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional\r\ntaxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your\r\naccountant or lawyer prior to declaring nexus.\r\n \r\nThis API is intended to provide useful information when examining a tax form. If you are about to begin filing\r\na tax form, you may want to know whether you have declared nexus in all the jurisdictions related to that tax\r\nform in order to better understand how the form will be filled out.\r\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:\r\n \r\n * Parameters\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/byform/:formCode?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", "byform", ":formCode" ], "query": [ { "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this nexus object" }, { "key": "formCode", "value": "string", "description": "The form code that we are looking up the nexus for" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"formCode\": \"UNKNOWNFORM\",\n \"companyId\": 12345,\n \"nexusDefinitions\": [],\n \"companyNexus\": []\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/byform/:formCode?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", "byform", ":formCode" ], "query": [ { "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this nexus object" }, { "key": "formCode", "value": "string", "description": "The form code that we are looking up the nexus for" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/byform/:formCode?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", "byform", ":formCode" ], "query": [ { "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this nexus object" }, { "key": "formCode", "value": "string", "description": "The form code that we are looking up the nexus for" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/byform/:formCode?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", "byform", ":formCode" ], "query": [ { "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this nexus object" }, { "key": "formCode", "value": "string", "description": "The form code that we are looking up the nexus for" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] } ] }, { "name": "byTaxTypeGroup", "item": [ { "name": "{taxTypeGroup}", "item": [ { "name": "Retrieve nexus for this company By TaxTypeGroup", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/byTaxTypeGroup/:taxTypeGroup?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", "byTaxTypeGroup", ":taxTypeGroup" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters" }, { "key": "$include", "value": "string", "description": "A comma separated list of additional data to retrieve." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these nexus objects" }, { "key": "taxTypeGroup", "value": "string", "description": "Name of TaxTypeGroup to filter by" } ] }, "description": "List all nexus objects defined for this company filtered by TaxTypeGroup.\r\n \r\nThe concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional\r\ntaxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your\r\naccountant or lawyer prior to declaring nexus.\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\r\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:\r\n \r\n * Parameters\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/byTaxTypeGroup/:taxTypeGroup?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", "byTaxTypeGroup", ":taxTypeGroup" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these nexus objects" }, { "key": "taxTypeGroup", "value": "string", "description": "Name of TaxTypeGroup to filter by" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 1459,\n \"value\": [\n {\n \"id\": 0,\n \"companyId\": 0,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"State\",\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"effectiveDate\": \"2017-04-01\",\n \"endDate\": \"2017-03-31\",\n \"shortName\": \"CALIFORNIA\",\n \"signatureCode\": \"\",\n \"stateAssignedNo\": \"\",\n \"nexusTypeId\": \"SalesOrSellersUseTax\",\n \"sourcing\": \"Destination\",\n \"hasLocalNexus\": false,\n \"hasPermanentEstablishment\": true,\n \"streamlinedSalesTax\": false,\n \"isSSTActive\": false,\n \"createdDate\": \"2017-06-30T05:14:06.003\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2022-04-20T01:34:46.39\",\n \"modifiedUserId\": 0,\n \"taxTypeGroup\": \"EWaste\",\n \"nexusTaxTypeGroup\": \"SalesAndUse\",\n \"isSellerImporterOfRecord\": false,\n \"taxName\": \"Tire Fee\",\n \"taxableNexus\": true\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"State\",\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"effectiveDate\": \"2017-04-01\",\n \"endDate\": \"2017-03-31\",\n \"shortName\": \"CALIFORNIA\",\n \"signatureCode\": \"\",\n \"stateAssignedNo\": \"\",\n \"nexusTypeId\": \"SalesOrSellersUseTax\",\n \"sourcing\": \"Destination\",\n \"hasLocalNexus\": false,\n \"hasPermanentEstablishment\": true,\n \"streamlinedSalesTax\": false,\n \"isSSTActive\": false,\n \"createdDate\": \"2017-06-30T05:14:06.003\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2022-04-20T01:34:46.39\",\n \"modifiedUserId\": 0,\n \"taxTypeGroup\": \"EWaste\",\n \"nexusTaxTypeGroup\": \"SalesAndUse\",\n \"isSellerImporterOfRecord\": false,\n \"taxName\": \"Tire Fee\",\n \"taxableNexus\": true\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/byTaxTypeGroup/:taxTypeGroup?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", "byTaxTypeGroup", ":taxTypeGroup" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these nexus objects" }, { "key": "taxTypeGroup", "value": "string", "description": "Name of TaxTypeGroup to filter by" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/byTaxTypeGroup/:taxTypeGroup?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", "byTaxTypeGroup", ":taxTypeGroup" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these nexus objects" }, { "key": "taxTypeGroup", "value": "string", "description": "Name of TaxTypeGroup to filter by" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus/byTaxTypeGroup/:taxTypeGroup?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus", "byTaxTypeGroup", ":taxTypeGroup" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these nexus objects" }, { "key": "taxTypeGroup", "value": "string", "description": "Name of TaxTypeGroup to filter by" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] } ] }, { "name": "Retrieve nexus for this company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters" }, { "key": "$include", "value": "string", "description": "A comma separated list of additional data to retrieve." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these nexus objects" } ] }, "description": "List all nexus objects defined for this company.\r\n \r\nThe concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional\r\ntaxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your\r\naccountant or lawyer prior to declaring nexus.\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\r\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:\r\n \r\n * Parameters\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these nexus objects" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 1459,\n \"value\": [\n {\n \"id\": 0,\n \"companyId\": 0,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"State\",\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"effectiveDate\": \"2017-04-01\",\n \"endDate\": \"2017-03-31\",\n \"shortName\": \"CALIFORNIA\",\n \"signatureCode\": \"\",\n \"stateAssignedNo\": \"\",\n \"nexusTypeId\": \"SalesOrSellersUseTax\",\n \"sourcing\": \"Destination\",\n \"hasLocalNexus\": false,\n \"hasPermanentEstablishment\": true,\n \"streamlinedSalesTax\": false,\n \"isSSTActive\": false,\n \"createdDate\": \"2017-06-30T05:14:06.003\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2022-04-20T01:34:46.39\",\n \"modifiedUserId\": 0,\n \"taxTypeGroup\": \"EWaste\",\n \"nexusTaxTypeGroup\": \"SalesAndUse\",\n \"isSellerImporterOfRecord\": false,\n \"taxName\": \"Tire Fee\",\n \"taxableNexus\": true\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"State\",\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"effectiveDate\": \"2017-04-01\",\n \"endDate\": \"2017-03-31\",\n \"shortName\": \"CALIFORNIA\",\n \"signatureCode\": \"\",\n \"stateAssignedNo\": \"\",\n \"nexusTypeId\": \"SalesOrSellersUseTax\",\n \"sourcing\": \"Destination\",\n \"hasLocalNexus\": false,\n \"hasPermanentEstablishment\": true,\n \"streamlinedSalesTax\": false,\n \"isSSTActive\": false,\n \"createdDate\": \"2017-06-30T05:14:06.003\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2022-04-20T01:34:46.39\",\n \"modifiedUserId\": 0,\n \"taxTypeGroup\": \"EWaste\",\n \"nexusTaxTypeGroup\": \"SalesAndUse\",\n \"isSellerImporterOfRecord\": false,\n \"taxName\": \"Tire Fee\",\n \"taxableNexus\": true\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these nexus objects" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these nexus objects" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these nexus objects" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] }, { "name": "Create a new nexus", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"companyId\": 0,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"State\",\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"effectiveDate\": \"2017-04-01\",\n \"endDate\": \"2017-03-31\",\n \"shortName\": \"CALIFORNIA\",\n \"signatureCode\": \"\",\n \"stateAssignedNo\": \"\",\n \"nexusTypeId\": \"SalesOrSellersUseTax\",\n \"sourcing\": \"Destination\",\n \"hasLocalNexus\": false,\n \"hasPermanentEstablishment\": true,\n \"streamlinedSalesTax\": false,\n \"isSSTActive\": false,\n \"createdDate\": \"2017-06-30T05:14:06.003\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2022-04-20T01:34:46.39\",\n \"modifiedUserId\": 0,\n \"taxTypeGroup\": \"EWaste\",\n \"nexusTaxTypeGroup\": \"SalesAndUse\",\n \"isSellerImporterOfRecord\": false,\n \"taxName\": \"Tire Fee\",\n \"taxableNexus\": true\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"State\",\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"effectiveDate\": \"2017-04-01\",\n \"endDate\": \"2017-03-31\",\n \"shortName\": \"CALIFORNIA\",\n \"signatureCode\": \"\",\n \"stateAssignedNo\": \"\",\n \"nexusTypeId\": \"SalesOrSellersUseTax\",\n \"sourcing\": \"Destination\",\n \"hasLocalNexus\": false,\n \"hasPermanentEstablishment\": true,\n \"streamlinedSalesTax\": false,\n \"isSSTActive\": false,\n \"createdDate\": \"2017-06-30T05:14:06.003\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2022-04-20T01:34:46.39\",\n \"modifiedUserId\": 0,\n \"taxTypeGroup\": \"EWaste\",\n \"nexusTaxTypeGroup\": \"SalesAndUse\",\n \"isSellerImporterOfRecord\": false,\n \"taxName\": \"Tire Fee\",\n \"taxableNexus\": true\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this nexus." } ] }, "description": "Creates one or more new nexus declarations attached to this company.\r\n \r\nThe concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional\r\ntaxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your\r\naccountant or lawyer prior to declaring nexus.\r\n \r\nTo create a nexus declaration for your company, you must first call the Definitions API `ListNexus` to obtain a\r\nlist of Avalara-defined nexus. Once you have determined which nexus you wish to declare, you should customize\r\nonly the user-selectable fields in this object.\r\n \r\nThe user selectable fields for the nexus object are `companyId`, `effectiveDate`, `endDate`, `localNexusTypeId`,\r\n`taxId`, `nexusTypeId`, `hasPermanentEstablishment`, and `isSellerImporterOfRecord`.\r\n \r\nWhen calling `CreateNexus` or `UpdateNexus`, all values in your nexus object except for the user-selectable fields\r\nmust match an Avalara-defined system nexus object. You can retrieve a list of Avalara-defined system nexus objects\r\nby calling `ListNexus`. If any data does not match, AvaTax may not recognize your nexus declaration.\r\n \r\nPlease note that nexus changes may not take effect immediately and you should plan to update your nexus settings in advance\r\nof calculating tax for a location.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"companyId\": 0,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"State\",\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"effectiveDate\": \"2017-04-01\",\n \"endDate\": \"2017-03-31\",\n \"shortName\": \"CALIFORNIA\",\n \"signatureCode\": \"\",\n \"stateAssignedNo\": \"\",\n \"nexusTypeId\": \"SalesOrSellersUseTax\",\n \"sourcing\": \"Destination\",\n \"hasLocalNexus\": false,\n \"hasPermanentEstablishment\": true,\n \"streamlinedSalesTax\": false,\n \"isSSTActive\": false,\n \"createdDate\": \"2017-06-30T05:14:06.003\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2022-04-20T01:34:46.39\",\n \"modifiedUserId\": 0,\n \"taxTypeGroup\": \"EWaste\",\n \"nexusTaxTypeGroup\": \"SalesAndUse\",\n \"isSellerImporterOfRecord\": false,\n \"taxName\": \"Tire Fee\",\n \"taxableNexus\": true\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"State\",\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"effectiveDate\": \"2017-04-01\",\n \"endDate\": \"2017-03-31\",\n \"shortName\": \"CALIFORNIA\",\n \"signatureCode\": \"\",\n \"stateAssignedNo\": \"\",\n \"nexusTypeId\": \"SalesOrSellersUseTax\",\n \"sourcing\": \"Destination\",\n \"hasLocalNexus\": false,\n \"hasPermanentEstablishment\": true,\n \"streamlinedSalesTax\": false,\n \"isSSTActive\": false,\n \"createdDate\": \"2017-06-30T05:14:06.003\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2022-04-20T01:34:46.39\",\n \"modifiedUserId\": 0,\n \"taxTypeGroup\": \"EWaste\",\n \"nexusTaxTypeGroup\": \"SalesAndUse\",\n \"isSellerImporterOfRecord\": false,\n \"taxName\": \"Tire Fee\",\n \"taxableNexus\": true\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this nexus." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": 0,\n \"companyId\": 0,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"State\",\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"effectiveDate\": \"2017-04-01\",\n \"endDate\": \"2017-03-31\",\n \"shortName\": \"CALIFORNIA\",\n \"signatureCode\": \"\",\n \"stateAssignedNo\": \"\",\n \"nexusTypeId\": \"SalesOrSellersUseTax\",\n \"sourcing\": \"Destination\",\n \"hasLocalNexus\": false,\n \"hasPermanentEstablishment\": true,\n \"streamlinedSalesTax\": false,\n \"isSSTActive\": false,\n \"createdDate\": \"2017-06-30T05:14:06.003\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2022-04-20T01:34:46.39\",\n \"modifiedUserId\": 0,\n \"taxTypeGroup\": \"EWaste\",\n \"nexusTaxTypeGroup\": \"SalesAndUse\",\n \"isSellerImporterOfRecord\": false,\n \"taxName\": \"Tire Fee\",\n \"taxableNexus\": true\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"State\",\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"effectiveDate\": \"2017-04-01\",\n \"endDate\": \"2017-03-31\",\n \"shortName\": \"CALIFORNIA\",\n \"signatureCode\": \"\",\n \"stateAssignedNo\": \"\",\n \"nexusTypeId\": \"SalesOrSellersUseTax\",\n \"sourcing\": \"Destination\",\n \"hasLocalNexus\": false,\n \"hasPermanentEstablishment\": true,\n \"streamlinedSalesTax\": false,\n \"isSSTActive\": false,\n \"createdDate\": \"2017-06-30T05:14:06.003\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2022-04-20T01:34:46.39\",\n \"modifiedUserId\": 0,\n \"taxTypeGroup\": \"EWaste\",\n \"nexusTaxTypeGroup\": \"SalesAndUse\",\n \"isSellerImporterOfRecord\": false,\n \"taxName\": \"Tire Fee\",\n \"taxableNexus\": true\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"companyId\": 0,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"State\",\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"effectiveDate\": \"2017-04-01\",\n \"endDate\": \"2017-03-31\",\n \"shortName\": \"CALIFORNIA\",\n \"signatureCode\": \"\",\n \"stateAssignedNo\": \"\",\n \"nexusTypeId\": \"SalesOrSellersUseTax\",\n \"sourcing\": \"Destination\",\n \"hasLocalNexus\": false,\n \"hasPermanentEstablishment\": true,\n \"streamlinedSalesTax\": false,\n \"isSSTActive\": false,\n \"createdDate\": \"2017-06-30T05:14:06.003\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2022-04-20T01:34:46.39\",\n \"modifiedUserId\": 0,\n \"taxTypeGroup\": \"EWaste\",\n \"nexusTaxTypeGroup\": \"SalesAndUse\",\n \"isSellerImporterOfRecord\": false,\n \"taxName\": \"Tire Fee\",\n \"taxableNexus\": true\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"State\",\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"effectiveDate\": \"2017-04-01\",\n \"endDate\": \"2017-03-31\",\n \"shortName\": \"CALIFORNIA\",\n \"signatureCode\": \"\",\n \"stateAssignedNo\": \"\",\n \"nexusTypeId\": \"SalesOrSellersUseTax\",\n \"sourcing\": \"Destination\",\n \"hasLocalNexus\": false,\n \"hasPermanentEstablishment\": true,\n \"streamlinedSalesTax\": false,\n \"isSSTActive\": false,\n \"createdDate\": \"2017-06-30T05:14:06.003\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2022-04-20T01:34:46.39\",\n \"modifiedUserId\": 0,\n \"taxTypeGroup\": \"EWaste\",\n \"nexusTaxTypeGroup\": \"SalesAndUse\",\n \"isSellerImporterOfRecord\": false,\n \"taxName\": \"Tire Fee\",\n \"taxableNexus\": true\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this nexus." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"companyId\": 0,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"State\",\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"effectiveDate\": \"2017-04-01\",\n \"endDate\": \"2017-03-31\",\n \"shortName\": \"CALIFORNIA\",\n \"signatureCode\": \"\",\n \"stateAssignedNo\": \"\",\n \"nexusTypeId\": \"SalesOrSellersUseTax\",\n \"sourcing\": \"Destination\",\n \"hasLocalNexus\": false,\n \"hasPermanentEstablishment\": true,\n \"streamlinedSalesTax\": false,\n \"isSSTActive\": false,\n \"createdDate\": \"2017-06-30T05:14:06.003\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2022-04-20T01:34:46.39\",\n \"modifiedUserId\": 0,\n \"taxTypeGroup\": \"EWaste\",\n \"nexusTaxTypeGroup\": \"SalesAndUse\",\n \"isSellerImporterOfRecord\": false,\n \"taxName\": \"Tire Fee\",\n \"taxableNexus\": true\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"State\",\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"effectiveDate\": \"2017-04-01\",\n \"endDate\": \"2017-03-31\",\n \"shortName\": \"CALIFORNIA\",\n \"signatureCode\": \"\",\n \"stateAssignedNo\": \"\",\n \"nexusTypeId\": \"SalesOrSellersUseTax\",\n \"sourcing\": \"Destination\",\n \"hasLocalNexus\": false,\n \"hasPermanentEstablishment\": true,\n \"streamlinedSalesTax\": false,\n \"isSSTActive\": false,\n \"createdDate\": \"2017-06-30T05:14:06.003\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2022-04-20T01:34:46.39\",\n \"modifiedUserId\": 0,\n \"taxTypeGroup\": \"EWaste\",\n \"nexusTaxTypeGroup\": \"SalesAndUse\",\n \"isSellerImporterOfRecord\": false,\n \"taxName\": \"Tire Fee\",\n \"taxableNexus\": true\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this nexus." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 0,\n \"companyId\": 0,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"State\",\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"effectiveDate\": \"2017-04-01\",\n \"endDate\": \"2017-03-31\",\n \"shortName\": \"CALIFORNIA\",\n \"signatureCode\": \"\",\n \"stateAssignedNo\": \"\",\n \"nexusTypeId\": \"SalesOrSellersUseTax\",\n \"sourcing\": \"Destination\",\n \"hasLocalNexus\": false,\n \"hasPermanentEstablishment\": true,\n \"streamlinedSalesTax\": false,\n \"isSSTActive\": false,\n \"createdDate\": \"2017-06-30T05:14:06.003\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2022-04-20T01:34:46.39\",\n \"modifiedUserId\": 0,\n \"taxTypeGroup\": \"EWaste\",\n \"nexusTaxTypeGroup\": \"SalesAndUse\",\n \"isSellerImporterOfRecord\": false,\n \"taxName\": \"Tire Fee\",\n \"taxableNexus\": true\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"State\",\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"effectiveDate\": \"2017-04-01\",\n \"endDate\": \"2017-03-31\",\n \"shortName\": \"CALIFORNIA\",\n \"signatureCode\": \"\",\n \"stateAssignedNo\": \"\",\n \"nexusTypeId\": \"SalesOrSellersUseTax\",\n \"sourcing\": \"Destination\",\n \"hasLocalNexus\": false,\n \"hasPermanentEstablishment\": true,\n \"streamlinedSalesTax\": false,\n \"isSSTActive\": false,\n \"createdDate\": \"2017-06-30T05:14:06.003\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2022-04-20T01:34:46.39\",\n \"modifiedUserId\": 0,\n \"taxTypeGroup\": \"EWaste\",\n \"nexusTaxTypeGroup\": \"SalesAndUse\",\n \"isSellerImporterOfRecord\": false,\n \"taxName\": \"Tire Fee\",\n \"taxableNexus\": true\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/nexus", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "nexus" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this nexus." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "reports", "item": [ { "name": "exportdocumentline", "item": [ { "name": "initiate", "item": [ { "name": "Initiate an ExportDocumentLine report task", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"format\": \"CSV\",\n \"startDate\": \"2026-03-02T00:00:00+00:00\",\n \"endDate\": \"2026-04-02T00:00:00+00:00\",\n \"country\": \"US\",\n \"state\": \"All\",\n \"dateFilter\": \"DocumentDate\",\n \"docType\": \"Sales\",\n \"currencyCode\": \"USD\",\n \"isLocked\": false,\n \"merchantSellerIdentifier\": \"abc,xyz\",\n \"documentStatus\": \"Committed\",\n \"isModifiedDateSameAsDocumentDate\": false,\n \"taxGroup\": \"Alcohol\",\n \"taxName\": \"VAT\",\n \"taxCode\": \"123\",\n \"taxSubType\": \"Prepared Food and Beverage\",\n \"reportSource\": \"SNOWFLAKE\",\n \"compression\": \"NONE\",\n \"includeDocumentLineDetails\": false,\n \"includeMultiTaxLineDetails\": false,\n \"incorrectCurrencyOnly\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/reports/exportdocumentline/initiate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "reports", "exportdocumentline", "initiate" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company to report on." } ] }, "description": "Begins running an `ExportDocumentLine` report task and returns the identity of the report.\r\n \r\nReports are run as asynchronous report tasks on the server. When complete, the report file will be available for download\r\nfor up to 30 days after completion. To run an asynchronous report, you should follow these steps:\r\n \r\n* Begin a report by calling the report's Initiate API.\r\n* In the result of the Initiate API, you receive back a report's `id` value.\r\n* All reports with `InQueue` status are picked up by the report service and processed in the background.\r\n* Reports that are picked up by the report service will have an `InProgress` status.\r\n* Reports will be updated to `Completed` status when the report is ready for download.\r\n* Check the status of a report by calling `GetReport` and passing in the report's `id` value.\r\n* When a report's status is `Completed`, call `DownloadReport` to retrieve the file.\r\n \r\nThe `ExportDocumentLine` report produces information about invoice lines recorded within your account.\r\n \r\nSet `compression` to `GZIP` to reduce the size of the report file and increase download speed.\r\n \r\nThe currently supported reports are: **Document Line**, **Document Line Detail**, **Multitax Line Detail**, **Liability**, **Tax Region**, **AP Document**, **AP Document Detail**, and **Document Line Detail All Taxes**.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"format\": \"CSV\",\n \"startDate\": \"2026-03-02T00:00:00+00:00\",\n \"endDate\": \"2026-04-02T00:00:00+00:00\",\n \"country\": \"US\",\n \"state\": \"All\",\n \"dateFilter\": \"DocumentDate\",\n \"docType\": \"Sales\",\n \"currencyCode\": \"USD\",\n \"isLocked\": false,\n \"merchantSellerIdentifier\": \"abc,xyz\",\n \"documentStatus\": \"Committed\",\n \"isModifiedDateSameAsDocumentDate\": false,\n \"taxGroup\": \"Alcohol\",\n \"taxName\": \"VAT\",\n \"taxCode\": \"123\",\n \"taxSubType\": \"Prepared Food and Beverage\",\n \"reportSource\": \"SNOWFLAKE\",\n \"compression\": \"NONE\",\n \"includeDocumentLineDetails\": false,\n \"includeMultiTaxLineDetails\": false,\n \"incorrectCurrencyOnly\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/reports/exportdocumentline/initiate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "reports", "exportdocumentline", "initiate" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company to report on." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": 1,\n \"accountId\": 2087654354,\n \"companyId\": 2087654354,\n \"reportType\": \"ExportDocumentLine\",\n \"parameters\": {\n \"startDate\": \"2026-03-02T00:00:00+00:00\",\n \"endDate\": \"2026-04-02T00:00:00+00:00\",\n \"country\": \"US\",\n \"state\": \"All\",\n \"dateFilter\": \"DD\",\n \"docType\": \"S\",\n \"dateFormat\": \"MM/dd/yyyy\",\n \"currencyCode\": \"USD\",\n \"isLocked\": false,\n \"merchantSellerId\": \"abcd\",\n \"documentStatus\": \"Commited\",\n \"isModifiedDateSameAsDocumentDate\": false,\n \"taxGroup\": \"Alcohol\",\n \"taxName\": \"VAT\",\n \"taxCode\": \"123\",\n \"taxSubType\": \"Amusement\",\n \"compression\": \"NONE\",\n \"includeDocumentLineDetails\": false,\n \"includeMultiTaxLineDetails\": false,\n \"incorrectCurrencyOnly\": false\n },\n \"status\": \"InQueue\",\n \"format\": \"CSV\",\n \"file\": \"2087654354_2087654354_1_ExportDocumentLine.CSV\",\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"createdUserId\": 0\n },\n {\n \"id\": 1,\n \"accountId\": 2087654354,\n \"companyId\": 2087654354,\n \"reportType\": \"ExportDocumentLine\",\n \"parameters\": {\n \"startDate\": \"2026-03-02T00:00:00+00:00\",\n \"endDate\": \"2026-04-02T00:00:00+00:00\",\n \"country\": \"US\",\n \"state\": \"All\",\n \"dateFilter\": \"DD\",\n \"docType\": \"S\",\n \"dateFormat\": \"MM/dd/yyyy\",\n \"currencyCode\": \"USD\",\n \"isLocked\": false,\n \"merchantSellerId\": \"abcd\",\n \"documentStatus\": \"Commited\",\n \"isModifiedDateSameAsDocumentDate\": false,\n \"taxGroup\": \"Alcohol\",\n \"taxName\": \"VAT\",\n \"taxCode\": \"123\",\n \"taxSubType\": \"Amusement\",\n \"compression\": \"NONE\",\n \"includeDocumentLineDetails\": false,\n \"includeMultiTaxLineDetails\": false,\n \"incorrectCurrencyOnly\": false\n },\n \"status\": \"InQueue\",\n \"format\": \"CSV\",\n \"file\": \"2087654354_2087654354_1_ExportDocumentLine.CSV\",\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"createdUserId\": 0\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"format\": \"CSV\",\n \"startDate\": \"2026-03-02T00:00:00+00:00\",\n \"endDate\": \"2026-04-02T00:00:00+00:00\",\n \"country\": \"US\",\n \"state\": \"All\",\n \"dateFilter\": \"DocumentDate\",\n \"docType\": \"Sales\",\n \"currencyCode\": \"USD\",\n \"isLocked\": false,\n \"merchantSellerIdentifier\": \"abc,xyz\",\n \"documentStatus\": \"Committed\",\n \"isModifiedDateSameAsDocumentDate\": false,\n \"taxGroup\": \"Alcohol\",\n \"taxName\": \"VAT\",\n \"taxCode\": \"123\",\n \"taxSubType\": \"Prepared Food and Beverage\",\n \"reportSource\": \"SNOWFLAKE\",\n \"compression\": \"NONE\",\n \"includeDocumentLineDetails\": false,\n \"includeMultiTaxLineDetails\": false,\n \"incorrectCurrencyOnly\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/reports/exportdocumentline/initiate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "reports", "exportdocumentline", "initiate" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company to report on." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"format\": \"CSV\",\n \"startDate\": \"2026-03-02T00:00:00+00:00\",\n \"endDate\": \"2026-04-02T00:00:00+00:00\",\n \"country\": \"US\",\n \"state\": \"All\",\n \"dateFilter\": \"DocumentDate\",\n \"docType\": \"Sales\",\n \"currencyCode\": \"USD\",\n \"isLocked\": false,\n \"merchantSellerIdentifier\": \"abc,xyz\",\n \"documentStatus\": \"Committed\",\n \"isModifiedDateSameAsDocumentDate\": false,\n \"taxGroup\": \"Alcohol\",\n \"taxName\": \"VAT\",\n \"taxCode\": \"123\",\n \"taxSubType\": \"Prepared Food and Beverage\",\n \"reportSource\": \"SNOWFLAKE\",\n \"compression\": \"NONE\",\n \"includeDocumentLineDetails\": false,\n \"includeMultiTaxLineDetails\": false,\n \"incorrectCurrencyOnly\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/reports/exportdocumentline/initiate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "reports", "exportdocumentline", "initiate" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company to report on." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"format\": \"CSV\",\n \"startDate\": \"2026-03-02T00:00:00+00:00\",\n \"endDate\": \"2026-04-02T00:00:00+00:00\",\n \"country\": \"US\",\n \"state\": \"All\",\n \"dateFilter\": \"DocumentDate\",\n \"docType\": \"Sales\",\n \"currencyCode\": \"USD\",\n \"isLocked\": false,\n \"merchantSellerIdentifier\": \"abc,xyz\",\n \"documentStatus\": \"Committed\",\n \"isModifiedDateSameAsDocumentDate\": false,\n \"taxGroup\": \"Alcohol\",\n \"taxName\": \"VAT\",\n \"taxCode\": \"123\",\n \"taxSubType\": \"Prepared Food and Beverage\",\n \"reportSource\": \"SNOWFLAKE\",\n \"compression\": \"NONE\",\n \"includeDocumentLineDetails\": false,\n \"includeMultiTaxLineDetails\": false,\n \"incorrectCurrencyOnly\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/reports/exportdocumentline/initiate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "reports", "exportdocumentline", "initiate" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company to report on." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] } ] }, { "name": "settings", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a single setting", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/settings/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "settings", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this setting" }, { "key": "id", "value": "451", "description": "The primary key of this setting" } ] }, "description": "Get a single setting object by its unique ID.\r\n \r\nThe company settings system is a metadata system that you can use to store extra information\r\nabout a company. Your integration or connector could use this data storage to keep track of\r\npreference information, reminders, or any other storage that would need to persist even if\r\nthe customer uninstalls your application.\r\n \r\nA setting can refer to any type of data you need to remember about this company object.\r\nWhen creating this object, you may define your own `set`, `name`, and `value` parameters.\r\nTo define your own values, please choose a `set` name that begins with `X-` to indicate an extension.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/settings/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "settings", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this setting" }, { "key": "id", "value": "451", "description": "The primary key of this setting" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 56789,\n \"companyId\": 12345,\n \"set\": \"ItemsToRemember\",\n \"name\": \"Texas\",\n \"value\": \"Alamo\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/settings/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "settings", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this setting" }, { "key": "id", "value": "451", "description": "The primary key of this setting" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/settings/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "settings", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this setting" }, { "key": "id", "value": "451", "description": "The primary key of this setting" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/settings/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "settings", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this setting" }, { "key": "id", "value": "451", "description": "The primary key of this setting" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Update a single setting", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 56789,\n \"companyId\": 12345,\n \"set\": \"ItemsToRemember\",\n \"name\": \"Texas\",\n \"value\": \"Alamo\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/settings/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "settings", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this setting belongs to." }, { "key": "id", "value": "451", "description": "The ID of the setting you wish to update" } ] }, "description": "Replace the existing setting object at this URL with an updated object.\r\n \r\nThe company settings system is a metadata system that you can use to store extra information\r\nabout a company. Your integration or connector could use this data storage to keep track of\r\npreference information, reminders, or any other storage that would need to persist even if\r\nthe customer uninstalls your application.\r\n \r\nA setting can refer to any type of data you need to remember about this company object.\r\nWhen creating this object, you may define your own `set`, `name`, and `value` parameters.\r\nTo define your own values, please choose a `set` name that begins with `X-` to indicate an extension.\r\n \r\nAll data from the existing object will be replaced with data in the object you `PUT`.\r\n \r\nTo 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.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 56789,\n \"companyId\": 12345,\n \"set\": \"ItemsToRemember\",\n \"name\": \"Texas\",\n \"value\": \"Alamo\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/settings/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "settings", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this setting belongs to." }, { "key": "id", "value": "451", "description": "The ID of the setting you wish to update" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 56789,\n \"companyId\": 12345,\n \"set\": \"ItemsToRemember\",\n \"name\": \"Texas\",\n \"value\": \"Alamo\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 56789,\n \"companyId\": 12345,\n \"set\": \"ItemsToRemember\",\n \"name\": \"Texas\",\n \"value\": \"Alamo\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/settings/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "settings", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this setting belongs to." }, { "key": "id", "value": "451", "description": "The ID of the setting you wish to update" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 56789,\n \"companyId\": 12345,\n \"set\": \"ItemsToRemember\",\n \"name\": \"Texas\",\n \"value\": \"Alamo\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/settings/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "settings", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this setting belongs to." }, { "key": "id", "value": "451", "description": "The ID of the setting you wish to update" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 56789,\n \"companyId\": 12345,\n \"set\": \"ItemsToRemember\",\n \"name\": \"Texas\",\n \"value\": \"Alamo\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/settings/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "settings", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this setting belongs to." }, { "key": "id", "value": "451", "description": "The ID of the setting you wish to update" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete a single setting", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/settings/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "settings", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this setting." }, { "key": "id", "value": "451", "description": "The ID of the setting you wish to delete." } ] }, "description": "Mark the setting object at this URL as deleted.\r\n \r\nThe company settings system is a metadata system that you can use to store extra information\r\nabout a company. Your integration or connector could use this data storage to keep track of\r\npreference information, reminders, or any other storage that would need to persist even if\r\nthe customer uninstalls your application.\r\n \r\nA setting can refer to any type of data you need to remember about this company object.\r\nWhen creating this object, you may define your own `set`, `name`, and `value` parameters.\r\nTo define your own values, please choose a `set` name that begins with `X-` to indicate an extension.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/settings/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "settings", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this setting." }, { "key": "id", "value": "451", "description": "The ID of the setting you wish to delete." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/settings/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "settings", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this setting." }, { "key": "id", "value": "451", "description": "The ID of the setting you wish to delete." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/settings/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "settings", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this setting." }, { "key": "id", "value": "451", "description": "The ID of the setting you wish to delete." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/settings/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "settings", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this setting." }, { "key": "id", "value": "451", "description": "The ID of the setting you wish to delete." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Retrieve all settings for this company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/settings?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "settings" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* modifiedDate, ModifiedUserId" }, { "key": "$include", "value": "string", "description": "A comma separated list of additional data to retrieve." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these settings" } ] }, "description": "List all setting objects attached to this company.\r\n \r\nThe company settings system is a metadata system that you can use to store extra information\r\nabout a company. Your integration or connector could use this data storage to keep track of\r\npreference information, reminders, or any other storage that would need to persist even if\r\nthe customer uninstalls your application.\r\n \r\nA setting can refer to any type of data you need to remember about this company object.\r\nWhen creating this object, you may define your own `set`, `name`, and `value` parameters.\r\nTo define your own values, please choose a `set` name that begins with `X-` to indicate an extension.\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/settings?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "settings" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* modifiedDate, ModifiedUserId", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these settings" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 9178,\n \"value\": [\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"set\": \"ItemsToRemember\",\n \"name\": \"Texas\",\n \"value\": \"Alamo\"\n },\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"set\": \"ItemsToRemember\",\n \"name\": \"Texas\",\n \"value\": \"Alamo\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/settings?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "settings" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* modifiedDate, ModifiedUserId", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these settings" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/settings?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "settings" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* modifiedDate, ModifiedUserId", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these settings" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/settings?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "settings" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* modifiedDate, ModifiedUserId", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these settings" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Create a new setting", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"set\": \"ItemsToRemember\",\n \"name\": \"Texas\",\n \"value\": \"Alamo\"\n },\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"set\": \"ItemsToRemember\",\n \"name\": \"Texas\",\n \"value\": \"Alamo\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "settings" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this setting." } ] }, "description": "Create one or more new setting objects attached to this company.\r\n \r\nThe company settings system is a metadata system that you can use to store extra information\r\nabout a company. Your integration or connector could use this data storage to keep track of\r\npreference information, reminders, or any other storage that would need to persist even if\r\nthe customer uninstalls your application.\r\n \r\nA setting can refer to any type of data you need to remember about this company object.\r\nWhen creating this object, you may define your own `set`, `name`, and `value` parameters.\r\nTo define your own values, please choose a `set` name that begins with `X-` to indicate an extension.\r\n \r\nUse Set = Transactions, Name = TaxCodePrioritization/HSCodePrioritization and Value = Transaction/ItemMaster for prioritizing which TaxCodes/HsCodes should be used for calculating taxes.\r\n \r\nExample: To prioritize TaxCodes passed in a Transaction over values stored with Items when calculating tax, use\r\nSet = Transactions, Name = TaxCodePrioritization, Value = Transaction\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"set\": \"ItemsToRemember\",\n \"name\": \"Texas\",\n \"value\": \"Alamo\"\n },\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"set\": \"ItemsToRemember\",\n \"name\": \"Texas\",\n \"value\": \"Alamo\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "settings" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this setting." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"set\": \"ItemsToRemember\",\n \"name\": \"Texas\",\n \"value\": \"Alamo\"\n },\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"set\": \"ItemsToRemember\",\n \"name\": \"Texas\",\n \"value\": \"Alamo\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"set\": \"ItemsToRemember\",\n \"name\": \"Texas\",\n \"value\": \"Alamo\"\n },\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"set\": \"ItemsToRemember\",\n \"name\": \"Texas\",\n \"value\": \"Alamo\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "settings" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this setting." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"set\": \"ItemsToRemember\",\n \"name\": \"Texas\",\n \"value\": \"Alamo\"\n },\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"set\": \"ItemsToRemember\",\n \"name\": \"Texas\",\n \"value\": \"Alamo\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "settings" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this setting." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"set\": \"ItemsToRemember\",\n \"name\": \"Texas\",\n \"value\": \"Alamo\"\n },\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"set\": \"ItemsToRemember\",\n \"name\": \"Texas\",\n \"value\": \"Alamo\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "settings" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this setting." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "taxcodes", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a single tax code", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxcodes/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxcodes", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this tax code" }, { "key": "id", "value": "451", "description": "The primary key of this tax code" } ] }, "description": "Get the taxcode object identified by this URL.\r\nA 'TaxCode' represents a uniquely identified type of product, good, or service.\r\nAvalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.\r\nIf you identify your products by tax code in your 'Create Transaction' API calls, Avalara will correctly calculate tax rates and\r\ntaxability rules for this product in all supported jurisdictions.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxcodes/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxcodes", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this tax code" }, { "key": "id", "value": "451", "description": "The primary key of this tax code" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 56789,\n \"companyId\": 12345,\n \"taxCode\": \"PS081282\",\n \"taxCodeTypeId\": \"P\",\n \"description\": \"Yarn\",\n \"parentTaxCode\": \"PS080100\",\n \"isPhysical\": true,\n \"goodsServiceCode\": 0,\n \"entityUseCode\": \"\",\n \"isActive\": true,\n \"isSSTCertified\": false\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxcodes/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxcodes", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this tax code" }, { "key": "id", "value": "451", "description": "The primary key of this tax code" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxcodes/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxcodes", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this tax code" }, { "key": "id", "value": "451", "description": "The primary key of this tax code" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxcodes/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxcodes", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this tax code" }, { "key": "id", "value": "451", "description": "The primary key of this tax code" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Update a single tax code", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 56789,\n \"companyId\": 12345,\n \"taxCode\": \"PS081282\",\n \"taxCodeTypeId\": \"P\",\n \"description\": \"Yarn\",\n \"parentTaxCode\": \"PS080100\",\n \"isPhysical\": true,\n \"goodsServiceCode\": 0,\n \"entityUseCode\": \"\",\n \"isActive\": true,\n \"isSSTCertified\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxcodes/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxcodes", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this tax code belongs to." }, { "key": "id", "value": "451", "description": "The ID of the tax code you wish to update" } ] }, "description": "Replace the existing taxcode object at this URL with an updated object.\r\nA 'TaxCode' represents a uniquely identified type of product, good, or service.\r\nAvalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.\r\nIf you identify your products by tax code in your 'Create Transaction' API calls, Avalara will correctly calculate tax rates and\r\ntaxability rules for this product in all supported jurisdictions.\r\nAll data from the existing object will be replaced with data in the object you PUT.\r\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.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 56789,\n \"companyId\": 12345,\n \"taxCode\": \"PS081282\",\n \"taxCodeTypeId\": \"P\",\n \"description\": \"Yarn\",\n \"parentTaxCode\": \"PS080100\",\n \"isPhysical\": true,\n \"goodsServiceCode\": 0,\n \"entityUseCode\": \"\",\n \"isActive\": true,\n \"isSSTCertified\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxcodes/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxcodes", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this tax code belongs to." }, { "key": "id", "value": "451", "description": "The ID of the tax code you wish to update" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 56789,\n \"companyId\": 12345,\n \"taxCode\": \"PS081282\",\n \"taxCodeTypeId\": \"P\",\n \"description\": \"Yarn\",\n \"parentTaxCode\": \"PS080100\",\n \"isPhysical\": true,\n \"goodsServiceCode\": 0,\n \"entityUseCode\": \"\",\n \"isActive\": true,\n \"isSSTCertified\": false\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 56789,\n \"companyId\": 12345,\n \"taxCode\": \"PS081282\",\n \"taxCodeTypeId\": \"P\",\n \"description\": \"Yarn\",\n \"parentTaxCode\": \"PS080100\",\n \"isPhysical\": true,\n \"goodsServiceCode\": 0,\n \"entityUseCode\": \"\",\n \"isActive\": true,\n \"isSSTCertified\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxcodes/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxcodes", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this tax code belongs to." }, { "key": "id", "value": "451", "description": "The ID of the tax code you wish to update" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 56789,\n \"companyId\": 12345,\n \"taxCode\": \"PS081282\",\n \"taxCodeTypeId\": \"P\",\n \"description\": \"Yarn\",\n \"parentTaxCode\": \"PS080100\",\n \"isPhysical\": true,\n \"goodsServiceCode\": 0,\n \"entityUseCode\": \"\",\n \"isActive\": true,\n \"isSSTCertified\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxcodes/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxcodes", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this tax code belongs to." }, { "key": "id", "value": "451", "description": "The ID of the tax code you wish to update" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 56789,\n \"companyId\": 12345,\n \"taxCode\": \"PS081282\",\n \"taxCodeTypeId\": \"P\",\n \"description\": \"Yarn\",\n \"parentTaxCode\": \"PS080100\",\n \"isPhysical\": true,\n \"goodsServiceCode\": 0,\n \"entityUseCode\": \"\",\n \"isActive\": true,\n \"isSSTCertified\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxcodes/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxcodes", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this tax code belongs to." }, { "key": "id", "value": "451", "description": "The ID of the tax code you wish to update" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete a single tax code", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxcodes/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxcodes", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this tax code." }, { "key": "id", "value": "451", "description": "The ID of the tax code you wish to delete." } ] }, "description": "Marks the existing TaxCode object at this URL as deleted.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxcodes/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxcodes", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this tax code." }, { "key": "id", "value": "451", "description": "The ID of the tax code you wish to delete." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxcodes/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxcodes", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this tax code." }, { "key": "id", "value": "451", "description": "The ID of the tax code you wish to delete." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxcodes/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxcodes", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this tax code." }, { "key": "id", "value": "451", "description": "The ID of the tax code you wish to delete." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxcodes/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxcodes", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this tax code." }, { "key": "id", "value": "451", "description": "The ID of the tax code you wish to delete." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Retrieve tax codes for this company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxcodes?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxcodes" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/)." }, { "key": "$include", "value": "string", "description": "A comma separated list of additional data to retrieve." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these tax codes" } ] }, "description": "List all taxcode objects attached to this company.\r\nA 'TaxCode' represents a uniquely identified type of product, good, or service.\r\nAvalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.\r\nIf you identify your products by tax code in your 'Create Transaction' API calls, Avalara will correctly calculate tax rates and\r\ntaxability rules for this product in all supported jurisdictions.\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxcodes?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxcodes" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these tax codes" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 6614,\n \"value\": [\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"taxCode\": \"PS081282\",\n \"taxCodeTypeId\": \"P\",\n \"description\": \"Yarn\",\n \"parentTaxCode\": \"PS080100\",\n \"isPhysical\": true,\n \"goodsServiceCode\": 0,\n \"entityUseCode\": \"\",\n \"isActive\": true,\n \"isSSTCertified\": false\n },\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"taxCode\": \"PS081282\",\n \"taxCodeTypeId\": \"P\",\n \"description\": \"Yarn\",\n \"parentTaxCode\": \"PS080100\",\n \"isPhysical\": true,\n \"goodsServiceCode\": 0,\n \"entityUseCode\": \"\",\n \"isActive\": true,\n \"isSSTCertified\": false\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxcodes?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxcodes" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these tax codes" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxcodes?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxcodes" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these tax codes" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxcodes?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxcodes" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these tax codes" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Create a new tax code", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"taxCode\": \"PS081282\",\n \"taxCodeTypeId\": \"P\",\n \"description\": \"Yarn\",\n \"parentTaxCode\": \"PS080100\",\n \"isPhysical\": true,\n \"goodsServiceCode\": 0,\n \"entityUseCode\": \"\",\n \"isActive\": true,\n \"isSSTCertified\": false\n },\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"taxCode\": \"PS081282\",\n \"taxCodeTypeId\": \"P\",\n \"description\": \"Yarn\",\n \"parentTaxCode\": \"PS080100\",\n \"isPhysical\": true,\n \"goodsServiceCode\": 0,\n \"entityUseCode\": \"\",\n \"isActive\": true,\n \"isSSTCertified\": false\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxcodes", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxcodes" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this tax code." } ] }, "description": "Create one or more new taxcode objects attached to this company.\r\nA 'TaxCode' represents a uniquely identified type of product, good, or service.\r\nAvalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.\r\nIf you identify your products by tax code in your 'Create Transaction' API calls, Avalara will correctly calculate tax rates and\r\ntaxability rules for this product in all supported jurisdictions.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"taxCode\": \"PS081282\",\n \"taxCodeTypeId\": \"P\",\n \"description\": \"Yarn\",\n \"parentTaxCode\": \"PS080100\",\n \"isPhysical\": true,\n \"goodsServiceCode\": 0,\n \"entityUseCode\": \"\",\n \"isActive\": true,\n \"isSSTCertified\": false\n },\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"taxCode\": \"PS081282\",\n \"taxCodeTypeId\": \"P\",\n \"description\": \"Yarn\",\n \"parentTaxCode\": \"PS080100\",\n \"isPhysical\": true,\n \"goodsServiceCode\": 0,\n \"entityUseCode\": \"\",\n \"isActive\": true,\n \"isSSTCertified\": false\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxcodes", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxcodes" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this tax code." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"taxCode\": \"PS081282\",\n \"taxCodeTypeId\": \"P\",\n \"description\": \"Yarn\",\n \"parentTaxCode\": \"PS080100\",\n \"isPhysical\": true,\n \"goodsServiceCode\": 0,\n \"entityUseCode\": \"\",\n \"isActive\": true,\n \"isSSTCertified\": false\n },\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"taxCode\": \"PS081282\",\n \"taxCodeTypeId\": \"P\",\n \"description\": \"Yarn\",\n \"parentTaxCode\": \"PS080100\",\n \"isPhysical\": true,\n \"goodsServiceCode\": 0,\n \"entityUseCode\": \"\",\n \"isActive\": true,\n \"isSSTCertified\": false\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"taxCode\": \"PS081282\",\n \"taxCodeTypeId\": \"P\",\n \"description\": \"Yarn\",\n \"parentTaxCode\": \"PS080100\",\n \"isPhysical\": true,\n \"goodsServiceCode\": 0,\n \"entityUseCode\": \"\",\n \"isActive\": true,\n \"isSSTCertified\": false\n },\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"taxCode\": \"PS081282\",\n \"taxCodeTypeId\": \"P\",\n \"description\": \"Yarn\",\n \"parentTaxCode\": \"PS080100\",\n \"isPhysical\": true,\n \"goodsServiceCode\": 0,\n \"entityUseCode\": \"\",\n \"isActive\": true,\n \"isSSTCertified\": false\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxcodes", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxcodes" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this tax code." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"taxCode\": \"PS081282\",\n \"taxCodeTypeId\": \"P\",\n \"description\": \"Yarn\",\n \"parentTaxCode\": \"PS080100\",\n \"isPhysical\": true,\n \"goodsServiceCode\": 0,\n \"entityUseCode\": \"\",\n \"isActive\": true,\n \"isSSTCertified\": false\n },\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"taxCode\": \"PS081282\",\n \"taxCodeTypeId\": \"P\",\n \"description\": \"Yarn\",\n \"parentTaxCode\": \"PS080100\",\n \"isPhysical\": true,\n \"goodsServiceCode\": 0,\n \"entityUseCode\": \"\",\n \"isActive\": true,\n \"isSSTCertified\": false\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxcodes", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxcodes" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this tax code." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"taxCode\": \"PS081282\",\n \"taxCodeTypeId\": \"P\",\n \"description\": \"Yarn\",\n \"parentTaxCode\": \"PS080100\",\n \"isPhysical\": true,\n \"goodsServiceCode\": 0,\n \"entityUseCode\": \"\",\n \"isActive\": true,\n \"isSSTCertified\": false\n },\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"taxCode\": \"PS081282\",\n \"taxCodeTypeId\": \"P\",\n \"description\": \"Yarn\",\n \"parentTaxCode\": \"PS080100\",\n \"isPhysical\": true,\n \"goodsServiceCode\": 0,\n \"entityUseCode\": \"\",\n \"isActive\": true,\n \"isSSTCertified\": false\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxcodes", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxcodes" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this tax code." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "taxrules", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a single tax rule", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxrules/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxrules", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this tax rule" }, { "key": "id", "value": "451", "description": "The primary key of this tax rule" } ] }, "description": "Get the taxrule object identified by this URL.\r\n \r\nA tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules\r\ncan be used to change the taxability of an item, to change the tax base of an item, or to change the tax rate\r\ncharged when selling an item. Tax rules can also change tax behavior depending on the `entityUseCode` value submitted\r\nwith the transaction.\r\n \r\nYou can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your\r\nbusiness. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use\r\ncustom tax rules to redefine the behavior for your company or item.\r\n \r\nPlease use custom tax rules carefully and ensure that these tax rules match the behavior agreed upon with your\r\nauditor, legal representative, and accounting team.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxrules/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxrules", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this tax rule" }, { "key": "id", "value": "451", "description": "The primary key of this tax rule" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 56789,\n \"companyId\": 12345,\n \"taxCode\": \"FR020800\",\n \"stateFIPS\": \"04\",\n \"jurisName\": \"MARICOPA\",\n \"jurisCode\": \"013\",\n \"jurisTypeId\": 0,\n \"jurisdictionTypeId\": \"County\",\n \"taxTypeId\": \"BothSalesAndUseTax\",\n \"taxTypeCode\": \"ALL\",\n \"taxRuleTypeId\": \"ProductTaxabilityRule\",\n \"isAllJuris\": false,\n \"value\": 0,\n \"cap\": 0,\n \"threshold\": 0,\n \"effectiveDate\": \"2026-04-02\",\n \"description\": \"Freight\",\n \"countyFIPS\": \"013\",\n \"country\": \"US\",\n \"region\": \"AZ\",\n \"taxTypeGroup\": \"SalesAndUse\",\n \"taxSubType\": \"ALL\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxrules/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxrules", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this tax rule" }, { "key": "id", "value": "451", "description": "The primary key of this tax rule" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxrules/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxrules", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this tax rule" }, { "key": "id", "value": "451", "description": "The primary key of this tax rule" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxrules/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxrules", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this tax rule" }, { "key": "id", "value": "451", "description": "The primary key of this tax rule" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Update a single tax rule", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 56789,\n \"companyId\": 12345,\n \"taxCode\": \"FR020800\",\n \"stateFIPS\": \"04\",\n \"jurisName\": \"MARICOPA\",\n \"jurisCode\": \"013\",\n \"jurisTypeId\": 0,\n \"jurisdictionTypeId\": \"County\",\n \"taxTypeId\": \"BothSalesAndUseTax\",\n \"taxTypeCode\": \"ALL\",\n \"taxRuleTypeId\": \"ProductTaxabilityRule\",\n \"isAllJuris\": false,\n \"value\": 0,\n \"cap\": 0,\n \"threshold\": 0,\n \"effectiveDate\": \"2026-04-02\",\n \"description\": \"Freight\",\n \"countyFIPS\": \"013\",\n \"country\": \"US\",\n \"region\": \"AZ\",\n \"taxTypeGroup\": \"SalesAndUse\",\n \"taxSubType\": \"ALL\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxrules/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxrules", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this tax rule belongs to." }, { "key": "id", "value": "451", "description": "The ID of the tax rule you wish to update" } ] }, "description": "Replace the existing custom tax rule object at this URL with an updated object.\r\n \r\nA tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules\r\ncan be used to change the taxability of an item, to change the tax base of an item, or to change the tax rate\r\ncharged when selling an item. Tax rules can also change tax behavior depending on the `entityUseCode` value submitted\r\nwith the transaction.\r\n \r\nYou can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your\r\nbusiness. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use\r\ncustom tax rules to redefine the behavior for your company or item.\r\n \r\nPlease use custom tax rules carefully and ensure that these tax rules match the behavior agreed upon with your\r\nauditor, legal representative, and accounting team.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 56789,\n \"companyId\": 12345,\n \"taxCode\": \"FR020800\",\n \"stateFIPS\": \"04\",\n \"jurisName\": \"MARICOPA\",\n \"jurisCode\": \"013\",\n \"jurisTypeId\": 0,\n \"jurisdictionTypeId\": \"County\",\n \"taxTypeId\": \"BothSalesAndUseTax\",\n \"taxTypeCode\": \"ALL\",\n \"taxRuleTypeId\": \"ProductTaxabilityRule\",\n \"isAllJuris\": false,\n \"value\": 0,\n \"cap\": 0,\n \"threshold\": 0,\n \"effectiveDate\": \"2026-04-02\",\n \"description\": \"Freight\",\n \"countyFIPS\": \"013\",\n \"country\": \"US\",\n \"region\": \"AZ\",\n \"taxTypeGroup\": \"SalesAndUse\",\n \"taxSubType\": \"ALL\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxrules/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxrules", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this tax rule belongs to." }, { "key": "id", "value": "451", "description": "The ID of the tax rule you wish to update" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 56789,\n \"companyId\": 12345,\n \"taxCode\": \"FR020800\",\n \"stateFIPS\": \"04\",\n \"jurisName\": \"MARICOPA\",\n \"jurisCode\": \"013\",\n \"jurisTypeId\": 0,\n \"jurisdictionTypeId\": \"County\",\n \"taxTypeId\": \"BothSalesAndUseTax\",\n \"taxTypeCode\": \"ALL\",\n \"taxRuleTypeId\": \"ProductTaxabilityRule\",\n \"isAllJuris\": false,\n \"value\": 0,\n \"cap\": 0,\n \"threshold\": 0,\n \"effectiveDate\": \"2026-04-02\",\n \"description\": \"Freight\",\n \"countyFIPS\": \"013\",\n \"country\": \"US\",\n \"region\": \"AZ\",\n \"taxTypeGroup\": \"SalesAndUse\",\n \"taxSubType\": \"ALL\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 56789,\n \"companyId\": 12345,\n \"taxCode\": \"FR020800\",\n \"stateFIPS\": \"04\",\n \"jurisName\": \"MARICOPA\",\n \"jurisCode\": \"013\",\n \"jurisTypeId\": 0,\n \"jurisdictionTypeId\": \"County\",\n \"taxTypeId\": \"BothSalesAndUseTax\",\n \"taxTypeCode\": \"ALL\",\n \"taxRuleTypeId\": \"ProductTaxabilityRule\",\n \"isAllJuris\": false,\n \"value\": 0,\n \"cap\": 0,\n \"threshold\": 0,\n \"effectiveDate\": \"2026-04-02\",\n \"description\": \"Freight\",\n \"countyFIPS\": \"013\",\n \"country\": \"US\",\n \"region\": \"AZ\",\n \"taxTypeGroup\": \"SalesAndUse\",\n \"taxSubType\": \"ALL\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxrules/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxrules", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this tax rule belongs to." }, { "key": "id", "value": "451", "description": "The ID of the tax rule you wish to update" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 56789,\n \"companyId\": 12345,\n \"taxCode\": \"FR020800\",\n \"stateFIPS\": \"04\",\n \"jurisName\": \"MARICOPA\",\n \"jurisCode\": \"013\",\n \"jurisTypeId\": 0,\n \"jurisdictionTypeId\": \"County\",\n \"taxTypeId\": \"BothSalesAndUseTax\",\n \"taxTypeCode\": \"ALL\",\n \"taxRuleTypeId\": \"ProductTaxabilityRule\",\n \"isAllJuris\": false,\n \"value\": 0,\n \"cap\": 0,\n \"threshold\": 0,\n \"effectiveDate\": \"2026-04-02\",\n \"description\": \"Freight\",\n \"countyFIPS\": \"013\",\n \"country\": \"US\",\n \"region\": \"AZ\",\n \"taxTypeGroup\": \"SalesAndUse\",\n \"taxSubType\": \"ALL\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxrules/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxrules", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this tax rule belongs to." }, { "key": "id", "value": "451", "description": "The ID of the tax rule you wish to update" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 56789,\n \"companyId\": 12345,\n \"taxCode\": \"FR020800\",\n \"stateFIPS\": \"04\",\n \"jurisName\": \"MARICOPA\",\n \"jurisCode\": \"013\",\n \"jurisTypeId\": 0,\n \"jurisdictionTypeId\": \"County\",\n \"taxTypeId\": \"BothSalesAndUseTax\",\n \"taxTypeCode\": \"ALL\",\n \"taxRuleTypeId\": \"ProductTaxabilityRule\",\n \"isAllJuris\": false,\n \"value\": 0,\n \"cap\": 0,\n \"threshold\": 0,\n \"effectiveDate\": \"2026-04-02\",\n \"description\": \"Freight\",\n \"countyFIPS\": \"013\",\n \"country\": \"US\",\n \"region\": \"AZ\",\n \"taxTypeGroup\": \"SalesAndUse\",\n \"taxSubType\": \"ALL\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxrules/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxrules", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this tax rule belongs to." }, { "key": "id", "value": "451", "description": "The ID of the tax rule you wish to update" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete a single tax rule", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxrules/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxrules", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this tax rule." }, { "key": "id", "value": "451", "description": "The ID of the tax rule you wish to delete." } ] }, "description": "Mark the custom tax rule identified by this URL as deleted.\r\n \r\nA tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules\r\ncan be used to change the taxability of an item, to change the tax base of an item, or to change the tax rate\r\ncharged when selling an item. Tax rules can also change tax behavior depending on the `entityUseCode` value submitted\r\nwith the transaction.\r\n \r\nYou can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your\r\nbusiness. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use\r\ncustom tax rules to redefine the behavior for your company or item.\r\n \r\nPlease use custom tax rules carefully and ensure that these tax rules match the behavior agreed upon with your\r\nauditor, legal representative, and accounting team.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxrules/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxrules", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this tax rule." }, { "key": "id", "value": "451", "description": "The ID of the tax rule you wish to delete." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxrules/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxrules", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this tax rule." }, { "key": "id", "value": "451", "description": "The ID of the tax rule you wish to delete." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxrules/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxrules", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this tax rule." }, { "key": "id", "value": "451", "description": "The ID of the tax rule you wish to delete." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxrules/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxrules", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this tax rule." }, { "key": "id", "value": "451", "description": "The ID of the tax rule you wish to delete." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Retrieve tax rules for this company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxrules?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxrules" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxCode, taxTypeCode, taxRuleProductDetail, rateTypeCode, taxTypeGroup, taxSubType, unitOfBasis" }, { "key": "$include", "value": "string", "description": "A comma separated list of additional data to retrieve." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these tax rules" } ] }, "description": "List all taxrule objects attached to this company.\r\n \r\nA tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules\r\ncan be used to change the taxability of an item, to change the tax base of an item, or to change the tax rate\r\ncharged when selling an item. Tax rules can also change tax behavior depending on the `entityUseCode` value submitted\r\nwith the transaction.\r\n \r\nYou can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your\r\nbusiness. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use\r\ncustom tax rules to redefine the behavior for your company or item.\r\n \r\nPlease use custom tax rules carefully and ensure that these tax rules match the behavior agreed upon with your\r\nauditor, legal representative, and accounting team.\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxrules?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxrules" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxCode, taxTypeCode, taxRuleProductDetail, rateTypeCode, taxTypeGroup, taxSubType, unitOfBasis", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these tax rules" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 8811,\n \"value\": [\n {\n \"country\": \"US\",\n \"id\": 56789,\n \"jurisCode\": \"013\",\n \"taxRuleTypeId\": \"RateRule\",\n \"companyId\": 12345,\n \"taxCodeId\": 3849,\n \"taxCode\": \"FR020800\",\n \"stateFIPS\": \"04\",\n \"jurisName\": \"MARICOPA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"Country\",\n \"customerUsageType\": \"string\",\n \"entityUseCode\": \"string\",\n \"taxTypeId\": \"E\",\n \"taxTypeCode\": \"ALL\",\n \"taxRuleProductDetail\": [\n {\n \"taxRuleProductDetailId\": 1,\n \"taxRuleId\": 123,\n \"productCode\": \"220720\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"endDate\": \"2027-04-02T00:00:00+00:00\",\n \"systemId\": 28\n },\n {\n \"taxRuleProductDetailId\": 1,\n \"taxRuleId\": 123,\n \"productCode\": \"220720\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"endDate\": \"2027-04-02T00:00:00+00:00\",\n \"systemId\": 28\n }\n ],\n \"rateTypeId\": \"ReducedA\",\n \"rateTypeCode\": \"string\",\n \"isAllJuris\": false,\n \"value\": 0,\n \"cap\": 0,\n \"threshold\": 0,\n \"options\": \"string\",\n \"effectiveDate\": \"1968-03-01\",\n \"endDate\": \"2014-11-01\",\n \"description\": \"Freight\",\n \"countyFIPS\": \"013\",\n \"isSTPro\": true,\n \"region\": \"AZ\",\n \"sourcing\": \"Mixed\",\n \"taxTypeGroup\": \"SalesAndUse\",\n \"taxSubType\": \"ALL\",\n \"nonPassthroughExpression\": \"string\",\n \"currencyCode\": \"st\",\n \"preferredProgramId\": 28,\n \"uomId\": 2250,\n \"createdDate\": \"2001-05-20T00:17:39.348Z\",\n \"createdUserId\": 398,\n \"modifiedDate\": \"2010-03-11T04:49:05.648Z\",\n \"modifiedUserId\": 6527,\n \"unitOfBasis\": \"string\"\n },\n {\n \"country\": \"US\",\n \"id\": 56789,\n \"jurisCode\": \"013\",\n \"taxRuleTypeId\": \"RateRule\",\n \"companyId\": 12345,\n \"taxCodeId\": 5026,\n \"taxCode\": \"FR020800\",\n \"stateFIPS\": \"04\",\n \"jurisName\": \"MARICOPA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"Country\",\n \"customerUsageType\": \"str\",\n \"entityUseCode\": \"string\",\n \"taxTypeId\": \"E\",\n \"taxTypeCode\": \"ALL\",\n \"taxRuleProductDetail\": [\n {\n \"taxRuleProductDetailId\": 1,\n \"taxRuleId\": 123,\n \"productCode\": \"220720\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"endDate\": \"2027-04-02T00:00:00+00:00\",\n \"systemId\": 28\n },\n {\n \"taxRuleProductDetailId\": 1,\n \"taxRuleId\": 123,\n \"productCode\": \"220720\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"endDate\": \"2027-04-02T00:00:00+00:00\",\n \"systemId\": 28\n }\n ],\n \"rateTypeId\": \"ReducedA\",\n \"rateTypeCode\": \"string\",\n \"isAllJuris\": false,\n \"value\": 0,\n \"cap\": 0,\n \"threshold\": 0,\n \"options\": \"string\",\n \"effectiveDate\": \"2018-07-15\",\n \"endDate\": \"2002-04-18\",\n \"description\": \"Freight\",\n \"countyFIPS\": \"013\",\n \"isSTPro\": false,\n \"region\": \"AZ\",\n \"sourcing\": \"Mixed\",\n \"taxTypeGroup\": \"SalesAndUse\",\n \"taxSubType\": \"ALL\",\n \"nonPassthroughExpression\": \"string\",\n \"currencyCode\": \"s\",\n \"preferredProgramId\": 1959,\n \"uomId\": 9107,\n \"createdDate\": \"1968-04-14T08:55:54.408Z\",\n \"createdUserId\": 4308,\n \"modifiedDate\": \"1988-11-27T03:19:26.332Z\",\n \"modifiedUserId\": 5121,\n \"unitOfBasis\": \"string\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxrules?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxrules" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxCode, taxTypeCode, taxRuleProductDetail, rateTypeCode, taxTypeGroup, taxSubType, unitOfBasis", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these tax rules" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxrules?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxrules" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxCode, taxTypeCode, taxRuleProductDetail, rateTypeCode, taxTypeGroup, taxSubType, unitOfBasis", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these tax rules" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxrules?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxrules" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxCode, taxTypeCode, taxRuleProductDetail, rateTypeCode, taxTypeGroup, taxSubType, unitOfBasis", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these tax rules" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Create a new tax rule", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"country\": \"US\",\n \"id\": 56789,\n \"jurisCode\": \"013\",\n \"taxRuleTypeId\": \"RateRule\",\n \"companyId\": 12345,\n \"taxCodeId\": 4122,\n \"taxCode\": \"FR020800\",\n \"stateFIPS\": \"04\",\n \"jurisName\": \"MARICOPA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"Country\",\n \"customerUsageType\": \"string\",\n \"entityUseCode\": \"string\",\n \"taxTypeId\": \"E\",\n \"taxTypeCode\": \"ALL\",\n \"taxRuleProductDetail\": [\n {\n \"taxRuleProductDetailId\": 1,\n \"taxRuleId\": 123,\n \"productCode\": \"220720\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"endDate\": \"2027-04-02T00:00:00+00:00\",\n \"systemId\": 28\n },\n {\n \"taxRuleProductDetailId\": 1,\n \"taxRuleId\": 123,\n \"productCode\": \"220720\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"endDate\": \"2027-04-02T00:00:00+00:00\",\n \"systemId\": 28\n }\n ],\n \"rateTypeId\": \"ReducedA\",\n \"rateTypeCode\": \"string\",\n \"isAllJuris\": false,\n \"value\": 0,\n \"cap\": 0,\n \"threshold\": 0,\n \"options\": \"string\",\n \"effectiveDate\": \"1974-03-15\",\n \"endDate\": \"1951-11-12\",\n \"description\": \"Freight\",\n \"countyFIPS\": \"013\",\n \"isSTPro\": true,\n \"region\": \"AZ\",\n \"sourcing\": \"Mixed\",\n \"taxTypeGroup\": \"SalesAndUse\",\n \"taxSubType\": \"ALL\",\n \"nonPassthroughExpression\": \"string\",\n \"currencyCode\": \"s\",\n \"preferredProgramId\": 2953,\n \"uomId\": 1670,\n \"unitOfBasis\": \"string\"\n },\n {\n \"country\": \"US\",\n \"id\": 56789,\n \"jurisCode\": \"013\",\n \"taxRuleTypeId\": \"RateRule\",\n \"companyId\": 12345,\n \"taxCodeId\": 1434,\n \"taxCode\": \"FR020800\",\n \"stateFIPS\": \"04\",\n \"jurisName\": \"MARICOPA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"Country\",\n \"customerUsageType\": \"\",\n \"entityUseCode\": \"string\",\n \"taxTypeId\": \"E\",\n \"taxTypeCode\": \"ALL\",\n \"taxRuleProductDetail\": [\n {\n \"taxRuleProductDetailId\": 1,\n \"taxRuleId\": 123,\n \"productCode\": \"220720\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"endDate\": \"2027-04-02T00:00:00+00:00\",\n \"systemId\": 28\n },\n {\n \"taxRuleProductDetailId\": 1,\n \"taxRuleId\": 123,\n \"productCode\": \"220720\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"endDate\": \"2027-04-02T00:00:00+00:00\",\n \"systemId\": 28\n }\n ],\n \"rateTypeId\": \"ReducedA\",\n \"rateTypeCode\": \"string\",\n \"isAllJuris\": false,\n \"value\": 0,\n \"cap\": 0,\n \"threshold\": 0,\n \"options\": \"string\",\n \"effectiveDate\": \"1958-12-31\",\n \"endDate\": \"2025-09-10\",\n \"description\": \"Freight\",\n \"countyFIPS\": \"013\",\n \"isSTPro\": true,\n \"region\": \"AZ\",\n \"sourcing\": \"Mixed\",\n \"taxTypeGroup\": \"SalesAndUse\",\n \"taxSubType\": \"ALL\",\n \"nonPassthroughExpression\": \"string\",\n \"currencyCode\": \"\",\n \"preferredProgramId\": 7938,\n \"uomId\": 9164,\n \"unitOfBasis\": \"string\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxrules", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxrules" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this tax rule." } ] }, "description": "Create one or more custom tax rules attached to this company.\r\n \r\nA tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules\r\ncan be used to change the taxability of an item, to change the tax base of an item, or to change the tax rate\r\ncharged when selling an item. Tax rules can also change tax behavior depending on the `entityUseCode` value submitted\r\nwith the transaction.\r\n \r\nYou can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your\r\nbusiness. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use\r\ncustom tax rules to redefine the behavior for your company or item.\r\n \r\nPlease use custom tax rules carefully and ensure that these tax rules match the behavior agreed upon with your\r\nauditor, legal representative, and accounting team.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"country\": \"US\",\n \"id\": 56789,\n \"jurisCode\": \"013\",\n \"taxRuleTypeId\": \"RateRule\",\n \"companyId\": 12345,\n \"taxCodeId\": 4122,\n \"taxCode\": \"FR020800\",\n \"stateFIPS\": \"04\",\n \"jurisName\": \"MARICOPA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"Country\",\n \"customerUsageType\": \"string\",\n \"entityUseCode\": \"string\",\n \"taxTypeId\": \"E\",\n \"taxTypeCode\": \"ALL\",\n \"taxRuleProductDetail\": [\n {\n \"taxRuleProductDetailId\": 1,\n \"taxRuleId\": 123,\n \"productCode\": \"220720\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"endDate\": \"2027-04-02T00:00:00+00:00\",\n \"systemId\": 28\n },\n {\n \"taxRuleProductDetailId\": 1,\n \"taxRuleId\": 123,\n \"productCode\": \"220720\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"endDate\": \"2027-04-02T00:00:00+00:00\",\n \"systemId\": 28\n }\n ],\n \"rateTypeId\": \"ReducedA\",\n \"rateTypeCode\": \"string\",\n \"isAllJuris\": false,\n \"value\": 0,\n \"cap\": 0,\n \"threshold\": 0,\n \"options\": \"string\",\n \"effectiveDate\": \"1974-03-15\",\n \"endDate\": \"1951-11-12\",\n \"description\": \"Freight\",\n \"countyFIPS\": \"013\",\n \"isSTPro\": true,\n \"region\": \"AZ\",\n \"sourcing\": \"Mixed\",\n \"taxTypeGroup\": \"SalesAndUse\",\n \"taxSubType\": \"ALL\",\n \"nonPassthroughExpression\": \"string\",\n \"currencyCode\": \"s\",\n \"preferredProgramId\": 2953,\n \"uomId\": 1670,\n \"unitOfBasis\": \"string\"\n },\n {\n \"country\": \"US\",\n \"id\": 56789,\n \"jurisCode\": \"013\",\n \"taxRuleTypeId\": \"RateRule\",\n \"companyId\": 12345,\n \"taxCodeId\": 1434,\n \"taxCode\": \"FR020800\",\n \"stateFIPS\": \"04\",\n \"jurisName\": \"MARICOPA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"Country\",\n \"customerUsageType\": \"\",\n \"entityUseCode\": \"string\",\n \"taxTypeId\": \"E\",\n \"taxTypeCode\": \"ALL\",\n \"taxRuleProductDetail\": [\n {\n \"taxRuleProductDetailId\": 1,\n \"taxRuleId\": 123,\n \"productCode\": \"220720\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"endDate\": \"2027-04-02T00:00:00+00:00\",\n \"systemId\": 28\n },\n {\n \"taxRuleProductDetailId\": 1,\n \"taxRuleId\": 123,\n \"productCode\": \"220720\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"endDate\": \"2027-04-02T00:00:00+00:00\",\n \"systemId\": 28\n }\n ],\n \"rateTypeId\": \"ReducedA\",\n \"rateTypeCode\": \"string\",\n \"isAllJuris\": false,\n \"value\": 0,\n \"cap\": 0,\n \"threshold\": 0,\n \"options\": \"string\",\n \"effectiveDate\": \"1958-12-31\",\n \"endDate\": \"2025-09-10\",\n \"description\": \"Freight\",\n \"countyFIPS\": \"013\",\n \"isSTPro\": true,\n \"region\": \"AZ\",\n \"sourcing\": \"Mixed\",\n \"taxTypeGroup\": \"SalesAndUse\",\n \"taxSubType\": \"ALL\",\n \"nonPassthroughExpression\": \"string\",\n \"currencyCode\": \"\",\n \"preferredProgramId\": 7938,\n \"uomId\": 9164,\n \"unitOfBasis\": \"string\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxrules", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxrules" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this tax rule." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"country\": \"US\",\n \"id\": 56789,\n \"jurisCode\": \"013\",\n \"taxRuleTypeId\": \"RateRule\",\n \"companyId\": 12345,\n \"taxCodeId\": 387,\n \"taxCode\": \"FR020800\",\n \"stateFIPS\": \"04\",\n \"jurisName\": \"MARICOPA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"Country\",\n \"customerUsageType\": \"string\",\n \"entityUseCode\": \"string\",\n \"taxTypeId\": \"E\",\n \"taxTypeCode\": \"ALL\",\n \"taxRuleProductDetail\": [\n {\n \"taxRuleProductDetailId\": 1,\n \"taxRuleId\": 123,\n \"productCode\": \"220720\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"endDate\": \"2027-04-02T00:00:00+00:00\",\n \"systemId\": 28\n },\n {\n \"taxRuleProductDetailId\": 1,\n \"taxRuleId\": 123,\n \"productCode\": \"220720\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"endDate\": \"2027-04-02T00:00:00+00:00\",\n \"systemId\": 28\n }\n ],\n \"rateTypeId\": \"ReducedA\",\n \"rateTypeCode\": \"string\",\n \"isAllJuris\": false,\n \"value\": 0,\n \"cap\": 0,\n \"threshold\": 0,\n \"options\": \"string\",\n \"effectiveDate\": \"2008-03-05\",\n \"endDate\": \"2011-07-07\",\n \"description\": \"Freight\",\n \"countyFIPS\": \"013\",\n \"isSTPro\": false,\n \"region\": \"AZ\",\n \"sourcing\": \"Mixed\",\n \"taxTypeGroup\": \"SalesAndUse\",\n \"taxSubType\": \"ALL\",\n \"nonPassthroughExpression\": \"string\",\n \"currencyCode\": \"str\",\n \"preferredProgramId\": 4673,\n \"uomId\": 4182,\n \"createdDate\": \"2006-03-03T02:54:28.454Z\",\n \"createdUserId\": 2791,\n \"modifiedDate\": \"1973-03-21T02:59:36.645Z\",\n \"modifiedUserId\": 7030,\n \"unitOfBasis\": \"string\"\n },\n {\n \"country\": \"US\",\n \"id\": 56789,\n \"jurisCode\": \"013\",\n \"taxRuleTypeId\": \"RateRule\",\n \"companyId\": 12345,\n \"taxCodeId\": 891,\n \"taxCode\": \"FR020800\",\n \"stateFIPS\": \"04\",\n \"jurisName\": \"MARICOPA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"Country\",\n \"customerUsageType\": \"string\",\n \"entityUseCode\": \"str\",\n \"taxTypeId\": \"E\",\n \"taxTypeCode\": \"ALL\",\n \"taxRuleProductDetail\": [\n {\n \"taxRuleProductDetailId\": 1,\n \"taxRuleId\": 123,\n \"productCode\": \"220720\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"endDate\": \"2027-04-02T00:00:00+00:00\",\n \"systemId\": 28\n },\n {\n \"taxRuleProductDetailId\": 1,\n \"taxRuleId\": 123,\n \"productCode\": \"220720\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"endDate\": \"2027-04-02T00:00:00+00:00\",\n \"systemId\": 28\n }\n ],\n \"rateTypeId\": \"ReducedA\",\n \"rateTypeCode\": \"string\",\n \"isAllJuris\": false,\n \"value\": 0,\n \"cap\": 0,\n \"threshold\": 0,\n \"options\": \"string\",\n \"effectiveDate\": \"2009-03-19\",\n \"endDate\": \"1964-11-13\",\n \"description\": \"Freight\",\n \"countyFIPS\": \"013\",\n \"isSTPro\": true,\n \"region\": \"AZ\",\n \"sourcing\": \"Mixed\",\n \"taxTypeGroup\": \"SalesAndUse\",\n \"taxSubType\": \"ALL\",\n \"nonPassthroughExpression\": \"string\",\n \"currencyCode\": \"\",\n \"preferredProgramId\": 9874,\n \"uomId\": 53,\n \"createdDate\": \"2009-10-01T20:38:44.285Z\",\n \"createdUserId\": 4661,\n \"modifiedDate\": \"1961-08-23T23:42:25.039Z\",\n \"modifiedUserId\": 9300,\n \"unitOfBasis\": \"string\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"country\": \"US\",\n \"id\": 56789,\n \"jurisCode\": \"013\",\n \"taxRuleTypeId\": \"RateRule\",\n \"companyId\": 12345,\n \"taxCodeId\": 4122,\n \"taxCode\": \"FR020800\",\n \"stateFIPS\": \"04\",\n \"jurisName\": \"MARICOPA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"Country\",\n \"customerUsageType\": \"string\",\n \"entityUseCode\": \"string\",\n \"taxTypeId\": \"E\",\n \"taxTypeCode\": \"ALL\",\n \"taxRuleProductDetail\": [\n {\n \"taxRuleProductDetailId\": 1,\n \"taxRuleId\": 123,\n \"productCode\": \"220720\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"endDate\": \"2027-04-02T00:00:00+00:00\",\n \"systemId\": 28\n },\n {\n \"taxRuleProductDetailId\": 1,\n \"taxRuleId\": 123,\n \"productCode\": \"220720\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"endDate\": \"2027-04-02T00:00:00+00:00\",\n \"systemId\": 28\n }\n ],\n \"rateTypeId\": \"ReducedA\",\n \"rateTypeCode\": \"string\",\n \"isAllJuris\": false,\n \"value\": 0,\n \"cap\": 0,\n \"threshold\": 0,\n \"options\": \"string\",\n \"effectiveDate\": \"1974-03-15\",\n \"endDate\": \"1951-11-12\",\n \"description\": \"Freight\",\n \"countyFIPS\": \"013\",\n \"isSTPro\": true,\n \"region\": \"AZ\",\n \"sourcing\": \"Mixed\",\n \"taxTypeGroup\": \"SalesAndUse\",\n \"taxSubType\": \"ALL\",\n \"nonPassthroughExpression\": \"string\",\n \"currencyCode\": \"s\",\n \"preferredProgramId\": 2953,\n \"uomId\": 1670,\n \"unitOfBasis\": \"string\"\n },\n {\n \"country\": \"US\",\n \"id\": 56789,\n \"jurisCode\": \"013\",\n \"taxRuleTypeId\": \"RateRule\",\n \"companyId\": 12345,\n \"taxCodeId\": 1434,\n \"taxCode\": \"FR020800\",\n \"stateFIPS\": \"04\",\n \"jurisName\": \"MARICOPA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"Country\",\n \"customerUsageType\": \"\",\n \"entityUseCode\": \"string\",\n \"taxTypeId\": \"E\",\n \"taxTypeCode\": \"ALL\",\n \"taxRuleProductDetail\": [\n {\n \"taxRuleProductDetailId\": 1,\n \"taxRuleId\": 123,\n \"productCode\": \"220720\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"endDate\": \"2027-04-02T00:00:00+00:00\",\n \"systemId\": 28\n },\n {\n \"taxRuleProductDetailId\": 1,\n \"taxRuleId\": 123,\n \"productCode\": \"220720\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"endDate\": \"2027-04-02T00:00:00+00:00\",\n \"systemId\": 28\n }\n ],\n \"rateTypeId\": \"ReducedA\",\n \"rateTypeCode\": \"string\",\n \"isAllJuris\": false,\n \"value\": 0,\n \"cap\": 0,\n \"threshold\": 0,\n \"options\": \"string\",\n \"effectiveDate\": \"1958-12-31\",\n \"endDate\": \"2025-09-10\",\n \"description\": \"Freight\",\n \"countyFIPS\": \"013\",\n \"isSTPro\": true,\n \"region\": \"AZ\",\n \"sourcing\": \"Mixed\",\n \"taxTypeGroup\": \"SalesAndUse\",\n \"taxSubType\": \"ALL\",\n \"nonPassthroughExpression\": \"string\",\n \"currencyCode\": \"\",\n \"preferredProgramId\": 7938,\n \"uomId\": 9164,\n \"unitOfBasis\": \"string\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxrules", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxrules" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this tax rule." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"country\": \"US\",\n \"id\": 56789,\n \"jurisCode\": \"013\",\n \"taxRuleTypeId\": \"RateRule\",\n \"companyId\": 12345,\n \"taxCodeId\": 4122,\n \"taxCode\": \"FR020800\",\n \"stateFIPS\": \"04\",\n \"jurisName\": \"MARICOPA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"Country\",\n \"customerUsageType\": \"string\",\n \"entityUseCode\": \"string\",\n \"taxTypeId\": \"E\",\n \"taxTypeCode\": \"ALL\",\n \"taxRuleProductDetail\": [\n {\n \"taxRuleProductDetailId\": 1,\n \"taxRuleId\": 123,\n \"productCode\": \"220720\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"endDate\": \"2027-04-02T00:00:00+00:00\",\n \"systemId\": 28\n },\n {\n \"taxRuleProductDetailId\": 1,\n \"taxRuleId\": 123,\n \"productCode\": \"220720\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"endDate\": \"2027-04-02T00:00:00+00:00\",\n \"systemId\": 28\n }\n ],\n \"rateTypeId\": \"ReducedA\",\n \"rateTypeCode\": \"string\",\n \"isAllJuris\": false,\n \"value\": 0,\n \"cap\": 0,\n \"threshold\": 0,\n \"options\": \"string\",\n \"effectiveDate\": \"1974-03-15\",\n \"endDate\": \"1951-11-12\",\n \"description\": \"Freight\",\n \"countyFIPS\": \"013\",\n \"isSTPro\": true,\n \"region\": \"AZ\",\n \"sourcing\": \"Mixed\",\n \"taxTypeGroup\": \"SalesAndUse\",\n \"taxSubType\": \"ALL\",\n \"nonPassthroughExpression\": \"string\",\n \"currencyCode\": \"s\",\n \"preferredProgramId\": 2953,\n \"uomId\": 1670,\n \"unitOfBasis\": \"string\"\n },\n {\n \"country\": \"US\",\n \"id\": 56789,\n \"jurisCode\": \"013\",\n \"taxRuleTypeId\": \"RateRule\",\n \"companyId\": 12345,\n \"taxCodeId\": 1434,\n \"taxCode\": \"FR020800\",\n \"stateFIPS\": \"04\",\n \"jurisName\": \"MARICOPA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"Country\",\n \"customerUsageType\": \"\",\n \"entityUseCode\": \"string\",\n \"taxTypeId\": \"E\",\n \"taxTypeCode\": \"ALL\",\n \"taxRuleProductDetail\": [\n {\n \"taxRuleProductDetailId\": 1,\n \"taxRuleId\": 123,\n \"productCode\": \"220720\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"endDate\": \"2027-04-02T00:00:00+00:00\",\n \"systemId\": 28\n },\n {\n \"taxRuleProductDetailId\": 1,\n \"taxRuleId\": 123,\n \"productCode\": \"220720\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"endDate\": \"2027-04-02T00:00:00+00:00\",\n \"systemId\": 28\n }\n ],\n \"rateTypeId\": \"ReducedA\",\n \"rateTypeCode\": \"string\",\n \"isAllJuris\": false,\n \"value\": 0,\n \"cap\": 0,\n \"threshold\": 0,\n \"options\": \"string\",\n \"effectiveDate\": \"1958-12-31\",\n \"endDate\": \"2025-09-10\",\n \"description\": \"Freight\",\n \"countyFIPS\": \"013\",\n \"isSTPro\": true,\n \"region\": \"AZ\",\n \"sourcing\": \"Mixed\",\n \"taxTypeGroup\": \"SalesAndUse\",\n \"taxSubType\": \"ALL\",\n \"nonPassthroughExpression\": \"string\",\n \"currencyCode\": \"\",\n \"preferredProgramId\": 7938,\n \"uomId\": 9164,\n \"unitOfBasis\": \"string\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxrules", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxrules" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this tax rule." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"country\": \"US\",\n \"id\": 56789,\n \"jurisCode\": \"013\",\n \"taxRuleTypeId\": \"RateRule\",\n \"companyId\": 12345,\n \"taxCodeId\": 4122,\n \"taxCode\": \"FR020800\",\n \"stateFIPS\": \"04\",\n \"jurisName\": \"MARICOPA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"Country\",\n \"customerUsageType\": \"string\",\n \"entityUseCode\": \"string\",\n \"taxTypeId\": \"E\",\n \"taxTypeCode\": \"ALL\",\n \"taxRuleProductDetail\": [\n {\n \"taxRuleProductDetailId\": 1,\n \"taxRuleId\": 123,\n \"productCode\": \"220720\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"endDate\": \"2027-04-02T00:00:00+00:00\",\n \"systemId\": 28\n },\n {\n \"taxRuleProductDetailId\": 1,\n \"taxRuleId\": 123,\n \"productCode\": \"220720\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"endDate\": \"2027-04-02T00:00:00+00:00\",\n \"systemId\": 28\n }\n ],\n \"rateTypeId\": \"ReducedA\",\n \"rateTypeCode\": \"string\",\n \"isAllJuris\": false,\n \"value\": 0,\n \"cap\": 0,\n \"threshold\": 0,\n \"options\": \"string\",\n \"effectiveDate\": \"1974-03-15\",\n \"endDate\": \"1951-11-12\",\n \"description\": \"Freight\",\n \"countyFIPS\": \"013\",\n \"isSTPro\": true,\n \"region\": \"AZ\",\n \"sourcing\": \"Mixed\",\n \"taxTypeGroup\": \"SalesAndUse\",\n \"taxSubType\": \"ALL\",\n \"nonPassthroughExpression\": \"string\",\n \"currencyCode\": \"s\",\n \"preferredProgramId\": 2953,\n \"uomId\": 1670,\n \"unitOfBasis\": \"string\"\n },\n {\n \"country\": \"US\",\n \"id\": 56789,\n \"jurisCode\": \"013\",\n \"taxRuleTypeId\": \"RateRule\",\n \"companyId\": 12345,\n \"taxCodeId\": 1434,\n \"taxCode\": \"FR020800\",\n \"stateFIPS\": \"04\",\n \"jurisName\": \"MARICOPA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"Country\",\n \"customerUsageType\": \"\",\n \"entityUseCode\": \"string\",\n \"taxTypeId\": \"E\",\n \"taxTypeCode\": \"ALL\",\n \"taxRuleProductDetail\": [\n {\n \"taxRuleProductDetailId\": 1,\n \"taxRuleId\": 123,\n \"productCode\": \"220720\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"endDate\": \"2027-04-02T00:00:00+00:00\",\n \"systemId\": 28\n },\n {\n \"taxRuleProductDetailId\": 1,\n \"taxRuleId\": 123,\n \"productCode\": \"220720\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"endDate\": \"2027-04-02T00:00:00+00:00\",\n \"systemId\": 28\n }\n ],\n \"rateTypeId\": \"ReducedA\",\n \"rateTypeCode\": \"string\",\n \"isAllJuris\": false,\n \"value\": 0,\n \"cap\": 0,\n \"threshold\": 0,\n \"options\": \"string\",\n \"effectiveDate\": \"1958-12-31\",\n \"endDate\": \"2025-09-10\",\n \"description\": \"Freight\",\n \"countyFIPS\": \"013\",\n \"isSTPro\": true,\n \"region\": \"AZ\",\n \"sourcing\": \"Mixed\",\n \"taxTypeGroup\": \"SalesAndUse\",\n \"taxSubType\": \"ALL\",\n \"nonPassthroughExpression\": \"string\",\n \"currencyCode\": \"\",\n \"preferredProgramId\": 7938,\n \"uomId\": 9164,\n \"unitOfBasis\": \"string\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/taxrules", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "taxrules" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this tax rule." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "upcs", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a single UPC", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/upcs/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "upcs", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this UPC" }, { "key": "id", "value": "451", "description": "The primary key of this UPC" } ] }, "description": "Get the UPC object identified by this URL.\r\nA UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaUpc.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/upcs/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "upcs", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this UPC" }, { "key": "id", "value": "451", "description": "The primary key of this UPC" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 123456789,\n \"companyId\": 1234567,\n \"upc\": \"023032550992\",\n \"legacyTaxCode\": \"PS081282\",\n \"description\": \"Yarn\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/upcs/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "upcs", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this UPC" }, { "key": "id", "value": "451", "description": "The primary key of this UPC" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/upcs/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "upcs", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this UPC" }, { "key": "id", "value": "451", "description": "The primary key of this UPC" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/upcs/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "upcs", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this UPC" }, { "key": "id", "value": "451", "description": "The primary key of this UPC" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Update a single UPC", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 123456789,\n \"companyId\": 1234567,\n \"upc\": \"023032550992\",\n \"legacyTaxCode\": \"PS081282\",\n \"description\": \"Yarn\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/upcs/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "upcs", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this UPC belongs to." }, { "key": "id", "value": "451", "description": "The ID of the UPC you wish to update" } ] }, "description": "Replace the existing UPC object at this URL with an updated object.\r\nA UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC.\r\nAll data from the existing object will be replaced with data in the object you PUT.\r\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.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n* This API depends on the following active services:*Required* (all): AvaUpc.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 123456789,\n \"companyId\": 1234567,\n \"upc\": \"023032550992\",\n \"legacyTaxCode\": \"PS081282\",\n \"description\": \"Yarn\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/upcs/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "upcs", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this UPC belongs to." }, { "key": "id", "value": "451", "description": "The ID of the UPC you wish to update" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 123456789,\n \"companyId\": 1234567,\n \"upc\": \"023032550992\",\n \"legacyTaxCode\": \"PS081282\",\n \"description\": \"Yarn\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 123456789,\n \"companyId\": 1234567,\n \"upc\": \"023032550992\",\n \"legacyTaxCode\": \"PS081282\",\n \"description\": \"Yarn\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/upcs/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "upcs", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this UPC belongs to." }, { "key": "id", "value": "451", "description": "The ID of the UPC you wish to update" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 123456789,\n \"companyId\": 1234567,\n \"upc\": \"023032550992\",\n \"legacyTaxCode\": \"PS081282\",\n \"description\": \"Yarn\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/upcs/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "upcs", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this UPC belongs to." }, { "key": "id", "value": "451", "description": "The ID of the UPC you wish to update" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 123456789,\n \"companyId\": 1234567,\n \"upc\": \"023032550992\",\n \"legacyTaxCode\": \"PS081282\",\n \"description\": \"Yarn\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/upcs/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "upcs", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that this UPC belongs to." }, { "key": "id", "value": "451", "description": "The ID of the UPC you wish to update" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete a single UPC", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/upcs/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "upcs", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this UPC." }, { "key": "id", "value": "451", "description": "The ID of the UPC you wish to delete." } ] }, "description": "Marks the UPC object identified by this URL as deleted.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n* This API depends on the following active services:*Required* (all): AvaUpc.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/upcs/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "upcs", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this UPC." }, { "key": "id", "value": "451", "description": "The ID of the UPC you wish to delete." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/upcs/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "upcs", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this UPC." }, { "key": "id", "value": "451", "description": "The ID of the UPC you wish to delete." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/upcs/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "upcs", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this UPC." }, { "key": "id", "value": "451", "description": "The ID of the UPC you wish to delete." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/upcs/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "upcs", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this UPC." }, { "key": "id", "value": "451", "description": "The ID of the UPC you wish to delete." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Retrieve UPCs for this company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/upcs?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "upcs" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/)." }, { "key": "$include", "value": "string", "description": "A comma separated list of additional data to retrieve." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these UPCs" } ] }, "description": "List all UPC objects attached to this company.\r\nA UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC.\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaUpc.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/upcs?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "upcs" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these UPCs" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 5024,\n \"value\": [\n {\n \"id\": 123456789,\n \"companyId\": 1234567,\n \"upc\": \"023032550992\",\n \"legacyTaxCode\": \"PS081282\",\n \"description\": \"Yarn\"\n },\n {\n \"id\": 123456789,\n \"companyId\": 1234567,\n \"upc\": \"023032550992\",\n \"legacyTaxCode\": \"PS081282\",\n \"description\": \"Yarn\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/upcs?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "upcs" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these UPCs" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/upcs?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "upcs" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these UPCs" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/upcs?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "upcs" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns these UPCs" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Create a new UPC", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 123456789,\n \"companyId\": 1234567,\n \"upc\": \"023032550992\",\n \"legacyTaxCode\": \"PS081282\",\n \"description\": \"Yarn\"\n },\n {\n \"id\": 123456789,\n \"companyId\": 1234567,\n \"upc\": \"023032550992\",\n \"legacyTaxCode\": \"PS081282\",\n \"description\": \"Yarn\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/upcs", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "upcs" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this UPC." } ] }, "description": "Create one or more new UPC objects attached to this company.\r\nA UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n* This API depends on the following active services:*Required* (all): AvaUpc.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 123456789,\n \"companyId\": 1234567,\n \"upc\": \"023032550992\",\n \"legacyTaxCode\": \"PS081282\",\n \"description\": \"Yarn\"\n },\n {\n \"id\": 123456789,\n \"companyId\": 1234567,\n \"upc\": \"023032550992\",\n \"legacyTaxCode\": \"PS081282\",\n \"description\": \"Yarn\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/upcs", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "upcs" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this UPC." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": 123456789,\n \"companyId\": 1234567,\n \"upc\": \"023032550992\",\n \"legacyTaxCode\": \"PS081282\",\n \"description\": \"Yarn\"\n },\n {\n \"id\": 123456789,\n \"companyId\": 1234567,\n \"upc\": \"023032550992\",\n \"legacyTaxCode\": \"PS081282\",\n \"description\": \"Yarn\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 123456789,\n \"companyId\": 1234567,\n \"upc\": \"023032550992\",\n \"legacyTaxCode\": \"PS081282\",\n \"description\": \"Yarn\"\n },\n {\n \"id\": 123456789,\n \"companyId\": 1234567,\n \"upc\": \"023032550992\",\n \"legacyTaxCode\": \"PS081282\",\n \"description\": \"Yarn\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/upcs", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "upcs" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this UPC." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 123456789,\n \"companyId\": 1234567,\n \"upc\": \"023032550992\",\n \"legacyTaxCode\": \"PS081282\",\n \"description\": \"Yarn\"\n },\n {\n \"id\": 123456789,\n \"companyId\": 1234567,\n \"upc\": \"023032550992\",\n \"legacyTaxCode\": \"PS081282\",\n \"description\": \"Yarn\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/upcs", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "upcs" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this UPC." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 123456789,\n \"companyId\": 1234567,\n \"upc\": \"023032550992\",\n \"legacyTaxCode\": \"PS081282\",\n \"description\": \"Yarn\"\n },\n {\n \"id\": 123456789,\n \"companyId\": 1234567,\n \"upc\": \"023032550992\",\n \"legacyTaxCode\": \"PS081282\",\n \"description\": \"Yarn\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/upcs", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "upcs" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company that owns this UPC." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "userdefinedfields", "item": [ { "name": "{id}", "item": [ { "name": "Delete a User Defined Field by User Defined Field id for a company.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/userdefinedfields/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "userdefinedfields", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The id of the company the User Defined Field belongs to." }, { "key": "id", "value": "155", "description": "The id of the User Defined Field you wish to delete." } ] }, "description": "Marks the existing user defined field for a company as deleted.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/userdefinedfields/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "userdefinedfields", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The id of the company the User Defined Field belongs to." }, { "key": "id", "value": "155", "description": "The id of the User Defined Field you wish to delete." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/userdefinedfields/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "userdefinedfields", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The id of the company the User Defined Field belongs to." }, { "key": "id", "value": "155", "description": "The id of the User Defined Field you wish to delete." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/userdefinedfields/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "userdefinedfields", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The id of the company the User Defined Field belongs to." }, { "key": "id", "value": "155", "description": "The id of the User Defined Field you wish to delete." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/userdefinedfields/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "userdefinedfields", ":id" ], "variable": [ { "key": "companyId", "value": "451", "description": "The id of the company the User Defined Field belongs to." }, { "key": "id", "value": "155", "description": "The id of the User Defined Field you wish to delete." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "List User Defined Fields By Company Id", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/userdefinedfields?udfType=Document&allowDefaults=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "userdefinedfields" ], "query": [ { "key": "udfType", "value": "Document", "description": "Document or Line level UDF" }, { "key": "allowDefaults", "value": "true", "description": "If true this will add defaulted UDFs to the list that are not named yet" } ], "variable": [ { "key": "companyId", "value": "451" } ] }, "description": "\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/userdefinedfields?udfType=Document&allowDefaults=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "userdefinedfields" ], "query": [ { "description": "Document or Line level UDF", "key": "udfType", "value": "Document" }, { "description": "If true this will add defaulted UDFs to the list that are not named yet", "key": "allowDefaults", "value": "true" } ], "variable": [ { "key": "companyId", "value": "451" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 457,\n \"value\": [\n {\n \"id\": 1,\n \"companyId\": 12345,\n \"name\": \"UDF1\",\n \"friendlyName\": \"General Ledger Account Number\",\n \"dataType\": \"String\",\n \"userDefinedFieldType\": \"Document\",\n \"createdUserId\": 123,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 12,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\"\n },\n {\n \"id\": 1,\n \"companyId\": 12345,\n \"name\": \"UDF1\",\n \"friendlyName\": \"General Ledger Account Number\",\n \"dataType\": \"String\",\n \"userDefinedFieldType\": \"Document\",\n \"createdUserId\": 123,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 12,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/userdefinedfields?udfType=Document&allowDefaults=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "userdefinedfields" ], "query": [ { "description": "Document or Line level UDF", "key": "udfType", "value": "Document" }, { "description": "If true this will add defaulted UDFs to the list that are not named yet", "key": "allowDefaults", "value": "true" } ], "variable": [ { "key": "companyId", "value": "451" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/userdefinedfields?udfType=Document&allowDefaults=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "userdefinedfields" ], "query": [ { "description": "Document or Line level UDF", "key": "udfType", "value": "Document" }, { "description": "If true this will add defaulted UDFs to the list that are not named yet", "key": "allowDefaults", "value": "true" } ], "variable": [ { "key": "companyId", "value": "451" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/userdefinedfields?udfType=Document&allowDefaults=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "userdefinedfields" ], "query": [ { "description": "Document or Line level UDF", "key": "udfType", "value": "Document" }, { "description": "If true this will add defaulted UDFs to the list that are not named yet", "key": "allowDefaults", "value": "true" } ], "variable": [ { "key": "companyId", "value": "451" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Update a User Defined Field identified by id for a company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 1,\n \"companyId\": 12345,\n \"name\": \"UDF1\",\n \"friendlyName\": \"General Ledger Account Number\",\n \"dataType\": \"String\",\n \"userDefinedFieldType\": \"Document\",\n \"createdUserId\": 123,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 12,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/userdefinedfields?id=155", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "userdefinedfields" ], "query": [ { "key": "id", "value": "155" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The id of the company the user defined field belongs to." } ] }, "description": "Updates a User Defined Field for a company.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 1,\n \"companyId\": 12345,\n \"name\": \"UDF1\",\n \"friendlyName\": \"General Ledger Account Number\",\n \"dataType\": \"String\",\n \"userDefinedFieldType\": \"Document\",\n \"createdUserId\": 123,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 12,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/userdefinedfields?id=155", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "userdefinedfields" ], "query": [ { "key": "id", "value": "155" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The id of the company the user defined field belongs to." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 1,\n \"companyId\": 12345,\n \"name\": \"UDF1\",\n \"friendlyName\": \"General Ledger Account Number\",\n \"dataType\": \"String\",\n \"userDefinedFieldType\": \"Document\",\n \"createdUserId\": 123,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 12,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 1,\n \"companyId\": 12345,\n \"name\": \"UDF1\",\n \"friendlyName\": \"General Ledger Account Number\",\n \"dataType\": \"String\",\n \"userDefinedFieldType\": \"Document\",\n \"createdUserId\": 123,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 12,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/userdefinedfields?id=155", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "userdefinedfields" ], "query": [ { "key": "id", "value": "155" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The id of the company the user defined field belongs to." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 1,\n \"companyId\": 12345,\n \"name\": \"UDF1\",\n \"friendlyName\": \"General Ledger Account Number\",\n \"dataType\": \"String\",\n \"userDefinedFieldType\": \"Document\",\n \"createdUserId\": 123,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 12,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/userdefinedfields?id=155", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "userdefinedfields" ], "query": [ { "key": "id", "value": "155" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The id of the company the user defined field belongs to." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 1,\n \"companyId\": 12345,\n \"name\": \"UDF1\",\n \"friendlyName\": \"General Ledger Account Number\",\n \"dataType\": \"String\",\n \"userDefinedFieldType\": \"Document\",\n \"createdUserId\": 123,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 12,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/userdefinedfields?id=155", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "userdefinedfields" ], "query": [ { "key": "id", "value": "155" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The id of the company the user defined field belongs to." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "vendors", "item": [ { "name": "{vendorCode}", "item": [ { "name": "certificates", "item": [ { "name": "List certificates linked to a vendor", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/vendors/:vendorCode/certificates?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "vendors", ":vendorCode", "certificates" ], "query": [ { "key": "$include", "value": "string", "description": "OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:\r\n \r\n * vendors - Retrieves the list of vendors linked to the certificate.\r\n * po_numbers - Retrieves all PO numbers tied to the certificate.\r\n * attributes - Retrieves all attributes applied to the certificate.\r\n * histories - Retrieves the certificate update history\r\n * jobs - Retrieves the jobs for this certificate\r\n * logs - Retrieves the certificate log\r\n * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid\r\n * custom_fields - Retrieves custom fields set for this certificate" }, { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* documentTypeId, documentTypeDescription, exemptionNumber, ecmsId, ecmsStatus, pdf, pages" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this vendor" }, { "key": "vendorCode", "value": "string", "description": "The unique code representing this vendor" } ] }, "description": "List all certificates linked to a vendor.\r\n \r\nA vendor object defines information about a person or business that purchases products from your\r\ncompany. When you create a tax transaction in AvaTax, you can use the `vendorCode` from this\r\nrecord in your `CreateTransaction` API call. AvaTax will search for this `vendorCode` value and\r\nidentify any certificates linked to this `vendor` object. If any certificate applies to the transaction,\r\nAvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\r\n \r\nYou can filter certificates by exposure zone name using the $filter parameter with the syntax:\r\n`$filter=exposureZoneName eq 'ZoneName'` or `$filter=contains(exposureZoneName,'PartialName')`\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/vendors/:vendorCode/certificates?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "vendors", ":vendorCode", "certificates" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:\r\n \r\n * vendors - Retrieves the list of vendors linked to the certificate.\r\n * po_numbers - Retrieves all PO numbers tied to the certificate.\r\n * attributes - Retrieves all attributes applied to the certificate.\r\n * histories - Retrieves the certificate update history\r\n * jobs - Retrieves the jobs for this certificate\r\n * logs - Retrieves the certificate log\r\n * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid\r\n * custom_fields - Retrieves custom fields set for this certificate", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* documentTypeId, documentTypeDescription, exemptionNumber, ecmsId, ecmsStatus, pdf, pages", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this vendor" }, { "key": "vendorCode", "value": "string", "description": "The unique code representing this vendor" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 4789,\n \"value\": [\n {\n \"documentTypeId\": 1,\n \"documentTypeName\": \"Vendor Purchase Certificate\",\n \"documentTypeDescription\": \"Certificate for vendor purchase exemptions\",\n \"documentTypeOutgoing\": false,\n \"id\": 0,\n \"signedDate\": \"2016-02-01\",\n \"expirationDate\": \"2020-12-31\",\n \"filename\": \"230956bc-c2ce-4c69-a624-465fcdf0bd93\",\n \"documentExists\": false,\n \"valid\": true,\n \"verified\": false,\n \"exemptPercentage\": 0,\n \"isSingleCertificate\": false,\n \"exemptionNumber\": \"VENDOR-EXEMPT-1234\",\n \"exemptionReason\": {\n \"name\": \"VENDOR_RESALE\"\n },\n \"ecmStatus\": \"None\",\n \"createdDate\": \"2026-04-02T10:55:19.570143Z\",\n \"modifiedDate\": \"2026-04-02\",\n \"taxNumberType\": \"FEIN\",\n \"businessNumberType\": \"Vendor Services\",\n \"pageCount\": 0,\n \"customers\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"2ac6fde5-42a8-4c06-bfdc-12473b74cf9a\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"exposureZone\": {\n \"name\": \"Washington\"\n },\n \"exposureZoneName\": \"Washington\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/vendors/:vendorCode/certificates?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "vendors", ":vendorCode", "certificates" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:\r\n \r\n * vendors - Retrieves the list of vendors linked to the certificate.\r\n * po_numbers - Retrieves all PO numbers tied to the certificate.\r\n * attributes - Retrieves all attributes applied to the certificate.\r\n * histories - Retrieves the certificate update history\r\n * jobs - Retrieves the jobs for this certificate\r\n * logs - Retrieves the certificate log\r\n * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid\r\n * custom_fields - Retrieves custom fields set for this certificate", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* documentTypeId, documentTypeDescription, exemptionNumber, ecmsId, ecmsStatus, pdf, pages", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this vendor" }, { "key": "vendorCode", "value": "string", "description": "The unique code representing this vendor" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/vendors/:vendorCode/certificates?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "vendors", ":vendorCode", "certificates" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:\r\n \r\n * vendors - Retrieves the list of vendors linked to the certificate.\r\n * po_numbers - Retrieves all PO numbers tied to the certificate.\r\n * attributes - Retrieves all attributes applied to the certificate.\r\n * histories - Retrieves the certificate update history\r\n * jobs - Retrieves the jobs for this certificate\r\n * logs - Retrieves the certificate log\r\n * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid\r\n * custom_fields - Retrieves custom fields set for this certificate", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* documentTypeId, documentTypeDescription, exemptionNumber, ecmsId, ecmsStatus, pdf, pages", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this vendor" }, { "key": "vendorCode", "value": "string", "description": "The unique code representing this vendor" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/vendors/:vendorCode/certificates?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "vendors", ":vendorCode", "certificates" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:\r\n \r\n * vendors - Retrieves the list of vendors linked to the certificate.\r\n * po_numbers - Retrieves all PO numbers tied to the certificate.\r\n * attributes - Retrieves all attributes applied to the certificate.\r\n * histories - Retrieves the certificate update history\r\n * jobs - Retrieves the jobs for this certificate\r\n * logs - Retrieves the certificate log\r\n * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid\r\n * custom_fields - Retrieves custom fields set for this certificate", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* documentTypeId, documentTypeDescription, exemptionNumber, ecmsId, ecmsStatus, pdf, pages", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this vendor" }, { "key": "vendorCode", "value": "string", "description": "The unique code representing this vendor" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "Retrieve a single vendor", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/vendors/:vendorCode?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "vendors", ":vendorCode" ], "query": [ { "key": "$include", "value": "string", "description": "Specify optional additional objects to include in this fetch request" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this vendor" }, { "key": "vendorCode", "value": "string" } ] }, "description": "Retrieve the vendor identified by this URL.\r\n \r\nA vendor object defines information about a person or business that purchases products from your\r\ncompany. When you create a tax transaction in AvaTax, you can use the `customerCode` from this\r\nrecord in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and\r\nidentify any certificates linked to this vendor object. If any certificate applies to the transaction,\r\nAvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.\r\n \r\nYou can use the `$include` parameter to fetch the following additional objects for expansion:\r\n \r\n* certificates - Fetch a list of certificates linked to this vendor.\r\n* attributes - Retrieves all attributes applied to the vendor.\r\n* active_certificates - Retrieves all the active certificates linked to this vendor\r\n* histories - Retrieves the update history for this vendor\r\n* logs - Retrieves vendor logs\r\n* jobs - Retrieves vendor jobs\r\n* billTos - Retrieves bill-tos linked with this vendor\r\n* shipTos - Retrieves ship-tos linked with this vendor\r\n* shipToStates - Retrieves ship-to states for this vendor\r\n* custom_fields - Retrieves custom fields set for this vendor\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/vendors/:vendorCode?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "vendors", ":vendorCode" ], "query": [ { "description": "Specify optional additional objects to include in this fetch request", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this vendor" }, { "key": "vendorCode", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"isVendor\": true,\n \"vendorAdditionalInfo\": {\n \"id\": 1,\n \"vendorId\": 12345,\n \"costCenterId\": 100,\n \"costCenterCode\": \"CC-MAIN\",\n \"itemCodeId\": 200,\n \"itemCode\": \"ITEM-001\",\n \"defaultTaxExemption\": \"RESALE\",\n \"shipFromLocationId\": 1001,\n \"shipFromLocationCode\": \"WAREHOUSE-01\",\n \"shipFromAddressLine\": \"1234 Warehouse Drive\",\n \"shipFromAddressCity\": \"Seattle\",\n \"shipFromAddressState\": \"WA\",\n \"shipFromAddressZip\": \"98101\",\n \"shipFromAddressCountry\": \"US\",\n \"shipToLocationId\": 2001,\n \"shipToLocationCode\": \"STORE-01\",\n \"shipToAddressLine\": \"5678 Main Street\",\n \"shipToAddressCity\": \"Portland\",\n \"shipToAddressState\": \"OR\",\n \"shipToAddressZip\": \"97201\",\n \"shipToAddressCountry\": \"US\",\n \"isTrustedVendor\": true,\n \"isAccrual\": false,\n \"isTaxOnVendor\": false\n },\n \"companyId\": 0,\n \"customerCode\": \"3bcff8d5-5c73-4640-b281-aa5c7bcc9802\",\n \"alternateId\": \"VENDOR123456\",\n \"name\": \"ABC Supply Company\",\n \"attnName\": \"Attn: Accounts Payable\",\n \"line1\": \"1234 Industrial Blvd\",\n \"city\": \"Chicago\",\n \"postalCode\": \"60601\",\n \"phoneNumber\": \"(312) 555-1234\",\n \"faxNumber\": \"312.555.1235\",\n \"emailAddress\": \"accounting@abcsupply.com\",\n \"contactName\": \"John Vendor\",\n \"country\": \"US\",\n \"region\": \"IL\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/vendors/:vendorCode?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "vendors", ":vendorCode" ], "query": [ { "description": "Specify optional additional objects to include in this fetch request", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this vendor" }, { "key": "vendorCode", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/vendors/:vendorCode?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "vendors", ":vendorCode" ], "query": [ { "description": "Specify optional additional objects to include in this fetch request", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this vendor" }, { "key": "vendorCode", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/vendors/:vendorCode?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "vendors", ":vendorCode" ], "query": [ { "description": "Specify optional additional objects to include in this fetch request", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this vendor" }, { "key": "vendorCode", "value": "string" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "List all vendors for this company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/vendors?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "vendors" ], "query": [ { "key": "$include", "value": "string", "description": "OPTIONAL - You can specify any of the values in `certificates`, `attributes`, `active_certificates`, `histories`, `logs`, `jobs`, `billTos`, `shipTos`, `shipToStates`, and `custom_fields` to fetch additional information for this certificate." }, { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* VendorAdditionalInfo" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this vendor" } ] }, "description": "List all vendors recorded by this company matching the specified criteria.\r\n \r\nA vendor object defines information about a person or business that purchases products from your\r\ncompany. When you create a tax transaction in AvaTax, you can use the `vendorCode` from this\r\nrecord in your `CreateTransaction` API call. AvaTax will search for this `vendorCode` value and\r\nidentify any certificates linked to this `vendor` object. If any certificate applies to the transaction,\r\nAvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.\r\n \r\nYou can use the `$include` parameter to fetch the following additional objects for expansion:\r\n \r\n* certificates - Fetch a list of certificates linked to this vendor.\r\n* attributes - Retrieves all attributes applied to the vendor.\r\n* active_certificates - Retrieves all the active certificates linked to this vendor\r\n* histories - Retrieves the update history for this vendor\r\n* logs - Retrieves vendor logs\r\n* jobs - Retrieves vendor jobs\r\n* billTos - Retrieves bill-tos linked with this vendor\r\n* shipTos - Retrieves ship-tos linked with this vendor\r\n* shipToStates - Retrieves ship-to states for this vendor\r\n* custom_fields - Retrieves custom fields set for this vendor\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\r\n \r\nNote* Filtering not supported for isVendor field.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/vendors?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "vendors" ], "query": [ { "description": "OPTIONAL - You can specify any of the values in `certificates`, `attributes`, `active_certificates`, `histories`, `logs`, `jobs`, `billTos`, `shipTos`, `shipToStates`, and `custom_fields` to fetch additional information for this certificate.", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* VendorAdditionalInfo", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this vendor" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 705,\n \"value\": [\n {\n \"isVendor\": true,\n \"vendorAdditionalInfo\": {\n \"id\": 1,\n \"vendorId\": 12345,\n \"costCenterId\": 100,\n \"costCenterCode\": \"CC-MAIN\",\n \"itemCodeId\": 200,\n \"itemCode\": \"ITEM-001\",\n \"defaultTaxExemption\": \"RESALE\",\n \"shipFromLocationId\": 1001,\n \"shipFromLocationCode\": \"WAREHOUSE-01\",\n \"shipFromAddressLine\": \"1234 Warehouse Drive\",\n \"shipFromAddressCity\": \"Seattle\",\n \"shipFromAddressState\": \"WA\",\n \"shipFromAddressZip\": \"98101\",\n \"shipFromAddressCountry\": \"US\",\n \"shipToLocationId\": 2001,\n \"shipToLocationCode\": \"STORE-01\",\n \"shipToAddressLine\": \"5678 Main Street\",\n \"shipToAddressCity\": \"Portland\",\n \"shipToAddressState\": \"OR\",\n \"shipToAddressZip\": \"97201\",\n \"shipToAddressCountry\": \"US\",\n \"isTrustedVendor\": true,\n \"isAccrual\": false,\n \"isTaxOnVendor\": false\n },\n \"companyId\": 0,\n \"customerCode\": \"3bcff8d5-5c73-4640-b281-aa5c7bcc9802\",\n \"alternateId\": \"VENDOR123456\",\n \"name\": \"ABC Supply Company\",\n \"attnName\": \"Attn: Accounts Payable\",\n \"line1\": \"1234 Industrial Blvd\",\n \"city\": \"Chicago\",\n \"postalCode\": \"60601\",\n \"phoneNumber\": \"(312) 555-1234\",\n \"faxNumber\": \"312.555.1235\",\n \"emailAddress\": \"accounting@abcsupply.com\",\n \"contactName\": \"John Vendor\",\n \"country\": \"US\",\n \"region\": \"IL\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/vendors?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "vendors" ], "query": [ { "description": "OPTIONAL - You can specify any of the values in `certificates`, `attributes`, `active_certificates`, `histories`, `logs`, `jobs`, `billTos`, `shipTos`, `shipToStates`, and `custom_fields` to fetch additional information for this certificate.", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* VendorAdditionalInfo", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this vendor" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/vendors?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "vendors" ], "query": [ { "description": "OPTIONAL - You can specify any of the values in `certificates`, `attributes`, `active_certificates`, `histories`, `logs`, `jobs`, `billTos`, `shipTos`, `shipToStates`, and `custom_fields` to fetch additional information for this certificate.", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* VendorAdditionalInfo", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this vendor" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/vendors?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "vendors" ], "query": [ { "description": "OPTIONAL - You can specify any of the values in `certificates`, `attributes`, `active_certificates`, `histories`, `logs`, `jobs`, `billTos`, `shipTos`, `shipToStates`, and `custom_fields` to fetch additional information for this certificate.", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* VendorAdditionalInfo", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this vendor" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] }, { "name": "Create vendors for this company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"isVendor\": true,\n \"vendorAdditionalInfo\": {\n \"id\": 1,\n \"vendorId\": 12345,\n \"costCenterId\": 100,\n \"costCenterCode\": \"CC-MAIN\",\n \"itemCodeId\": 200,\n \"itemCode\": \"ITEM-001\",\n \"defaultTaxExemption\": \"RESALE\",\n \"shipFromLocationId\": 1001,\n \"shipFromLocationCode\": \"WAREHOUSE-01\",\n \"shipFromAddressLine\": \"1234 Warehouse Drive\",\n \"shipFromAddressCity\": \"Seattle\",\n \"shipFromAddressState\": \"WA\",\n \"shipFromAddressZip\": \"98101\",\n \"shipFromAddressCountry\": \"US\",\n \"shipToLocationId\": 2001,\n \"shipToLocationCode\": \"STORE-01\",\n \"shipToAddressLine\": \"5678 Main Street\",\n \"shipToAddressCity\": \"Portland\",\n \"shipToAddressState\": \"OR\",\n \"shipToAddressZip\": \"97201\",\n \"shipToAddressCountry\": \"US\",\n \"isTrustedVendor\": true,\n \"isAccrual\": false,\n \"isTaxOnVendor\": false\n },\n \"companyId\": 0,\n \"customerCode\": \"3bcff8d5-5c73-4640-b281-aa5c7bcc9802\",\n \"alternateId\": \"VENDOR123456\",\n \"name\": \"ABC Supply Company\",\n \"attnName\": \"Attn: Accounts Payable\",\n \"line1\": \"1234 Industrial Blvd\",\n \"city\": \"Chicago\",\n \"postalCode\": \"60601\",\n \"phoneNumber\": \"(312) 555-1234\",\n \"faxNumber\": \"312.555.1235\",\n \"emailAddress\": \"accounting@abcsupply.com\",\n \"contactName\": \"John Vendor\",\n \"country\": \"US\",\n \"region\": \"IL\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/vendors", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "vendors" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this vendor" } ] }, "description": "Create one or more vendors for this company.\r\n \r\nA vendor object defines information about a person or business that purchases products from your\r\ncompany. When you create a tax transaction in AvaTax, you can use the `vendorCode` from this\r\nrecord in your `CreateTransaction` API call. AvaTax will search for this `vendorCode` value and\r\nidentify any certificates linked to this `vendor` object. If any certificate applies to the transaction,\r\nAvaTax will record the appropriate elements of the transaction as exempt and link it to the `certificate`.\r\n \r\nA nested object such as CustomFields could be specified and created along with the vendor object. To fetch the\r\nnested object, please call 'GetVendor' API with appropriate $include parameters.\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"isVendor\": true,\n \"vendorAdditionalInfo\": {\n \"id\": 1,\n \"vendorId\": 12345,\n \"costCenterId\": 100,\n \"costCenterCode\": \"CC-MAIN\",\n \"itemCodeId\": 200,\n \"itemCode\": \"ITEM-001\",\n \"defaultTaxExemption\": \"RESALE\",\n \"shipFromLocationId\": 1001,\n \"shipFromLocationCode\": \"WAREHOUSE-01\",\n \"shipFromAddressLine\": \"1234 Warehouse Drive\",\n \"shipFromAddressCity\": \"Seattle\",\n \"shipFromAddressState\": \"WA\",\n \"shipFromAddressZip\": \"98101\",\n \"shipFromAddressCountry\": \"US\",\n \"shipToLocationId\": 2001,\n \"shipToLocationCode\": \"STORE-01\",\n \"shipToAddressLine\": \"5678 Main Street\",\n \"shipToAddressCity\": \"Portland\",\n \"shipToAddressState\": \"OR\",\n \"shipToAddressZip\": \"97201\",\n \"shipToAddressCountry\": \"US\",\n \"isTrustedVendor\": true,\n \"isAccrual\": false,\n \"isTaxOnVendor\": false\n },\n \"companyId\": 0,\n \"customerCode\": \"3bcff8d5-5c73-4640-b281-aa5c7bcc9802\",\n \"alternateId\": \"VENDOR123456\",\n \"name\": \"ABC Supply Company\",\n \"attnName\": \"Attn: Accounts Payable\",\n \"line1\": \"1234 Industrial Blvd\",\n \"city\": \"Chicago\",\n \"postalCode\": \"60601\",\n \"phoneNumber\": \"(312) 555-1234\",\n \"faxNumber\": \"312.555.1235\",\n \"emailAddress\": \"accounting@abcsupply.com\",\n \"contactName\": \"John Vendor\",\n \"country\": \"US\",\n \"region\": \"IL\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/vendors", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "vendors" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this vendor" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"isVendor\": true,\n \"vendorAdditionalInfo\": {\n \"id\": 1,\n \"vendorId\": 12345,\n \"costCenterId\": 100,\n \"costCenterCode\": \"CC-MAIN\",\n \"itemCodeId\": 200,\n \"itemCode\": \"ITEM-001\",\n \"defaultTaxExemption\": \"RESALE\",\n \"shipFromLocationId\": 1001,\n \"shipFromLocationCode\": \"WAREHOUSE-01\",\n \"shipFromAddressLine\": \"1234 Warehouse Drive\",\n \"shipFromAddressCity\": \"Seattle\",\n \"shipFromAddressState\": \"WA\",\n \"shipFromAddressZip\": \"98101\",\n \"shipFromAddressCountry\": \"US\",\n \"shipToLocationId\": 2001,\n \"shipToLocationCode\": \"STORE-01\",\n \"shipToAddressLine\": \"5678 Main Street\",\n \"shipToAddressCity\": \"Portland\",\n \"shipToAddressState\": \"OR\",\n \"shipToAddressZip\": \"97201\",\n \"shipToAddressCountry\": \"US\",\n \"isTrustedVendor\": true,\n \"isAccrual\": false,\n \"isTaxOnVendor\": false\n },\n \"companyId\": 0,\n \"customerCode\": \"3bcff8d5-5c73-4640-b281-aa5c7bcc9802\",\n \"alternateId\": \"VENDOR123456\",\n \"name\": \"ABC Supply Company\",\n \"attnName\": \"Attn: Accounts Payable\",\n \"line1\": \"1234 Industrial Blvd\",\n \"city\": \"Chicago\",\n \"postalCode\": \"60601\",\n \"phoneNumber\": \"(312) 555-1234\",\n \"faxNumber\": \"312.555.1235\",\n \"emailAddress\": \"accounting@abcsupply.com\",\n \"contactName\": \"John Vendor\",\n \"country\": \"US\",\n \"region\": \"IL\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"isVendor\": true,\n \"vendorAdditionalInfo\": {\n \"id\": 1,\n \"vendorId\": 12345,\n \"costCenterId\": 100,\n \"costCenterCode\": \"CC-MAIN\",\n \"itemCodeId\": 200,\n \"itemCode\": \"ITEM-001\",\n \"defaultTaxExemption\": \"RESALE\",\n \"shipFromLocationId\": 1001,\n \"shipFromLocationCode\": \"WAREHOUSE-01\",\n \"shipFromAddressLine\": \"1234 Warehouse Drive\",\n \"shipFromAddressCity\": \"Seattle\",\n \"shipFromAddressState\": \"WA\",\n \"shipFromAddressZip\": \"98101\",\n \"shipFromAddressCountry\": \"US\",\n \"shipToLocationId\": 2001,\n \"shipToLocationCode\": \"STORE-01\",\n \"shipToAddressLine\": \"5678 Main Street\",\n \"shipToAddressCity\": \"Portland\",\n \"shipToAddressState\": \"OR\",\n \"shipToAddressZip\": \"97201\",\n \"shipToAddressCountry\": \"US\",\n \"isTrustedVendor\": true,\n \"isAccrual\": false,\n \"isTaxOnVendor\": false\n },\n \"companyId\": 0,\n \"customerCode\": \"3bcff8d5-5c73-4640-b281-aa5c7bcc9802\",\n \"alternateId\": \"VENDOR123456\",\n \"name\": \"ABC Supply Company\",\n \"attnName\": \"Attn: Accounts Payable\",\n \"line1\": \"1234 Industrial Blvd\",\n \"city\": \"Chicago\",\n \"postalCode\": \"60601\",\n \"phoneNumber\": \"(312) 555-1234\",\n \"faxNumber\": \"312.555.1235\",\n \"emailAddress\": \"accounting@abcsupply.com\",\n \"contactName\": \"John Vendor\",\n \"country\": \"US\",\n \"region\": \"IL\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/vendors", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "vendors" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this vendor" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"isVendor\": true,\n \"vendorAdditionalInfo\": {\n \"id\": 1,\n \"vendorId\": 12345,\n \"costCenterId\": 100,\n \"costCenterCode\": \"CC-MAIN\",\n \"itemCodeId\": 200,\n \"itemCode\": \"ITEM-001\",\n \"defaultTaxExemption\": \"RESALE\",\n \"shipFromLocationId\": 1001,\n \"shipFromLocationCode\": \"WAREHOUSE-01\",\n \"shipFromAddressLine\": \"1234 Warehouse Drive\",\n \"shipFromAddressCity\": \"Seattle\",\n \"shipFromAddressState\": \"WA\",\n \"shipFromAddressZip\": \"98101\",\n \"shipFromAddressCountry\": \"US\",\n \"shipToLocationId\": 2001,\n \"shipToLocationCode\": \"STORE-01\",\n \"shipToAddressLine\": \"5678 Main Street\",\n \"shipToAddressCity\": \"Portland\",\n \"shipToAddressState\": \"OR\",\n \"shipToAddressZip\": \"97201\",\n \"shipToAddressCountry\": \"US\",\n \"isTrustedVendor\": true,\n \"isAccrual\": false,\n \"isTaxOnVendor\": false\n },\n \"companyId\": 0,\n \"customerCode\": \"3bcff8d5-5c73-4640-b281-aa5c7bcc9802\",\n \"alternateId\": \"VENDOR123456\",\n \"name\": \"ABC Supply Company\",\n \"attnName\": \"Attn: Accounts Payable\",\n \"line1\": \"1234 Industrial Blvd\",\n \"city\": \"Chicago\",\n \"postalCode\": \"60601\",\n \"phoneNumber\": \"(312) 555-1234\",\n \"faxNumber\": \"312.555.1235\",\n \"emailAddress\": \"accounting@abcsupply.com\",\n \"contactName\": \"John Vendor\",\n \"country\": \"US\",\n \"region\": \"IL\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/vendors", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "vendors" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this vendor" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"isVendor\": true,\n \"vendorAdditionalInfo\": {\n \"id\": 1,\n \"vendorId\": 12345,\n \"costCenterId\": 100,\n \"costCenterCode\": \"CC-MAIN\",\n \"itemCodeId\": 200,\n \"itemCode\": \"ITEM-001\",\n \"defaultTaxExemption\": \"RESALE\",\n \"shipFromLocationId\": 1001,\n \"shipFromLocationCode\": \"WAREHOUSE-01\",\n \"shipFromAddressLine\": \"1234 Warehouse Drive\",\n \"shipFromAddressCity\": \"Seattle\",\n \"shipFromAddressState\": \"WA\",\n \"shipFromAddressZip\": \"98101\",\n \"shipFromAddressCountry\": \"US\",\n \"shipToLocationId\": 2001,\n \"shipToLocationCode\": \"STORE-01\",\n \"shipToAddressLine\": \"5678 Main Street\",\n \"shipToAddressCity\": \"Portland\",\n \"shipToAddressState\": \"OR\",\n \"shipToAddressZip\": \"97201\",\n \"shipToAddressCountry\": \"US\",\n \"isTrustedVendor\": true,\n \"isAccrual\": false,\n \"isTaxOnVendor\": false\n },\n \"companyId\": 0,\n \"customerCode\": \"3bcff8d5-5c73-4640-b281-aa5c7bcc9802\",\n \"alternateId\": \"VENDOR123456\",\n \"name\": \"ABC Supply Company\",\n \"attnName\": \"Attn: Accounts Payable\",\n \"line1\": \"1234 Industrial Blvd\",\n \"city\": \"Chicago\",\n \"postalCode\": \"60601\",\n \"phoneNumber\": \"(312) 555-1234\",\n \"faxNumber\": \"312.555.1235\",\n \"emailAddress\": \"accounting@abcsupply.com\",\n \"contactName\": \"John Vendor\",\n \"country\": \"US\",\n \"region\": \"IL\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyId/vendors", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyId", "vendors" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded this vendor" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] } ] }, { "name": "{accountId}", "item": [ { "name": "clerk", "item": [ { "name": "locations", "item": [ { "name": "Retrieves a list of location records associated with the specified account.\r\nThis endpoint is secured and requires appropriate subscription and permission levels.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:accountId/clerk/locations?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":accountId", "clerk", "locations" ], "query": [ { "key": "$include", "value": "string", "description": "OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:" }, { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* id" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "accountId", "value": "451", "description": "The unique identifier of the account whose locations are being requested." } ] }, "description": "\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:accountId/clerk/locations?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":accountId", "clerk", "locations" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* id", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "accountId", "value": "451", "description": "The unique identifier of the account whose locations are being requested." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 5881,\n \"value\": [\n {\n \"id\": 1,\n \"name\": \"Main Office\",\n \"code\": \"MAIN001\",\n \"addressLine1\": \"123 Business Ave\",\n \"addressLine2\": \"Suite 100\",\n \"city\": \"Seattle\",\n \"zip\": \"98101\",\n \"stateId\": 53,\n \"stateName\": \"Washington\",\n \"stateInitials\": \"WA\",\n \"countryId\": 1,\n \"countryName\": \"United States\",\n \"countryInitials\": \"USA\",\n \"clientId\": 100,\n \"clientName\": \"Example Corp\",\n \"avataxCompanyId\": \"12345\"\n },\n {\n \"id\": 1,\n \"name\": \"Main Office\",\n \"code\": \"MAIN001\",\n \"addressLine1\": \"123 Business Ave\",\n \"addressLine2\": \"Suite 100\",\n \"city\": \"Seattle\",\n \"zip\": \"98101\",\n \"stateId\": 53,\n \"stateName\": \"Washington\",\n \"stateInitials\": \"WA\",\n \"countryId\": 1,\n \"countryName\": \"United States\",\n \"countryInitials\": \"USA\",\n \"clientId\": 100,\n \"clientName\": \"Example Corp\",\n \"avataxCompanyId\": \"12345\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:accountId/clerk/locations?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":accountId", "clerk", "locations" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* id", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "accountId", "value": "451", "description": "The unique identifier of the account whose locations are being requested." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:accountId/clerk/locations?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":accountId", "clerk", "locations" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* id", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "accountId", "value": "451", "description": "The unique identifier of the account whose locations are being requested." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:accountId/clerk/locations?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":accountId", "clerk", "locations" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* id", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "accountId", "value": "451", "description": "The unique identifier of the account whose locations are being requested." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] } ] } ] }, { "name": "{id}", "item": [ { "name": "certify", "item": [ { "name": "Checks whether the integration being used to set up this company and run transactions onto this company is compliant to all requirements.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/certify", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "certify" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the company to check if its integration is certified." } ] }, "description": "Examines the most recent 100 transactions or data from the last month when verifying transaction-related integrations.\r\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\r\nwritten integrations for a company are sufficient enough to be delivered to the respective customers to start using it.\r\n \r\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.\r\nThe API makes the following checks to conclude if the company is NOT fully certified:\r\n1. Any past month items contains generic tax code of P0000000.\r\n2. All the companies on the requesting account are test companies.\r\n3. No Voided/Cancelled documents in the past 30 days.\r\n4. There are less than 2 committed documents.\r\n5. Any documentCode is a generic GUID string.\r\n6. Any customerCode on document is a generic GUID string.\r\n7. No document has more than 1 documentLine.\r\n8. All of the documents have missing exemptionNo, customerUsageType, taxDateOverride or negative amount.\r\n9. Any document quantity is a negative number.\r\n10. Any document have repeated lines.\r\n11. No document has shipping charge.\r\n12. All documents have same ItemCodes, descriptions and taxCodes.\r\n13. Less than 2 addresses used across all documents.\r\n14. Whether locationCode was used in documents.\r\n15. Account with AvaGlobal subscription and no documents have VATBuyerId.\r\n16. Any document has currencyCode not being USD for accounts with AvaGlobal subscription.\r\n17. All documents have countryCode used for accounts with AvaGlobal subscription.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/certify", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "certify" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the company to check if its integration is certified." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "string" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/certify", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "certify" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the company to check if its integration is certified." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/certify", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "certify" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the company to check if its integration is certified." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/certify", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "certify" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the company to check if its integration is certified." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "configuration", "item": [ { "name": "Get configuration settings for this company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/configuration", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "configuration" ], "variable": [ { "key": "id", "value": "451" } ] }, "description": "Retrieve a list of all configuration settings tied to this company.\r\n \r\nConfiguration settings provide you with the ability to control features of your account and of your\r\ntax software. The category name `AvaCertServiceConfig` is reserved for\r\nAvalara internal software configuration values; to store your own company-level settings, please\r\ncreate a new category name that begins with `X-`, for example, `X-MyCustomCategory`.\r\n \r\nCompany settings are permanent settings that cannot be deleted. You can set the value of a\r\ncompany setting to null if desired and if the particular setting supports it.\r\n \r\nAvalara-based company settings for `AvaCertServiceConfig` affect your company's exemption certificate\r\nprocessing, and should be changed with care.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/configuration", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "configuration" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"companyId\": 0,\n \"category\": \"AvaCertServiceConfig\",\n \"name\": \"AllowPending\",\n \"value\": \"true\"\n },\n {\n \"companyId\": 0,\n \"category\": \"AvaCertServiceConfig\",\n \"name\": \"AllowPending\",\n \"value\": \"true\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/configuration", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "configuration" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/configuration", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "configuration" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/configuration", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "configuration" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] }, { "name": "Change configuration settings for this company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"companyId\": 0,\n \"category\": \"AvaCertServiceConfig\",\n \"name\": \"AllowPending\",\n \"value\": \"true\"\n },\n {\n \"companyId\": 0,\n \"category\": \"AvaCertServiceConfig\",\n \"name\": \"AllowPending\",\n \"value\": \"true\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/configuration", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "configuration" ], "variable": [ { "key": "id", "value": "451" } ] }, "description": "Update configuration settings tied to this company.\r\n \r\nConfiguration settings provide you with the ability to control features of your account and of your\r\ntax software. The category names `AvaCertServiceConfig` is reserved for\r\nAvalara internal software configuration values; to store your own company-level settings, please\r\ncreate a new category name that begins with `X-`, for example, `X-MyCustomCategory`.\r\n \r\nCompany settings are permanent settings that cannot be deleted. You can set the value of a\r\ncompany setting to null if desired and if the particular setting supports it.\r\n \r\nAvalara-based company settings for `AvaCertServiceConfig` affect your company's exemption certificate\r\nprocessing, and should be changed with care.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"companyId\": 0,\n \"category\": \"AvaCertServiceConfig\",\n \"name\": \"AllowPending\",\n \"value\": \"true\"\n },\n {\n \"companyId\": 0,\n \"category\": \"AvaCertServiceConfig\",\n \"name\": \"AllowPending\",\n \"value\": \"true\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/configuration", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "configuration" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"companyId\": 0,\n \"category\": \"AvaCertServiceConfig\",\n \"name\": \"AllowPending\",\n \"value\": \"true\"\n },\n {\n \"companyId\": 0,\n \"category\": \"AvaCertServiceConfig\",\n \"name\": \"AllowPending\",\n \"value\": \"true\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"companyId\": 0,\n \"category\": \"AvaCertServiceConfig\",\n \"name\": \"AllowPending\",\n \"value\": \"true\"\n },\n {\n \"companyId\": 0,\n \"category\": \"AvaCertServiceConfig\",\n \"name\": \"AllowPending\",\n \"value\": \"true\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/configuration", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "configuration" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"companyId\": 0,\n \"category\": \"AvaCertServiceConfig\",\n \"name\": \"AllowPending\",\n \"value\": \"true\"\n },\n {\n \"companyId\": 0,\n \"category\": \"AvaCertServiceConfig\",\n \"name\": \"AllowPending\",\n \"value\": \"true\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/configuration", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "configuration" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"companyId\": 0,\n \"category\": \"AvaCertServiceConfig\",\n \"name\": \"AllowPending\",\n \"value\": \"true\"\n },\n {\n \"companyId\": 0,\n \"category\": \"AvaCertServiceConfig\",\n \"name\": \"AllowPending\",\n \"value\": \"true\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/configuration", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "configuration" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "filingstatus", "item": [ { "name": "Get this company's filing status", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/filingstatus", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "filingstatus" ], "variable": [ { "key": "id", "value": "451" } ] }, "description": "Retrieve the current filing status of this company.\r\n \r\nFor customers using Avalara's Managed Returns Service, each company within their account can request\r\nfor Avalara to file tax returns on their behalf. Avalara compliance team members will review all\r\nrequested filing calendars prior to beginning filing tax returns on behalf of this company.\r\n \r\nA company's filing status can be one of the following values:\r\n \r\n* `NoReporting` - This company is not configured to report tax returns; instead, it reports through a parent company.\r\n* `NotYetFiling` - This company has not yet begun filing tax returns through Avalara's Managed Returns Service.\r\n* `FilingRequested` - The company has requested to begin filing tax returns, but Avalara's compliance team has not yet begun filing.\r\n* `FirstFiling` - The company has recently filing tax returns and is in a new status.\r\n* `Active` - The company is currently active and is filing tax returns via Avalara Managed Returns.\r\n* `Inactive` - The company is currently inactive.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/filingstatus", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "filingstatus" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "NotConfiguredForCompliance" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/filingstatus", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "filingstatus" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/filingstatus", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "filingstatus" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/filingstatus", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "filingstatus" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] }, { "name": "Change the filing status of this company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"requestedStatus\": \"FirstFiling\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/filingstatus", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "filingstatus" ], "variable": [ { "key": "id", "value": "451" } ] }, "description": "Changes the current filing status of this company.\r\n \r\nFor customers using Avalara's Managed Returns Service, each company within their account can request\r\nfor Avalara to file tax returns on their behalf. Avalara compliance team members will review all\r\nrequested filing calendars prior to beginning filing tax returns on behalf of this company.\r\n \r\nThe following changes may be requested through this API:\r\n \r\n* If a company is in `NotYetFiling` status, the customer may request this be changed to `FilingRequested`.\r\n* Avalara compliance team members may change a company from `FilingRequested` to `FirstFiling`.\r\n* Avalara compliance team members may change a company from `FirstFiling` to `Active`.\r\n \r\nAll other status changes must be requested through the Avalara customer support team.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"requestedStatus\": \"FirstFiling\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/filingstatus", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "filingstatus" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "NotConfiguredForCompliance" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"requestedStatus\": \"FirstFiling\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/filingstatus", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "filingstatus" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"requestedStatus\": \"FirstFiling\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/filingstatus", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "filingstatus" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"requestedStatus\": \"FirstFiling\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/filingstatus", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "filingstatus" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "funding", "item": [ { "name": "setup", "item": [ { "name": "Request managed returns funding setup for a company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"requestEmail\": true,\n \"fundingEmailRecipient\": \"user@example.org\",\n \"currency\": \"USD\",\n \"agreementType\": \"ACHDebit\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/funding/setup?businessUnit=Telecom&subscriptionType=AvaComms", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "funding", "setup" ], "query": [ { "key": "businessUnit", "value": "Telecom", "description": "The company's business unit" }, { "key": "subscriptionType", "value": "AvaComms", "description": "The company's subscription type" } ], "variable": [ { "key": "id", "value": "451", "description": "The unique identifier of the company" } ] }, "description": "This API is available by invitation only.\r\nCompanies that use the Avalara Managed Returns or the SST Certified Service Provider services are\r\nrequired to setup their funding configuration before Avalara can begin filing tax returns on their\r\nbehalf.\r\nFunding configuration for each company is set up by submitting a funding setup request, which can\r\nbe sent either via email or via an embedded HTML widget.\r\nWhen the funding configuration is submitted to Avalara, it will be reviewed by treasury team members\r\nbefore approval.\r\nThis API records that an ambedded HTML funding setup widget was activated.\r\nThis API requires a subscription to Avalara Managed Returns or SST Certified Service Provider.\n\n### Security Policies\n\n* This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"requestEmail\": true,\n \"fundingEmailRecipient\": \"user@example.org\",\n \"currency\": \"USD\",\n \"agreementType\": \"ACHDebit\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/funding/setup?businessUnit=Telecom&subscriptionType=AvaComms", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "funding", "setup" ], "query": [ { "description": "The company's business unit", "key": "businessUnit", "value": "Telecom" }, { "description": "The company's subscription type", "key": "subscriptionType", "value": "AvaComms" } ], "variable": [ { "key": "id", "value": "451", "description": "The unique identifier of the company" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"requestId\": 12345,\n \"subledgerProfileID\": 12345,\n \"companyID\": \"123456\",\n \"domain\": \"AvaTax15\",\n \"recipient\": \"bob@example.org\",\n \"sender\": \"treasury@avalara.com\",\n \"documentKey\": \"RTdIy3AAABLblqZhBCV9kul4F1qC -\",\n \"documentType\": \"ACH\",\n \"documentName\": \"New Customer - Avalara Returns Funding Power of Attorney\",\n \"methodReturn\": {\n \"javaScriptReady\": false\n },\n \"status\": \"Expired\",\n \"lastPolled\": \"2016-01-01T20:16:17\",\n \"lastActivated\": \"2016-01-01T19:16:17\",\n \"currency\": \"USD\",\n \"agreementType\": \"ACHDebit\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"requestEmail\": true,\n \"fundingEmailRecipient\": \"user@example.org\",\n \"currency\": \"USD\",\n \"agreementType\": \"ACHDebit\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/funding/setup?businessUnit=Telecom&subscriptionType=AvaComms", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "funding", "setup" ], "query": [ { "description": "The company's business unit", "key": "businessUnit", "value": "Telecom" }, { "description": "The company's subscription type", "key": "subscriptionType", "value": "AvaComms" } ], "variable": [ { "key": "id", "value": "451", "description": "The unique identifier of the company" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"requestEmail\": true,\n \"fundingEmailRecipient\": \"user@example.org\",\n \"currency\": \"USD\",\n \"agreementType\": \"ACHDebit\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/funding/setup?businessUnit=Telecom&subscriptionType=AvaComms", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "funding", "setup" ], "query": [ { "description": "The company's business unit", "key": "businessUnit", "value": "Telecom" }, { "description": "The company's subscription type", "key": "subscriptionType", "value": "AvaComms" } ], "variable": [ { "key": "id", "value": "451", "description": "The unique identifier of the company" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"requestEmail\": true,\n \"fundingEmailRecipient\": \"user@example.org\",\n \"currency\": \"USD\",\n \"agreementType\": \"ACHDebit\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/funding/setup?businessUnit=Telecom&subscriptionType=AvaComms", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "funding", "setup" ], "query": [ { "description": "The company's business unit", "key": "businessUnit", "value": "Telecom" }, { "description": "The company's subscription type", "key": "subscriptionType", "value": "AvaComms" } ], "variable": [ { "key": "id", "value": "451", "description": "The unique identifier of the company" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "Check managed returns funding status for a company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/funding", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "funding" ], "variable": [ { "key": "id", "value": "451", "description": "The unique identifier of the company" } ] }, "description": "This API is available by invitation only.\r\nRequires a subscription to Avalara Managed Returns or SST Certified Service Provider.\r\nReturns a list of funding setup requests and their current status.\r\nEach object in the result is a request that was made to setup or adjust funding status for this company.\n\n### Security Policies\n\n* This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/funding", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "funding" ], "variable": [ { "key": "id", "value": "451", "description": "The unique identifier of the company" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"requestId\": 12345,\n \"subledgerProfileID\": 12345,\n \"companyID\": \"123456\",\n \"domain\": \"AvaTax15\",\n \"recipient\": \"bob@example.org\",\n \"sender\": \"treasury@avalara.com\",\n \"documentKey\": \"RTdIy3AAABLblqZhBCV9kul4F1qC -\",\n \"documentType\": \"ACH\",\n \"documentName\": \"New Customer - Avalara Returns Funding Power of Attorney\",\n \"methodReturn\": {\n \"javaScriptReady\": false\n },\n \"status\": \"Expired\",\n \"lastPolled\": \"2016-01-01T20:16:17\",\n \"lastActivated\": \"2016-01-01T19:16:17\",\n \"currency\": \"USD\",\n \"agreementType\": \"ACHDebit\"\n },\n {\n \"requestId\": 12345,\n \"subledgerProfileID\": 12345,\n \"companyID\": \"123456\",\n \"domain\": \"AvaTax15\",\n \"recipient\": \"bob@example.org\",\n \"sender\": \"treasury@avalara.com\",\n \"documentKey\": \"RTdIy3AAABLblqZhBCV9kul4F1qC -\",\n \"documentType\": \"ACH\",\n \"documentName\": \"New Customer - Avalara Returns Funding Power of Attorney\",\n \"methodReturn\": {\n \"javaScriptReady\": false\n },\n \"status\": \"Expired\",\n \"lastPolled\": \"2016-01-01T20:16:17\",\n \"lastActivated\": \"2016-01-01T19:16:17\",\n \"currency\": \"USD\",\n \"agreementType\": \"ACHDebit\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/funding", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "funding" ], "variable": [ { "key": "id", "value": "451", "description": "The unique identifier of the company" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/funding", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "funding" ], "variable": [ { "key": "id", "value": "451", "description": "The unique identifier of the company" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/funding", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "funding" ], "variable": [ { "key": "id", "value": "451", "description": "The unique identifier of the company" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "paymentdetails", "item": [ { "name": "{periodyear}", "item": [ { "name": "{periodmonth}", "item": [ { "name": "Get ACH entry detail report for company and period", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/paymentdetails/:periodyear/:periodmonth", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "paymentdetails", ":periodyear", ":periodmonth" ], "variable": [ { "key": "id", "value": "451", "description": "The unique identifier of the company" }, { "key": "periodyear", "value": "451", "description": "The period year" }, { "key": "periodmonth", "value": "451", "description": "The period month" } ] }, "description": "This API is available by invitation only.\r\nRequires a subscription to Avalara Managed Returns or SST Certified Service Provider.\r\nReturns a list of ACH entry details for the given company and period.\r\nEach object in the result is an ach entry trace record for a payment made on behalf of this company.\n\n### Security Policies\n\n* This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/paymentdetails/:periodyear/:periodmonth", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "paymentdetails", ":periodyear", ":periodmonth" ], "variable": [ { "key": "id", "value": "451", "description": "The unique identifier of the company" }, { "key": "periodyear", "value": "451", "description": "The period year" }, { "key": "periodmonth", "value": "451", "description": "The period month" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"companyId\": 1,\n \"companyName\": \"Cmpany Name\",\n \"state\": \"TENNESSEE\",\n \"stateRegion\": \"TN\",\n \"individualId\": \"\",\n \"individualName\": \"\",\n \"amount\": 1.23,\n \"traceNumber\": \"\"\n },\n {\n \"companyId\": 1,\n \"companyName\": \"Cmpany Name\",\n \"state\": \"TENNESSEE\",\n \"stateRegion\": \"TN\",\n \"individualId\": \"\",\n \"individualName\": \"\",\n \"amount\": 1.23,\n \"traceNumber\": \"\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/paymentdetails/:periodyear/:periodmonth", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "paymentdetails", ":periodyear", ":periodmonth" ], "variable": [ { "key": "id", "value": "451", "description": "The unique identifier of the company" }, { "key": "periodyear", "value": "451", "description": "The period year" }, { "key": "periodmonth", "value": "451", "description": "The period month" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/paymentdetails/:periodyear/:periodmonth", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "paymentdetails", ":periodyear", ":periodmonth" ], "variable": [ { "key": "id", "value": "451", "description": "The unique identifier of the company" }, { "key": "periodyear", "value": "451", "description": "The period year" }, { "key": "periodmonth", "value": "451", "description": "The period month" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:id/paymentdetails/:periodyear/:periodmonth", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id", "paymentdetails", ":periodyear", ":periodmonth" ], "variable": [ { "key": "id", "value": "451", "description": "The unique identifier of the company" }, { "key": "periodyear", "value": "451", "description": "The period year" }, { "key": "periodmonth", "value": "451", "description": "The period month" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] } ] } ] }, { "name": "Retrieve a single company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id" ], "query": [ { "key": "$include", "value": "string", "description": "OPTIONAL: A comma separated list of special fetch options.\r\n \r\n * Child objects - Specify one or more of the following to retrieve objects related to each company: \"Contacts\", \"FilingCalendars\", \"Items\", \"Locations\", \"Nexus\", \"TaxCodes\", \"NonReportingChildren\" or \"TaxRules\".\r\n * Deleted objects - Specify \"FetchDeleted\" to retrieve information about previously deleted objects." } ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the company to retrieve." } ] }, "description": "Get the company object identified by this URL.\r\nA 'company' represents a single corporation or individual that is registered to handle transactional taxes.\r\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:\r\n \r\n * Contacts\r\n * Items\r\n * Locations\r\n * Nexus\r\n * Settings\r\n * TaxCodes\r\n * TaxRules\r\n * UPC\r\n * Parameters\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options.\r\n \r\n * Child objects - Specify one or more of the following to retrieve objects related to each company: \"Contacts\", \"FilingCalendars\", \"Items\", \"Locations\", \"Nexus\", \"TaxCodes\", \"NonReportingChildren\" or \"TaxRules\".\r\n * Deleted objects - Specify \"FetchDeleted\" to retrieve information about previously deleted objects.", "key": "$include", "value": "string" } ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the company to retrieve." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 12345,\n \"accountId\": 123456789,\n \"companyCode\": \"DEFAULT\",\n \"name\": \"Default Company\",\n \"isDefault\": false,\n \"isActive\": true,\n \"taxpayerIdNumber\": \"123456789\",\n \"isFein\": false,\n \"hasProfile\": true,\n \"isReportingEntity\": false,\n \"defaultCountry\": \"US\",\n \"baseCurrencyCode\": \"USD\",\n \"roundingLevelId\": \"Document\",\n \"isTest\": true,\n \"taxDependencyLevelId\": \"Document\",\n \"inProgress\": false,\n \"isDeleted\": false,\n \"isAdvSave\": false\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options.\r\n \r\n * Child objects - Specify one or more of the following to retrieve objects related to each company: \"Contacts\", \"FilingCalendars\", \"Items\", \"Locations\", \"Nexus\", \"TaxCodes\", \"NonReportingChildren\" or \"TaxRules\".\r\n * Deleted objects - Specify \"FetchDeleted\" to retrieve information about previously deleted objects.", "key": "$include", "value": "string" } ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the company to retrieve." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options.\r\n \r\n * Child objects - Specify one or more of the following to retrieve objects related to each company: \"Contacts\", \"FilingCalendars\", \"Items\", \"Locations\", \"Nexus\", \"TaxCodes\", \"NonReportingChildren\" or \"TaxRules\".\r\n * Deleted objects - Specify \"FetchDeleted\" to retrieve information about previously deleted objects.", "key": "$include", "value": "string" } ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the company to retrieve." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options.\r\n \r\n * Child objects - Specify one or more of the following to retrieve objects related to each company: \"Contacts\", \"FilingCalendars\", \"Items\", \"Locations\", \"Nexus\", \"TaxCodes\", \"NonReportingChildren\" or \"TaxRules\".\r\n * Deleted objects - Specify \"FetchDeleted\" to retrieve information about previously deleted objects.", "key": "$include", "value": "string" } ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the company to retrieve." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] }, { "name": "Update a single company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 12345,\n \"accountId\": 123456789,\n \"companyCode\": \"DEFAULT\",\n \"name\": \"Default Company\",\n \"isDefault\": false,\n \"isActive\": true,\n \"taxpayerIdNumber\": \"123456789\",\n \"isFein\": false,\n \"hasProfile\": true,\n \"isReportingEntity\": false,\n \"defaultCountry\": \"US\",\n \"baseCurrencyCode\": \"USD\",\n \"roundingLevelId\": \"Document\",\n \"isTest\": true,\n \"taxDependencyLevelId\": \"Document\",\n \"inProgress\": false,\n \"isDeleted\": false,\n \"isAdvSave\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the company you wish to update." } ] }, "description": "Replace the existing company object at this URL with an updated object.\r\n \r\nA `CompanyModel` represents a single corporation or individual that is registered to handle transactional taxes.\r\nAll data from the existing object will be replaced with data in the object you PUT.\r\n \r\nWhen calling `UpdateCompany`, you are permitted to update the company itself. Updates to the nested objects\r\nsuch as contacts, locations, or settings are not permitted. To update the nested objects\r\n \r\nTo set a field's value to `null`, you may either set its value to `null` or omit that field from the object you PUT.\r\n \r\nNOTE: Please do not use these blacklisted characters in company name and code: ';', '\\', '|'.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 12345,\n \"accountId\": 123456789,\n \"companyCode\": \"DEFAULT\",\n \"name\": \"Default Company\",\n \"isDefault\": false,\n \"isActive\": true,\n \"taxpayerIdNumber\": \"123456789\",\n \"isFein\": false,\n \"hasProfile\": true,\n \"isReportingEntity\": false,\n \"defaultCountry\": \"US\",\n \"baseCurrencyCode\": \"USD\",\n \"roundingLevelId\": \"Document\",\n \"isTest\": true,\n \"taxDependencyLevelId\": \"Document\",\n \"inProgress\": false,\n \"isDeleted\": false,\n \"isAdvSave\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the company you wish to update." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 12345,\n \"accountId\": 123456789,\n \"companyCode\": \"DEFAULT\",\n \"name\": \"Default Company\",\n \"isDefault\": false,\n \"isActive\": true,\n \"taxpayerIdNumber\": \"123456789\",\n \"isFein\": false,\n \"hasProfile\": true,\n \"isReportingEntity\": false,\n \"defaultCountry\": \"US\",\n \"baseCurrencyCode\": \"USD\",\n \"roundingLevelId\": \"Document\",\n \"isTest\": true,\n \"taxDependencyLevelId\": \"Document\",\n \"inProgress\": false,\n \"isDeleted\": false,\n \"isAdvSave\": false\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 12345,\n \"accountId\": 123456789,\n \"companyCode\": \"DEFAULT\",\n \"name\": \"Default Company\",\n \"isDefault\": false,\n \"isActive\": true,\n \"taxpayerIdNumber\": \"123456789\",\n \"isFein\": false,\n \"hasProfile\": true,\n \"isReportingEntity\": false,\n \"defaultCountry\": \"US\",\n \"baseCurrencyCode\": \"USD\",\n \"roundingLevelId\": \"Document\",\n \"isTest\": true,\n \"taxDependencyLevelId\": \"Document\",\n \"inProgress\": false,\n \"isDeleted\": false,\n \"isAdvSave\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the company you wish to update." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 12345,\n \"accountId\": 123456789,\n \"companyCode\": \"DEFAULT\",\n \"name\": \"Default Company\",\n \"isDefault\": false,\n \"isActive\": true,\n \"taxpayerIdNumber\": \"123456789\",\n \"isFein\": false,\n \"hasProfile\": true,\n \"isReportingEntity\": false,\n \"defaultCountry\": \"US\",\n \"baseCurrencyCode\": \"USD\",\n \"roundingLevelId\": \"Document\",\n \"isTest\": true,\n \"taxDependencyLevelId\": \"Document\",\n \"inProgress\": false,\n \"isDeleted\": false,\n \"isAdvSave\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the company you wish to update." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 12345,\n \"accountId\": 123456789,\n \"companyCode\": \"DEFAULT\",\n \"name\": \"Default Company\",\n \"isDefault\": false,\n \"isActive\": true,\n \"taxpayerIdNumber\": \"123456789\",\n \"isFein\": false,\n \"hasProfile\": true,\n \"isReportingEntity\": false,\n \"defaultCountry\": \"US\",\n \"baseCurrencyCode\": \"USD\",\n \"roundingLevelId\": \"Document\",\n \"isTest\": true,\n \"taxDependencyLevelId\": \"Document\",\n \"inProgress\": false,\n \"isDeleted\": false,\n \"isAdvSave\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the company you wish to update." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] }, { "name": "Delete a single company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the company you wish to delete." } ] }, "description": "Deleting a company will delete all child companies, and all users attached to this company.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the company you wish to delete." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the company you wish to delete." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the company you wish to delete." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the company you wish to delete." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "initialize", "item": [ { "name": "Quick setup for a company with a single physical address", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Bob's Artisan Pottery\",\n \"companyCode\": \"DEFAULT\",\n \"taxpayerIdNumber\": \"12-3456789\",\n \"isFein\": false,\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Example\",\n \"title\": \"Owner\",\n \"email\": \"bob@example.org\",\n \"phoneNumber\": \"714 555-2121\",\n \"mobileNumber\": \"714 555-1212\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/initialize", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", "initialize" ] }, "description": "Shortcut to quickly setup a single-physical-location company with critical information and activate it.\r\nThis API provides quick and simple company setup functionality and does the following things:\r\n \r\n* Create a company object with its own tax profile\r\n* Add a key contact person for the company\r\n* Set up one physical location for the main office\r\n* Declare nexus in all taxing jurisdictions for that main office address\r\n* Activate the company\r\n \r\nThis API only provides a limited subset of functionality compared to the 'Create Company' API call.\r\nIf you need additional features or options not present in this 'Quick Setup' API call, please use the full 'Create Company' call instead.\r\nPlease allow 1 minute before making transactions using the company.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Bob's Artisan Pottery\",\n \"companyCode\": \"DEFAULT\",\n \"taxpayerIdNumber\": \"12-3456789\",\n \"isFein\": false,\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Example\",\n \"title\": \"Owner\",\n \"email\": \"bob@example.org\",\n \"phoneNumber\": \"714 555-2121\",\n \"mobileNumber\": \"714 555-1212\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/initialize", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", "initialize" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 12345,\n \"accountId\": 123456789,\n \"companyCode\": \"DEFAULT\",\n \"name\": \"Default Company\",\n \"isDefault\": false,\n \"isActive\": true,\n \"taxpayerIdNumber\": \"123456789\",\n \"isFein\": false,\n \"hasProfile\": true,\n \"isReportingEntity\": false,\n \"defaultCountry\": \"US\",\n \"baseCurrencyCode\": \"USD\",\n \"roundingLevelId\": \"Document\",\n \"isTest\": true,\n \"taxDependencyLevelId\": \"Document\",\n \"inProgress\": false,\n \"isDeleted\": false,\n \"isAdvSave\": false\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Bob's Artisan Pottery\",\n \"companyCode\": \"DEFAULT\",\n \"taxpayerIdNumber\": \"12-3456789\",\n \"isFein\": false,\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Example\",\n \"title\": \"Owner\",\n \"email\": \"bob@example.org\",\n \"phoneNumber\": \"714 555-2121\",\n \"mobileNumber\": \"714 555-1212\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/initialize", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", "initialize" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Bob's Artisan Pottery\",\n \"companyCode\": \"DEFAULT\",\n \"taxpayerIdNumber\": \"12-3456789\",\n \"isFein\": false,\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Example\",\n \"title\": \"Owner\",\n \"email\": \"bob@example.org\",\n \"phoneNumber\": \"714 555-2121\",\n \"mobileNumber\": \"714 555-1212\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/initialize", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", "initialize" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "mrs", "item": [ { "name": "Retrieve a list of MRS Companies with account", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/mrs", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", "mrs" ] }, "description": "This API is available by invitation only.\r\n \r\nGet a list of companies with an active MRS service.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/mrs", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", "mrs" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 6227,\n \"value\": [\n {\n \"companyId\": 12345,\n \"companyName\": \"Default Company\",\n \"accountId\": 123456789,\n \"accountName\": \"Default Account\"\n },\n {\n \"companyId\": 12345,\n \"companyName\": \"Default Company\",\n \"accountId\": 123456789,\n \"accountName\": \"Default Account\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/mrs", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", "mrs" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/mrs", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", "mrs" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "{companyCode}", "item": [ { "name": "AllVariance", "item": [ { "name": "Fetches the Variance data generated for all the transactions done by Company.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/AllVariance", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "AllVariance" ], "variable": [ { "key": "companyCode", "value": "string" } ] }, "description": "\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/AllVariance", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "AllVariance" ], "variable": [ { "key": "companyCode", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"totalRequest\": 0\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/AllVariance", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "AllVariance" ], "variable": [ { "key": "companyCode", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/AllVariance", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "AllVariance" ], "variable": [ { "key": "companyCode", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/AllVariance", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "AllVariance" ], "variable": [ { "key": "companyCode", "value": "string" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "transactions", "item": [ { "name": "{transactionCode}", "item": [ { "name": "adjust", "item": [ { "name": "Correct a previously created transaction", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"adjustmentReason\": \"PriceAdjusted\",\n \"adjustmentDescription\": \"Price drop before shipping\",\n \"newTransaction\": {\n \"lines\": [\n {\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 100,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/adjust?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "adjust" ], "query": [ { "key": "documentType", "value": "PurchaseOrder", "description": "(Optional): The document type of the transaction to adjust." }, { "key": "$include", "value": "string", "description": "Specifies objects to include in this fetch call" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to adjust" } ] }, "description": "Replaces the current transaction uniquely identified by this URL with a new transaction.\r\n \r\nA transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\r\nsales, purchases, inventory transfer, and returns (also called refunds).\r\n \r\nWhen you adjust a committed transaction, the original transaction will be updated with the status code `Adjusted`, and\r\nboth revisions will be available for retrieval based on their code and ID numbers.\r\nOnly transactions in `Committed` status are reported by Avalara Managed Returns.\r\n \r\nTransactions that have been previously reported to a tax authority by Avalara Managed Returns are considered `locked` and are\r\nno longer available for adjustments.\r\n \r\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:\r\n \r\n* Lines\r\n* Details (implies lines)\r\n* AccountPayableSalesTaxDetails (implies lines - only for Account Payable transaction)\r\n* Summary (implies details)\r\n* Addresses\r\n* SummaryOnly (omit lines and details - reduces API response size)\r\n* LinesOnly (omit details - reduces API response size)\r\n* TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary.\r\n \r\nNOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:\r\n* Replace '/' with '\\_-ava2f-\\_' For example: document/Code becomes document_-ava2f-_Code\r\n* Replace '+' with '\\_-ava2b-\\_' For example: document+Code becomes document_-ava2b-_Code\r\n* Replace '?' with '\\_-ava3f-\\_' For example: document?Code becomes document_-ava3f-_Code\r\n* Replace '%' with '\\_-ava25-\\_' For example: document%Code becomes document_-ava25-_Code\r\n* Replace '#' with '\\_-ava23-\\_' For example: document#Code becomes document_-ava23-_Code\r\n* Replace ' ' with '%20' For example: document Code becomes document%20Code\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"adjustmentReason\": \"PriceAdjusted\",\n \"adjustmentDescription\": \"Price drop before shipping\",\n \"newTransaction\": {\n \"lines\": [\n {\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 100,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/adjust?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "adjust" ], "query": [ { "description": "(Optional): The document type of the transaction to adjust.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to adjust" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 123456789,\n \"code\": \"ed92c353-a94c-4fe2-a32f-0d52f4f5ccf6\",\n \"companyId\": 12345,\n \"date\": \"2026-04-02\",\n \"status\": \"Committed\",\n \"type\": \"SalesInvoice\",\n \"currencyCode\": \"USD\",\n \"exchangeRateCurrencyCode\": \"USD\",\n \"entityUseCode\": \"\",\n \"customerVendorCode\": \"ABC\",\n \"customerCode\": \"ABC\",\n \"exemptNo\": \"\",\n \"reconciled\": true,\n \"locationCode\": \"DEFAULT\",\n \"salespersonCode\": \"DEF\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"totalAmount\": 1000,\n \"totalExempt\": 0,\n \"totalDiscount\": 0,\n \"totalTax\": 62.5,\n \"totalTaxable\": 1000,\n \"totalTaxCalculated\": 62.5,\n \"adjustmentReason\": \"NotAdjusted\",\n \"adjustmentDescription\": \"\",\n \"locked\": false,\n \"region\": \"CA\",\n \"country\": \"US\",\n \"version\": 0,\n \"originAddressId\": 123456789,\n \"destinationAddressId\": 123456789,\n \"exchangeRateEffectiveDate\": \"2026-04-02\",\n \"exchangeRate\": 2,\n \"isSellerImporterOfRecord\": false,\n \"description\": \"Yarn\",\n \"taxDate\": \"2026-04-02T00:00:00+00:00\",\n \"lines\": [\n {\n \"id\": 123456789,\n \"transactionId\": 123456789,\n \"lineNumber\": \"1\",\n \"boundaryOverrideId\": 0,\n \"entityUseCode\": \"\",\n \"description\": \"Yarn\",\n \"destinationAddressId\": 12345,\n \"originAddressId\": 123456789,\n \"discountAmount\": 100,\n \"discountTypeId\": 0,\n \"exemptAmount\": 0,\n \"exemptCertId\": 0,\n \"exemptNo\": \"\",\n \"isItemTaxable\": true,\n \"isSSTP\": false,\n \"itemCode\": \"116292\",\n \"lineAmount\": 1000,\n \"quantity\": 1,\n \"ref1\": \"Note: Deliver to Bob\",\n \"reportingDate\": \"2026-04-02\",\n \"revAccount\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxCalculated\": 62.5,\n \"taxCode\": \"PS081282\",\n \"taxDate\": \"2026-04-02\",\n \"taxEngine\": \"\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"taxIncluded\": false,\n \"details\": [\n {\n \"id\": 123456789,\n \"transactionLineId\": 123456789,\n \"transactionId\": 123456789,\n \"addressId\": 12345,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"stateFIPS\": \"06\",\n \"exemptAmount\": 0,\n \"exemptReasonId\": 4,\n \"exemptRuleId\": 0,\n \"inState\": false,\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"jurisdictionId\": 5000531,\n \"signatureCode\": \"AGAM\",\n \"stateAssignedNo\": \"\",\n \"jurisType\": \"STA\",\n \"nonTaxableAmount\": 0,\n \"nonTaxableRuleId\": 0,\n \"nonTaxableType\": \"BaseRule\",\n \"rate\": 0.0625,\n \"rateRuleId\": 1321915,\n \"rateSourceId\": 3,\n \"serCode\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxType\": \"Sales\",\n \"taxName\": \"CA STATE TAX\",\n \"taxAuthorityTypeId\": 45,\n \"taxRegionId\": 2127184,\n \"taxCalculated\": 62.5,\n \"taxOverride\": 0,\n \"rateType\": \"General\",\n \"taxableUnits\": 62.5,\n \"nonTaxableUnits\": 1000,\n \"exemptUnits\": 62.5,\n \"reportingTaxableUnits\": 125,\n \"reportingNonTaxableUnits\": 2000,\n \"reportingExemptUnits\": 125,\n \"reportingTax\": 125,\n \"reportingTaxCalculated\": 125,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0,\n \"vatCode\": \"\",\n \"granularDutyDetails\": [\n {\n \"dutyType\": \"ImportDuty\",\n \"rate\": \"10.5\",\n \"amount\": \"105.00\"\n }\n ]\n }\n ],\n \"vatNumberTypeId\": 0,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0\n }\n ],\n \"addresses\": [\n {\n \"id\": 0,\n \"transactionId\": 0,\n \"boundaryLevel\": \"Address\",\n \"line1\": \"100 Ravine Lane Northeast #220\",\n \"city\": \"Bainbridge Island\",\n \"region\": \"WA\",\n \"postalCode\": \"98110\",\n \"country\": \"US\",\n \"taxRegionId\": 0\n }\n ],\n \"taxDetailsByTaxType\": [\n {\n \"taxType\": \"SalesAndUse\",\n \"totalTaxable\": 100,\n \"totalExempt\": 0.05,\n \"totalNonTaxable\": 0,\n \"totalTax\": 0.625\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"adjustmentReason\": \"PriceAdjusted\",\n \"adjustmentDescription\": \"Price drop before shipping\",\n \"newTransaction\": {\n \"lines\": [\n {\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 100,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/adjust?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "adjust" ], "query": [ { "description": "(Optional): The document type of the transaction to adjust.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to adjust" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"adjustmentReason\": \"PriceAdjusted\",\n \"adjustmentDescription\": \"Price drop before shipping\",\n \"newTransaction\": {\n \"lines\": [\n {\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 100,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/adjust?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "adjust" ], "query": [ { "description": "(Optional): The document type of the transaction to adjust.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to adjust" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"adjustmentReason\": \"PriceAdjusted\",\n \"adjustmentDescription\": \"Price drop before shipping\",\n \"newTransaction\": {\n \"lines\": [\n {\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 100,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/adjust?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "adjust" ], "query": [ { "description": "(Optional): The document type of the transaction to adjust.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to adjust" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "audit", "item": [ { "name": "Get audit information about a transaction", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/audit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "audit" ], "variable": [ { "key": "companyCode", "value": "string", "description": "The code identifying the company that owns this transaction" }, { "key": "transactionCode", "value": "string", "description": "The code identifying the transaction" } ] }, "description": "Retrieve audit information about a transaction stored in AvaTax.\r\n \r\nThe `AuditTransaction` API retrieves audit information related to a specific transaction. This audit\r\ninformation includes the following:\r\n \r\n* The `CompanyId` of the company that created the transaction\r\n* The server timestamp representing the exact server time when the transaction was created\r\n* The server duration - how long it took to process this transaction\r\n* Whether exact API call details were logged\r\n* A reconstructed API call showing what the original CreateTransaction call looked like\r\n \r\nThis API can be used to examine information about a previously created transaction.\r\n \r\nA transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\r\nsales, purchases, inventory transfer, and returns (also called refunds).\r\n \r\nNOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:\r\n* Replace '/' with '\\_-ava2f-\\_' For example: document/Code becomes document_-ava2f-_Code\r\n* Replace '+' with '\\_-ava2b-\\_' For example: document+Code becomes document_-ava2b-_Code\r\n* Replace '?' with '\\_-ava3f-\\_' For example: document?Code becomes document_-ava3f-_Code\r\n* Replace '%' with '\\_-ava25-\\_' For example: document%Code becomes document_-ava25-_Code\r\n* Replace '#' with '\\_-ava23-\\_' For example: document#Code becomes document_-ava23-_Code\r\n* Replace ' ' with '%20' For example: document Code becomes document%20Code\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/audit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "audit" ], "variable": [ { "key": "companyCode", "value": "string", "description": "The code identifying the company that owns this transaction" }, { "key": "transactionCode", "value": "string", "description": "The code identifying the transaction" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"companyId\": 0,\n \"reconstructed\": {\n \"request\": {\n \"lines\": [\n {\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 100,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n }\n },\n \"serverTimestamp\": \"2026-04-02T10:55:18.9009734Z\",\n \"apiCallStatus\": \"ReconstructedApiCallAvailable\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/audit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "audit" ], "variable": [ { "key": "companyCode", "value": "string", "description": "The code identifying the company that owns this transaction" }, { "key": "transactionCode", "value": "string", "description": "The code identifying the transaction" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/audit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "audit" ], "variable": [ { "key": "companyCode", "value": "string", "description": "The code identifying the company that owns this transaction" }, { "key": "transactionCode", "value": "string", "description": "The code identifying the transaction" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/audit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "audit" ], "variable": [ { "key": "companyCode", "value": "string", "description": "The code identifying the company that owns this transaction" }, { "key": "transactionCode", "value": "string", "description": "The code identifying the transaction" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "changecode", "item": [ { "name": "Change a transaction's code", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"newCode\": \"ea60471c-47a0-43bc-b65e-33de55f494a8\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/changecode?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "changecode" ], "query": [ { "key": "documentType", "value": "PurchaseOrder", "description": "(Optional): The document type of the transaction to change document code. If not provided, the default is SalesInvoice." }, { "key": "$include", "value": "string", "description": "Specifies objects to include in this fetch call" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to change" } ] }, "description": "Renames a transaction uniquely identified by this URL by changing its `code` value.\r\n \r\nThis API is available as long as the transaction is in `saved` or `posted` status. When a transaction\r\nis `committed`, it can be modified by using the [AdjustTransaction](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/AdjustTransaction/) method.\r\n \r\nAfter this API call succeeds, the transaction will have a new URL matching its new `code`.\r\n \r\nIf you have more than one document with the same `code`, specify the `documentType` parameter to choose between them.\r\n \r\nA transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\r\nsales, purchases, inventory transfer, and returns (also called refunds).\r\n \r\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:\r\n \r\n* Lines\r\n* Details (implies lines)\r\n* AccountPayableSalesTaxDetails (implies lines - only for Account Payable transaction)\r\n* Summary (implies details)\r\n* Addresses\r\n* SummaryOnly (omit lines and details - reduces API response size)\r\n* LinesOnly (omit details - reduces API response size)\r\n* TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary.\r\n \r\nNOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:\r\n* Replace '/' with '\\_-ava2f-\\_' For example: document/Code becomes document_-ava2f-_Code\r\n* Replace '+' with '\\_-ava2b-\\_' For example: document+Code becomes document_-ava2b-_Code\r\n* Replace '?' with '\\_-ava3f-\\_' For example: document?Code becomes document_-ava3f-_Code\r\n* Replace '%' with '\\_-ava25-\\_' For example: document%Code becomes document_-ava25-_Code\r\n* Replace '#' with '\\_-ava23-\\_' For example: document#Code becomes document_-ava23-_Code\r\n* Replace ' ' with '%20' For example: document Code becomes document%20Code\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"newCode\": \"ea60471c-47a0-43bc-b65e-33de55f494a8\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/changecode?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "changecode" ], "query": [ { "description": "(Optional): The document type of the transaction to change document code. If not provided, the default is SalesInvoice.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to change" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 123456789,\n \"code\": \"ed92c353-a94c-4fe2-a32f-0d52f4f5ccf6\",\n \"companyId\": 12345,\n \"date\": \"2026-04-02\",\n \"status\": \"Committed\",\n \"type\": \"SalesInvoice\",\n \"currencyCode\": \"USD\",\n \"exchangeRateCurrencyCode\": \"USD\",\n \"entityUseCode\": \"\",\n \"customerVendorCode\": \"ABC\",\n \"customerCode\": \"ABC\",\n \"exemptNo\": \"\",\n \"reconciled\": true,\n \"locationCode\": \"DEFAULT\",\n \"salespersonCode\": \"DEF\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"totalAmount\": 1000,\n \"totalExempt\": 0,\n \"totalDiscount\": 0,\n \"totalTax\": 62.5,\n \"totalTaxable\": 1000,\n \"totalTaxCalculated\": 62.5,\n \"adjustmentReason\": \"NotAdjusted\",\n \"adjustmentDescription\": \"\",\n \"locked\": false,\n \"region\": \"CA\",\n \"country\": \"US\",\n \"version\": 0,\n \"originAddressId\": 123456789,\n \"destinationAddressId\": 123456789,\n \"exchangeRateEffectiveDate\": \"2026-04-02\",\n \"exchangeRate\": 2,\n \"isSellerImporterOfRecord\": false,\n \"description\": \"Yarn\",\n \"taxDate\": \"2026-04-02T00:00:00+00:00\",\n \"lines\": [\n {\n \"id\": 123456789,\n \"transactionId\": 123456789,\n \"lineNumber\": \"1\",\n \"boundaryOverrideId\": 0,\n \"entityUseCode\": \"\",\n \"description\": \"Yarn\",\n \"destinationAddressId\": 12345,\n \"originAddressId\": 123456789,\n \"discountAmount\": 100,\n \"discountTypeId\": 0,\n \"exemptAmount\": 0,\n \"exemptCertId\": 0,\n \"exemptNo\": \"\",\n \"isItemTaxable\": true,\n \"isSSTP\": false,\n \"itemCode\": \"116292\",\n \"lineAmount\": 1000,\n \"quantity\": 1,\n \"ref1\": \"Note: Deliver to Bob\",\n \"reportingDate\": \"2026-04-02\",\n \"revAccount\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxCalculated\": 62.5,\n \"taxCode\": \"PS081282\",\n \"taxDate\": \"2026-04-02\",\n \"taxEngine\": \"\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"taxIncluded\": false,\n \"details\": [\n {\n \"id\": 123456789,\n \"transactionLineId\": 123456789,\n \"transactionId\": 123456789,\n \"addressId\": 12345,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"stateFIPS\": \"06\",\n \"exemptAmount\": 0,\n \"exemptReasonId\": 4,\n \"exemptRuleId\": 0,\n \"inState\": false,\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"jurisdictionId\": 5000531,\n \"signatureCode\": \"AGAM\",\n \"stateAssignedNo\": \"\",\n \"jurisType\": \"STA\",\n \"nonTaxableAmount\": 0,\n \"nonTaxableRuleId\": 0,\n \"nonTaxableType\": \"BaseRule\",\n \"rate\": 0.0625,\n \"rateRuleId\": 1321915,\n \"rateSourceId\": 3,\n \"serCode\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxType\": \"Sales\",\n \"taxName\": \"CA STATE TAX\",\n \"taxAuthorityTypeId\": 45,\n \"taxRegionId\": 2127184,\n \"taxCalculated\": 62.5,\n \"taxOverride\": 0,\n \"rateType\": \"General\",\n \"taxableUnits\": 62.5,\n \"nonTaxableUnits\": 1000,\n \"exemptUnits\": 62.5,\n \"reportingTaxableUnits\": 125,\n \"reportingNonTaxableUnits\": 2000,\n \"reportingExemptUnits\": 125,\n \"reportingTax\": 125,\n \"reportingTaxCalculated\": 125,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0,\n \"vatCode\": \"\",\n \"granularDutyDetails\": [\n {\n \"dutyType\": \"ImportDuty\",\n \"rate\": \"10.5\",\n \"amount\": \"105.00\"\n }\n ]\n }\n ],\n \"vatNumberTypeId\": 0,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0\n }\n ],\n \"addresses\": [\n {\n \"id\": 0,\n \"transactionId\": 0,\n \"boundaryLevel\": \"Address\",\n \"line1\": \"100 Ravine Lane Northeast #220\",\n \"city\": \"Bainbridge Island\",\n \"region\": \"WA\",\n \"postalCode\": \"98110\",\n \"country\": \"US\",\n \"taxRegionId\": 0\n }\n ],\n \"taxDetailsByTaxType\": [\n {\n \"taxType\": \"SalesAndUse\",\n \"totalTaxable\": 100,\n \"totalExempt\": 0.05,\n \"totalNonTaxable\": 0,\n \"totalTax\": 0.625\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"newCode\": \"ea60471c-47a0-43bc-b65e-33de55f494a8\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/changecode?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "changecode" ], "query": [ { "description": "(Optional): The document type of the transaction to change document code. If not provided, the default is SalesInvoice.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to change" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"newCode\": \"ea60471c-47a0-43bc-b65e-33de55f494a8\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/changecode?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "changecode" ], "query": [ { "description": "(Optional): The document type of the transaction to change document code. If not provided, the default is SalesInvoice.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to change" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"newCode\": \"ea60471c-47a0-43bc-b65e-33de55f494a8\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/changecode?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "changecode" ], "query": [ { "description": "(Optional): The document type of the transaction to change document code. If not provided, the default is SalesInvoice.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to change" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "commit", "item": [ { "name": "Commit a transaction for reporting", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"commit\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/commit?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "commit" ], "query": [ { "key": "documentType", "value": "PurchaseOrder", "description": "(Optional): The document type of the transaction to commit. If not provided, the default is SalesInvoice." }, { "key": "$include", "value": "string", "description": "Specifies objects to include in this fetch call" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to commit" } ] }, "description": "Marks a transaction by changing its status to `Committed`.\r\n \r\nTransactions that are committed are available to be reported to a tax authority by Avalara Managed Returns.\r\n \r\nA transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\r\nsales, purchases, inventory transfer, and returns (also called refunds).\r\n \r\nIf you have more than one document with the same `code`, specify the `documentType` parameter to choose between them.\r\n \r\nAny changes made to a committed transaction will generate a transaction history.\r\n \r\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:\r\n \r\n* Lines\r\n* Details (implies lines)\r\n* AccountPayableSalesTaxDetails (implies lines - only for Account Payable transaction)\r\n* Summary (implies details)\r\n* Addresses\r\n* SummaryOnly (omit lines and details - reduces API response size)\r\n* LinesOnly (omit details - reduces API response size)\r\n* TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary.\r\n \r\nNOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:\r\n* Replace '/' with '\\_-ava2f-\\_' For example: document/Code becomes document_-ava2f-_Code\r\n* Replace '+' with '\\_-ava2b-\\_' For example: document+Code becomes document_-ava2b-_Code\r\n* Replace '?' with '\\_-ava3f-\\_' For example: document?Code becomes document_-ava3f-_Code\r\n* Replace '%' with '\\_-ava25-\\_' For example: document%Code becomes document_-ava25-_Code\r\n* Replace '#' with '\\_-ava23-\\_' For example: document#Code becomes document_-ava23-_Code\r\n* Replace ' ' with '%20' For example: document Code becomes document%20Code\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"commit\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/commit?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "commit" ], "query": [ { "description": "(Optional): The document type of the transaction to commit. If not provided, the default is SalesInvoice.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to commit" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 123456789,\n \"code\": \"ed92c353-a94c-4fe2-a32f-0d52f4f5ccf6\",\n \"companyId\": 12345,\n \"date\": \"2026-04-02\",\n \"status\": \"Committed\",\n \"type\": \"SalesInvoice\",\n \"currencyCode\": \"USD\",\n \"exchangeRateCurrencyCode\": \"USD\",\n \"entityUseCode\": \"\",\n \"customerVendorCode\": \"ABC\",\n \"customerCode\": \"ABC\",\n \"exemptNo\": \"\",\n \"reconciled\": true,\n \"locationCode\": \"DEFAULT\",\n \"salespersonCode\": \"DEF\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"totalAmount\": 1000,\n \"totalExempt\": 0,\n \"totalDiscount\": 0,\n \"totalTax\": 62.5,\n \"totalTaxable\": 1000,\n \"totalTaxCalculated\": 62.5,\n \"adjustmentReason\": \"NotAdjusted\",\n \"adjustmentDescription\": \"\",\n \"locked\": false,\n \"region\": \"CA\",\n \"country\": \"US\",\n \"version\": 0,\n \"originAddressId\": 123456789,\n \"destinationAddressId\": 123456789,\n \"exchangeRateEffectiveDate\": \"2026-04-02\",\n \"exchangeRate\": 2,\n \"isSellerImporterOfRecord\": false,\n \"description\": \"Yarn\",\n \"taxDate\": \"2026-04-02T00:00:00+00:00\",\n \"lines\": [\n {\n \"id\": 123456789,\n \"transactionId\": 123456789,\n \"lineNumber\": \"1\",\n \"boundaryOverrideId\": 0,\n \"entityUseCode\": \"\",\n \"description\": \"Yarn\",\n \"destinationAddressId\": 12345,\n \"originAddressId\": 123456789,\n \"discountAmount\": 100,\n \"discountTypeId\": 0,\n \"exemptAmount\": 0,\n \"exemptCertId\": 0,\n \"exemptNo\": \"\",\n \"isItemTaxable\": true,\n \"isSSTP\": false,\n \"itemCode\": \"116292\",\n \"lineAmount\": 1000,\n \"quantity\": 1,\n \"ref1\": \"Note: Deliver to Bob\",\n \"reportingDate\": \"2026-04-02\",\n \"revAccount\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxCalculated\": 62.5,\n \"taxCode\": \"PS081282\",\n \"taxDate\": \"2026-04-02\",\n \"taxEngine\": \"\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"taxIncluded\": false,\n \"details\": [\n {\n \"id\": 123456789,\n \"transactionLineId\": 123456789,\n \"transactionId\": 123456789,\n \"addressId\": 12345,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"stateFIPS\": \"06\",\n \"exemptAmount\": 0,\n \"exemptReasonId\": 4,\n \"exemptRuleId\": 0,\n \"inState\": false,\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"jurisdictionId\": 5000531,\n \"signatureCode\": \"AGAM\",\n \"stateAssignedNo\": \"\",\n \"jurisType\": \"STA\",\n \"nonTaxableAmount\": 0,\n \"nonTaxableRuleId\": 0,\n \"nonTaxableType\": \"BaseRule\",\n \"rate\": 0.0625,\n \"rateRuleId\": 1321915,\n \"rateSourceId\": 3,\n \"serCode\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxType\": \"Sales\",\n \"taxName\": \"CA STATE TAX\",\n \"taxAuthorityTypeId\": 45,\n \"taxRegionId\": 2127184,\n \"taxCalculated\": 62.5,\n \"taxOverride\": 0,\n \"rateType\": \"General\",\n \"taxableUnits\": 62.5,\n \"nonTaxableUnits\": 1000,\n \"exemptUnits\": 62.5,\n \"reportingTaxableUnits\": 125,\n \"reportingNonTaxableUnits\": 2000,\n \"reportingExemptUnits\": 125,\n \"reportingTax\": 125,\n \"reportingTaxCalculated\": 125,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0,\n \"vatCode\": \"\",\n \"granularDutyDetails\": [\n {\n \"dutyType\": \"ImportDuty\",\n \"rate\": \"10.5\",\n \"amount\": \"105.00\"\n }\n ]\n }\n ],\n \"vatNumberTypeId\": 0,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0\n }\n ],\n \"addresses\": [\n {\n \"id\": 0,\n \"transactionId\": 0,\n \"boundaryLevel\": \"Address\",\n \"line1\": \"100 Ravine Lane Northeast #220\",\n \"city\": \"Bainbridge Island\",\n \"region\": \"WA\",\n \"postalCode\": \"98110\",\n \"country\": \"US\",\n \"taxRegionId\": 0\n }\n ],\n \"taxDetailsByTaxType\": [\n {\n \"taxType\": \"SalesAndUse\",\n \"totalTaxable\": 100,\n \"totalExempt\": 0.05,\n \"totalNonTaxable\": 0,\n \"totalTax\": 0.625\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"commit\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/commit?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "commit" ], "query": [ { "description": "(Optional): The document type of the transaction to commit. If not provided, the default is SalesInvoice.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to commit" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"commit\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/commit?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "commit" ], "query": [ { "description": "(Optional): The document type of the transaction to commit. If not provided, the default is SalesInvoice.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to commit" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"commit\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/commit?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "commit" ], "query": [ { "description": "(Optional): The document type of the transaction to commit. If not provided, the default is SalesInvoice.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to commit" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "lock", "item": [ { "name": "Lock a single transaction", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"isLocked\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/lock?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "lock" ], "query": [ { "key": "documentType", "value": "PurchaseOrder", "description": "(Optional): The document type of the transaction to lock. If not provided, the default is SalesInvoice." }, { "key": "$include", "value": "string", "description": "Specifies objects to include in this fetch call" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to lock" } ] }, "description": "Lock a transaction uniquely identified by this URL.\r\n \r\nThis API is mainly used for connector developers to simulate what happens when the Returns product locks a document.\r\nAfter this API call succeeds, the document will be locked and can't be voided or adjusted.\r\n \r\nOn Sandbox, this API is only available to customers who have both an AvaTaxPro and a Managed Returns subscription. On Production, this API is only available internally for the Avalara Returns team.\r\n \r\nIf you have more than one document with the same `code`, specify the `documentType` parameter to choose between them.\r\n \r\nA transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\r\nsales, purchases, inventory transfer, and returns (also called refunds).\r\n \r\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:\r\n \r\n* Lines\r\n* Details (implies lines)\r\n* AccountPayableSalesTaxDetails (implies lines - only for Account Payable transaction)\r\n* Summary (implies details)\r\n* Addresses\r\n* SummaryOnly (omit lines and details - reduces API response size)\r\n* LinesOnly (omit details - reduces API response size)\r\n* TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary.\r\n \r\nNOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:\r\n* Replace '/' with '\\_-ava2f-\\_' For example: document/Code becomes document_-ava2f-_Code\r\n* Replace '+' with '\\_-ava2b-\\_' For example: document+Code becomes document_-ava2b-_Code\r\n* Replace '?' with '\\_-ava3f-\\_' For example: document?Code becomes document_-ava3f-_Code\r\n* Replace '%' with '\\_-ava25-\\_' For example: document%Code becomes document_-ava25-_Code\r\n* Replace '#' with '\\_-ava23-\\_' For example: document#Code becomes document_-ava23-_Code\r\n* Replace ' ' with '%20' For example: document Code becomes document%20Code\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"isLocked\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/lock?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "lock" ], "query": [ { "description": "(Optional): The document type of the transaction to lock. If not provided, the default is SalesInvoice.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to lock" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 123456789,\n \"code\": \"ed92c353-a94c-4fe2-a32f-0d52f4f5ccf6\",\n \"companyId\": 12345,\n \"date\": \"2026-04-02\",\n \"status\": \"Committed\",\n \"type\": \"SalesInvoice\",\n \"currencyCode\": \"USD\",\n \"exchangeRateCurrencyCode\": \"USD\",\n \"entityUseCode\": \"\",\n \"customerVendorCode\": \"ABC\",\n \"customerCode\": \"ABC\",\n \"exemptNo\": \"\",\n \"reconciled\": true,\n \"locationCode\": \"DEFAULT\",\n \"salespersonCode\": \"DEF\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"totalAmount\": 1000,\n \"totalExempt\": 0,\n \"totalDiscount\": 0,\n \"totalTax\": 62.5,\n \"totalTaxable\": 1000,\n \"totalTaxCalculated\": 62.5,\n \"adjustmentReason\": \"NotAdjusted\",\n \"adjustmentDescription\": \"\",\n \"locked\": false,\n \"region\": \"CA\",\n \"country\": \"US\",\n \"version\": 0,\n \"originAddressId\": 123456789,\n \"destinationAddressId\": 123456789,\n \"exchangeRateEffectiveDate\": \"2026-04-02\",\n \"exchangeRate\": 2,\n \"isSellerImporterOfRecord\": false,\n \"description\": \"Yarn\",\n \"taxDate\": \"2026-04-02T00:00:00+00:00\",\n \"lines\": [\n {\n \"id\": 123456789,\n \"transactionId\": 123456789,\n \"lineNumber\": \"1\",\n \"boundaryOverrideId\": 0,\n \"entityUseCode\": \"\",\n \"description\": \"Yarn\",\n \"destinationAddressId\": 12345,\n \"originAddressId\": 123456789,\n \"discountAmount\": 100,\n \"discountTypeId\": 0,\n \"exemptAmount\": 0,\n \"exemptCertId\": 0,\n \"exemptNo\": \"\",\n \"isItemTaxable\": true,\n \"isSSTP\": false,\n \"itemCode\": \"116292\",\n \"lineAmount\": 1000,\n \"quantity\": 1,\n \"ref1\": \"Note: Deliver to Bob\",\n \"reportingDate\": \"2026-04-02\",\n \"revAccount\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxCalculated\": 62.5,\n \"taxCode\": \"PS081282\",\n \"taxDate\": \"2026-04-02\",\n \"taxEngine\": \"\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"taxIncluded\": false,\n \"details\": [\n {\n \"id\": 123456789,\n \"transactionLineId\": 123456789,\n \"transactionId\": 123456789,\n \"addressId\": 12345,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"stateFIPS\": \"06\",\n \"exemptAmount\": 0,\n \"exemptReasonId\": 4,\n \"exemptRuleId\": 0,\n \"inState\": false,\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"jurisdictionId\": 5000531,\n \"signatureCode\": \"AGAM\",\n \"stateAssignedNo\": \"\",\n \"jurisType\": \"STA\",\n \"nonTaxableAmount\": 0,\n \"nonTaxableRuleId\": 0,\n \"nonTaxableType\": \"BaseRule\",\n \"rate\": 0.0625,\n \"rateRuleId\": 1321915,\n \"rateSourceId\": 3,\n \"serCode\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxType\": \"Sales\",\n \"taxName\": \"CA STATE TAX\",\n \"taxAuthorityTypeId\": 45,\n \"taxRegionId\": 2127184,\n \"taxCalculated\": 62.5,\n \"taxOverride\": 0,\n \"rateType\": \"General\",\n \"taxableUnits\": 62.5,\n \"nonTaxableUnits\": 1000,\n \"exemptUnits\": 62.5,\n \"reportingTaxableUnits\": 125,\n \"reportingNonTaxableUnits\": 2000,\n \"reportingExemptUnits\": 125,\n \"reportingTax\": 125,\n \"reportingTaxCalculated\": 125,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0,\n \"vatCode\": \"\",\n \"granularDutyDetails\": [\n {\n \"dutyType\": \"ImportDuty\",\n \"rate\": \"10.5\",\n \"amount\": \"105.00\"\n }\n ]\n }\n ],\n \"vatNumberTypeId\": 0,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0\n }\n ],\n \"addresses\": [\n {\n \"id\": 0,\n \"transactionId\": 0,\n \"boundaryLevel\": \"Address\",\n \"line1\": \"100 Ravine Lane Northeast #220\",\n \"city\": \"Bainbridge Island\",\n \"region\": \"WA\",\n \"postalCode\": \"98110\",\n \"country\": \"US\",\n \"taxRegionId\": 0\n }\n ],\n \"taxDetailsByTaxType\": [\n {\n \"taxType\": \"SalesAndUse\",\n \"totalTaxable\": 100,\n \"totalExempt\": 0.05,\n \"totalNonTaxable\": 0,\n \"totalTax\": 0.625\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"isLocked\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/lock?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "lock" ], "query": [ { "description": "(Optional): The document type of the transaction to lock. If not provided, the default is SalesInvoice.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to lock" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"isLocked\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/lock?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "lock" ], "query": [ { "description": "(Optional): The document type of the transaction to lock. If not provided, the default is SalesInvoice.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to lock" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"isLocked\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/lock?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "lock" ], "query": [ { "description": "(Optional): The document type of the transaction to lock. If not provided, the default is SalesInvoice.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to lock" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "refund", "item": [ { "name": "Create a refund for a transaction", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"refundTransactionCode\": \"7b543d25-4240-4137-b95a-d0e42d8692cf\",\n \"refundDate\": \"2026-04-02\",\n \"refundType\": \"Full\",\n \"referenceCode\": \"Refund for a committed transaction\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/refund?$include=string&documentType=PurchaseOrder&useTaxDateOverride=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "refund" ], "query": [ { "key": "$include", "value": "string", "description": "Specifies objects to include in the response after transaction is created" }, { "key": "documentType", "value": "PurchaseOrder", "description": "(Optional): The document type of the transaction to refund. If not provided, the default is SalesInvoice." }, { "key": "useTaxDateOverride", "value": "false", "description": "(Optional): If set to true, processes refund using taxDateOverride rather than taxAmountOverride (Note: taxAmountOverride is not allowed for SST states)." } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The code of the company that made the original sale" }, { "key": "transactionCode", "value": "string", "description": "The transaction code of the original sale" } ] }, "description": "Create a refund for a transaction.\r\n \r\nThe `RefundTransaction` API allows you to quickly and easily create a `ReturnInvoice` representing a refund\r\nfor a previously created `SalesInvoice` transaction. You can choose to create a full or partial refund, and\r\nspecify individual line items from the original sale for refund.\r\n \r\nThe `RefundTransaction` API ensures that the tax amount you refund to the customer exactly matches the tax that\r\nwas calculated during the original transaction, regardless of any changes to your company's configuration, rules,\r\nnexus, or any other setting.\r\n \r\nThis API is intended to be a shortcut to allow you to quickly and accurately generate a refund for the following\r\ncommon refund scenarios:\r\n \r\n* A full refund of a previous sale\r\n* Refunding the tax that was charged on a previous sale, when the customer provides an exemption certificate after the purchase\r\n* Refunding one or more items (lines) from a previous sale\r\n* Granting a customer a percentage refund of a previous sale\r\n \r\nFor more complex scenarios than the ones above, please use `CreateTransaction` with document type `ReturnInvoice` to\r\ncreate a custom refund transaction.\r\n \r\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:\r\n \r\n* Lines\r\n* Details (implies lines)\r\n* AccountPayableSalesTaxDetails (implies lines - only for Account Payable transaction)\r\n* Summary (implies details)\r\n* Addresses\r\n* SummaryOnly (omit lines and details - reduces API response size)\r\n* LinesOnly (omit details - reduces API response size)\r\n* TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary.\r\nIf you omit the `$include` parameter, the API will assume you want `Summary,Addresses`.\r\n \r\nNOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:\r\n* Replace '/' with '\\_-ava2f-\\_' For example: document/Code becomes document_-ava2f-_Code\r\n* Replace '+' with '\\_-ava2b-\\_' For example: document+Code becomes document_-ava2b-_Code\r\n* Replace '?' with '\\_-ava3f-\\_' For example: document?Code becomes document_-ava3f-_Code\r\n* Replace '%' with '\\_-ava25-\\_' For example: document%Code becomes document_-ava25-_Code\r\n* Replace '#' with '\\_-ava23-\\_' For example: document#Code becomes document_-ava23-_Code\r\n* Replace ' ' with '%20' For example: document Code becomes document%20Code\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"refundTransactionCode\": \"7b543d25-4240-4137-b95a-d0e42d8692cf\",\n \"refundDate\": \"2026-04-02\",\n \"refundType\": \"Full\",\n \"referenceCode\": \"Refund for a committed transaction\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/refund?$include=string&documentType=PurchaseOrder&useTaxDateOverride=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "refund" ], "query": [ { "description": "Specifies objects to include in the response after transaction is created", "key": "$include", "value": "string" }, { "description": "(Optional): The document type of the transaction to refund. If not provided, the default is SalesInvoice.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "(Optional): If set to true, processes refund using taxDateOverride rather than taxAmountOverride (Note: taxAmountOverride is not allowed for SST states).", "key": "useTaxDateOverride", "value": "false" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The code of the company that made the original sale" }, { "key": "transactionCode", "value": "string", "description": "The transaction code of the original sale" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 123456789,\n \"code\": \"ed92c353-a94c-4fe2-a32f-0d52f4f5ccf6\",\n \"companyId\": 12345,\n \"date\": \"2026-04-02\",\n \"status\": \"Committed\",\n \"type\": \"SalesInvoice\",\n \"currencyCode\": \"USD\",\n \"exchangeRateCurrencyCode\": \"USD\",\n \"entityUseCode\": \"\",\n \"customerVendorCode\": \"ABC\",\n \"customerCode\": \"ABC\",\n \"exemptNo\": \"\",\n \"reconciled\": true,\n \"locationCode\": \"DEFAULT\",\n \"salespersonCode\": \"DEF\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"totalAmount\": 1000,\n \"totalExempt\": 0,\n \"totalDiscount\": 0,\n \"totalTax\": 62.5,\n \"totalTaxable\": 1000,\n \"totalTaxCalculated\": 62.5,\n \"adjustmentReason\": \"NotAdjusted\",\n \"adjustmentDescription\": \"\",\n \"locked\": false,\n \"region\": \"CA\",\n \"country\": \"US\",\n \"version\": 0,\n \"originAddressId\": 123456789,\n \"destinationAddressId\": 123456789,\n \"exchangeRateEffectiveDate\": \"2026-04-02\",\n \"exchangeRate\": 2,\n \"isSellerImporterOfRecord\": false,\n \"description\": \"Yarn\",\n \"taxDate\": \"2026-04-02T00:00:00+00:00\",\n \"lines\": [\n {\n \"id\": 123456789,\n \"transactionId\": 123456789,\n \"lineNumber\": \"1\",\n \"boundaryOverrideId\": 0,\n \"entityUseCode\": \"\",\n \"description\": \"Yarn\",\n \"destinationAddressId\": 12345,\n \"originAddressId\": 123456789,\n \"discountAmount\": 100,\n \"discountTypeId\": 0,\n \"exemptAmount\": 0,\n \"exemptCertId\": 0,\n \"exemptNo\": \"\",\n \"isItemTaxable\": true,\n \"isSSTP\": false,\n \"itemCode\": \"116292\",\n \"lineAmount\": 1000,\n \"quantity\": 1,\n \"ref1\": \"Note: Deliver to Bob\",\n \"reportingDate\": \"2026-04-02\",\n \"revAccount\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxCalculated\": 62.5,\n \"taxCode\": \"PS081282\",\n \"taxDate\": \"2026-04-02\",\n \"taxEngine\": \"\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"taxIncluded\": false,\n \"details\": [\n {\n \"id\": 123456789,\n \"transactionLineId\": 123456789,\n \"transactionId\": 123456789,\n \"addressId\": 12345,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"stateFIPS\": \"06\",\n \"exemptAmount\": 0,\n \"exemptReasonId\": 4,\n \"exemptRuleId\": 0,\n \"inState\": false,\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"jurisdictionId\": 5000531,\n \"signatureCode\": \"AGAM\",\n \"stateAssignedNo\": \"\",\n \"jurisType\": \"STA\",\n \"nonTaxableAmount\": 0,\n \"nonTaxableRuleId\": 0,\n \"nonTaxableType\": \"BaseRule\",\n \"rate\": 0.0625,\n \"rateRuleId\": 1321915,\n \"rateSourceId\": 3,\n \"serCode\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxType\": \"Sales\",\n \"taxName\": \"CA STATE TAX\",\n \"taxAuthorityTypeId\": 45,\n \"taxRegionId\": 2127184,\n \"taxCalculated\": 62.5,\n \"taxOverride\": 0,\n \"rateType\": \"General\",\n \"taxableUnits\": 62.5,\n \"nonTaxableUnits\": 1000,\n \"exemptUnits\": 62.5,\n \"reportingTaxableUnits\": 125,\n \"reportingNonTaxableUnits\": 2000,\n \"reportingExemptUnits\": 125,\n \"reportingTax\": 125,\n \"reportingTaxCalculated\": 125,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0,\n \"vatCode\": \"\",\n \"granularDutyDetails\": [\n {\n \"dutyType\": \"ImportDuty\",\n \"rate\": \"10.5\",\n \"amount\": \"105.00\"\n }\n ]\n }\n ],\n \"vatNumberTypeId\": 0,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0\n }\n ],\n \"addresses\": [\n {\n \"id\": 0,\n \"transactionId\": 0,\n \"boundaryLevel\": \"Address\",\n \"line1\": \"100 Ravine Lane Northeast #220\",\n \"city\": \"Bainbridge Island\",\n \"region\": \"WA\",\n \"postalCode\": \"98110\",\n \"country\": \"US\",\n \"taxRegionId\": 0\n }\n ],\n \"taxDetailsByTaxType\": [\n {\n \"taxType\": \"SalesAndUse\",\n \"totalTaxable\": 100,\n \"totalExempt\": 0.05,\n \"totalNonTaxable\": 0,\n \"totalTax\": 0.625\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"refundTransactionCode\": \"7b543d25-4240-4137-b95a-d0e42d8692cf\",\n \"refundDate\": \"2026-04-02\",\n \"refundType\": \"Full\",\n \"referenceCode\": \"Refund for a committed transaction\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/refund?$include=string&documentType=PurchaseOrder&useTaxDateOverride=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "refund" ], "query": [ { "description": "Specifies objects to include in the response after transaction is created", "key": "$include", "value": "string" }, { "description": "(Optional): The document type of the transaction to refund. If not provided, the default is SalesInvoice.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "(Optional): If set to true, processes refund using taxDateOverride rather than taxAmountOverride (Note: taxAmountOverride is not allowed for SST states).", "key": "useTaxDateOverride", "value": "false" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The code of the company that made the original sale" }, { "key": "transactionCode", "value": "string", "description": "The transaction code of the original sale" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"refundTransactionCode\": \"7b543d25-4240-4137-b95a-d0e42d8692cf\",\n \"refundDate\": \"2026-04-02\",\n \"refundType\": \"Full\",\n \"referenceCode\": \"Refund for a committed transaction\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/refund?$include=string&documentType=PurchaseOrder&useTaxDateOverride=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "refund" ], "query": [ { "description": "Specifies objects to include in the response after transaction is created", "key": "$include", "value": "string" }, { "description": "(Optional): The document type of the transaction to refund. If not provided, the default is SalesInvoice.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "(Optional): If set to true, processes refund using taxDateOverride rather than taxAmountOverride (Note: taxAmountOverride is not allowed for SST states).", "key": "useTaxDateOverride", "value": "false" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The code of the company that made the original sale" }, { "key": "transactionCode", "value": "string", "description": "The transaction code of the original sale" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"refundTransactionCode\": \"7b543d25-4240-4137-b95a-d0e42d8692cf\",\n \"refundDate\": \"2026-04-02\",\n \"refundType\": \"Full\",\n \"referenceCode\": \"Refund for a committed transaction\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/refund?$include=string&documentType=PurchaseOrder&useTaxDateOverride=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "refund" ], "query": [ { "description": "Specifies objects to include in the response after transaction is created", "key": "$include", "value": "string" }, { "description": "(Optional): The document type of the transaction to refund. If not provided, the default is SalesInvoice.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "(Optional): If set to true, processes refund using taxDateOverride rather than taxAmountOverride (Note: taxAmountOverride is not allowed for SST states).", "key": "useTaxDateOverride", "value": "false" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The code of the company that made the original sale" }, { "key": "transactionCode", "value": "string", "description": "The transaction code of the original sale" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "settle", "item": [ { "name": "Perform multiple actions on a transaction", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"verify\": {\n \"verifyTransactionDate\": \"2026-04-02T00:00:00+00:00\",\n \"verifyTotalAmount\": 100,\n \"verifyTotalTax\": 6.25\n },\n \"changeCode\": {\n \"newCode\": \"2844fda0-3ce3-4cde-a35d-63d1800e89c9\"\n },\n \"commit\": {\n \"commit\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/settle?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "settle" ], "query": [ { "key": "documentType", "value": "PurchaseOrder", "description": "(Optional): The document type of the transaction to settle. If not provided, the default is SalesInvoice." }, { "key": "$include", "value": "string", "description": "Specifies objects to include in this fetch call" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to settle" } ] }, "description": "Performs one or more actions against the current transaction uniquely identified by this URL.\r\n \r\nThe `SettleTransaction` API call can perform the work of `ChangeCode`, `VerifyTransaction`, and `CommitTransaction`.\r\n \r\nA transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\r\nsales, purchases, inventory transfer, and returns (also called refunds).\r\n \r\nIf you have more than one document with the same `code`, specify the `documentType` parameter to choose between them.\r\n \r\nThis API is available for users who want to execute more than one action at a time.\r\n \r\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:\r\n \r\n* Lines\r\n* Details (implies lines)\r\n* AccountPayableSalesTaxDetails (implies lines - only for Account Payable transaction)\r\n* Summary (implies details)\r\n* Addresses\r\n* SummaryOnly (omit lines and details - reduces API response size)\r\n* LinesOnly (omit details - reduces API response size)\r\n* TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary.\r\n \r\nNOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:\r\n* Replace '/' with '\\_-ava2f-\\_' For example: document/Code becomes document_-ava2f-_Code\r\n* Replace '+' with '\\_-ava2b-\\_' For example: document+Code becomes document_-ava2b-_Code\r\n* Replace '?' with '\\_-ava3f-\\_' For example: document?Code becomes document_-ava3f-_Code\r\n* Replace '%' with '\\_-ava25-\\_' For example: document%Code becomes document_-ava25-_Code\r\n* Replace '#' with '\\_-ava23-\\_' For example: document#Code becomes document_-ava23-_Code\r\n* Replace ' ' with '%20' For example: document Code becomes document%20Code\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"verify\": {\n \"verifyTransactionDate\": \"2026-04-02T00:00:00+00:00\",\n \"verifyTotalAmount\": 100,\n \"verifyTotalTax\": 6.25\n },\n \"changeCode\": {\n \"newCode\": \"2844fda0-3ce3-4cde-a35d-63d1800e89c9\"\n },\n \"commit\": {\n \"commit\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/settle?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "settle" ], "query": [ { "description": "(Optional): The document type of the transaction to settle. If not provided, the default is SalesInvoice.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to settle" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 123456789,\n \"code\": \"ed92c353-a94c-4fe2-a32f-0d52f4f5ccf6\",\n \"companyId\": 12345,\n \"date\": \"2026-04-02\",\n \"status\": \"Committed\",\n \"type\": \"SalesInvoice\",\n \"currencyCode\": \"USD\",\n \"exchangeRateCurrencyCode\": \"USD\",\n \"entityUseCode\": \"\",\n \"customerVendorCode\": \"ABC\",\n \"customerCode\": \"ABC\",\n \"exemptNo\": \"\",\n \"reconciled\": true,\n \"locationCode\": \"DEFAULT\",\n \"salespersonCode\": \"DEF\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"totalAmount\": 1000,\n \"totalExempt\": 0,\n \"totalDiscount\": 0,\n \"totalTax\": 62.5,\n \"totalTaxable\": 1000,\n \"totalTaxCalculated\": 62.5,\n \"adjustmentReason\": \"NotAdjusted\",\n \"adjustmentDescription\": \"\",\n \"locked\": false,\n \"region\": \"CA\",\n \"country\": \"US\",\n \"version\": 0,\n \"originAddressId\": 123456789,\n \"destinationAddressId\": 123456789,\n \"exchangeRateEffectiveDate\": \"2026-04-02\",\n \"exchangeRate\": 2,\n \"isSellerImporterOfRecord\": false,\n \"description\": \"Yarn\",\n \"taxDate\": \"2026-04-02T00:00:00+00:00\",\n \"lines\": [\n {\n \"id\": 123456789,\n \"transactionId\": 123456789,\n \"lineNumber\": \"1\",\n \"boundaryOverrideId\": 0,\n \"entityUseCode\": \"\",\n \"description\": \"Yarn\",\n \"destinationAddressId\": 12345,\n \"originAddressId\": 123456789,\n \"discountAmount\": 100,\n \"discountTypeId\": 0,\n \"exemptAmount\": 0,\n \"exemptCertId\": 0,\n \"exemptNo\": \"\",\n \"isItemTaxable\": true,\n \"isSSTP\": false,\n \"itemCode\": \"116292\",\n \"lineAmount\": 1000,\n \"quantity\": 1,\n \"ref1\": \"Note: Deliver to Bob\",\n \"reportingDate\": \"2026-04-02\",\n \"revAccount\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxCalculated\": 62.5,\n \"taxCode\": \"PS081282\",\n \"taxDate\": \"2026-04-02\",\n \"taxEngine\": \"\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"taxIncluded\": false,\n \"details\": [\n {\n \"id\": 123456789,\n \"transactionLineId\": 123456789,\n \"transactionId\": 123456789,\n \"addressId\": 12345,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"stateFIPS\": \"06\",\n \"exemptAmount\": 0,\n \"exemptReasonId\": 4,\n \"exemptRuleId\": 0,\n \"inState\": false,\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"jurisdictionId\": 5000531,\n \"signatureCode\": \"AGAM\",\n \"stateAssignedNo\": \"\",\n \"jurisType\": \"STA\",\n \"nonTaxableAmount\": 0,\n \"nonTaxableRuleId\": 0,\n \"nonTaxableType\": \"BaseRule\",\n \"rate\": 0.0625,\n \"rateRuleId\": 1321915,\n \"rateSourceId\": 3,\n \"serCode\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxType\": \"Sales\",\n \"taxName\": \"CA STATE TAX\",\n \"taxAuthorityTypeId\": 45,\n \"taxRegionId\": 2127184,\n \"taxCalculated\": 62.5,\n \"taxOverride\": 0,\n \"rateType\": \"General\",\n \"taxableUnits\": 62.5,\n \"nonTaxableUnits\": 1000,\n \"exemptUnits\": 62.5,\n \"reportingTaxableUnits\": 125,\n \"reportingNonTaxableUnits\": 2000,\n \"reportingExemptUnits\": 125,\n \"reportingTax\": 125,\n \"reportingTaxCalculated\": 125,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0,\n \"vatCode\": \"\",\n \"granularDutyDetails\": [\n {\n \"dutyType\": \"ImportDuty\",\n \"rate\": \"10.5\",\n \"amount\": \"105.00\"\n }\n ]\n }\n ],\n \"vatNumberTypeId\": 0,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0\n }\n ],\n \"addresses\": [\n {\n \"id\": 0,\n \"transactionId\": 0,\n \"boundaryLevel\": \"Address\",\n \"line1\": \"100 Ravine Lane Northeast #220\",\n \"city\": \"Bainbridge Island\",\n \"region\": \"WA\",\n \"postalCode\": \"98110\",\n \"country\": \"US\",\n \"taxRegionId\": 0\n }\n ],\n \"taxDetailsByTaxType\": [\n {\n \"taxType\": \"SalesAndUse\",\n \"totalTaxable\": 100,\n \"totalExempt\": 0.05,\n \"totalNonTaxable\": 0,\n \"totalTax\": 0.625\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"verify\": {\n \"verifyTransactionDate\": \"2026-04-02T00:00:00+00:00\",\n \"verifyTotalAmount\": 100,\n \"verifyTotalTax\": 6.25\n },\n \"changeCode\": {\n \"newCode\": \"2844fda0-3ce3-4cde-a35d-63d1800e89c9\"\n },\n \"commit\": {\n \"commit\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/settle?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "settle" ], "query": [ { "description": "(Optional): The document type of the transaction to settle. If not provided, the default is SalesInvoice.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to settle" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"verify\": {\n \"verifyTransactionDate\": \"2026-04-02T00:00:00+00:00\",\n \"verifyTotalAmount\": 100,\n \"verifyTotalTax\": 6.25\n },\n \"changeCode\": {\n \"newCode\": \"2844fda0-3ce3-4cde-a35d-63d1800e89c9\"\n },\n \"commit\": {\n \"commit\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/settle?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "settle" ], "query": [ { "description": "(Optional): The document type of the transaction to settle. If not provided, the default is SalesInvoice.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to settle" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"verify\": {\n \"verifyTransactionDate\": \"2026-04-02T00:00:00+00:00\",\n \"verifyTotalAmount\": 100,\n \"verifyTotalTax\": 6.25\n },\n \"changeCode\": {\n \"newCode\": \"2844fda0-3ce3-4cde-a35d-63d1800e89c9\"\n },\n \"commit\": {\n \"commit\": true\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/settle?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "settle" ], "query": [ { "description": "(Optional): The document type of the transaction to settle. If not provided, the default is SalesInvoice.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to settle" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "types", "item": [ { "name": "{documentType}", "item": [ { "name": "audit", "item": [ { "name": "Get audit information about a transaction", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/types/:documentType/audit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "types", ":documentType", "audit" ], "variable": [ { "key": "companyCode", "value": "string", "description": "The code identifying the company that owns this transaction" }, { "key": "transactionCode", "value": "string", "description": "The code identifying the transaction" }, { "key": "documentType", "value": "PurchaseOrder", "description": "The document type of the original transaction" } ] }, "description": "Retrieve audit information about a transaction stored in AvaTax.\r\n \r\nThe `AuditTransaction` API retrieves audit information related to a specific transaction. This audit\r\ninformation includes the following:\r\n \r\n* The `CompanyId` of the company that created the transaction\r\n* The server timestamp representing the exact server time when the transaction was created\r\n* The server duration - how long it took to process this transaction\r\n* Whether exact API call details were logged\r\n* A reconstructed API call showing what the original CreateTransaction call looked like\r\n \r\nThis API can be used to examine information about a previously created transaction.\r\n \r\nA transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\r\nsales, purchases, inventory transfer, and returns (also called refunds).\r\n \r\nNOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:\r\n* Replace '/' with '\\_-ava2f-\\_' For example: document/Code becomes document_-ava2f-_Code\r\n* Replace '+' with '\\_-ava2b-\\_' For example: document+Code becomes document_-ava2b-_Code\r\n* Replace '?' with '\\_-ava3f-\\_' For example: document?Code becomes document_-ava3f-_Code\r\n* Replace '%' with '\\_-ava25-\\_' For example: document%Code becomes document_-ava25-_Code\r\n* Replace '#' with '\\_-ava23-\\_' For example: document#Code becomes document_-ava23-_Code\r\n* Replace ' ' with '%20' For example: document Code becomes document%20Code\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/types/:documentType/audit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "types", ":documentType", "audit" ], "variable": [ { "key": "companyCode", "value": "string", "description": "The code identifying the company that owns this transaction" }, { "key": "transactionCode", "value": "string", "description": "The code identifying the transaction" }, { "key": "documentType", "value": "PurchaseOrder", "description": "The document type of the original transaction" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"companyId\": 0,\n \"reconstructed\": {\n \"request\": {\n \"lines\": [\n {\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 100,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n }\n },\n \"serverTimestamp\": \"2026-04-02T10:55:18.9009734Z\",\n \"apiCallStatus\": \"ReconstructedApiCallAvailable\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/types/:documentType/audit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "types", ":documentType", "audit" ], "variable": [ { "key": "companyCode", "value": "string", "description": "The code identifying the company that owns this transaction" }, { "key": "transactionCode", "value": "string", "description": "The code identifying the transaction" }, { "key": "documentType", "value": "PurchaseOrder", "description": "The document type of the original transaction" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/types/:documentType/audit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "types", ":documentType", "audit" ], "variable": [ { "key": "companyCode", "value": "string", "description": "The code identifying the company that owns this transaction" }, { "key": "transactionCode", "value": "string", "description": "The code identifying the transaction" }, { "key": "documentType", "value": "PurchaseOrder", "description": "The document type of the original transaction" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/types/:documentType/audit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "types", ":documentType", "audit" ], "variable": [ { "key": "companyCode", "value": "string", "description": "The code identifying the company that owns this transaction" }, { "key": "transactionCode", "value": "string", "description": "The code identifying the transaction" }, { "key": "documentType", "value": "PurchaseOrder", "description": "The document type of the original transaction" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Retrieve a single transaction by code", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/types/:documentType?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "types", ":documentType" ], "query": [ { "key": "$include", "value": "string", "description": "Specifies objects to include in this fetch call" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to retrieve" }, { "key": "documentType", "value": "PurchaseOrder", "description": "The transaction type to retrieve" } ] }, "description": "DEPRECATED: Please use the `GetTransactionByCode` API instead.\r\n \r\nNOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:\r\n* Replace '/' with '\\_-ava2f-\\_' For example: document/Code becomes document_-ava2f-_Code\r\n* Replace '+' with '\\_-ava2b-\\_' For example: document+Code becomes document_-ava2b-_Code\r\n* Replace '?' with '\\_-ava3f-\\_' For example: document?Code becomes document_-ava3f-_Code\r\n* Replace '%' with '\\_-ava25-\\_' For example: document%Code becomes document_-ava25-_Code\r\n* Replace '#' with '\\_-ava23-\\_' For example: document#Code becomes document_-ava23-_Code\r\n* Replace ' ' with '%20' For example: document Code becomes document%20Code\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/types/:documentType?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "types", ":documentType" ], "query": [ { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to retrieve" }, { "key": "documentType", "value": "PurchaseOrder", "description": "The transaction type to retrieve" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 123456789,\n \"code\": \"ed92c353-a94c-4fe2-a32f-0d52f4f5ccf6\",\n \"companyId\": 12345,\n \"date\": \"2026-04-02\",\n \"status\": \"Committed\",\n \"type\": \"SalesInvoice\",\n \"currencyCode\": \"USD\",\n \"exchangeRateCurrencyCode\": \"USD\",\n \"entityUseCode\": \"\",\n \"customerVendorCode\": \"ABC\",\n \"customerCode\": \"ABC\",\n \"exemptNo\": \"\",\n \"reconciled\": true,\n \"locationCode\": \"DEFAULT\",\n \"salespersonCode\": \"DEF\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"totalAmount\": 1000,\n \"totalExempt\": 0,\n \"totalDiscount\": 0,\n \"totalTax\": 62.5,\n \"totalTaxable\": 1000,\n \"totalTaxCalculated\": 62.5,\n \"adjustmentReason\": \"NotAdjusted\",\n \"adjustmentDescription\": \"\",\n \"locked\": false,\n \"region\": \"CA\",\n \"country\": \"US\",\n \"version\": 0,\n \"originAddressId\": 123456789,\n \"destinationAddressId\": 123456789,\n \"exchangeRateEffectiveDate\": \"2026-04-02\",\n \"exchangeRate\": 2,\n \"isSellerImporterOfRecord\": false,\n \"description\": \"Yarn\",\n \"taxDate\": \"2026-04-02T00:00:00+00:00\",\n \"lines\": [\n {\n \"id\": 123456789,\n \"transactionId\": 123456789,\n \"lineNumber\": \"1\",\n \"boundaryOverrideId\": 0,\n \"entityUseCode\": \"\",\n \"description\": \"Yarn\",\n \"destinationAddressId\": 12345,\n \"originAddressId\": 123456789,\n \"discountAmount\": 100,\n \"discountTypeId\": 0,\n \"exemptAmount\": 0,\n \"exemptCertId\": 0,\n \"exemptNo\": \"\",\n \"isItemTaxable\": true,\n \"isSSTP\": false,\n \"itemCode\": \"116292\",\n \"lineAmount\": 1000,\n \"quantity\": 1,\n \"ref1\": \"Note: Deliver to Bob\",\n \"reportingDate\": \"2026-04-02\",\n \"revAccount\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxCalculated\": 62.5,\n \"taxCode\": \"PS081282\",\n \"taxDate\": \"2026-04-02\",\n \"taxEngine\": \"\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"taxIncluded\": false,\n \"details\": [\n {\n \"id\": 123456789,\n \"transactionLineId\": 123456789,\n \"transactionId\": 123456789,\n \"addressId\": 12345,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"stateFIPS\": \"06\",\n \"exemptAmount\": 0,\n \"exemptReasonId\": 4,\n \"exemptRuleId\": 0,\n \"inState\": false,\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"jurisdictionId\": 5000531,\n \"signatureCode\": \"AGAM\",\n \"stateAssignedNo\": \"\",\n \"jurisType\": \"STA\",\n \"nonTaxableAmount\": 0,\n \"nonTaxableRuleId\": 0,\n \"nonTaxableType\": \"BaseRule\",\n \"rate\": 0.0625,\n \"rateRuleId\": 1321915,\n \"rateSourceId\": 3,\n \"serCode\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxType\": \"Sales\",\n \"taxName\": \"CA STATE TAX\",\n \"taxAuthorityTypeId\": 45,\n \"taxRegionId\": 2127184,\n \"taxCalculated\": 62.5,\n \"taxOverride\": 0,\n \"rateType\": \"General\",\n \"taxableUnits\": 62.5,\n \"nonTaxableUnits\": 1000,\n \"exemptUnits\": 62.5,\n \"reportingTaxableUnits\": 125,\n \"reportingNonTaxableUnits\": 2000,\n \"reportingExemptUnits\": 125,\n \"reportingTax\": 125,\n \"reportingTaxCalculated\": 125,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0,\n \"vatCode\": \"\",\n \"granularDutyDetails\": [\n {\n \"dutyType\": \"ImportDuty\",\n \"rate\": \"10.5\",\n \"amount\": \"105.00\"\n }\n ]\n }\n ],\n \"vatNumberTypeId\": 0,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0\n }\n ],\n \"addresses\": [\n {\n \"id\": 0,\n \"transactionId\": 0,\n \"boundaryLevel\": \"Address\",\n \"line1\": \"100 Ravine Lane Northeast #220\",\n \"city\": \"Bainbridge Island\",\n \"region\": \"WA\",\n \"postalCode\": \"98110\",\n \"country\": \"US\",\n \"taxRegionId\": 0\n }\n ],\n \"taxDetailsByTaxType\": [\n {\n \"taxType\": \"SalesAndUse\",\n \"totalTaxable\": 100,\n \"totalExempt\": 0.05,\n \"totalNonTaxable\": 0,\n \"totalTax\": 0.625\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/types/:documentType?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "types", ":documentType" ], "query": [ { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to retrieve" }, { "key": "documentType", "value": "PurchaseOrder", "description": "The transaction type to retrieve" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/types/:documentType?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "types", ":documentType" ], "query": [ { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to retrieve" }, { "key": "documentType", "value": "PurchaseOrder", "description": "The transaction type to retrieve" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/types/:documentType?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "types", ":documentType" ], "query": [ { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to retrieve" }, { "key": "documentType", "value": "PurchaseOrder", "description": "The transaction type to retrieve" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "uncommit", "item": [ { "name": "Uncommit a transaction for reporting", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/uncommit?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "uncommit" ], "query": [ { "key": "documentType", "value": "PurchaseOrder", "description": "(Optional): The document type of the transaction to Uncommit. If not provided, the default is SalesInvoice." }, { "key": "$include", "value": "string", "description": "Specifies objects to include in this fetch call" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to Uncommit" } ] }, "description": "Adjusts a transaction by changing it to an uncommitted status.\r\n \r\nTransactions that have been previously reported to a tax authority by Avalara Managed Returns are considered `locked` and are\r\nno longer available to be uncommitted.\r\n \r\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:\r\n \r\n* Lines\r\n* Details (implies lines)\r\n* AccountPayableSalesTaxDetails (implies lines - only for Account Payable transaction)\r\n* Summary (implies details)\r\n* Addresses\r\n* SummaryOnly (omit lines and details - reduces API response size)\r\n* LinesOnly (omit details - reduces API response size)\r\n* TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary.\r\n \r\nNOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:\r\n* Replace '/' with '\\_-ava2f-\\_' For example: document/Code becomes document_-ava2f-_Code\r\n* Replace '+' with '\\_-ava2b-\\_' For example: document+Code becomes document_-ava2b-_Code\r\n* Replace '?' with '\\_-ava3f-\\_' For example: document?Code becomes document_-ava3f-_Code\r\n* Replace '%' with '\\_-ava25-\\_' For example: document%Code becomes document_-ava25-_Code\r\n* Replace '#' with '\\_-ava23-\\_' For example: document#Code becomes document_-ava23-_Code\r\n* Replace ' ' with '%20' For example: document Code becomes document%20Code\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/uncommit?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "uncommit" ], "query": [ { "description": "(Optional): The document type of the transaction to Uncommit. If not provided, the default is SalesInvoice.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to Uncommit" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 123456789,\n \"code\": \"ed92c353-a94c-4fe2-a32f-0d52f4f5ccf6\",\n \"companyId\": 12345,\n \"date\": \"2026-04-02\",\n \"status\": \"Committed\",\n \"type\": \"SalesInvoice\",\n \"currencyCode\": \"USD\",\n \"exchangeRateCurrencyCode\": \"USD\",\n \"entityUseCode\": \"\",\n \"customerVendorCode\": \"ABC\",\n \"customerCode\": \"ABC\",\n \"exemptNo\": \"\",\n \"reconciled\": true,\n \"locationCode\": \"DEFAULT\",\n \"salespersonCode\": \"DEF\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"totalAmount\": 1000,\n \"totalExempt\": 0,\n \"totalDiscount\": 0,\n \"totalTax\": 62.5,\n \"totalTaxable\": 1000,\n \"totalTaxCalculated\": 62.5,\n \"adjustmentReason\": \"NotAdjusted\",\n \"adjustmentDescription\": \"\",\n \"locked\": false,\n \"region\": \"CA\",\n \"country\": \"US\",\n \"version\": 0,\n \"originAddressId\": 123456789,\n \"destinationAddressId\": 123456789,\n \"exchangeRateEffectiveDate\": \"2026-04-02\",\n \"exchangeRate\": 2,\n \"isSellerImporterOfRecord\": false,\n \"description\": \"Yarn\",\n \"taxDate\": \"2026-04-02T00:00:00+00:00\",\n \"lines\": [\n {\n \"id\": 123456789,\n \"transactionId\": 123456789,\n \"lineNumber\": \"1\",\n \"boundaryOverrideId\": 0,\n \"entityUseCode\": \"\",\n \"description\": \"Yarn\",\n \"destinationAddressId\": 12345,\n \"originAddressId\": 123456789,\n \"discountAmount\": 100,\n \"discountTypeId\": 0,\n \"exemptAmount\": 0,\n \"exemptCertId\": 0,\n \"exemptNo\": \"\",\n \"isItemTaxable\": true,\n \"isSSTP\": false,\n \"itemCode\": \"116292\",\n \"lineAmount\": 1000,\n \"quantity\": 1,\n \"ref1\": \"Note: Deliver to Bob\",\n \"reportingDate\": \"2026-04-02\",\n \"revAccount\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxCalculated\": 62.5,\n \"taxCode\": \"PS081282\",\n \"taxDate\": \"2026-04-02\",\n \"taxEngine\": \"\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"taxIncluded\": false,\n \"details\": [\n {\n \"id\": 123456789,\n \"transactionLineId\": 123456789,\n \"transactionId\": 123456789,\n \"addressId\": 12345,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"stateFIPS\": \"06\",\n \"exemptAmount\": 0,\n \"exemptReasonId\": 4,\n \"exemptRuleId\": 0,\n \"inState\": false,\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"jurisdictionId\": 5000531,\n \"signatureCode\": \"AGAM\",\n \"stateAssignedNo\": \"\",\n \"jurisType\": \"STA\",\n \"nonTaxableAmount\": 0,\n \"nonTaxableRuleId\": 0,\n \"nonTaxableType\": \"BaseRule\",\n \"rate\": 0.0625,\n \"rateRuleId\": 1321915,\n \"rateSourceId\": 3,\n \"serCode\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxType\": \"Sales\",\n \"taxName\": \"CA STATE TAX\",\n \"taxAuthorityTypeId\": 45,\n \"taxRegionId\": 2127184,\n \"taxCalculated\": 62.5,\n \"taxOverride\": 0,\n \"rateType\": \"General\",\n \"taxableUnits\": 62.5,\n \"nonTaxableUnits\": 1000,\n \"exemptUnits\": 62.5,\n \"reportingTaxableUnits\": 125,\n \"reportingNonTaxableUnits\": 2000,\n \"reportingExemptUnits\": 125,\n \"reportingTax\": 125,\n \"reportingTaxCalculated\": 125,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0,\n \"vatCode\": \"\",\n \"granularDutyDetails\": [\n {\n \"dutyType\": \"ImportDuty\",\n \"rate\": \"10.5\",\n \"amount\": \"105.00\"\n }\n ]\n }\n ],\n \"vatNumberTypeId\": 0,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0\n }\n ],\n \"addresses\": [\n {\n \"id\": 0,\n \"transactionId\": 0,\n \"boundaryLevel\": \"Address\",\n \"line1\": \"100 Ravine Lane Northeast #220\",\n \"city\": \"Bainbridge Island\",\n \"region\": \"WA\",\n \"postalCode\": \"98110\",\n \"country\": \"US\",\n \"taxRegionId\": 0\n }\n ],\n \"taxDetailsByTaxType\": [\n {\n \"taxType\": \"SalesAndUse\",\n \"totalTaxable\": 100,\n \"totalExempt\": 0.05,\n \"totalNonTaxable\": 0,\n \"totalTax\": 0.625\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/uncommit?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "uncommit" ], "query": [ { "description": "(Optional): The document type of the transaction to Uncommit. If not provided, the default is SalesInvoice.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to Uncommit" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/uncommit?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "uncommit" ], "query": [ { "description": "(Optional): The document type of the transaction to Uncommit. If not provided, the default is SalesInvoice.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to Uncommit" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/uncommit?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "uncommit" ], "query": [ { "description": "(Optional): The document type of the transaction to Uncommit. If not provided, the default is SalesInvoice.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to Uncommit" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "unvoid", "item": [ { "name": "Unvoids a transaction", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/unvoid?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "unvoid" ], "query": [ { "key": "documentType", "value": "PurchaseOrder", "description": "(Optional): The document type of the transaction to commit. If not provided, the default is SalesInvoice." }, { "key": "$include", "value": "string", "description": "Specifies objects to include in this fetch call" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to commit" } ] }, "description": "Unvoids a voided transaction\r\n \r\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:\r\n \r\n* Lines\r\n* Details (implies lines)\r\n* AccountPayableSalesTaxDetails (implies lines - only for Account Payable transaction)\r\n* Summary (implies details)\r\n* Addresses\r\n* SummaryOnly (omit lines and details - reduces API response size)\r\n* LinesOnly (omit details - reduces API response size)\r\n* TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary.\r\n \r\nNOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:\r\n* Replace '/' with '\\_-ava2f-\\_' For example: document/Code becomes document_-ava2f-_Code\r\n* Replace '+' with '\\_-ava2b-\\_' For example: document+Code becomes document_-ava2b-_Code\r\n* Replace '?' with '\\_-ava3f-\\_' For example: document?Code becomes document_-ava3f-_Code\r\n* Replace '%' with '\\_-ava25-\\_' For example: document%Code becomes document_-ava25-_Code\r\n* Replace '#' with '\\_-ava23-\\_' For example: document#Code becomes document_-ava23-_Code\r\n* Replace ' ' with '%20' For example: document Code becomes document%20Code\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/unvoid?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "unvoid" ], "query": [ { "description": "(Optional): The document type of the transaction to commit. If not provided, the default is SalesInvoice.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to commit" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 123456789,\n \"code\": \"ed92c353-a94c-4fe2-a32f-0d52f4f5ccf6\",\n \"companyId\": 12345,\n \"date\": \"2026-04-02\",\n \"status\": \"Committed\",\n \"type\": \"SalesInvoice\",\n \"currencyCode\": \"USD\",\n \"exchangeRateCurrencyCode\": \"USD\",\n \"entityUseCode\": \"\",\n \"customerVendorCode\": \"ABC\",\n \"customerCode\": \"ABC\",\n \"exemptNo\": \"\",\n \"reconciled\": true,\n \"locationCode\": \"DEFAULT\",\n \"salespersonCode\": \"DEF\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"totalAmount\": 1000,\n \"totalExempt\": 0,\n \"totalDiscount\": 0,\n \"totalTax\": 62.5,\n \"totalTaxable\": 1000,\n \"totalTaxCalculated\": 62.5,\n \"adjustmentReason\": \"NotAdjusted\",\n \"adjustmentDescription\": \"\",\n \"locked\": false,\n \"region\": \"CA\",\n \"country\": \"US\",\n \"version\": 0,\n \"originAddressId\": 123456789,\n \"destinationAddressId\": 123456789,\n \"exchangeRateEffectiveDate\": \"2026-04-02\",\n \"exchangeRate\": 2,\n \"isSellerImporterOfRecord\": false,\n \"description\": \"Yarn\",\n \"taxDate\": \"2026-04-02T00:00:00+00:00\",\n \"lines\": [\n {\n \"id\": 123456789,\n \"transactionId\": 123456789,\n \"lineNumber\": \"1\",\n \"boundaryOverrideId\": 0,\n \"entityUseCode\": \"\",\n \"description\": \"Yarn\",\n \"destinationAddressId\": 12345,\n \"originAddressId\": 123456789,\n \"discountAmount\": 100,\n \"discountTypeId\": 0,\n \"exemptAmount\": 0,\n \"exemptCertId\": 0,\n \"exemptNo\": \"\",\n \"isItemTaxable\": true,\n \"isSSTP\": false,\n \"itemCode\": \"116292\",\n \"lineAmount\": 1000,\n \"quantity\": 1,\n \"ref1\": \"Note: Deliver to Bob\",\n \"reportingDate\": \"2026-04-02\",\n \"revAccount\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxCalculated\": 62.5,\n \"taxCode\": \"PS081282\",\n \"taxDate\": \"2026-04-02\",\n \"taxEngine\": \"\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"taxIncluded\": false,\n \"details\": [\n {\n \"id\": 123456789,\n \"transactionLineId\": 123456789,\n \"transactionId\": 123456789,\n \"addressId\": 12345,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"stateFIPS\": \"06\",\n \"exemptAmount\": 0,\n \"exemptReasonId\": 4,\n \"exemptRuleId\": 0,\n \"inState\": false,\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"jurisdictionId\": 5000531,\n \"signatureCode\": \"AGAM\",\n \"stateAssignedNo\": \"\",\n \"jurisType\": \"STA\",\n \"nonTaxableAmount\": 0,\n \"nonTaxableRuleId\": 0,\n \"nonTaxableType\": \"BaseRule\",\n \"rate\": 0.0625,\n \"rateRuleId\": 1321915,\n \"rateSourceId\": 3,\n \"serCode\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxType\": \"Sales\",\n \"taxName\": \"CA STATE TAX\",\n \"taxAuthorityTypeId\": 45,\n \"taxRegionId\": 2127184,\n \"taxCalculated\": 62.5,\n \"taxOverride\": 0,\n \"rateType\": \"General\",\n \"taxableUnits\": 62.5,\n \"nonTaxableUnits\": 1000,\n \"exemptUnits\": 62.5,\n \"reportingTaxableUnits\": 125,\n \"reportingNonTaxableUnits\": 2000,\n \"reportingExemptUnits\": 125,\n \"reportingTax\": 125,\n \"reportingTaxCalculated\": 125,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0,\n \"vatCode\": \"\",\n \"granularDutyDetails\": [\n {\n \"dutyType\": \"ImportDuty\",\n \"rate\": \"10.5\",\n \"amount\": \"105.00\"\n }\n ]\n }\n ],\n \"vatNumberTypeId\": 0,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0\n }\n ],\n \"addresses\": [\n {\n \"id\": 0,\n \"transactionId\": 0,\n \"boundaryLevel\": \"Address\",\n \"line1\": \"100 Ravine Lane Northeast #220\",\n \"city\": \"Bainbridge Island\",\n \"region\": \"WA\",\n \"postalCode\": \"98110\",\n \"country\": \"US\",\n \"taxRegionId\": 0\n }\n ],\n \"taxDetailsByTaxType\": [\n {\n \"taxType\": \"SalesAndUse\",\n \"totalTaxable\": 100,\n \"totalExempt\": 0.05,\n \"totalNonTaxable\": 0,\n \"totalTax\": 0.625\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/unvoid?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "unvoid" ], "query": [ { "description": "(Optional): The document type of the transaction to commit. If not provided, the default is SalesInvoice.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to commit" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/unvoid?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "unvoid" ], "query": [ { "description": "(Optional): The document type of the transaction to commit. If not provided, the default is SalesInvoice.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to commit" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/unvoid?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "unvoid" ], "query": [ { "description": "(Optional): The document type of the transaction to commit. If not provided, the default is SalesInvoice.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to commit" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "verify", "item": [ { "name": "Verify a transaction", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"verifyTransactionDate\": \"2026-04-02T00:00:00+00:00\",\n \"verifyTotalAmount\": 100,\n \"verifyTotalTax\": 6.25\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/verify?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "verify" ], "query": [ { "key": "documentType", "value": "PurchaseOrder", "description": "(Optional): The document type of the transaction to verify. If not provided, the default is SalesInvoice." }, { "key": "$include", "value": "string", "description": "Specifies objects to include in this fetch call" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to settle" } ] }, "description": "Verifies that the transaction uniquely identified by this URL matches certain expected values.\r\n \r\nIf the transaction does not match these expected values, this API will return an error code indicating which value did not match.\r\n \r\nIf you have more than one document with the same `code`, specify the `documentType` parameter to choose between them.\r\n \r\nA transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\r\nsales, purchases, inventory transfer, and returns (also called refunds).\r\n \r\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:\r\n \r\n* Lines\r\n* Details (implies lines)\r\n* AccountPayableSalesTaxDetails (implies lines - only for Account Payable transaction)\r\n* Summary (implies details)\r\n* Addresses\r\n* SummaryOnly (omit lines and details - reduces API response size)\r\n* LinesOnly (omit details - reduces API response size)\r\n* TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary.\r\n \r\nNOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:\r\n* Replace '/' with '\\_-ava2f-\\_' For example: document/Code becomes document_-ava2f-_Code\r\n* Replace '+' with '\\_-ava2b-\\_' For example: document+Code becomes document_-ava2b-_Code\r\n* Replace '?' with '\\_-ava3f-\\_' For example: document?Code becomes document_-ava3f-_Code\r\n* Replace '%' with '\\_-ava25-\\_' For example: document%Code becomes document_-ava25-_Code\r\n* Replace '#' with '\\_-ava23-\\_' For example: document#Code becomes document_-ava23-_Code\r\n* Replace ' ' with '%20' For example: document Code becomes document%20Code\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"verifyTransactionDate\": \"2026-04-02T00:00:00+00:00\",\n \"verifyTotalAmount\": 100,\n \"verifyTotalTax\": 6.25\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/verify?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "verify" ], "query": [ { "description": "(Optional): The document type of the transaction to verify. If not provided, the default is SalesInvoice.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to settle" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 123456789,\n \"code\": \"ed92c353-a94c-4fe2-a32f-0d52f4f5ccf6\",\n \"companyId\": 12345,\n \"date\": \"2026-04-02\",\n \"status\": \"Committed\",\n \"type\": \"SalesInvoice\",\n \"currencyCode\": \"USD\",\n \"exchangeRateCurrencyCode\": \"USD\",\n \"entityUseCode\": \"\",\n \"customerVendorCode\": \"ABC\",\n \"customerCode\": \"ABC\",\n \"exemptNo\": \"\",\n \"reconciled\": true,\n \"locationCode\": \"DEFAULT\",\n \"salespersonCode\": \"DEF\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"totalAmount\": 1000,\n \"totalExempt\": 0,\n \"totalDiscount\": 0,\n \"totalTax\": 62.5,\n \"totalTaxable\": 1000,\n \"totalTaxCalculated\": 62.5,\n \"adjustmentReason\": \"NotAdjusted\",\n \"adjustmentDescription\": \"\",\n \"locked\": false,\n \"region\": \"CA\",\n \"country\": \"US\",\n \"version\": 0,\n \"originAddressId\": 123456789,\n \"destinationAddressId\": 123456789,\n \"exchangeRateEffectiveDate\": \"2026-04-02\",\n \"exchangeRate\": 2,\n \"isSellerImporterOfRecord\": false,\n \"description\": \"Yarn\",\n \"taxDate\": \"2026-04-02T00:00:00+00:00\",\n \"lines\": [\n {\n \"id\": 123456789,\n \"transactionId\": 123456789,\n \"lineNumber\": \"1\",\n \"boundaryOverrideId\": 0,\n \"entityUseCode\": \"\",\n \"description\": \"Yarn\",\n \"destinationAddressId\": 12345,\n \"originAddressId\": 123456789,\n \"discountAmount\": 100,\n \"discountTypeId\": 0,\n \"exemptAmount\": 0,\n \"exemptCertId\": 0,\n \"exemptNo\": \"\",\n \"isItemTaxable\": true,\n \"isSSTP\": false,\n \"itemCode\": \"116292\",\n \"lineAmount\": 1000,\n \"quantity\": 1,\n \"ref1\": \"Note: Deliver to Bob\",\n \"reportingDate\": \"2026-04-02\",\n \"revAccount\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxCalculated\": 62.5,\n \"taxCode\": \"PS081282\",\n \"taxDate\": \"2026-04-02\",\n \"taxEngine\": \"\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"taxIncluded\": false,\n \"details\": [\n {\n \"id\": 123456789,\n \"transactionLineId\": 123456789,\n \"transactionId\": 123456789,\n \"addressId\": 12345,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"stateFIPS\": \"06\",\n \"exemptAmount\": 0,\n \"exemptReasonId\": 4,\n \"exemptRuleId\": 0,\n \"inState\": false,\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"jurisdictionId\": 5000531,\n \"signatureCode\": \"AGAM\",\n \"stateAssignedNo\": \"\",\n \"jurisType\": \"STA\",\n \"nonTaxableAmount\": 0,\n \"nonTaxableRuleId\": 0,\n \"nonTaxableType\": \"BaseRule\",\n \"rate\": 0.0625,\n \"rateRuleId\": 1321915,\n \"rateSourceId\": 3,\n \"serCode\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxType\": \"Sales\",\n \"taxName\": \"CA STATE TAX\",\n \"taxAuthorityTypeId\": 45,\n \"taxRegionId\": 2127184,\n \"taxCalculated\": 62.5,\n \"taxOverride\": 0,\n \"rateType\": \"General\",\n \"taxableUnits\": 62.5,\n \"nonTaxableUnits\": 1000,\n \"exemptUnits\": 62.5,\n \"reportingTaxableUnits\": 125,\n \"reportingNonTaxableUnits\": 2000,\n \"reportingExemptUnits\": 125,\n \"reportingTax\": 125,\n \"reportingTaxCalculated\": 125,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0,\n \"vatCode\": \"\",\n \"granularDutyDetails\": [\n {\n \"dutyType\": \"ImportDuty\",\n \"rate\": \"10.5\",\n \"amount\": \"105.00\"\n }\n ]\n }\n ],\n \"vatNumberTypeId\": 0,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0\n }\n ],\n \"addresses\": [\n {\n \"id\": 0,\n \"transactionId\": 0,\n \"boundaryLevel\": \"Address\",\n \"line1\": \"100 Ravine Lane Northeast #220\",\n \"city\": \"Bainbridge Island\",\n \"region\": \"WA\",\n \"postalCode\": \"98110\",\n \"country\": \"US\",\n \"taxRegionId\": 0\n }\n ],\n \"taxDetailsByTaxType\": [\n {\n \"taxType\": \"SalesAndUse\",\n \"totalTaxable\": 100,\n \"totalExempt\": 0.05,\n \"totalNonTaxable\": 0,\n \"totalTax\": 0.625\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"verifyTransactionDate\": \"2026-04-02T00:00:00+00:00\",\n \"verifyTotalAmount\": 100,\n \"verifyTotalTax\": 6.25\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/verify?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "verify" ], "query": [ { "description": "(Optional): The document type of the transaction to verify. If not provided, the default is SalesInvoice.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to settle" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"verifyTransactionDate\": \"2026-04-02T00:00:00+00:00\",\n \"verifyTotalAmount\": 100,\n \"verifyTotalTax\": 6.25\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/verify?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "verify" ], "query": [ { "description": "(Optional): The document type of the transaction to verify. If not provided, the default is SalesInvoice.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to settle" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"verifyTransactionDate\": \"2026-04-02T00:00:00+00:00\",\n \"verifyTotalAmount\": 100,\n \"verifyTotalTax\": 6.25\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/verify?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "verify" ], "query": [ { "description": "(Optional): The document type of the transaction to verify. If not provided, the default is SalesInvoice.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to settle" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "void", "item": [ { "name": "Void a transaction", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"DocVoided\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/void?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "void" ], "query": [ { "key": "documentType", "value": "PurchaseOrder", "description": "(Optional): The document type of the transaction to void. If not provided, the default is SalesInvoice." }, { "key": "$include", "value": "string", "description": "Specifies objects to include in this fetch call" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to void" } ] }, "description": "Voids the current transaction uniquely identified by this URL.\r\n \r\nA transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\r\nsales, purchases, inventory transfer, and returns (also called refunds).\r\n \r\nWhen you void a transaction, that transaction's status is recorded as `DocVoided`.\r\n \r\nIf you have more than one document with the same `code`, specify the `documentType` parameter to choose between them.\r\n \r\nTransactions that have been previously reported to a tax authority by Avalara Managed Returns are no longer available to be voided.\r\n \r\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:\r\n \r\n* Lines\r\n* Details (implies lines)\r\n* AccountPayableSalesTaxDetails (implies lines - only for Account Payable transaction)\r\n* Summary (implies details)\r\n* Addresses\r\n* SummaryOnly (omit lines and details - reduces API response size)\r\n* LinesOnly (omit details - reduces API response size)\r\n* TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary.\r\n \r\nNOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:\r\n* Replace '/' with '\\_-ava2f-\\_' For example: document/Code becomes document_-ava2f-_Code\r\n* Replace '+' with '\\_-ava2b-\\_' For example: document+Code becomes document_-ava2b-_Code\r\n* Replace '?' with '\\_-ava3f-\\_' For example: document?Code becomes document_-ava3f-_Code\r\n* Replace '%' with '\\_-ava25-\\_' For example: document%Code becomes document_-ava25-_Code\r\n* Replace '#' with '\\_-ava23-\\_' For example: document#Code becomes document_-ava23-_Code\r\n* Replace ' ' with '%20' For example: document Code becomes document%20Code\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"DocVoided\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/void?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "void" ], "query": [ { "description": "(Optional): The document type of the transaction to void. If not provided, the default is SalesInvoice.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to void" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 123456789,\n \"code\": \"ed92c353-a94c-4fe2-a32f-0d52f4f5ccf6\",\n \"companyId\": 12345,\n \"date\": \"2026-04-02\",\n \"status\": \"Committed\",\n \"type\": \"SalesInvoice\",\n \"currencyCode\": \"USD\",\n \"exchangeRateCurrencyCode\": \"USD\",\n \"entityUseCode\": \"\",\n \"customerVendorCode\": \"ABC\",\n \"customerCode\": \"ABC\",\n \"exemptNo\": \"\",\n \"reconciled\": true,\n \"locationCode\": \"DEFAULT\",\n \"salespersonCode\": \"DEF\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"totalAmount\": 1000,\n \"totalExempt\": 0,\n \"totalDiscount\": 0,\n \"totalTax\": 62.5,\n \"totalTaxable\": 1000,\n \"totalTaxCalculated\": 62.5,\n \"adjustmentReason\": \"NotAdjusted\",\n \"adjustmentDescription\": \"\",\n \"locked\": false,\n \"region\": \"CA\",\n \"country\": \"US\",\n \"version\": 0,\n \"originAddressId\": 123456789,\n \"destinationAddressId\": 123456789,\n \"exchangeRateEffectiveDate\": \"2026-04-02\",\n \"exchangeRate\": 2,\n \"isSellerImporterOfRecord\": false,\n \"description\": \"Yarn\",\n \"taxDate\": \"2026-04-02T00:00:00+00:00\",\n \"lines\": [\n {\n \"id\": 123456789,\n \"transactionId\": 123456789,\n \"lineNumber\": \"1\",\n \"boundaryOverrideId\": 0,\n \"entityUseCode\": \"\",\n \"description\": \"Yarn\",\n \"destinationAddressId\": 12345,\n \"originAddressId\": 123456789,\n \"discountAmount\": 100,\n \"discountTypeId\": 0,\n \"exemptAmount\": 0,\n \"exemptCertId\": 0,\n \"exemptNo\": \"\",\n \"isItemTaxable\": true,\n \"isSSTP\": false,\n \"itemCode\": \"116292\",\n \"lineAmount\": 1000,\n \"quantity\": 1,\n \"ref1\": \"Note: Deliver to Bob\",\n \"reportingDate\": \"2026-04-02\",\n \"revAccount\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxCalculated\": 62.5,\n \"taxCode\": \"PS081282\",\n \"taxDate\": \"2026-04-02\",\n \"taxEngine\": \"\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"taxIncluded\": false,\n \"details\": [\n {\n \"id\": 123456789,\n \"transactionLineId\": 123456789,\n \"transactionId\": 123456789,\n \"addressId\": 12345,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"stateFIPS\": \"06\",\n \"exemptAmount\": 0,\n \"exemptReasonId\": 4,\n \"exemptRuleId\": 0,\n \"inState\": false,\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"jurisdictionId\": 5000531,\n \"signatureCode\": \"AGAM\",\n \"stateAssignedNo\": \"\",\n \"jurisType\": \"STA\",\n \"nonTaxableAmount\": 0,\n \"nonTaxableRuleId\": 0,\n \"nonTaxableType\": \"BaseRule\",\n \"rate\": 0.0625,\n \"rateRuleId\": 1321915,\n \"rateSourceId\": 3,\n \"serCode\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxType\": \"Sales\",\n \"taxName\": \"CA STATE TAX\",\n \"taxAuthorityTypeId\": 45,\n \"taxRegionId\": 2127184,\n \"taxCalculated\": 62.5,\n \"taxOverride\": 0,\n \"rateType\": \"General\",\n \"taxableUnits\": 62.5,\n \"nonTaxableUnits\": 1000,\n \"exemptUnits\": 62.5,\n \"reportingTaxableUnits\": 125,\n \"reportingNonTaxableUnits\": 2000,\n \"reportingExemptUnits\": 125,\n \"reportingTax\": 125,\n \"reportingTaxCalculated\": 125,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0,\n \"vatCode\": \"\",\n \"granularDutyDetails\": [\n {\n \"dutyType\": \"ImportDuty\",\n \"rate\": \"10.5\",\n \"amount\": \"105.00\"\n }\n ]\n }\n ],\n \"vatNumberTypeId\": 0,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0\n }\n ],\n \"addresses\": [\n {\n \"id\": 0,\n \"transactionId\": 0,\n \"boundaryLevel\": \"Address\",\n \"line1\": \"100 Ravine Lane Northeast #220\",\n \"city\": \"Bainbridge Island\",\n \"region\": \"WA\",\n \"postalCode\": \"98110\",\n \"country\": \"US\",\n \"taxRegionId\": 0\n }\n ],\n \"taxDetailsByTaxType\": [\n {\n \"taxType\": \"SalesAndUse\",\n \"totalTaxable\": 100,\n \"totalExempt\": 0.05,\n \"totalNonTaxable\": 0,\n \"totalTax\": 0.625\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"DocVoided\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/void?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "void" ], "query": [ { "description": "(Optional): The document type of the transaction to void. If not provided, the default is SalesInvoice.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to void" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"DocVoided\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/void?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "void" ], "query": [ { "description": "(Optional): The document type of the transaction to void. If not provided, the default is SalesInvoice.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to void" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"DocVoided\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode/void?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode", "void" ], "query": [ { "description": "(Optional): The document type of the transaction to void. If not provided, the default is SalesInvoice.", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to void" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Retrieve a single transaction by code", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode" ], "query": [ { "key": "documentType", "value": "PurchaseOrder", "description": "(Optional): The document type of the transaction to retrieve" }, { "key": "$include", "value": "string", "description": "Specifies objects to include in this fetch call" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to retrieve" } ] }, "description": "Get the current transaction identified by this company code, transaction code, and document type.\r\n \r\nA transaction is uniquely identified by `companyCode`, `code` (often called Transaction Code), and `documentType`.\r\n \r\nFor compatibility purposes, when this API finds multiple transactions with the same transaction code, and if you have not specified\r\nthe `type` parameter to this API, it will default to selecting the `SalesInvoices` transaction. To change this behavior, use the\r\noptional `documentType` parameter to specify the specific document type you wish to find.\r\n \r\nIf this transaction was adjusted, the return value of this API will be the current transaction with this code.\r\n \r\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:\r\n \r\n* Lines\r\n* Details (implies lines)\r\n* AccountPayableSalesTaxDetails (implies lines - only for Account Payable transaction)\r\n* Summary (implies details)\r\n* Addresses\r\n* SummaryOnly (omit lines and details - reduces API response size)\r\n* LinesOnly (omit details - reduces API response size)\r\n \r\nNOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:\r\n* Replace '/' with '\\_-ava2f-\\_' For example: document/Code becomes document_-ava2f-_Code\r\n* Replace '+' with '\\_-ava2b-\\_' For example: document+Code becomes document_-ava2b-_Code\r\n* Replace '?' with '\\_-ava3f-\\_' For example: document?Code becomes document_-ava3f-_Code\r\n* Replace '%' with '\\_-ava25-\\_' For example: document%Code becomes document_-ava25-_Code\r\n* Replace '#' with '\\_-ava23-\\_' For example: document#Code becomes document_-ava23-_Code\r\n* Replace ' ' with '%20' For example: document Code becomes document%20Code\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode" ], "query": [ { "description": "(Optional): The document type of the transaction to retrieve", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to retrieve" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 123456789,\n \"code\": \"ed92c353-a94c-4fe2-a32f-0d52f4f5ccf6\",\n \"companyId\": 12345,\n \"date\": \"2026-04-02\",\n \"status\": \"Committed\",\n \"type\": \"SalesInvoice\",\n \"currencyCode\": \"USD\",\n \"exchangeRateCurrencyCode\": \"USD\",\n \"entityUseCode\": \"\",\n \"customerVendorCode\": \"ABC\",\n \"customerCode\": \"ABC\",\n \"exemptNo\": \"\",\n \"reconciled\": true,\n \"locationCode\": \"DEFAULT\",\n \"salespersonCode\": \"DEF\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"totalAmount\": 1000,\n \"totalExempt\": 0,\n \"totalDiscount\": 0,\n \"totalTax\": 62.5,\n \"totalTaxable\": 1000,\n \"totalTaxCalculated\": 62.5,\n \"adjustmentReason\": \"NotAdjusted\",\n \"adjustmentDescription\": \"\",\n \"locked\": false,\n \"region\": \"CA\",\n \"country\": \"US\",\n \"version\": 0,\n \"originAddressId\": 123456789,\n \"destinationAddressId\": 123456789,\n \"exchangeRateEffectiveDate\": \"2026-04-02\",\n \"exchangeRate\": 2,\n \"isSellerImporterOfRecord\": false,\n \"description\": \"Yarn\",\n \"taxDate\": \"2026-04-02T00:00:00+00:00\",\n \"lines\": [\n {\n \"id\": 123456789,\n \"transactionId\": 123456789,\n \"lineNumber\": \"1\",\n \"boundaryOverrideId\": 0,\n \"entityUseCode\": \"\",\n \"description\": \"Yarn\",\n \"destinationAddressId\": 12345,\n \"originAddressId\": 123456789,\n \"discountAmount\": 100,\n \"discountTypeId\": 0,\n \"exemptAmount\": 0,\n \"exemptCertId\": 0,\n \"exemptNo\": \"\",\n \"isItemTaxable\": true,\n \"isSSTP\": false,\n \"itemCode\": \"116292\",\n \"lineAmount\": 1000,\n \"quantity\": 1,\n \"ref1\": \"Note: Deliver to Bob\",\n \"reportingDate\": \"2026-04-02\",\n \"revAccount\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxCalculated\": 62.5,\n \"taxCode\": \"PS081282\",\n \"taxDate\": \"2026-04-02\",\n \"taxEngine\": \"\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"taxIncluded\": false,\n \"details\": [\n {\n \"id\": 123456789,\n \"transactionLineId\": 123456789,\n \"transactionId\": 123456789,\n \"addressId\": 12345,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"stateFIPS\": \"06\",\n \"exemptAmount\": 0,\n \"exemptReasonId\": 4,\n \"exemptRuleId\": 0,\n \"inState\": false,\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"jurisdictionId\": 5000531,\n \"signatureCode\": \"AGAM\",\n \"stateAssignedNo\": \"\",\n \"jurisType\": \"STA\",\n \"nonTaxableAmount\": 0,\n \"nonTaxableRuleId\": 0,\n \"nonTaxableType\": \"BaseRule\",\n \"rate\": 0.0625,\n \"rateRuleId\": 1321915,\n \"rateSourceId\": 3,\n \"serCode\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxType\": \"Sales\",\n \"taxName\": \"CA STATE TAX\",\n \"taxAuthorityTypeId\": 45,\n \"taxRegionId\": 2127184,\n \"taxCalculated\": 62.5,\n \"taxOverride\": 0,\n \"rateType\": \"General\",\n \"taxableUnits\": 62.5,\n \"nonTaxableUnits\": 1000,\n \"exemptUnits\": 62.5,\n \"reportingTaxableUnits\": 125,\n \"reportingNonTaxableUnits\": 2000,\n \"reportingExemptUnits\": 125,\n \"reportingTax\": 125,\n \"reportingTaxCalculated\": 125,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0,\n \"vatCode\": \"\",\n \"granularDutyDetails\": [\n {\n \"dutyType\": \"ImportDuty\",\n \"rate\": \"10.5\",\n \"amount\": \"105.00\"\n }\n ]\n }\n ],\n \"vatNumberTypeId\": 0,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0\n }\n ],\n \"addresses\": [\n {\n \"id\": 0,\n \"transactionId\": 0,\n \"boundaryLevel\": \"Address\",\n \"line1\": \"100 Ravine Lane Northeast #220\",\n \"city\": \"Bainbridge Island\",\n \"region\": \"WA\",\n \"postalCode\": \"98110\",\n \"country\": \"US\",\n \"taxRegionId\": 0\n }\n ],\n \"taxDetailsByTaxType\": [\n {\n \"taxType\": \"SalesAndUse\",\n \"totalTaxable\": 100,\n \"totalExempt\": 0.05,\n \"totalNonTaxable\": 0,\n \"totalTax\": 0.625\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode" ], "query": [ { "description": "(Optional): The document type of the transaction to retrieve", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to retrieve" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode" ], "query": [ { "description": "(Optional): The document type of the transaction to retrieve", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to retrieve" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionCode?documentType=PurchaseOrder&$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionCode" ], "query": [ { "description": "(Optional): The document type of the transaction to retrieve", "key": "documentType", "value": "PurchaseOrder" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" }, { "key": "transactionCode", "value": "string", "description": "The transaction code to retrieve" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "{transactionId}", "item": [ { "name": "variance", "item": [ { "name": "Fetches the Variance data generated for particular Company by transaction ID", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionId/variance", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionId", "variance" ], "variable": [ { "key": "companyCode", "value": "string" }, { "key": "transactionId", "value": "string" } ] }, "description": "\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionId/variance", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionId", "variance" ], "variable": [ { "key": "companyCode", "value": "string" }, { "key": "transactionId", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"totalRequest\": 0\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionId/variance", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionId", "variance" ], "variable": [ { "key": "companyCode", "value": "string" }, { "key": "transactionId", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionId/variance", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionId", "variance" ], "variable": [ { "key": "companyCode", "value": "string" }, { "key": "transactionId", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions/:transactionId/variance", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions", ":transactionId", "variance" ], "variable": [ { "key": "companyCode", "value": "string" }, { "key": "transactionId", "value": "string" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "Retrieve all transactions", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions?dataSourceId=451&$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions" ], "query": [ { "key": "dataSourceId", "value": "451", "description": "Optionally filter transactions to those from a specific data source." }, { "key": "$include", "value": "string", "description": "Specifies objects to include in this fetch call" }, { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* exchangeRateCurrencyCode, totalDiscount, lines, addresses, locationTypes, summary, taxDetailsByTaxType, parameters, userDefinedFields, messages, invoiceMessages, isFakeTransaction, deliveryTerms, apStatusCode, apStatus, vendorName, varianceAmount" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" } ] }, "description": "List all transactions attached to this company.\r\n \r\nThis endpoint is limited to returning 1,000 transactions at a time maximum.\r\n \r\nWhen listing transactions, you must specify a `date` range filter. If you do not specify a `$filter` that includes a `date` field\r\ncriteria, the query will default to looking at only those transactions with `date` in the past 30 days.\r\n \r\nA transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\r\nsales, purchases, inventory transfer, and returns (also called refunds).\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\r\n \r\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:\r\n \r\n* Lines\r\n* Details (implies lines)\r\n* AccountPayableSalesTaxDetails (implies lines - only for Account Payable transaction)\r\n* Summary (implies details)\r\n* Addresses\r\n* SummaryOnly (omit lines and details - reduces API response size)\r\n* LinesOnly (omit details - reduces API response size)\r\n \r\nNOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:\r\n* Replace '/' with '\\_-ava2f-\\_' For example: document/Code becomes document_-ava2f-_Code\r\n* Replace '+' with '\\_-ava2b-\\_' For example: document+Code becomes document_-ava2b-_Code\r\n* Replace '?' with '\\_-ava3f-\\_' For example: document?Code becomes document_-ava3f-_Code\r\n* Replace '%' with '\\_-ava25-\\_' For example: document%Code becomes document_-ava25-_Code\r\n* Replace '#' with '\\_-ava23-\\_' For example: document#Code becomes document_-ava23-_Code\r\n* Replace ' ' with '%20' For example: document Code becomes document%20Code\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions?dataSourceId=451&$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions" ], "query": [ { "description": "Optionally filter transactions to those from a specific data source.", "key": "dataSourceId", "value": "451" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* exchangeRateCurrencyCode, totalDiscount, lines, addresses, locationTypes, summary, taxDetailsByTaxType, parameters, userDefinedFields, messages, invoiceMessages, isFakeTransaction, deliveryTerms, apStatusCode, apStatus, vendorName, varianceAmount", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 411,\n \"value\": [\n {\n \"id\": 123456789,\n \"code\": \"ed92c353-a94c-4fe2-a32f-0d52f4f5ccf6\",\n \"companyId\": 12345,\n \"date\": \"2026-04-02\",\n \"status\": \"Committed\",\n \"type\": \"SalesInvoice\",\n \"currencyCode\": \"USD\",\n \"exchangeRateCurrencyCode\": \"USD\",\n \"entityUseCode\": \"\",\n \"customerVendorCode\": \"ABC\",\n \"customerCode\": \"ABC\",\n \"exemptNo\": \"\",\n \"reconciled\": true,\n \"locationCode\": \"DEFAULT\",\n \"salespersonCode\": \"DEF\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"totalAmount\": 1000,\n \"totalExempt\": 0,\n \"totalDiscount\": 0,\n \"totalTax\": 62.5,\n \"totalTaxable\": 1000,\n \"totalTaxCalculated\": 62.5,\n \"adjustmentReason\": \"NotAdjusted\",\n \"adjustmentDescription\": \"\",\n \"locked\": false,\n \"region\": \"CA\",\n \"country\": \"US\",\n \"version\": 0,\n \"originAddressId\": 123456789,\n \"destinationAddressId\": 123456789,\n \"exchangeRateEffectiveDate\": \"2026-04-02\",\n \"exchangeRate\": 2,\n \"isSellerImporterOfRecord\": false,\n \"description\": \"Yarn\",\n \"taxDate\": \"2026-04-02T00:00:00+00:00\",\n \"lines\": [\n {\n \"id\": 123456789,\n \"transactionId\": 123456789,\n \"lineNumber\": \"1\",\n \"boundaryOverrideId\": 0,\n \"entityUseCode\": \"\",\n \"description\": \"Yarn\",\n \"destinationAddressId\": 12345,\n \"originAddressId\": 123456789,\n \"discountAmount\": 100,\n \"discountTypeId\": 0,\n \"exemptAmount\": 0,\n \"exemptCertId\": 0,\n \"exemptNo\": \"\",\n \"isItemTaxable\": true,\n \"isSSTP\": false,\n \"itemCode\": \"116292\",\n \"lineAmount\": 1000,\n \"quantity\": 1,\n \"ref1\": \"Note: Deliver to Bob\",\n \"reportingDate\": \"2026-04-02\",\n \"revAccount\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxCalculated\": 62.5,\n \"taxCode\": \"PS081282\",\n \"taxDate\": \"2026-04-02\",\n \"taxEngine\": \"\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"taxIncluded\": false,\n \"details\": [\n {\n \"id\": 123456789,\n \"transactionLineId\": 123456789,\n \"transactionId\": 123456789,\n \"addressId\": 12345,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"stateFIPS\": \"06\",\n \"exemptAmount\": 0,\n \"exemptReasonId\": 4,\n \"exemptRuleId\": 0,\n \"inState\": false,\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"jurisdictionId\": 5000531,\n \"signatureCode\": \"AGAM\",\n \"stateAssignedNo\": \"\",\n \"jurisType\": \"STA\",\n \"nonTaxableAmount\": 0,\n \"nonTaxableRuleId\": 0,\n \"nonTaxableType\": \"BaseRule\",\n \"rate\": 0.0625,\n \"rateRuleId\": 1321915,\n \"rateSourceId\": 3,\n \"serCode\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxType\": \"Sales\",\n \"taxName\": \"CA STATE TAX\",\n \"taxAuthorityTypeId\": 45,\n \"taxRegionId\": 2127184,\n \"taxCalculated\": 62.5,\n \"taxOverride\": 0,\n \"rateType\": \"General\",\n \"taxableUnits\": 62.5,\n \"nonTaxableUnits\": 1000,\n \"exemptUnits\": 62.5,\n \"reportingTaxableUnits\": 125,\n \"reportingNonTaxableUnits\": 2000,\n \"reportingExemptUnits\": 125,\n \"reportingTax\": 125,\n \"reportingTaxCalculated\": 125,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0,\n \"vatCode\": \"\",\n \"granularDutyDetails\": [\n {\n \"dutyType\": \"ImportDuty\",\n \"rate\": \"10.5\",\n \"amount\": \"105.00\"\n }\n ]\n }\n ],\n \"vatNumberTypeId\": 0,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0\n }\n ],\n \"addresses\": [\n {\n \"id\": 0,\n \"transactionId\": 0,\n \"boundaryLevel\": \"Address\",\n \"line1\": \"100 Ravine Lane Northeast #220\",\n \"city\": \"Bainbridge Island\",\n \"region\": \"WA\",\n \"postalCode\": \"98110\",\n \"country\": \"US\",\n \"taxRegionId\": 0\n }\n ],\n \"taxDetailsByTaxType\": [\n {\n \"taxType\": \"SalesAndUse\",\n \"totalTaxable\": 100,\n \"totalExempt\": 0.05,\n \"totalNonTaxable\": 0,\n \"totalTax\": 0.625\n }\n ]\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions?dataSourceId=451&$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions" ], "query": [ { "description": "Optionally filter transactions to those from a specific data source.", "key": "dataSourceId", "value": "451" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* exchangeRateCurrencyCode, totalDiscount, lines, addresses, locationTypes, summary, taxDetailsByTaxType, parameters, userDefinedFields, messages, invoiceMessages, isFakeTransaction, deliveryTerms, apStatusCode, apStatus, vendorName, varianceAmount", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions?dataSourceId=451&$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions" ], "query": [ { "description": "Optionally filter transactions to those from a specific data source.", "key": "dataSourceId", "value": "451" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* exchangeRateCurrencyCode, totalDiscount, lines, addresses, locationTypes, summary, taxDetailsByTaxType, parameters, userDefinedFields, messages, invoiceMessages, isFakeTransaction, deliveryTerms, apStatusCode, apStatus, vendorName, varianceAmount", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/transactions?dataSourceId=451&$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "transactions" ], "query": [ { "description": "Optionally filter transactions to those from a specific data source.", "key": "dataSourceId", "value": "451" }, { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* exchangeRateCurrencyCode, totalDiscount, lines, addresses, locationTypes, summary, taxDetailsByTaxType, parameters, userDefinedFields, messages, invoiceMessages, isFakeTransaction, deliveryTerms, apStatusCode, apStatus, vendorName, varianceAmount", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code of the company that recorded this transaction" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "variance", "item": [ { "name": "Generates the Variance report which will capture the difference between \"Tax Calculated by Avalara\" Vs \"Actual Tax\" paid at custom clearance at line / header level.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"documentId\": 404,\n \"documentCode\": \"string\",\n \"purchaseOrderNo\": \"string\",\n \"referenceNo\": \"string\",\n \"exchangeRate\": 1052.2944245422773,\n \"lines\": [\n {\n \"lineNo\": \"string\",\n \"hsCode\": \"string\",\n \"dutyRate\": 6148.545679854967,\n \"taxRate\": 7015.13305409641,\n \"amount\": {\n \"amount\": 754.3021906868885,\n \"currency\": \"string\"\n },\n \"taxableAmount\": {\n \"amount\": 8687.789020870212,\n \"currency\": \"string\"\n },\n \"dutyPaid\": {\n \"amount\": 9277.334877381501,\n \"currency\": \"string\"\n },\n \"taxPaid\": {\n \"amount\": 6299.780684991953,\n \"currency\": \"string\"\n },\n \"totalTaxPaid\": {\n \"amount\": 9358.694006121254,\n \"currency\": \"string\"\n },\n \"details\": [\n {\n \"taxSubType\": \"string\",\n \"amount\": 910.8361715530044,\n \"currency\": \"string\"\n },\n {\n \"taxSubType\": \"string\",\n \"amount\": 5924.397236317926,\n \"currency\": \"string\"\n }\n ]\n },\n {\n \"lineNo\": \"string\",\n \"hsCode\": \"string\",\n \"dutyRate\": 7213.609517611099,\n \"taxRate\": 8404.789660063325,\n \"amount\": {\n \"amount\": 6994.017559830987,\n \"currency\": \"string\"\n },\n \"taxableAmount\": {\n \"amount\": 8402.233888933757,\n \"currency\": \"string\"\n },\n \"dutyPaid\": {\n \"amount\": 2028.7955802934675,\n \"currency\": \"string\"\n },\n \"taxPaid\": {\n \"amount\": 8827.092235901728,\n \"currency\": \"string\"\n },\n \"totalTaxPaid\": {\n \"amount\": 2163.4952786943386,\n \"currency\": \"string\"\n },\n \"details\": [\n {\n \"taxSubType\": \"string\",\n \"amount\": 606.5206199393435,\n \"currency\": \"string\"\n },\n {\n \"taxSubType\": \"string\",\n \"amount\": 4513.184201430338,\n \"currency\": \"string\"\n }\n ]\n }\n ],\n \"amount\": {\n \"amount\": 6426.982424692951,\n \"currency\": \"string\"\n },\n \"taxableAmount\": {\n \"amount\": 6783.520333585929,\n \"currency\": \"string\"\n },\n \"dutyPaid\": {\n \"amount\": 6947.804936970583,\n \"currency\": \"string\"\n },\n \"taxPaid\": {\n \"amount\": 9463.239824313852,\n \"currency\": \"string\"\n },\n \"totalTaxPaid\": {\n \"amount\": 3556.751880188602,\n \"currency\": \"string\"\n },\n \"details\": [\n {\n \"taxSubType\": \"string\",\n \"amount\": 6501.686003229283,\n \"currency\": \"string\"\n },\n {\n \"taxSubType\": \"string\",\n \"amount\": 5049.424389482897,\n \"currency\": \"string\"\n }\n ]\n },\n {\n \"documentId\": 4519,\n \"documentCode\": \"string\",\n \"purchaseOrderNo\": \"string\",\n \"referenceNo\": \"string\",\n \"exchangeRate\": 3729.5395062458183,\n \"lines\": [\n {\n \"lineNo\": \"string\",\n \"hsCode\": \"string\",\n \"dutyRate\": 9782.987758164512,\n \"taxRate\": 9716.681604803773,\n \"amount\": {\n \"amount\": 9215.603888187294,\n \"currency\": \"string\"\n },\n \"taxableAmount\": {\n \"amount\": 5251.517196502944,\n \"currency\": \"string\"\n },\n \"dutyPaid\": {\n \"amount\": 2371.5557550916633,\n \"currency\": \"string\"\n },\n \"taxPaid\": {\n \"amount\": 1271.675104296699,\n \"currency\": \"string\"\n },\n \"totalTaxPaid\": {\n \"amount\": 9260.854718495397,\n \"currency\": \"string\"\n },\n \"details\": [\n {\n \"taxSubType\": \"string\",\n \"amount\": 8660.019396702743,\n \"currency\": \"string\"\n },\n {\n \"taxSubType\": \"string\",\n \"amount\": 9851.620716130667,\n \"currency\": \"string\"\n }\n ]\n },\n {\n \"lineNo\": \"string\",\n \"hsCode\": \"string\",\n \"dutyRate\": 2985.8191835559887,\n \"taxRate\": 7349.701401997812,\n \"amount\": {\n \"amount\": 3223.686505444241,\n \"currency\": \"string\"\n },\n \"taxableAmount\": {\n \"amount\": 6930.94152604192,\n \"currency\": \"string\"\n },\n \"dutyPaid\": {\n \"amount\": 7424.58937256671,\n \"currency\": \"string\"\n },\n \"taxPaid\": {\n \"amount\": 517.0785273092271,\n \"currency\": \"string\"\n },\n \"totalTaxPaid\": {\n \"amount\": 3819.851145653883,\n \"currency\": \"string\"\n },\n \"details\": [\n {\n \"taxSubType\": \"string\",\n \"amount\": 5939.169288358672,\n \"currency\": \"string\"\n },\n {\n \"taxSubType\": \"string\",\n \"amount\": 2261.208831038615,\n \"currency\": \"string\"\n }\n ]\n }\n ],\n \"amount\": {\n \"amount\": 5348.17165713352,\n \"currency\": \"string\"\n },\n \"taxableAmount\": {\n \"amount\": 3384.9933559748592,\n \"currency\": \"string\"\n },\n \"dutyPaid\": {\n \"amount\": 3515.447983663773,\n \"currency\": \"string\"\n },\n \"taxPaid\": {\n \"amount\": 8496.602548921983,\n \"currency\": \"string\"\n },\n \"totalTaxPaid\": {\n \"amount\": 3450.5640581517728,\n \"currency\": \"string\"\n },\n \"details\": [\n {\n \"taxSubType\": \"string\",\n \"amount\": 4420.814468640267,\n \"currency\": \"string\"\n },\n {\n \"taxSubType\": \"string\",\n \"amount\": 4228.404586466776,\n \"currency\": \"string\"\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/variance", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "variance" ], "variable": [ { "key": "companyCode", "value": "string" } ] }, "description": "\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"documentId\": 404,\n \"documentCode\": \"string\",\n \"purchaseOrderNo\": \"string\",\n \"referenceNo\": \"string\",\n \"exchangeRate\": 1052.2944245422773,\n \"lines\": [\n {\n \"lineNo\": \"string\",\n \"hsCode\": \"string\",\n \"dutyRate\": 6148.545679854967,\n \"taxRate\": 7015.13305409641,\n \"amount\": {\n \"amount\": 754.3021906868885,\n \"currency\": \"string\"\n },\n \"taxableAmount\": {\n \"amount\": 8687.789020870212,\n \"currency\": \"string\"\n },\n \"dutyPaid\": {\n \"amount\": 9277.334877381501,\n \"currency\": \"string\"\n },\n \"taxPaid\": {\n \"amount\": 6299.780684991953,\n \"currency\": \"string\"\n },\n \"totalTaxPaid\": {\n \"amount\": 9358.694006121254,\n \"currency\": \"string\"\n },\n \"details\": [\n {\n \"taxSubType\": \"string\",\n \"amount\": 910.8361715530044,\n \"currency\": \"string\"\n },\n {\n \"taxSubType\": \"string\",\n \"amount\": 5924.397236317926,\n \"currency\": \"string\"\n }\n ]\n },\n {\n \"lineNo\": \"string\",\n \"hsCode\": \"string\",\n \"dutyRate\": 7213.609517611099,\n \"taxRate\": 8404.789660063325,\n \"amount\": {\n \"amount\": 6994.017559830987,\n \"currency\": \"string\"\n },\n \"taxableAmount\": {\n \"amount\": 8402.233888933757,\n \"currency\": \"string\"\n },\n \"dutyPaid\": {\n \"amount\": 2028.7955802934675,\n \"currency\": \"string\"\n },\n \"taxPaid\": {\n \"amount\": 8827.092235901728,\n \"currency\": \"string\"\n },\n \"totalTaxPaid\": {\n \"amount\": 2163.4952786943386,\n \"currency\": \"string\"\n },\n \"details\": [\n {\n \"taxSubType\": \"string\",\n \"amount\": 606.5206199393435,\n \"currency\": \"string\"\n },\n {\n \"taxSubType\": \"string\",\n \"amount\": 4513.184201430338,\n \"currency\": \"string\"\n }\n ]\n }\n ],\n \"amount\": {\n \"amount\": 6426.982424692951,\n \"currency\": \"string\"\n },\n \"taxableAmount\": {\n \"amount\": 6783.520333585929,\n \"currency\": \"string\"\n },\n \"dutyPaid\": {\n \"amount\": 6947.804936970583,\n \"currency\": \"string\"\n },\n \"taxPaid\": {\n \"amount\": 9463.239824313852,\n \"currency\": \"string\"\n },\n \"totalTaxPaid\": {\n \"amount\": 3556.751880188602,\n \"currency\": \"string\"\n },\n \"details\": [\n {\n \"taxSubType\": \"string\",\n \"amount\": 6501.686003229283,\n \"currency\": \"string\"\n },\n {\n \"taxSubType\": \"string\",\n \"amount\": 5049.424389482897,\n \"currency\": \"string\"\n }\n ]\n },\n {\n \"documentId\": 4519,\n \"documentCode\": \"string\",\n \"purchaseOrderNo\": \"string\",\n \"referenceNo\": \"string\",\n \"exchangeRate\": 3729.5395062458183,\n \"lines\": [\n {\n \"lineNo\": \"string\",\n \"hsCode\": \"string\",\n \"dutyRate\": 9782.987758164512,\n \"taxRate\": 9716.681604803773,\n \"amount\": {\n \"amount\": 9215.603888187294,\n \"currency\": \"string\"\n },\n \"taxableAmount\": {\n \"amount\": 5251.517196502944,\n \"currency\": \"string\"\n },\n \"dutyPaid\": {\n \"amount\": 2371.5557550916633,\n \"currency\": \"string\"\n },\n \"taxPaid\": {\n \"amount\": 1271.675104296699,\n \"currency\": \"string\"\n },\n \"totalTaxPaid\": {\n \"amount\": 9260.854718495397,\n \"currency\": \"string\"\n },\n \"details\": [\n {\n \"taxSubType\": \"string\",\n \"amount\": 8660.019396702743,\n \"currency\": \"string\"\n },\n {\n \"taxSubType\": \"string\",\n \"amount\": 9851.620716130667,\n \"currency\": \"string\"\n }\n ]\n },\n {\n \"lineNo\": \"string\",\n \"hsCode\": \"string\",\n \"dutyRate\": 2985.8191835559887,\n \"taxRate\": 7349.701401997812,\n \"amount\": {\n \"amount\": 3223.686505444241,\n \"currency\": \"string\"\n },\n \"taxableAmount\": {\n \"amount\": 6930.94152604192,\n \"currency\": \"string\"\n },\n \"dutyPaid\": {\n \"amount\": 7424.58937256671,\n \"currency\": \"string\"\n },\n \"taxPaid\": {\n \"amount\": 517.0785273092271,\n \"currency\": \"string\"\n },\n \"totalTaxPaid\": {\n \"amount\": 3819.851145653883,\n \"currency\": \"string\"\n },\n \"details\": [\n {\n \"taxSubType\": \"string\",\n \"amount\": 5939.169288358672,\n \"currency\": \"string\"\n },\n {\n \"taxSubType\": \"string\",\n \"amount\": 2261.208831038615,\n \"currency\": \"string\"\n }\n ]\n }\n ],\n \"amount\": {\n \"amount\": 5348.17165713352,\n \"currency\": \"string\"\n },\n \"taxableAmount\": {\n \"amount\": 3384.9933559748592,\n \"currency\": \"string\"\n },\n \"dutyPaid\": {\n \"amount\": 3515.447983663773,\n \"currency\": \"string\"\n },\n \"taxPaid\": {\n \"amount\": 8496.602548921983,\n \"currency\": \"string\"\n },\n \"totalTaxPaid\": {\n \"amount\": 3450.5640581517728,\n \"currency\": \"string\"\n },\n \"details\": [\n {\n \"taxSubType\": \"string\",\n \"amount\": 4420.814468640267,\n \"currency\": \"string\"\n },\n {\n \"taxSubType\": \"string\",\n \"amount\": 4228.404586466776,\n \"currency\": \"string\"\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/variance", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "variance" ], "variable": [ { "key": "companyCode", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"totalRequest\": 0\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"documentId\": 404,\n \"documentCode\": \"string\",\n \"purchaseOrderNo\": \"string\",\n \"referenceNo\": \"string\",\n \"exchangeRate\": 1052.2944245422773,\n \"lines\": [\n {\n \"lineNo\": \"string\",\n \"hsCode\": \"string\",\n \"dutyRate\": 6148.545679854967,\n \"taxRate\": 7015.13305409641,\n \"amount\": {\n \"amount\": 754.3021906868885,\n \"currency\": \"string\"\n },\n \"taxableAmount\": {\n \"amount\": 8687.789020870212,\n \"currency\": \"string\"\n },\n \"dutyPaid\": {\n \"amount\": 9277.334877381501,\n \"currency\": \"string\"\n },\n \"taxPaid\": {\n \"amount\": 6299.780684991953,\n \"currency\": \"string\"\n },\n \"totalTaxPaid\": {\n \"amount\": 9358.694006121254,\n \"currency\": \"string\"\n },\n \"details\": [\n {\n \"taxSubType\": \"string\",\n \"amount\": 910.8361715530044,\n \"currency\": \"string\"\n },\n {\n \"taxSubType\": \"string\",\n \"amount\": 5924.397236317926,\n \"currency\": \"string\"\n }\n ]\n },\n {\n \"lineNo\": \"string\",\n \"hsCode\": \"string\",\n \"dutyRate\": 7213.609517611099,\n \"taxRate\": 8404.789660063325,\n \"amount\": {\n \"amount\": 6994.017559830987,\n \"currency\": \"string\"\n },\n \"taxableAmount\": {\n \"amount\": 8402.233888933757,\n \"currency\": \"string\"\n },\n \"dutyPaid\": {\n \"amount\": 2028.7955802934675,\n \"currency\": \"string\"\n },\n \"taxPaid\": {\n \"amount\": 8827.092235901728,\n \"currency\": \"string\"\n },\n \"totalTaxPaid\": {\n \"amount\": 2163.4952786943386,\n \"currency\": \"string\"\n },\n \"details\": [\n {\n \"taxSubType\": \"string\",\n \"amount\": 606.5206199393435,\n \"currency\": \"string\"\n },\n {\n \"taxSubType\": \"string\",\n \"amount\": 4513.184201430338,\n \"currency\": \"string\"\n }\n ]\n }\n ],\n \"amount\": {\n \"amount\": 6426.982424692951,\n \"currency\": \"string\"\n },\n \"taxableAmount\": {\n \"amount\": 6783.520333585929,\n \"currency\": \"string\"\n },\n \"dutyPaid\": {\n \"amount\": 6947.804936970583,\n \"currency\": \"string\"\n },\n \"taxPaid\": {\n \"amount\": 9463.239824313852,\n \"currency\": \"string\"\n },\n \"totalTaxPaid\": {\n \"amount\": 3556.751880188602,\n \"currency\": \"string\"\n },\n \"details\": [\n {\n \"taxSubType\": \"string\",\n \"amount\": 6501.686003229283,\n \"currency\": \"string\"\n },\n {\n \"taxSubType\": \"string\",\n \"amount\": 5049.424389482897,\n \"currency\": \"string\"\n }\n ]\n },\n {\n \"documentId\": 4519,\n \"documentCode\": \"string\",\n \"purchaseOrderNo\": \"string\",\n \"referenceNo\": \"string\",\n \"exchangeRate\": 3729.5395062458183,\n \"lines\": [\n {\n \"lineNo\": \"string\",\n \"hsCode\": \"string\",\n \"dutyRate\": 9782.987758164512,\n \"taxRate\": 9716.681604803773,\n \"amount\": {\n \"amount\": 9215.603888187294,\n \"currency\": \"string\"\n },\n \"taxableAmount\": {\n \"amount\": 5251.517196502944,\n \"currency\": \"string\"\n },\n \"dutyPaid\": {\n \"amount\": 2371.5557550916633,\n \"currency\": \"string\"\n },\n \"taxPaid\": {\n \"amount\": 1271.675104296699,\n \"currency\": \"string\"\n },\n \"totalTaxPaid\": {\n \"amount\": 9260.854718495397,\n \"currency\": \"string\"\n },\n \"details\": [\n {\n \"taxSubType\": \"string\",\n \"amount\": 8660.019396702743,\n \"currency\": \"string\"\n },\n {\n \"taxSubType\": \"string\",\n \"amount\": 9851.620716130667,\n \"currency\": \"string\"\n }\n ]\n },\n {\n \"lineNo\": \"string\",\n \"hsCode\": \"string\",\n \"dutyRate\": 2985.8191835559887,\n \"taxRate\": 7349.701401997812,\n \"amount\": {\n \"amount\": 3223.686505444241,\n \"currency\": \"string\"\n },\n \"taxableAmount\": {\n \"amount\": 6930.94152604192,\n \"currency\": \"string\"\n },\n \"dutyPaid\": {\n \"amount\": 7424.58937256671,\n \"currency\": \"string\"\n },\n \"taxPaid\": {\n \"amount\": 517.0785273092271,\n \"currency\": \"string\"\n },\n \"totalTaxPaid\": {\n \"amount\": 3819.851145653883,\n \"currency\": \"string\"\n },\n \"details\": [\n {\n \"taxSubType\": \"string\",\n \"amount\": 5939.169288358672,\n \"currency\": \"string\"\n },\n {\n \"taxSubType\": \"string\",\n \"amount\": 2261.208831038615,\n \"currency\": \"string\"\n }\n ]\n }\n ],\n \"amount\": {\n \"amount\": 5348.17165713352,\n \"currency\": \"string\"\n },\n \"taxableAmount\": {\n \"amount\": 3384.9933559748592,\n \"currency\": \"string\"\n },\n \"dutyPaid\": {\n \"amount\": 3515.447983663773,\n \"currency\": \"string\"\n },\n \"taxPaid\": {\n \"amount\": 8496.602548921983,\n \"currency\": \"string\"\n },\n \"totalTaxPaid\": {\n \"amount\": 3450.5640581517728,\n \"currency\": \"string\"\n },\n \"details\": [\n {\n \"taxSubType\": \"string\",\n \"amount\": 4420.814468640267,\n \"currency\": \"string\"\n },\n {\n \"taxSubType\": \"string\",\n \"amount\": 4228.404586466776,\n \"currency\": \"string\"\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/variance", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "variance" ], "variable": [ { "key": "companyCode", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"documentId\": 404,\n \"documentCode\": \"string\",\n \"purchaseOrderNo\": \"string\",\n \"referenceNo\": \"string\",\n \"exchangeRate\": 1052.2944245422773,\n \"lines\": [\n {\n \"lineNo\": \"string\",\n \"hsCode\": \"string\",\n \"dutyRate\": 6148.545679854967,\n \"taxRate\": 7015.13305409641,\n \"amount\": {\n \"amount\": 754.3021906868885,\n \"currency\": \"string\"\n },\n \"taxableAmount\": {\n \"amount\": 8687.789020870212,\n \"currency\": \"string\"\n },\n \"dutyPaid\": {\n \"amount\": 9277.334877381501,\n \"currency\": \"string\"\n },\n \"taxPaid\": {\n \"amount\": 6299.780684991953,\n \"currency\": \"string\"\n },\n \"totalTaxPaid\": {\n \"amount\": 9358.694006121254,\n \"currency\": \"string\"\n },\n \"details\": [\n {\n \"taxSubType\": \"string\",\n \"amount\": 910.8361715530044,\n \"currency\": \"string\"\n },\n {\n \"taxSubType\": \"string\",\n \"amount\": 5924.397236317926,\n \"currency\": \"string\"\n }\n ]\n },\n {\n \"lineNo\": \"string\",\n \"hsCode\": \"string\",\n \"dutyRate\": 7213.609517611099,\n \"taxRate\": 8404.789660063325,\n \"amount\": {\n \"amount\": 6994.017559830987,\n \"currency\": \"string\"\n },\n \"taxableAmount\": {\n \"amount\": 8402.233888933757,\n \"currency\": \"string\"\n },\n \"dutyPaid\": {\n \"amount\": 2028.7955802934675,\n \"currency\": \"string\"\n },\n \"taxPaid\": {\n \"amount\": 8827.092235901728,\n \"currency\": \"string\"\n },\n \"totalTaxPaid\": {\n \"amount\": 2163.4952786943386,\n \"currency\": \"string\"\n },\n \"details\": [\n {\n \"taxSubType\": \"string\",\n \"amount\": 606.5206199393435,\n \"currency\": \"string\"\n },\n {\n \"taxSubType\": \"string\",\n \"amount\": 4513.184201430338,\n \"currency\": \"string\"\n }\n ]\n }\n ],\n \"amount\": {\n \"amount\": 6426.982424692951,\n \"currency\": \"string\"\n },\n \"taxableAmount\": {\n \"amount\": 6783.520333585929,\n \"currency\": \"string\"\n },\n \"dutyPaid\": {\n \"amount\": 6947.804936970583,\n \"currency\": \"string\"\n },\n \"taxPaid\": {\n \"amount\": 9463.239824313852,\n \"currency\": \"string\"\n },\n \"totalTaxPaid\": {\n \"amount\": 3556.751880188602,\n \"currency\": \"string\"\n },\n \"details\": [\n {\n \"taxSubType\": \"string\",\n \"amount\": 6501.686003229283,\n \"currency\": \"string\"\n },\n {\n \"taxSubType\": \"string\",\n \"amount\": 5049.424389482897,\n \"currency\": \"string\"\n }\n ]\n },\n {\n \"documentId\": 4519,\n \"documentCode\": \"string\",\n \"purchaseOrderNo\": \"string\",\n \"referenceNo\": \"string\",\n \"exchangeRate\": 3729.5395062458183,\n \"lines\": [\n {\n \"lineNo\": \"string\",\n \"hsCode\": \"string\",\n \"dutyRate\": 9782.987758164512,\n \"taxRate\": 9716.681604803773,\n \"amount\": {\n \"amount\": 9215.603888187294,\n \"currency\": \"string\"\n },\n \"taxableAmount\": {\n \"amount\": 5251.517196502944,\n \"currency\": \"string\"\n },\n \"dutyPaid\": {\n \"amount\": 2371.5557550916633,\n \"currency\": \"string\"\n },\n \"taxPaid\": {\n \"amount\": 1271.675104296699,\n \"currency\": \"string\"\n },\n \"totalTaxPaid\": {\n \"amount\": 9260.854718495397,\n \"currency\": \"string\"\n },\n \"details\": [\n {\n \"taxSubType\": \"string\",\n \"amount\": 8660.019396702743,\n \"currency\": \"string\"\n },\n {\n \"taxSubType\": \"string\",\n \"amount\": 9851.620716130667,\n \"currency\": \"string\"\n }\n ]\n },\n {\n \"lineNo\": \"string\",\n \"hsCode\": \"string\",\n \"dutyRate\": 2985.8191835559887,\n \"taxRate\": 7349.701401997812,\n \"amount\": {\n \"amount\": 3223.686505444241,\n \"currency\": \"string\"\n },\n \"taxableAmount\": {\n \"amount\": 6930.94152604192,\n \"currency\": \"string\"\n },\n \"dutyPaid\": {\n \"amount\": 7424.58937256671,\n \"currency\": \"string\"\n },\n \"taxPaid\": {\n \"amount\": 517.0785273092271,\n \"currency\": \"string\"\n },\n \"totalTaxPaid\": {\n \"amount\": 3819.851145653883,\n \"currency\": \"string\"\n },\n \"details\": [\n {\n \"taxSubType\": \"string\",\n \"amount\": 5939.169288358672,\n \"currency\": \"string\"\n },\n {\n \"taxSubType\": \"string\",\n \"amount\": 2261.208831038615,\n \"currency\": \"string\"\n }\n ]\n }\n ],\n \"amount\": {\n \"amount\": 5348.17165713352,\n \"currency\": \"string\"\n },\n \"taxableAmount\": {\n \"amount\": 3384.9933559748592,\n \"currency\": \"string\"\n },\n \"dutyPaid\": {\n \"amount\": 3515.447983663773,\n \"currency\": \"string\"\n },\n \"taxPaid\": {\n \"amount\": 8496.602548921983,\n \"currency\": \"string\"\n },\n \"totalTaxPaid\": {\n \"amount\": 3450.5640581517728,\n \"currency\": \"string\"\n },\n \"details\": [\n {\n \"taxSubType\": \"string\",\n \"amount\": 4420.814468640267,\n \"currency\": \"string\"\n },\n {\n \"taxSubType\": \"string\",\n \"amount\": 4228.404586466776,\n \"currency\": \"string\"\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/variance", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "variance" ], "variable": [ { "key": "companyCode", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"documentId\": 404,\n \"documentCode\": \"string\",\n \"purchaseOrderNo\": \"string\",\n \"referenceNo\": \"string\",\n \"exchangeRate\": 1052.2944245422773,\n \"lines\": [\n {\n \"lineNo\": \"string\",\n \"hsCode\": \"string\",\n \"dutyRate\": 6148.545679854967,\n \"taxRate\": 7015.13305409641,\n \"amount\": {\n \"amount\": 754.3021906868885,\n \"currency\": \"string\"\n },\n \"taxableAmount\": {\n \"amount\": 8687.789020870212,\n \"currency\": \"string\"\n },\n \"dutyPaid\": {\n \"amount\": 9277.334877381501,\n \"currency\": \"string\"\n },\n \"taxPaid\": {\n \"amount\": 6299.780684991953,\n \"currency\": \"string\"\n },\n \"totalTaxPaid\": {\n \"amount\": 9358.694006121254,\n \"currency\": \"string\"\n },\n \"details\": [\n {\n \"taxSubType\": \"string\",\n \"amount\": 910.8361715530044,\n \"currency\": \"string\"\n },\n {\n \"taxSubType\": \"string\",\n \"amount\": 5924.397236317926,\n \"currency\": \"string\"\n }\n ]\n },\n {\n \"lineNo\": \"string\",\n \"hsCode\": \"string\",\n \"dutyRate\": 7213.609517611099,\n \"taxRate\": 8404.789660063325,\n \"amount\": {\n \"amount\": 6994.017559830987,\n \"currency\": \"string\"\n },\n \"taxableAmount\": {\n \"amount\": 8402.233888933757,\n \"currency\": \"string\"\n },\n \"dutyPaid\": {\n \"amount\": 2028.7955802934675,\n \"currency\": \"string\"\n },\n \"taxPaid\": {\n \"amount\": 8827.092235901728,\n \"currency\": \"string\"\n },\n \"totalTaxPaid\": {\n \"amount\": 2163.4952786943386,\n \"currency\": \"string\"\n },\n \"details\": [\n {\n \"taxSubType\": \"string\",\n \"amount\": 606.5206199393435,\n \"currency\": \"string\"\n },\n {\n \"taxSubType\": \"string\",\n \"amount\": 4513.184201430338,\n \"currency\": \"string\"\n }\n ]\n }\n ],\n \"amount\": {\n \"amount\": 6426.982424692951,\n \"currency\": \"string\"\n },\n \"taxableAmount\": {\n \"amount\": 6783.520333585929,\n \"currency\": \"string\"\n },\n \"dutyPaid\": {\n \"amount\": 6947.804936970583,\n \"currency\": \"string\"\n },\n \"taxPaid\": {\n \"amount\": 9463.239824313852,\n \"currency\": \"string\"\n },\n \"totalTaxPaid\": {\n \"amount\": 3556.751880188602,\n \"currency\": \"string\"\n },\n \"details\": [\n {\n \"taxSubType\": \"string\",\n \"amount\": 6501.686003229283,\n \"currency\": \"string\"\n },\n {\n \"taxSubType\": \"string\",\n \"amount\": 5049.424389482897,\n \"currency\": \"string\"\n }\n ]\n },\n {\n \"documentId\": 4519,\n \"documentCode\": \"string\",\n \"purchaseOrderNo\": \"string\",\n \"referenceNo\": \"string\",\n \"exchangeRate\": 3729.5395062458183,\n \"lines\": [\n {\n \"lineNo\": \"string\",\n \"hsCode\": \"string\",\n \"dutyRate\": 9782.987758164512,\n \"taxRate\": 9716.681604803773,\n \"amount\": {\n \"amount\": 9215.603888187294,\n \"currency\": \"string\"\n },\n \"taxableAmount\": {\n \"amount\": 5251.517196502944,\n \"currency\": \"string\"\n },\n \"dutyPaid\": {\n \"amount\": 2371.5557550916633,\n \"currency\": \"string\"\n },\n \"taxPaid\": {\n \"amount\": 1271.675104296699,\n \"currency\": \"string\"\n },\n \"totalTaxPaid\": {\n \"amount\": 9260.854718495397,\n \"currency\": \"string\"\n },\n \"details\": [\n {\n \"taxSubType\": \"string\",\n \"amount\": 8660.019396702743,\n \"currency\": \"string\"\n },\n {\n \"taxSubType\": \"string\",\n \"amount\": 9851.620716130667,\n \"currency\": \"string\"\n }\n ]\n },\n {\n \"lineNo\": \"string\",\n \"hsCode\": \"string\",\n \"dutyRate\": 2985.8191835559887,\n \"taxRate\": 7349.701401997812,\n \"amount\": {\n \"amount\": 3223.686505444241,\n \"currency\": \"string\"\n },\n \"taxableAmount\": {\n \"amount\": 6930.94152604192,\n \"currency\": \"string\"\n },\n \"dutyPaid\": {\n \"amount\": 7424.58937256671,\n \"currency\": \"string\"\n },\n \"taxPaid\": {\n \"amount\": 517.0785273092271,\n \"currency\": \"string\"\n },\n \"totalTaxPaid\": {\n \"amount\": 3819.851145653883,\n \"currency\": \"string\"\n },\n \"details\": [\n {\n \"taxSubType\": \"string\",\n \"amount\": 5939.169288358672,\n \"currency\": \"string\"\n },\n {\n \"taxSubType\": \"string\",\n \"amount\": 2261.208831038615,\n \"currency\": \"string\"\n }\n ]\n }\n ],\n \"amount\": {\n \"amount\": 5348.17165713352,\n \"currency\": \"string\"\n },\n \"taxableAmount\": {\n \"amount\": 3384.9933559748592,\n \"currency\": \"string\"\n },\n \"dutyPaid\": {\n \"amount\": 3515.447983663773,\n \"currency\": \"string\"\n },\n \"taxPaid\": {\n \"amount\": 8496.602548921983,\n \"currency\": \"string\"\n },\n \"totalTaxPaid\": {\n \"amount\": 3450.5640581517728,\n \"currency\": \"string\"\n },\n \"details\": [\n {\n \"taxSubType\": \"string\",\n \"amount\": 4420.814468640267,\n \"currency\": \"string\"\n },\n {\n \"taxSubType\": \"string\",\n \"amount\": 4228.404586466776,\n \"currency\": \"string\"\n }\n ]\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/:companyCode/variance", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", ":companyCode", "variance" ], "variable": [ { "key": "companyCode", "value": "string" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "transactions", "item": [ { "name": "lines", "item": [ { "name": "add", "item": [ { "name": "Add lines to an existing unlocked transaction", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"companyCode\": \"DEFAULT\",\n \"transactionCode\": \"1234\",\n \"documentType\": \"SalesInvoice\",\n \"lines\": [\n {\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 100,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"renumber\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/transactions/lines/add?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", "transactions", "lines", "add" ], "query": [ { "key": "$include", "value": "string", "description": "Specifies objects to include in the response after transaction is created" } ] }, "description": " Add lines to an existing unlocked transaction.\r\n \r\n The `AddLines` API allows you to add additional transaction lines to existing transaction, so that customer will\r\n be able to append multiple calls together and form an extremely large transaction. If customer does not specify line number\r\n in the lines to be added, a new random Guid string will be generated for line number. If customer are not satisfied with\r\n the line number for the transaction lines, they can turn on the renumber switch to have REST v2 automatically renumber all\r\n transaction lines for them, in this case, the line number becomes: \"1\", \"2\", \"3\", ...\r\n \r\n A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\r\n sales, purchases, inventory transfer, and returns (also called refunds).\r\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:\r\n \r\n * Lines\r\n * Details (implies lines)\r\n* AccountPayableSalesTaxDetails (implies lines - only for Account Payable transaction)\r\n * Summary (implies details)\r\n * Addresses\r\n* SummaryOnly (omit lines and details - reduces API response size)\r\n* LinesOnly (omit details - reduces API response size)\r\n \r\n If you omit the `$include` parameter, the API will assume you want `Summary,Addresses`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"companyCode\": \"DEFAULT\",\n \"transactionCode\": \"1234\",\n \"documentType\": \"SalesInvoice\",\n \"lines\": [\n {\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 100,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"renumber\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/transactions/lines/add?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", "transactions", "lines", "add" ], "query": [ { "description": "Specifies objects to include in the response after transaction is created", "key": "$include", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 123456789,\n \"code\": \"ed92c353-a94c-4fe2-a32f-0d52f4f5ccf6\",\n \"companyId\": 12345,\n \"date\": \"2026-04-02\",\n \"status\": \"Committed\",\n \"type\": \"SalesInvoice\",\n \"currencyCode\": \"USD\",\n \"exchangeRateCurrencyCode\": \"USD\",\n \"entityUseCode\": \"\",\n \"customerVendorCode\": \"ABC\",\n \"customerCode\": \"ABC\",\n \"exemptNo\": \"\",\n \"reconciled\": true,\n \"locationCode\": \"DEFAULT\",\n \"salespersonCode\": \"DEF\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"totalAmount\": 1000,\n \"totalExempt\": 0,\n \"totalDiscount\": 0,\n \"totalTax\": 62.5,\n \"totalTaxable\": 1000,\n \"totalTaxCalculated\": 62.5,\n \"adjustmentReason\": \"NotAdjusted\",\n \"adjustmentDescription\": \"\",\n \"locked\": false,\n \"region\": \"CA\",\n \"country\": \"US\",\n \"version\": 0,\n \"originAddressId\": 123456789,\n \"destinationAddressId\": 123456789,\n \"exchangeRateEffectiveDate\": \"2026-04-02\",\n \"exchangeRate\": 2,\n \"isSellerImporterOfRecord\": false,\n \"description\": \"Yarn\",\n \"taxDate\": \"2026-04-02T00:00:00+00:00\",\n \"lines\": [\n {\n \"id\": 123456789,\n \"transactionId\": 123456789,\n \"lineNumber\": \"1\",\n \"boundaryOverrideId\": 0,\n \"entityUseCode\": \"\",\n \"description\": \"Yarn\",\n \"destinationAddressId\": 12345,\n \"originAddressId\": 123456789,\n \"discountAmount\": 100,\n \"discountTypeId\": 0,\n \"exemptAmount\": 0,\n \"exemptCertId\": 0,\n \"exemptNo\": \"\",\n \"isItemTaxable\": true,\n \"isSSTP\": false,\n \"itemCode\": \"116292\",\n \"lineAmount\": 1000,\n \"quantity\": 1,\n \"ref1\": \"Note: Deliver to Bob\",\n \"reportingDate\": \"2026-04-02\",\n \"revAccount\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxCalculated\": 62.5,\n \"taxCode\": \"PS081282\",\n \"taxDate\": \"2026-04-02\",\n \"taxEngine\": \"\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"taxIncluded\": false,\n \"details\": [\n {\n \"id\": 123456789,\n \"transactionLineId\": 123456789,\n \"transactionId\": 123456789,\n \"addressId\": 12345,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"stateFIPS\": \"06\",\n \"exemptAmount\": 0,\n \"exemptReasonId\": 4,\n \"exemptRuleId\": 0,\n \"inState\": false,\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"jurisdictionId\": 5000531,\n \"signatureCode\": \"AGAM\",\n \"stateAssignedNo\": \"\",\n \"jurisType\": \"STA\",\n \"nonTaxableAmount\": 0,\n \"nonTaxableRuleId\": 0,\n \"nonTaxableType\": \"BaseRule\",\n \"rate\": 0.0625,\n \"rateRuleId\": 1321915,\n \"rateSourceId\": 3,\n \"serCode\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxType\": \"Sales\",\n \"taxName\": \"CA STATE TAX\",\n \"taxAuthorityTypeId\": 45,\n \"taxRegionId\": 2127184,\n \"taxCalculated\": 62.5,\n \"taxOverride\": 0,\n \"rateType\": \"General\",\n \"taxableUnits\": 62.5,\n \"nonTaxableUnits\": 1000,\n \"exemptUnits\": 62.5,\n \"reportingTaxableUnits\": 125,\n \"reportingNonTaxableUnits\": 2000,\n \"reportingExemptUnits\": 125,\n \"reportingTax\": 125,\n \"reportingTaxCalculated\": 125,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0,\n \"vatCode\": \"\",\n \"granularDutyDetails\": [\n {\n \"dutyType\": \"ImportDuty\",\n \"rate\": \"10.5\",\n \"amount\": \"105.00\"\n }\n ]\n }\n ],\n \"vatNumberTypeId\": 0,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0\n }\n ],\n \"addresses\": [\n {\n \"id\": 0,\n \"transactionId\": 0,\n \"boundaryLevel\": \"Address\",\n \"line1\": \"100 Ravine Lane Northeast #220\",\n \"city\": \"Bainbridge Island\",\n \"region\": \"WA\",\n \"postalCode\": \"98110\",\n \"country\": \"US\",\n \"taxRegionId\": 0\n }\n ],\n \"taxDetailsByTaxType\": [\n {\n \"taxType\": \"SalesAndUse\",\n \"totalTaxable\": 100,\n \"totalExempt\": 0.05,\n \"totalNonTaxable\": 0,\n \"totalTax\": 0.625\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"companyCode\": \"DEFAULT\",\n \"transactionCode\": \"1234\",\n \"documentType\": \"SalesInvoice\",\n \"lines\": [\n {\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 100,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"renumber\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/transactions/lines/add?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", "transactions", "lines", "add" ], "query": [ { "description": "Specifies objects to include in the response after transaction is created", "key": "$include", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"companyCode\": \"DEFAULT\",\n \"transactionCode\": \"1234\",\n \"documentType\": \"SalesInvoice\",\n \"lines\": [\n {\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 100,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"renumber\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/transactions/lines/add?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", "transactions", "lines", "add" ], "query": [ { "description": "Specifies objects to include in the response after transaction is created", "key": "$include", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "delete", "item": [ { "name": "Remove lines from an existing unlocked transaction", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"companyCode\": \"DEFAULT\",\n \"transactionCode\": \"1234\",\n \"documentType\": \"SalesInvoice\",\n \"lines\": [\n \"1\"\n ],\n \"renumber\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/transactions/lines/delete?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", "transactions", "lines", "delete" ], "query": [ { "key": "$include", "value": "string", "description": "Specifies objects to include in the response after transaction is created" } ] }, "description": " Remove lines to an existing unlocked transaction.\r\n \r\n The `DeleteLines` API allows you to remove transaction lines from existing unlocked transaction, so that customer will\r\n be able to delete transaction lines and adjust original transaction the way they like\r\n \r\n A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\r\n sales, purchases, inventory transfer, and returns (also called refunds).\r\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:\r\n \r\n * Lines\r\n * Details (implies lines)\r\n* AccountPayableSalesTaxDetails (implies lines - only for Account Payable transaction)\r\n * Summary (implies details)\r\n * Addresses\r\n* SummaryOnly (omit lines and details - reduces API response size)\r\n* LinesOnly (omit details - reduces API response size)\r\n \r\n If you omit the `$include` parameter, the API will assume you want `Summary,Addresses`.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"companyCode\": \"DEFAULT\",\n \"transactionCode\": \"1234\",\n \"documentType\": \"SalesInvoice\",\n \"lines\": [\n \"1\"\n ],\n \"renumber\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/transactions/lines/delete?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", "transactions", "lines", "delete" ], "query": [ { "description": "Specifies objects to include in the response after transaction is created", "key": "$include", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 123456789,\n \"code\": \"ed92c353-a94c-4fe2-a32f-0d52f4f5ccf6\",\n \"companyId\": 12345,\n \"date\": \"2026-04-02\",\n \"status\": \"Committed\",\n \"type\": \"SalesInvoice\",\n \"currencyCode\": \"USD\",\n \"exchangeRateCurrencyCode\": \"USD\",\n \"entityUseCode\": \"\",\n \"customerVendorCode\": \"ABC\",\n \"customerCode\": \"ABC\",\n \"exemptNo\": \"\",\n \"reconciled\": true,\n \"locationCode\": \"DEFAULT\",\n \"salespersonCode\": \"DEF\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"totalAmount\": 1000,\n \"totalExempt\": 0,\n \"totalDiscount\": 0,\n \"totalTax\": 62.5,\n \"totalTaxable\": 1000,\n \"totalTaxCalculated\": 62.5,\n \"adjustmentReason\": \"NotAdjusted\",\n \"adjustmentDescription\": \"\",\n \"locked\": false,\n \"region\": \"CA\",\n \"country\": \"US\",\n \"version\": 0,\n \"originAddressId\": 123456789,\n \"destinationAddressId\": 123456789,\n \"exchangeRateEffectiveDate\": \"2026-04-02\",\n \"exchangeRate\": 2,\n \"isSellerImporterOfRecord\": false,\n \"description\": \"Yarn\",\n \"taxDate\": \"2026-04-02T00:00:00+00:00\",\n \"lines\": [\n {\n \"id\": 123456789,\n \"transactionId\": 123456789,\n \"lineNumber\": \"1\",\n \"boundaryOverrideId\": 0,\n \"entityUseCode\": \"\",\n \"description\": \"Yarn\",\n \"destinationAddressId\": 12345,\n \"originAddressId\": 123456789,\n \"discountAmount\": 100,\n \"discountTypeId\": 0,\n \"exemptAmount\": 0,\n \"exemptCertId\": 0,\n \"exemptNo\": \"\",\n \"isItemTaxable\": true,\n \"isSSTP\": false,\n \"itemCode\": \"116292\",\n \"lineAmount\": 1000,\n \"quantity\": 1,\n \"ref1\": \"Note: Deliver to Bob\",\n \"reportingDate\": \"2026-04-02\",\n \"revAccount\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxCalculated\": 62.5,\n \"taxCode\": \"PS081282\",\n \"taxDate\": \"2026-04-02\",\n \"taxEngine\": \"\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"taxIncluded\": false,\n \"details\": [\n {\n \"id\": 123456789,\n \"transactionLineId\": 123456789,\n \"transactionId\": 123456789,\n \"addressId\": 12345,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"stateFIPS\": \"06\",\n \"exemptAmount\": 0,\n \"exemptReasonId\": 4,\n \"exemptRuleId\": 0,\n \"inState\": false,\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"jurisdictionId\": 5000531,\n \"signatureCode\": \"AGAM\",\n \"stateAssignedNo\": \"\",\n \"jurisType\": \"STA\",\n \"nonTaxableAmount\": 0,\n \"nonTaxableRuleId\": 0,\n \"nonTaxableType\": \"BaseRule\",\n \"rate\": 0.0625,\n \"rateRuleId\": 1321915,\n \"rateSourceId\": 3,\n \"serCode\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxType\": \"Sales\",\n \"taxName\": \"CA STATE TAX\",\n \"taxAuthorityTypeId\": 45,\n \"taxRegionId\": 2127184,\n \"taxCalculated\": 62.5,\n \"taxOverride\": 0,\n \"rateType\": \"General\",\n \"taxableUnits\": 62.5,\n \"nonTaxableUnits\": 1000,\n \"exemptUnits\": 62.5,\n \"reportingTaxableUnits\": 125,\n \"reportingNonTaxableUnits\": 2000,\n \"reportingExemptUnits\": 125,\n \"reportingTax\": 125,\n \"reportingTaxCalculated\": 125,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0,\n \"vatCode\": \"\",\n \"granularDutyDetails\": [\n {\n \"dutyType\": \"ImportDuty\",\n \"rate\": \"10.5\",\n \"amount\": \"105.00\"\n }\n ]\n }\n ],\n \"vatNumberTypeId\": 0,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0\n }\n ],\n \"addresses\": [\n {\n \"id\": 0,\n \"transactionId\": 0,\n \"boundaryLevel\": \"Address\",\n \"line1\": \"100 Ravine Lane Northeast #220\",\n \"city\": \"Bainbridge Island\",\n \"region\": \"WA\",\n \"postalCode\": \"98110\",\n \"country\": \"US\",\n \"taxRegionId\": 0\n }\n ],\n \"taxDetailsByTaxType\": [\n {\n \"taxType\": \"SalesAndUse\",\n \"totalTaxable\": 100,\n \"totalExempt\": 0.05,\n \"totalNonTaxable\": 0,\n \"totalTax\": 0.625\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"companyCode\": \"DEFAULT\",\n \"transactionCode\": \"1234\",\n \"documentType\": \"SalesInvoice\",\n \"lines\": [\n \"1\"\n ],\n \"renumber\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/transactions/lines/delete?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", "transactions", "lines", "delete" ], "query": [ { "description": "Specifies objects to include in the response after transaction is created", "key": "$include", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"companyCode\": \"DEFAULT\",\n \"transactionCode\": \"1234\",\n \"documentType\": \"SalesInvoice\",\n \"lines\": [\n \"1\"\n ],\n \"renumber\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/transactions/lines/delete?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", "transactions", "lines", "delete" ], "query": [ { "description": "Specifies objects to include in the response after transaction is created", "key": "$include", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"companyCode\": \"DEFAULT\",\n \"transactionCode\": \"1234\",\n \"documentType\": \"SalesInvoice\",\n \"lines\": [\n \"1\"\n ],\n \"renumber\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies/transactions/lines/delete?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies", "transactions", "lines", "delete" ], "query": [ { "description": "Specifies objects to include in the response after transaction is created", "key": "$include", "value": "string" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] } ] }, { "name": "Retrieve all companies", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/companies?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies" ], "query": [ { "key": "$include", "value": "string", "description": "A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name." }, { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* IsFein, contacts, items, locations, nexus, settings, taxCodes, taxRules, upcs, nonReportingChildCompanies, exemptCerts, parameters, supplierandcustomers, isAdvSave, companyUrl, companyDescription" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Get multiple company objects.\r\n \r\nA `company` represents a single corporation or individual that is registered to handle transactional taxes.\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\r\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:\r\n \r\n* Contacts\r\n* Items\r\n* Locations\r\n* Nexus\r\n* Settings\r\n* TaxCodes\r\n* TaxRules\r\n* UPC\r\n* Parameters\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies" ], "query": [ { "description": "A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name.", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* IsFein, contacts, items, locations, nexus, settings, taxCodes, taxRules, upcs, nonReportingChildCompanies, exemptCerts, parameters, supplierandcustomers, isAdvSave, companyUrl, companyDescription", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 8988,\n \"value\": [\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"companyCode\": \"DEFAULT\",\n \"name\": \"Default Company\",\n \"isDefault\": false,\n \"isActive\": true,\n \"taxpayerIdNumber\": \"123456789\",\n \"isFein\": false,\n \"hasProfile\": true,\n \"isReportingEntity\": false,\n \"defaultCountry\": \"US\",\n \"baseCurrencyCode\": \"USD\",\n \"roundingLevelId\": \"Document\",\n \"isTest\": true,\n \"taxDependencyLevelId\": \"Document\",\n \"inProgress\": false,\n \"isDeleted\": false,\n \"isAdvSave\": false\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies" ], "query": [ { "description": "A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name.", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* IsFein, contacts, items, locations, nexus, settings, taxCodes, taxRules, upcs, nonReportingChildCompanies, exemptCerts, parameters, supplierandcustomers, isAdvSave, companyUrl, companyDescription", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies" ], "query": [ { "description": "A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name.", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* IsFein, contacts, items, locations, nexus, settings, taxCodes, taxRules, upcs, nonReportingChildCompanies, exemptCerts, parameters, supplierandcustomers, isAdvSave, companyUrl, companyDescription", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/companies?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies" ], "query": [ { "description": "A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name.", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* IsFein, contacts, items, locations, nexus, settings, taxCodes, taxRules, upcs, nonReportingChildCompanies, exemptCerts, parameters, supplierandcustomers, isAdvSave, companyUrl, companyDescription", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] }, { "name": "Create new companies", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"companyCode\": \"DEFAULT\",\n \"name\": \"Default Company\",\n \"isDefault\": false,\n \"isActive\": true,\n \"taxpayerIdNumber\": \"123456789\",\n \"isFein\": false,\n \"hasProfile\": true,\n \"isReportingEntity\": false,\n \"defaultCountry\": \"US\",\n \"baseCurrencyCode\": \"USD\",\n \"roundingLevelId\": \"Document\",\n \"isTest\": true,\n \"taxDependencyLevelId\": \"Document\",\n \"inProgress\": false,\n \"isDeleted\": false,\n \"isAdvSave\": false\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies" ] }, "description": "Create one or more new company objects.\r\nA 'company' represents a single corporation or individual that is registered to handle transactional taxes.\r\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.\r\n \r\nNOTE: Please do not use these blacklisted characters in company name and code: ';', '\\', '|'.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"companyCode\": \"DEFAULT\",\n \"name\": \"Default Company\",\n \"isDefault\": false,\n \"isActive\": true,\n \"taxpayerIdNumber\": \"123456789\",\n \"isFein\": false,\n \"hasProfile\": true,\n \"isReportingEntity\": false,\n \"defaultCountry\": \"US\",\n \"baseCurrencyCode\": \"USD\",\n \"roundingLevelId\": \"Document\",\n \"isTest\": true,\n \"taxDependencyLevelId\": \"Document\",\n \"inProgress\": false,\n \"isDeleted\": false,\n \"isAdvSave\": false\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"companyCode\": \"DEFAULT\",\n \"name\": \"Default Company\",\n \"isDefault\": false,\n \"isActive\": true,\n \"taxpayerIdNumber\": \"123456789\",\n \"isFein\": false,\n \"hasProfile\": true,\n \"isReportingEntity\": false,\n \"defaultCountry\": \"US\",\n \"baseCurrencyCode\": \"USD\",\n \"roundingLevelId\": \"Document\",\n \"isTest\": true,\n \"taxDependencyLevelId\": \"Document\",\n \"inProgress\": false,\n \"isDeleted\": false,\n \"isAdvSave\": false\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"companyCode\": \"DEFAULT\",\n \"name\": \"Default Company\",\n \"isDefault\": false,\n \"isActive\": true,\n \"taxpayerIdNumber\": \"123456789\",\n \"isFein\": false,\n \"hasProfile\": true,\n \"isReportingEntity\": false,\n \"defaultCountry\": \"US\",\n \"baseCurrencyCode\": \"USD\",\n \"roundingLevelId\": \"Document\",\n \"isTest\": true,\n \"taxDependencyLevelId\": \"Document\",\n \"inProgress\": false,\n \"isDeleted\": false,\n \"isAdvSave\": false\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"companyCode\": \"DEFAULT\",\n \"name\": \"Default Company\",\n \"isDefault\": false,\n \"isActive\": true,\n \"taxpayerIdNumber\": \"123456789\",\n \"isFein\": false,\n \"hasProfile\": true,\n \"isReportingEntity\": false,\n \"defaultCountry\": \"US\",\n \"baseCurrencyCode\": \"USD\",\n \"roundingLevelId\": \"Document\",\n \"isTest\": true,\n \"taxDependencyLevelId\": \"Document\",\n \"inProgress\": false,\n \"isDeleted\": false,\n \"isAdvSave\": false\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/companies", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "companies" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "avafileforms", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve a single AvaFileForm", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/avafileforms/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "avafileforms", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The primary key of this AvaFileForm" } ] }, "description": "Get the AvaFileForm object identified by this URL.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, FirmAdmin, FirmUser, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin.\n* This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/avafileforms/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "avafileforms", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The primary key of this AvaFileForm" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 2415,\n \"returnName\": \"CABOE401A2\",\n \"formName\": \"CA BOE 401 A2\",\n \"description\": \"State, Local, and District Sales and Use Tax Return\",\n \"effDate\": \"2005-04-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"formTypeId\": \"SalesAndUse\",\n \"filingOptionTypeId\": \"Paper\",\n \"dueDateTypeId\": \"ByDay\",\n \"dueDay\": 20,\n \"efileDueDateTypeId\": \"ByDay\",\n \"efileDueDay\": 20,\n \"efileDueTime\": \"1900-01-01T00:00:00\",\n \"hasVendorDiscount\": false,\n \"roundingTypeId\": \"None\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/avafileforms/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "avafileforms", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The primary key of this AvaFileForm" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/avafileforms/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "avafileforms", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The primary key of this AvaFileForm" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/avafileforms/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "avafileforms", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The primary key of this AvaFileForm" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Update a AvaFileForm", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 2415,\n \"returnName\": \"CABOE401A2\",\n \"formName\": \"CA BOE 401 A2\",\n \"description\": \"State, Local, and District Sales and Use Tax Return\",\n \"effDate\": \"2005-04-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"formTypeId\": \"SalesAndUse\",\n \"filingOptionTypeId\": \"Paper\",\n \"dueDateTypeId\": \"ByDay\",\n \"dueDay\": 20,\n \"efileDueDateTypeId\": \"ByDay\",\n \"efileDueDay\": 20,\n \"efileDueTime\": \"1900-01-01T00:00:00\",\n \"hasVendorDiscount\": false,\n \"roundingTypeId\": \"None\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/avafileforms/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "avafileforms", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the AvaFileForm you wish to update" } ] }, "description": "All data from the existing object will be replaced with data in the object you PUT.\r\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.\n\n### Security Policies\n\n* This API requires the user role Compliance Root User.\n* This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 2415,\n \"returnName\": \"CABOE401A2\",\n \"formName\": \"CA BOE 401 A2\",\n \"description\": \"State, Local, and District Sales and Use Tax Return\",\n \"effDate\": \"2005-04-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"formTypeId\": \"SalesAndUse\",\n \"filingOptionTypeId\": \"Paper\",\n \"dueDateTypeId\": \"ByDay\",\n \"dueDay\": 20,\n \"efileDueDateTypeId\": \"ByDay\",\n \"efileDueDay\": 20,\n \"efileDueTime\": \"1900-01-01T00:00:00\",\n \"hasVendorDiscount\": false,\n \"roundingTypeId\": \"None\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/avafileforms/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "avafileforms", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the AvaFileForm you wish to update" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 2415,\n \"returnName\": \"CABOE401A2\",\n \"formName\": \"CA BOE 401 A2\",\n \"description\": \"State, Local, and District Sales and Use Tax Return\",\n \"effDate\": \"2005-04-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"formTypeId\": \"SalesAndUse\",\n \"filingOptionTypeId\": \"Paper\",\n \"dueDateTypeId\": \"ByDay\",\n \"dueDay\": 20,\n \"efileDueDateTypeId\": \"ByDay\",\n \"efileDueDay\": 20,\n \"efileDueTime\": \"1900-01-01T00:00:00\",\n \"hasVendorDiscount\": false,\n \"roundingTypeId\": \"None\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 2415,\n \"returnName\": \"CABOE401A2\",\n \"formName\": \"CA BOE 401 A2\",\n \"description\": \"State, Local, and District Sales and Use Tax Return\",\n \"effDate\": \"2005-04-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"formTypeId\": \"SalesAndUse\",\n \"filingOptionTypeId\": \"Paper\",\n \"dueDateTypeId\": \"ByDay\",\n \"dueDay\": 20,\n \"efileDueDateTypeId\": \"ByDay\",\n \"efileDueDay\": 20,\n \"efileDueTime\": \"1900-01-01T00:00:00\",\n \"hasVendorDiscount\": false,\n \"roundingTypeId\": \"None\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/avafileforms/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "avafileforms", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the AvaFileForm you wish to update" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 2415,\n \"returnName\": \"CABOE401A2\",\n \"formName\": \"CA BOE 401 A2\",\n \"description\": \"State, Local, and District Sales and Use Tax Return\",\n \"effDate\": \"2005-04-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"formTypeId\": \"SalesAndUse\",\n \"filingOptionTypeId\": \"Paper\",\n \"dueDateTypeId\": \"ByDay\",\n \"dueDay\": 20,\n \"efileDueDateTypeId\": \"ByDay\",\n \"efileDueDay\": 20,\n \"efileDueTime\": \"1900-01-01T00:00:00\",\n \"hasVendorDiscount\": false,\n \"roundingTypeId\": \"None\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/avafileforms/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "avafileforms", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the AvaFileForm you wish to update" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 2415,\n \"returnName\": \"CABOE401A2\",\n \"formName\": \"CA BOE 401 A2\",\n \"description\": \"State, Local, and District Sales and Use Tax Return\",\n \"effDate\": \"2005-04-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"formTypeId\": \"SalesAndUse\",\n \"filingOptionTypeId\": \"Paper\",\n \"dueDateTypeId\": \"ByDay\",\n \"dueDay\": 20,\n \"efileDueDateTypeId\": \"ByDay\",\n \"efileDueDay\": 20,\n \"efileDueTime\": \"1900-01-01T00:00:00\",\n \"hasVendorDiscount\": false,\n \"roundingTypeId\": \"None\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/avafileforms/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "avafileforms", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the AvaFileForm you wish to update" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete a single AvaFileForm", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/avafileforms/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "avafileforms", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the AvaFileForm you wish to delete." } ] }, "description": "Marks the existing AvaFileForm object at this URL as deleted.\n\n### Security Policies\n\n* This API requires one of the following user roles: Compliance Root User, ComplianceUser, FirmAdmin.\n* This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/avafileforms/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "avafileforms", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the AvaFileForm you wish to delete." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/avafileforms/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "avafileforms", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the AvaFileForm you wish to delete." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/avafileforms/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "avafileforms", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the AvaFileForm you wish to delete." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/avafileforms/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "avafileforms", ":id" ], "variable": [ { "key": "id", "value": "451", "description": "The ID of the AvaFileForm you wish to delete." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Retrieve all AvaFileForms", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/avafileforms?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "avafileforms" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* outletTypeId" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, FirmAdmin, FirmUser, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin.\n* This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/avafileforms?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "avafileforms" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* outletTypeId", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 5506,\n \"value\": [\n {\n \"id\": 2415,\n \"returnName\": \"CABOE401A2\",\n \"formName\": \"CA BOE 401 A2\",\n \"description\": \"State, Local, and District Sales and Use Tax Return\",\n \"effDate\": \"2005-04-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"formTypeId\": \"SalesAndUse\",\n \"filingOptionTypeId\": \"Paper\",\n \"dueDateTypeId\": \"ByDay\",\n \"dueDay\": 20,\n \"efileDueDateTypeId\": \"ByDay\",\n \"efileDueDay\": 20,\n \"efileDueTime\": \"1900-01-01T00:00:00\",\n \"hasVendorDiscount\": false,\n \"roundingTypeId\": \"None\"\n },\n {\n \"id\": 2415,\n \"returnName\": \"CABOE401A2\",\n \"formName\": \"CA BOE 401 A2\",\n \"description\": \"State, Local, and District Sales and Use Tax Return\",\n \"effDate\": \"2005-04-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"formTypeId\": \"SalesAndUse\",\n \"filingOptionTypeId\": \"Paper\",\n \"dueDateTypeId\": \"ByDay\",\n \"dueDay\": 20,\n \"efileDueDateTypeId\": \"ByDay\",\n \"efileDueDay\": 20,\n \"efileDueTime\": \"1900-01-01T00:00:00\",\n \"hasVendorDiscount\": false,\n \"roundingTypeId\": \"None\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/avafileforms?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "avafileforms" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* outletTypeId", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/avafileforms?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "avafileforms" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* outletTypeId", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Create a new AvaFileForm", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 2415,\n \"returnName\": \"CABOE401A2\",\n \"formName\": \"CA BOE 401 A2\",\n \"description\": \"State, Local, and District Sales and Use Tax Return\",\n \"effDate\": \"2005-04-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"formTypeId\": \"SalesAndUse\",\n \"filingOptionTypeId\": \"Paper\",\n \"dueDateTypeId\": \"ByDay\",\n \"dueDay\": 20,\n \"efileDueDateTypeId\": \"ByDay\",\n \"efileDueDay\": 20,\n \"efileDueTime\": \"1900-01-01T00:00:00\",\n \"hasVendorDiscount\": false,\n \"roundingTypeId\": \"None\"\n },\n {\n \"id\": 2415,\n \"returnName\": \"CABOE401A2\",\n \"formName\": \"CA BOE 401 A2\",\n \"description\": \"State, Local, and District Sales and Use Tax Return\",\n \"effDate\": \"2005-04-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"formTypeId\": \"SalesAndUse\",\n \"filingOptionTypeId\": \"Paper\",\n \"dueDateTypeId\": \"ByDay\",\n \"dueDay\": 20,\n \"efileDueDateTypeId\": \"ByDay\",\n \"efileDueDay\": 20,\n \"efileDueTime\": \"1900-01-01T00:00:00\",\n \"hasVendorDiscount\": false,\n \"roundingTypeId\": \"None\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/avafileforms", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "avafileforms" ] }, "description": "Create one or more AvaFileForms\r\nA 'AvaFileForm' represents a form supported by our returns team\n\n### Security Policies\n\n* This API requires the user role Compliance Root User.\n* This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 2415,\n \"returnName\": \"CABOE401A2\",\n \"formName\": \"CA BOE 401 A2\",\n \"description\": \"State, Local, and District Sales and Use Tax Return\",\n \"effDate\": \"2005-04-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"formTypeId\": \"SalesAndUse\",\n \"filingOptionTypeId\": \"Paper\",\n \"dueDateTypeId\": \"ByDay\",\n \"dueDay\": 20,\n \"efileDueDateTypeId\": \"ByDay\",\n \"efileDueDay\": 20,\n \"efileDueTime\": \"1900-01-01T00:00:00\",\n \"hasVendorDiscount\": false,\n \"roundingTypeId\": \"None\"\n },\n {\n \"id\": 2415,\n \"returnName\": \"CABOE401A2\",\n \"formName\": \"CA BOE 401 A2\",\n \"description\": \"State, Local, and District Sales and Use Tax Return\",\n \"effDate\": \"2005-04-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"formTypeId\": \"SalesAndUse\",\n \"filingOptionTypeId\": \"Paper\",\n \"dueDateTypeId\": \"ByDay\",\n \"dueDay\": 20,\n \"efileDueDateTypeId\": \"ByDay\",\n \"efileDueDay\": 20,\n \"efileDueTime\": \"1900-01-01T00:00:00\",\n \"hasVendorDiscount\": false,\n \"roundingTypeId\": \"None\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/avafileforms", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "avafileforms" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": 2415,\n \"returnName\": \"CABOE401A2\",\n \"formName\": \"CA BOE 401 A2\",\n \"description\": \"State, Local, and District Sales and Use Tax Return\",\n \"effDate\": \"2005-04-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"formTypeId\": \"SalesAndUse\",\n \"filingOptionTypeId\": \"Paper\",\n \"dueDateTypeId\": \"ByDay\",\n \"dueDay\": 20,\n \"efileDueDateTypeId\": \"ByDay\",\n \"efileDueDay\": 20,\n \"efileDueTime\": \"1900-01-01T00:00:00\",\n \"hasVendorDiscount\": false,\n \"roundingTypeId\": \"None\"\n },\n {\n \"id\": 2415,\n \"returnName\": \"CABOE401A2\",\n \"formName\": \"CA BOE 401 A2\",\n \"description\": \"State, Local, and District Sales and Use Tax Return\",\n \"effDate\": \"2005-04-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"formTypeId\": \"SalesAndUse\",\n \"filingOptionTypeId\": \"Paper\",\n \"dueDateTypeId\": \"ByDay\",\n \"dueDay\": 20,\n \"efileDueDateTypeId\": \"ByDay\",\n \"efileDueDay\": 20,\n \"efileDueTime\": \"1900-01-01T00:00:00\",\n \"hasVendorDiscount\": false,\n \"roundingTypeId\": \"None\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 2415,\n \"returnName\": \"CABOE401A2\",\n \"formName\": \"CA BOE 401 A2\",\n \"description\": \"State, Local, and District Sales and Use Tax Return\",\n \"effDate\": \"2005-04-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"formTypeId\": \"SalesAndUse\",\n \"filingOptionTypeId\": \"Paper\",\n \"dueDateTypeId\": \"ByDay\",\n \"dueDay\": 20,\n \"efileDueDateTypeId\": \"ByDay\",\n \"efileDueDay\": 20,\n \"efileDueTime\": \"1900-01-01T00:00:00\",\n \"hasVendorDiscount\": false,\n \"roundingTypeId\": \"None\"\n },\n {\n \"id\": 2415,\n \"returnName\": \"CABOE401A2\",\n \"formName\": \"CA BOE 401 A2\",\n \"description\": \"State, Local, and District Sales and Use Tax Return\",\n \"effDate\": \"2005-04-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"formTypeId\": \"SalesAndUse\",\n \"filingOptionTypeId\": \"Paper\",\n \"dueDateTypeId\": \"ByDay\",\n \"dueDay\": 20,\n \"efileDueDateTypeId\": \"ByDay\",\n \"efileDueDay\": 20,\n \"efileDueTime\": \"1900-01-01T00:00:00\",\n \"hasVendorDiscount\": false,\n \"roundingTypeId\": \"None\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/avafileforms", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "avafileforms" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 2415,\n \"returnName\": \"CABOE401A2\",\n \"formName\": \"CA BOE 401 A2\",\n \"description\": \"State, Local, and District Sales and Use Tax Return\",\n \"effDate\": \"2005-04-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"formTypeId\": \"SalesAndUse\",\n \"filingOptionTypeId\": \"Paper\",\n \"dueDateTypeId\": \"ByDay\",\n \"dueDay\": 20,\n \"efileDueDateTypeId\": \"ByDay\",\n \"efileDueDay\": 20,\n \"efileDueTime\": \"1900-01-01T00:00:00\",\n \"hasVendorDiscount\": false,\n \"roundingTypeId\": \"None\"\n },\n {\n \"id\": 2415,\n \"returnName\": \"CABOE401A2\",\n \"formName\": \"CA BOE 401 A2\",\n \"description\": \"State, Local, and District Sales and Use Tax Return\",\n \"effDate\": \"2005-04-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"formTypeId\": \"SalesAndUse\",\n \"filingOptionTypeId\": \"Paper\",\n \"dueDateTypeId\": \"ByDay\",\n \"dueDay\": 20,\n \"efileDueDateTypeId\": \"ByDay\",\n \"efileDueDay\": 20,\n \"efileDueTime\": \"1900-01-01T00:00:00\",\n \"hasVendorDiscount\": false,\n \"roundingTypeId\": \"None\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/avafileforms", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "avafileforms" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "batches", "item": [ { "name": "Retrieve all batches", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/batches?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "batches" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* files" }, { "key": "$include", "value": "string", "description": "A comma separated list of additional data to retrieve." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Get multiple batch objects across all companies.\r\n \r\nA batch object is a large collection of API calls stored in a compact file.\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter;\r\nfull documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate results using the `$top`, `$skip`, and `$orderby` parameters.\r\n \r\nWhen a batch is created, it is added to the AvaTax Batch Queue and will be\r\nprocessed as quickly as possible in the order it was received. To check the\r\nstatus of a batch, fetch the batch and retrieve the results of the batch\r\noperation.\r\n \r\nBecause the batch system processes with a degree of concurrency, and\r\nbecause of batch sizes in the queue vary, AvaTax API is unable to accurately\r\npredict when a batch will complete. If high performance processing is\r\nrequired, please use the\r\n[CreateTransaction API](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/).\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/batches?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "batches" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* files", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 733,\n \"value\": [\n {\n \"type\": \"TransactionImport\",\n \"batchAgent\": \"manual\",\n \"name\": \"TestBatch\",\n \"files\": [\n {\n \"name\": \"samplebatch.csv\",\n \"content\": \"UHJvY2Vzc0NvZGUsRG9jQ29kZSxEb2NUeXBlLERvY0RhdGUsQ29tcGFueUNvZGUsQ3VzdG9tZXJDb2RlLEVudGl0eVVzZUNvZGUsTGluZU5vLFRheENvZGUsVGF4RGF0ZSxJdGVtQ29kZSxEZXNjcmlwdGlvbixRdHksQW1vdW50LERpc2NvdW50LFJlZjEsUmVmMixFeGVtcHRpb25ObyxSZXZBY2N0LERlc3RBZGRyZXNzLERlc3RDaXR5LERlc3RSZWdpb24sRGVzdFBvc3RhbENvZGUsRGVzdENvdW50cnksT3JpZ0FkZHJlc3MsT3JpZ0NpdHksT3JpZ1JlZ2lvbixPcmlnUG9zdGFsQ29kZSxPcmlnQ291bnRyeSxMb2NhdGlvbkNvZGUsU2FsZXNQZXJzb25Db2RlLFB1cmNoYXNlT3JkZXJObyxDdXJyZW5jeUNvZGUsRXhjaGFuZ2VSYXRlLEV4Y2hhbmdlUmF0ZUVmZkRhdGUsUGF5bWVudERhdGUsVGF4SW5jbHVkZWQsRGVzdFRheFJlZ2lvbixPcmlnVGF4UmVnaW9uLFRheGFibGUsVGF4VHlwZSxUb3RhbFRheCxDb3VudHJ5TmFtZSxDb3VudHJ5Q29kZSxDb3VudHJ5UmF0ZSxDb3VudHJ5VGF4LFN0YXRlTmFtZSxTdGF0ZUNvZGUsU3RhdGVSYXRlLFN0YXRlVGF4LENvdW50eU5hbWUsQ291bnR5Q29kZSxDb3VudHlSYXRlLENvdW50eVRheCxDaXR5TmFtZSxDaXR5Q29kZSxDaXR5UmF0ZSxDaXR5VGF4LE90aGVyMU5hbWUsT3RoZXIxQ29kZSxPdGhlcjFSYXRlLE90aGVyMVRheCxPdGhlcjJOYW1lLE90aGVyMkNvZGUsT3RoZXIyUmF0ZSxPdGhlcjJUYXgsT3RoZXIzTmFtZSxPdGhlcjNDb2RlLE90aGVyM1JhdGUsT3RoZXIzVGF4LE90aGVyNE5hbWUsT3RoZXI0Q29kZSxPdGhlcjRSYXRlLE90aGVyNFRheCxSZWZlcmVuY2VDb2RlLEJ1eWVyc1ZBVE5vLElzU2VsbGVySW1wb3J0ZXJPZlJlY29yZCxCUkJ1eWVyVHlwZSxCUkJ1eWVyX0lzRXhlbXB0T3JDYW5ub3RXSF9JUlJGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX1BJU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NPRklOU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NTTExSRixCUkJ1eWVyX0lzRXhlbXB0X1BJUyxCUkJ1eWVyX0lzRXhlbXB0X0NPRklOUyxCUkJ1eWVyX0lzRXhlbXB0X0NTTEwsSGVhZGVyX0Rlc2NyaXB0aW9uLEVtYWlsDQozLDlhYzI4MGMzLTNhNTUtNGEzNS1iZWQyLWE4M2RiNTNiMDUxZSwxLDEvMS8yMDE0LERFRkFVTFQsQ3VzdDEsLDEsLCwsLCwxMDAwLCwsLCwsMjM1IEUgNDJuZCBTdCAsTmV3IFlvcmssTlksMTAwMTctNTcwMyAgLFVTLDkwMCBXaW5zbG93IFdheSxCYWluYnJpZGdlIElzbGFuZCxXQSw5ODExMCxVUywsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwNCg==\",\n \"contentLength\": 0,\n \"contentType\": \"text/csv\",\n \"fileExtension\": \".csv\",\n \"filePath\": \"samplebatch.csv\"\n }\n ]\n },\n {\n \"type\": \"TransactionImport\",\n \"batchAgent\": \"manual\",\n \"name\": \"TestBatch\",\n \"files\": [\n {\n \"name\": \"samplebatch.csv\",\n \"content\": \"UHJvY2Vzc0NvZGUsRG9jQ29kZSxEb2NUeXBlLERvY0RhdGUsQ29tcGFueUNvZGUsQ3VzdG9tZXJDb2RlLEVudGl0eVVzZUNvZGUsTGluZU5vLFRheENvZGUsVGF4RGF0ZSxJdGVtQ29kZSxEZXNjcmlwdGlvbixRdHksQW1vdW50LERpc2NvdW50LFJlZjEsUmVmMixFeGVtcHRpb25ObyxSZXZBY2N0LERlc3RBZGRyZXNzLERlc3RDaXR5LERlc3RSZWdpb24sRGVzdFBvc3RhbENvZGUsRGVzdENvdW50cnksT3JpZ0FkZHJlc3MsT3JpZ0NpdHksT3JpZ1JlZ2lvbixPcmlnUG9zdGFsQ29kZSxPcmlnQ291bnRyeSxMb2NhdGlvbkNvZGUsU2FsZXNQZXJzb25Db2RlLFB1cmNoYXNlT3JkZXJObyxDdXJyZW5jeUNvZGUsRXhjaGFuZ2VSYXRlLEV4Y2hhbmdlUmF0ZUVmZkRhdGUsUGF5bWVudERhdGUsVGF4SW5jbHVkZWQsRGVzdFRheFJlZ2lvbixPcmlnVGF4UmVnaW9uLFRheGFibGUsVGF4VHlwZSxUb3RhbFRheCxDb3VudHJ5TmFtZSxDb3VudHJ5Q29kZSxDb3VudHJ5UmF0ZSxDb3VudHJ5VGF4LFN0YXRlTmFtZSxTdGF0ZUNvZGUsU3RhdGVSYXRlLFN0YXRlVGF4LENvdW50eU5hbWUsQ291bnR5Q29kZSxDb3VudHlSYXRlLENvdW50eVRheCxDaXR5TmFtZSxDaXR5Q29kZSxDaXR5UmF0ZSxDaXR5VGF4LE90aGVyMU5hbWUsT3RoZXIxQ29kZSxPdGhlcjFSYXRlLE90aGVyMVRheCxPdGhlcjJOYW1lLE90aGVyMkNvZGUsT3RoZXIyUmF0ZSxPdGhlcjJUYXgsT3RoZXIzTmFtZSxPdGhlcjNDb2RlLE90aGVyM1JhdGUsT3RoZXIzVGF4LE90aGVyNE5hbWUsT3RoZXI0Q29kZSxPdGhlcjRSYXRlLE90aGVyNFRheCxSZWZlcmVuY2VDb2RlLEJ1eWVyc1ZBVE5vLElzU2VsbGVySW1wb3J0ZXJPZlJlY29yZCxCUkJ1eWVyVHlwZSxCUkJ1eWVyX0lzRXhlbXB0T3JDYW5ub3RXSF9JUlJGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX1BJU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NPRklOU1JGLEJSQnV5ZXJfSXNFeGVtcHRPckNhbm5vdFdIX0NTTExSRixCUkJ1eWVyX0lzRXhlbXB0X1BJUyxCUkJ1eWVyX0lzRXhlbXB0X0NPRklOUyxCUkJ1eWVyX0lzRXhlbXB0X0NTTEwsSGVhZGVyX0Rlc2NyaXB0aW9uLEVtYWlsDQozLDlhYzI4MGMzLTNhNTUtNGEzNS1iZWQyLWE4M2RiNTNiMDUxZSwxLDEvMS8yMDE0LERFRkFVTFQsQ3VzdDEsLDEsLCwsLCwxMDAwLCwsLCwsMjM1IEUgNDJuZCBTdCAsTmV3IFlvcmssTlksMTAwMTctNTcwMyAgLFVTLDkwMCBXaW5zbG93IFdheSxCYWluYnJpZGdlIElzbGFuZCxXQSw5ODExMCxVUywsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwsLCwNCg==\",\n \"contentLength\": 0,\n \"contentType\": \"text/csv\",\n \"fileExtension\": \".csv\",\n \"filePath\": \"samplebatch.csv\"\n }\n ]\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/batches?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "batches" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* files", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/batches?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "batches" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* files", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "compliance", "item": [ { "name": "jurisnames", "item": [ { "name": "{country}", "item": [ { "name": "{region}", "item": [ { "name": "Retrieve all unique jurisnames based on filter.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/compliance/jurisnames/:country/:region?effectiveDate=1998-02-12T20:23:10.405Z&endDate=1998-02-12T20:23:10.405Z&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "compliance", "jurisnames", ":country", ":region" ], "query": [ { "key": "effectiveDate", "value": "1998-02-12T20:23:10.405Z", "description": "Used to limit the jurisnames returned." }, { "key": "endDate", "value": "1998-02-12T20:23:10.405Z", "description": "Used to limit the jurisnames returned." }, { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/)." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "country", "value": "string", "description": "The two-character ISO-3166 code for the country." }, { "key": "region", "value": "string", "description": "The two or three character region code for the region." } ] }, "description": "\n\n### Security Policies\n\n* This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/compliance/jurisnames/:country/:region?effectiveDate=1998-02-12T20:23:10.405Z&endDate=1998-02-12T20:23:10.405Z&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "compliance", "jurisnames", ":country", ":region" ], "query": [ { "description": "Used to limit the jurisnames returned.", "key": "effectiveDate", "value": "1998-02-12T20:23:10.405Z" }, { "description": "Used to limit the jurisnames returned.", "key": "endDate", "value": "1998-02-12T20:23:10.405Z" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "country", "value": "string", "description": "The two-character ISO-3166 code for the country." }, { "key": "region", "value": "string", "description": "The two or three character region code for the region." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 9356,\n \"value\": [\n {\n \"jurisName\": \"TestJurisName\"\n },\n {\n \"jurisName\": \"TestJurisName\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/compliance/jurisnames/:country/:region?effectiveDate=1998-02-12T20:23:10.405Z&endDate=1998-02-12T20:23:10.405Z&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "compliance", "jurisnames", ":country", ":region" ], "query": [ { "description": "Used to limit the jurisnames returned.", "key": "effectiveDate", "value": "1998-02-12T20:23:10.405Z" }, { "description": "Used to limit the jurisnames returned.", "key": "endDate", "value": "1998-02-12T20:23:10.405Z" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "country", "value": "string", "description": "The two-character ISO-3166 code for the country." }, { "key": "region", "value": "string", "description": "The two or three character region code for the region." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/compliance/jurisnames/:country/:region?effectiveDate=1998-02-12T20:23:10.405Z&endDate=1998-02-12T20:23:10.405Z&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "compliance", "jurisnames", ":country", ":region" ], "query": [ { "description": "Used to limit the jurisnames returned.", "key": "effectiveDate", "value": "1998-02-12T20:23:10.405Z" }, { "description": "Used to limit the jurisnames returned.", "key": "endDate", "value": "1998-02-12T20:23:10.405Z" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "country", "value": "string", "description": "The two-character ISO-3166 code for the country." }, { "key": "region", "value": "string", "description": "The two or three character region code for the region." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] } ] }, { "name": "rateOptions", "item": [ { "name": "{country}", "item": [ { "name": "{region}", "item": [ { "name": "Retrieve all RateOptions.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/compliance/rateOptions/:country/:region?effectiveDate=1998-02-12T20:23:10.405Z&endDate=1998-02-12T20:23:10.405Z&aggregationOption=AggregateCityAndCounty&$top=451&$skip=451&$filter=string&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "compliance", "rateOptions", ":country", ":region" ], "query": [ { "key": "effectiveDate", "value": "1998-02-12T20:23:10.405Z", "description": "Used to limit the jurisdictions or rates returned." }, { "key": "endDate", "value": "1998-02-12T20:23:10.405Z", "description": "Used to limit the jurisdictions or rates returned." }, { "key": "aggregationOption", "value": "AggregateCityAndCounty", "description": "Aggregation method used." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxRegionId, taxTypeCodeName, taxSubTypeCode, taxSubTypeCodeName, rateTypeCodeName, componentRate, taxAuthorityId, cityName, countyName, effDate, endDate" }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "country", "value": "string", "description": "The two-character ISO-3166 code for the country." }, { "key": "region", "value": "string", "description": "The two or three character region code for the region." } ] }, "description": "This API is available by invitation only.\n\n### Security Policies\n\n* This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/compliance/rateOptions/:country/:region?effectiveDate=1998-02-12T20:23:10.405Z&endDate=1998-02-12T20:23:10.405Z&aggregationOption=AggregateCityAndCounty&$top=451&$skip=451&$filter=string&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "compliance", "rateOptions", ":country", ":region" ], "query": [ { "description": "Used to limit the jurisdictions or rates returned.", "key": "effectiveDate", "value": "1998-02-12T20:23:10.405Z" }, { "description": "Used to limit the jurisdictions or rates returned.", "key": "endDate", "value": "1998-02-12T20:23:10.405Z" }, { "description": "Aggregation method used.", "key": "aggregationOption", "value": "AggregateCityAndCounty" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxRegionId, taxTypeCodeName, taxSubTypeCode, taxSubTypeCodeName, rateTypeCodeName, componentRate, taxAuthorityId, cityName, countyName, effDate, endDate", "key": "$filter", "value": "string" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "country", "value": "string", "description": "The two-character ISO-3166 code for the country." }, { "key": "region", "value": "string", "description": "The two or three character region code for the region." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 2984,\n \"value\": [\n {\n \"jurisName\": \"ABBEVILLE\",\n \"groupCode\": \"9356\",\n \"taxRegionId\": 2052407,\n \"taxRegionName\": \"ABBEVILLE\",\n \"reportLevel\": \"CIT\",\n \"taxTypeCode\": \"C\",\n \"taxTypeCodeName\": \"ConsumerUse\",\n \"taxSubTypeCode\": \"C\",\n \"taxSubTypeCodeName\": \"ConsumerUse\",\n \"rateTypeCode\": \"AutomobileSales\",\n \"rateTypeCodeName\": \"Automobile Sales\",\n \"stackRate\": 0.005,\n \"componentRate\": 0.005,\n \"taxAuthorityId\": 273,\n \"effDate\": \"0001-01-01T00:00:00\",\n \"endDate\": \"0001-01-01T00:00:00\"\n },\n {\n \"jurisName\": \"ABBEVILLE\",\n \"groupCode\": \"9356\",\n \"taxRegionId\": 2052407,\n \"taxRegionName\": \"ABBEVILLE\",\n \"reportLevel\": \"CIT\",\n \"taxTypeCode\": \"C\",\n \"taxTypeCodeName\": \"ConsumerUse\",\n \"taxSubTypeCode\": \"C\",\n \"taxSubTypeCodeName\": \"ConsumerUse\",\n \"rateTypeCode\": \"AutomobileSales\",\n \"rateTypeCodeName\": \"Automobile Sales\",\n \"stackRate\": 0.005,\n \"componentRate\": 0.005,\n \"taxAuthorityId\": 273,\n \"effDate\": \"0001-01-01T00:00:00\",\n \"endDate\": \"0001-01-01T00:00:00\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/compliance/rateOptions/:country/:region?effectiveDate=1998-02-12T20:23:10.405Z&endDate=1998-02-12T20:23:10.405Z&aggregationOption=AggregateCityAndCounty&$top=451&$skip=451&$filter=string&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "compliance", "rateOptions", ":country", ":region" ], "query": [ { "description": "Used to limit the jurisdictions or rates returned.", "key": "effectiveDate", "value": "1998-02-12T20:23:10.405Z" }, { "description": "Used to limit the jurisdictions or rates returned.", "key": "endDate", "value": "1998-02-12T20:23:10.405Z" }, { "description": "Aggregation method used.", "key": "aggregationOption", "value": "AggregateCityAndCounty" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxRegionId, taxTypeCodeName, taxSubTypeCode, taxSubTypeCodeName, rateTypeCodeName, componentRate, taxAuthorityId, cityName, countyName, effDate, endDate", "key": "$filter", "value": "string" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "country", "value": "string", "description": "The two-character ISO-3166 code for the country." }, { "key": "region", "value": "string", "description": "The two or three character region code for the region." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/compliance/rateOptions/:country/:region?effectiveDate=1998-02-12T20:23:10.405Z&endDate=1998-02-12T20:23:10.405Z&aggregationOption=AggregateCityAndCounty&$top=451&$skip=451&$filter=string&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "compliance", "rateOptions", ":country", ":region" ], "query": [ { "description": "Used to limit the jurisdictions or rates returned.", "key": "effectiveDate", "value": "1998-02-12T20:23:10.405Z" }, { "description": "Used to limit the jurisdictions or rates returned.", "key": "endDate", "value": "1998-02-12T20:23:10.405Z" }, { "description": "Aggregation method used.", "key": "aggregationOption", "value": "AggregateCityAndCounty" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxRegionId, taxTypeCodeName, taxSubTypeCode, taxSubTypeCodeName, rateTypeCodeName, componentRate, taxAuthorityId, cityName, countyName, effDate, endDate", "key": "$filter", "value": "string" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "country", "value": "string", "description": "The two-character ISO-3166 code for the country." }, { "key": "region", "value": "string", "description": "The two or three character region code for the region." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] } ] }, { "name": "stateconfig", "item": [ { "name": "Retrieve StateConfig information", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/compliance/stateconfig?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "compliance", "stateconfig" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* effDate, endDate, hasBoundary, hasRates, isLocalAdmin, isLocalNexus, isSerState, minBoundaryLevelId, sstStatusId, state, stateFips, boundaryTableBaseName, stjCount, tsStateId, isJaasEnabled, hasSSTBoundary" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "This API is available by invitation only.\n\n### Security Policies\n\n* This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/compliance/stateconfig?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "compliance", "stateconfig" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* effDate, endDate, hasBoundary, hasRates, isLocalAdmin, isLocalNexus, isSerState, minBoundaryLevelId, sstStatusId, state, stateFips, boundaryTableBaseName, stjCount, tsStateId, isJaasEnabled, hasSSTBoundary", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 4247,\n \"value\": [\n {\n \"stateConfigId\": 1,\n \"effDate\": \"0001-01-01T00:00:00\",\n \"hasBoundary\": false,\n \"hasRates\": false,\n \"isLocalAdmin\": false,\n \"isSerState\": false,\n \"minBoundaryLevelId\": 0,\n \"sstStatusId\": 0,\n \"state\": \"AL\",\n \"stateName\": \"ALABAMA\",\n \"country\": \"US\",\n \"hasSSTBoundary\": false,\n \"modifiedDate\": \"0001-01-01T00:00:00\"\n },\n {\n \"stateConfigId\": 1,\n \"effDate\": \"0001-01-01T00:00:00\",\n \"hasBoundary\": false,\n \"hasRates\": false,\n \"isLocalAdmin\": false,\n \"isSerState\": false,\n \"minBoundaryLevelId\": 0,\n \"sstStatusId\": 0,\n \"state\": \"AL\",\n \"stateName\": \"ALABAMA\",\n \"country\": \"US\",\n \"hasSSTBoundary\": false,\n \"modifiedDate\": \"0001-01-01T00:00:00\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/compliance/stateconfig?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "compliance", "stateconfig" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* effDate, endDate, hasBoundary, hasRates, isLocalAdmin, isLocalNexus, isSerState, minBoundaryLevelId, sstStatusId, state, stateFips, boundaryTableBaseName, stjCount, tsStateId, isJaasEnabled, hasSSTBoundary", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/compliance/stateconfig?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "compliance", "stateconfig" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* effDate, endDate, hasBoundary, hasRates, isLocalAdmin, isLocalNexus, isSerState, minBoundaryLevelId, sstStatusId, state, stateFips, boundaryTableBaseName, stjCount, tsStateId, isJaasEnabled, hasSSTBoundary", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "stateReportingCodes", "item": [ { "name": "{country}", "item": [ { "name": "{region}", "item": [ { "name": "Retrieve all State Reporting Codes based on filter.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/compliance/stateReportingCodes/:country/:region?effectiveDate=1998-02-12T20:23:10.405Z&endDate=1998-02-12T20:23:10.405Z&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "compliance", "stateReportingCodes", ":country", ":region" ], "query": [ { "key": "effectiveDate", "value": "1998-02-12T20:23:10.405Z", "description": "Used to limit the StateReportingCodes or rates returned." }, { "key": "endDate", "value": "1998-02-12T20:23:10.405Z", "description": "Used to limit the StateReportingCodes or rates returned." }, { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* label" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "country", "value": "string", "description": "The two-character ISO-3166 code for the country." }, { "key": "region", "value": "string", "description": "The two or three character region code for the region." } ] }, "description": "\n\n### Security Policies\n\n* This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/compliance/stateReportingCodes/:country/:region?effectiveDate=1998-02-12T20:23:10.405Z&endDate=1998-02-12T20:23:10.405Z&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "compliance", "stateReportingCodes", ":country", ":region" ], "query": [ { "description": "Used to limit the StateReportingCodes or rates returned.", "key": "effectiveDate", "value": "1998-02-12T20:23:10.405Z" }, { "description": "Used to limit the StateReportingCodes or rates returned.", "key": "endDate", "value": "1998-02-12T20:23:10.405Z" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* label", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "country", "value": "string", "description": "The two-character ISO-3166 code for the country." }, { "key": "region", "value": "string", "description": "The two or three character region code for the region." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 4840,\n \"value\": [\n {\n \"stateAssignedCode\": \"TestValue\",\n \"label\": \"TestLable\",\n \"jurisName\": \"TestJurisName\"\n },\n {\n \"stateAssignedCode\": \"TestValue\",\n \"label\": \"TestLable\",\n \"jurisName\": \"TestJurisName\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/compliance/stateReportingCodes/:country/:region?effectiveDate=1998-02-12T20:23:10.405Z&endDate=1998-02-12T20:23:10.405Z&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "compliance", "stateReportingCodes", ":country", ":region" ], "query": [ { "description": "Used to limit the StateReportingCodes or rates returned.", "key": "effectiveDate", "value": "1998-02-12T20:23:10.405Z" }, { "description": "Used to limit the StateReportingCodes or rates returned.", "key": "endDate", "value": "1998-02-12T20:23:10.405Z" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* label", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "country", "value": "string", "description": "The two-character ISO-3166 code for the country." }, { "key": "region", "value": "string", "description": "The two or three character region code for the region." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/compliance/stateReportingCodes/:country/:region?effectiveDate=1998-02-12T20:23:10.405Z&endDate=1998-02-12T20:23:10.405Z&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "compliance", "stateReportingCodes", ":country", ":region" ], "query": [ { "description": "Used to limit the StateReportingCodes or rates returned.", "key": "effectiveDate", "value": "1998-02-12T20:23:10.405Z" }, { "description": "Used to limit the StateReportingCodes or rates returned.", "key": "endDate", "value": "1998-02-12T20:23:10.405Z" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* label", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "country", "value": "string", "description": "The two-character ISO-3166 code for the country." }, { "key": "region", "value": "string", "description": "The two or three character region code for the region." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] } ] }, { "name": "taxtypemappings", "item": [ { "name": "Retrieve all tax type mappings based on filter.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/compliance/taxtypemappings?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "compliance", "taxtypemappings" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxTypeGroupIdSK, taxTypeIdSK, taxSubTypeIdSK, generalOrStandardRateTypeIdSK, taxTypeGroupId, taxTypeId, country, generalOrStandardRateTypeId, isCustomContent" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "\n\n### Security Policies\n\n* This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/compliance/taxtypemappings?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "compliance", "taxtypemappings" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxTypeGroupIdSK, taxTypeIdSK, taxSubTypeIdSK, generalOrStandardRateTypeIdSK, taxTypeGroupId, taxTypeId, country, generalOrStandardRateTypeId, isCustomContent", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 8479,\n \"value\": [\n {\n \"taxTypeMappingId\": 12345,\n \"taxTypeGroupIdSK\": 1234,\n \"taxTypeIdSK\": 1234,\n \"taxSubTypeIdSK\": 123,\n \"generalOrStandardRateTypeIdSK\": 123,\n \"taxTypeGroupId\": \"T\",\n \"taxTypeId\": \"T\",\n \"taxSubTypeId\": \"T\",\n \"country\": \"US\",\n \"generalOrStandardRateTypeId\": \"G\"\n },\n {\n \"taxTypeMappingId\": 12345,\n \"taxTypeGroupIdSK\": 1234,\n \"taxTypeIdSK\": 1234,\n \"taxSubTypeIdSK\": 123,\n \"generalOrStandardRateTypeIdSK\": 123,\n \"taxTypeGroupId\": \"T\",\n \"taxTypeId\": \"T\",\n \"taxSubTypeId\": \"T\",\n \"country\": \"US\",\n \"generalOrStandardRateTypeId\": \"G\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/compliance/taxtypemappings?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "compliance", "taxtypemappings" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxTypeGroupIdSK, taxTypeIdSK, taxSubTypeIdSK, generalOrStandardRateTypeIdSK, taxTypeGroupId, taxTypeId, country, generalOrStandardRateTypeId, isCustomContent", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/compliance/taxtypemappings?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "compliance", "taxtypemappings" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxTypeGroupIdSK, taxTypeIdSK, taxSubTypeIdSK, generalOrStandardRateTypeIdSK, taxTypeGroupId, taxTypeId, country, generalOrStandardRateTypeId, isCustomContent", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "contacts", "item": [ { "name": "Retrieve all contacts", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/contacts?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "contacts" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* scsContactId" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Get multiple contact objects across all companies.\r\nA 'contact' is a person associated with a company who is designated to handle certain responsibilities of\r\na tax collecting and filing entity.\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/contacts?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "contacts" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* scsContactId", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 211,\n \"value\": [\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"contactCode\": \"TestContact9cc59ad213e545\",\n \"firstName\": \"Bob\",\n \"lastName\": \"McExample\",\n \"title\": \"Owner\",\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"email\": \"bob@example.org\",\n \"phone\": \"714 555-1212\"\n },\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"contactCode\": \"TestContact9cc59ad213e545\",\n \"firstName\": \"Bob\",\n \"lastName\": \"McExample\",\n \"title\": \"Owner\",\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"email\": \"bob@example.org\",\n \"phone\": \"714 555-1212\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/contacts?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "contacts" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* scsContactId", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/contacts?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "contacts" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* scsContactId", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "costcenters", "item": [ { "name": "Retrieve all cost centers", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/costcenters?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "costcenters" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* companyId, meta, defaultItem" }, { "key": "$include", "value": "string", "description": "A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Retrieves all cost centers available. You can apply filters to retrieve specific records." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/costcenters?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "costcenters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* companyId, meta, defaultItem", "key": "$filter", "value": "string" }, { "description": "A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 5599,\n \"value\": [\n {\n \"costCenterId\": 0,\n \"companyId\": 1,\n \"meta\": {\n \"createdDate\": \"0001-01-01\",\n \"modifiedDate\": \"0001-01-01\"\n },\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"costCenterCode\": \"CostCenter1\"\n },\n {\n \"costCenterId\": 0,\n \"companyId\": 1,\n \"meta\": {\n \"createdDate\": \"0001-01-01\",\n \"modifiedDate\": \"0001-01-01\"\n },\n \"entityUseCode\": \"G\",\n \"effectiveDate\": \"2026-04-02\",\n \"endDate\": \"2026-04-02\",\n \"defaultItem\": {\n \"identifier\": 0\n },\n \"costCenterCode\": \"CostCenter1\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/costcenters?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "costcenters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* companyId, meta, defaultItem", "key": "$filter", "value": "string" }, { "description": "A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/costcenters?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "costcenters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* companyId, meta, defaultItem", "key": "$filter", "value": "string" }, { "description": "A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/costcenters?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "costcenters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* companyId, meta, defaultItem", "key": "$filter", "value": "string" }, { "description": "A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/costcenters?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "costcenters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* companyId, meta, defaultItem", "key": "$filter", "value": "string" }, { "description": "A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Conflict", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/costcenters?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "costcenters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* companyId, meta, defaultItem", "key": "$filter", "value": "string" }, { "description": "A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" }, { "name": "Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/costcenters?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "costcenters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* companyId, meta, defaultItem", "key": "$filter", "value": "string" }, { "description": "A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"title\": \"string\",\n \"status\": \"string\",\n \"detail\": \"string\"\n}" } ] } ] }, { "name": "datasources", "item": [ { "name": "Retrieve all datasources", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/datasources?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "datasources" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* isEnabled, isSynced, isAuthorized, name, externalState" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Get multiple datasource objects across all companies.\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/datasources?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "datasources" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* isEnabled, isSynced, isAuthorized, name, externalState", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 1664,\n \"value\": [\n {\n \"id\": 1,\n \"companyId\": 12345,\n \"source\": \"Amazon v2 Extractor\",\n \"instance\": \"2713cc25-0bce-42f8-b443-68301aff1b66\",\n \"isEnabled\": false,\n \"isSynced\": false,\n \"isAuthorized\": false,\n \"createdUserId\": 123,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 12,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"name\": \"TestName\",\n \"externalState\": \"Test Path\"\n },\n {\n \"id\": 1,\n \"companyId\": 12345,\n \"source\": \"Amazon v2 Extractor\",\n \"instance\": \"2713cc25-0bce-42f8-b443-68301aff1b66\",\n \"isEnabled\": false,\n \"isSynced\": false,\n \"isAuthorized\": false,\n \"createdUserId\": 123,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 12,\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"name\": \"TestName\",\n \"externalState\": \"Test Path\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/datasources?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "datasources" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* isEnabled, isSynced, isAuthorized, name, externalState", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/datasources?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "datasources" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* isEnabled, isSynced, isAuthorized, name, externalState", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "definitions", "item": [ { "name": "accounts", "item": [ { "name": "{accountId}", "item": [ { "name": "parameters", "item": [ { "name": "Retrieve the list of Avalara-supported parameters based on account subscriptions.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/accounts/:accountId/parameters?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "accounts", ":accountId", "parameters" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* serviceTypes, regularExpression, attributeSubType, values" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account to retrieve the parameters." } ] }, "description": "Returns the list of Avalara-supported parameters based on account subscriptions." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/accounts/:accountId/parameters?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "accounts", ":accountId", "parameters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* serviceTypes, regularExpression, attributeSubType, values", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "accountId", "value": "451", "description": "The ID of the account to retrieve the parameters." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 4629,\n \"value\": [\n {\n \"id\": 12345,\n \"category\": \"Lodging\",\n \"name\": \"NumberOfNights\",\n \"dataType\": \"NumericMeasured\",\n \"helpText\": \"Please enter the number of nights the customer stayed in your lodging; whole numbers only.\",\n \"serviceTypes\": [\n \"AvaLodging\"\n ],\n \"prompt\": \"Lodging Number of Nights\",\n \"regularExpression\": \"\\\\d*\",\n \"label\": \"lodging\",\n \"helpUrl\": \"www.example.com/lodging\",\n \"isNeededForCalculation\": true,\n \"isNeededForReturns\": false,\n \"isNeededForClassification\": false\n },\n {\n \"id\": 12345,\n \"category\": \"Lodging\",\n \"name\": \"NumberOfNights\",\n \"dataType\": \"NumericMeasured\",\n \"helpText\": \"Please enter the number of nights the customer stayed in your lodging; whole numbers only.\",\n \"serviceTypes\": [\n \"AvaLodging\"\n ],\n \"prompt\": \"Lodging Number of Nights\",\n \"regularExpression\": \"\\\\d*\",\n \"label\": \"lodging\",\n \"helpUrl\": \"www.example.com/lodging\",\n \"isNeededForCalculation\": true,\n \"isNeededForReturns\": false,\n \"isNeededForClassification\": false\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] } ] } ] }, { "name": "avafileforms", "item": [ { "name": "Retrieve the full list of the AvaFile Forms available", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/avafileforms?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "avafileforms" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* outletTypeId" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "This API is deprecated.\r\n \r\nPlease use the ListTaxForms API.\r\n \r\nReturns the full list of Avalara-supported AvaFile Forms\r\nThis API is intended to be useful to identify all the different AvaFile Forms" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/avafileforms?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "avafileforms" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* outletTypeId", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 5506,\n \"value\": [\n {\n \"id\": 2415,\n \"returnName\": \"CABOE401A2\",\n \"formName\": \"CA BOE 401 A2\",\n \"description\": \"State, Local, and District Sales and Use Tax Return\",\n \"effDate\": \"2005-04-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"formTypeId\": \"SalesAndUse\",\n \"filingOptionTypeId\": \"Paper\",\n \"dueDateTypeId\": \"ByDay\",\n \"dueDay\": 20,\n \"efileDueDateTypeId\": \"ByDay\",\n \"efileDueDay\": 20,\n \"efileDueTime\": \"1900-01-01T00:00:00\",\n \"hasVendorDiscount\": false,\n \"roundingTypeId\": \"None\"\n },\n {\n \"id\": 2415,\n \"returnName\": \"CABOE401A2\",\n \"formName\": \"CA BOE 401 A2\",\n \"description\": \"State, Local, and District Sales and Use Tax Return\",\n \"effDate\": \"2005-04-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"formTypeId\": \"SalesAndUse\",\n \"filingOptionTypeId\": \"Paper\",\n \"dueDateTypeId\": \"ByDay\",\n \"dueDay\": 20,\n \"efileDueDateTypeId\": \"ByDay\",\n \"efileDueDay\": 20,\n \"efileDueTime\": \"1900-01-01T00:00:00\",\n \"hasVendorDiscount\": false,\n \"roundingTypeId\": \"None\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "certificateattributes", "item": [ { "name": "List certificate attributes used by a company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/certificateattributes?companyid=451&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "certificateattributes" ], "query": [ { "key": "companyid", "value": "451", "description": "Id of the company the user wish to fetch the certificates' attributes from. If not specified the API will use user's default company." }, { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/)." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "List the certificate attributes defined by a company either specified by the user or the user's default company.\r\n \r\nA certificate may have multiple attributes that control its behavior. You may apply or remove attributes to a\r\ncertificate at any time.\r\n \r\nIf you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to\r\ncheck and provision account." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/certificateattributes?companyid=451&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "certificateattributes" ], "query": [ { "description": "Id of the company the user wish to fetch the certificates' attributes from. If not specified the API will use user's default company.", "key": "companyid", "value": "451" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 8388,\n \"value\": [\n {\n \"id\": 0,\n \"name\": \"DIRECT PAY\",\n \"isSystemCode\": false\n },\n {\n \"id\": 0,\n \"name\": \"DIRECT PAY\",\n \"isSystemCode\": false\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "certificateexemptreasons", "item": [ { "name": "List the certificate exempt reasons defined by a company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/certificateexemptreasons?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "certificateexemptreasons" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/)." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "List the certificate exempt reasons defined by a company.\r\n \r\nAn exemption reason defines why a certificate allows a customer to be exempt\r\nfor purposes of tax calculation.\r\n \r\nIf you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to\r\ncheck and provision account." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/certificateexemptreasons?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "certificateexemptreasons" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 1965,\n \"value\": [\n {\n \"name\": \"EXPOSURE\"\n },\n {\n \"name\": \"EXPOSURE\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "certificateexposurezones", "item": [ { "name": "List certificate exposure zones used by a company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/certificateexposurezones?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "certificateexposurezones" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* id, companyId, name, tag, description, created, modified, region, country" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "List the certificate exposure zones defined by a company.\r\n \r\nAn exposure zone is a location where a certificate can be valid. Exposure zones may indicate a taxing\r\nauthority or other legal entity to which a certificate may apply.\r\n \r\nIf you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to\r\ncheck and provision account." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/certificateexposurezones?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "certificateexposurezones" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* id, companyId, name, tag, description, created, modified, region, country", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 6531,\n \"value\": [\n {\n \"name\": \"Washington\"\n },\n {\n \"name\": \"Washington\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "classification", "item": [ { "name": "parametersusage", "item": [ { "name": "Retrieve the full list of Avalara-supported usage of extra parameters for classification of a item.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/classification/parametersusage?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "classification", "parametersusage" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* attributeSubType, values" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Returns the full list of Avalara-supported usage of extra parameters for item classification.\r\nThe list of parameters is available for use with Item Classification.\r\nSome parameters are only available for use if you have subscribed to certain features of AvaTax." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/classification/parametersusage?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "classification", "parametersusage" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* attributeSubType, values", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 8075,\n \"value\": [\n {\n \"id\": 12345,\n \"parameterId\": 12345,\n \"taxTypeGroupId\": \"EWaste\",\n \"visibility\": \"Required\",\n \"attributeType\": \"Product\",\n \"name\": \"ScreenSize\",\n \"dataType\": \"NumericMeasured\",\n \"helpText\": \"A diagonal length measure of a rectangular screen along it's surface; indicative of it's total surface area.\",\n \"label\": \"Screen Size\",\n \"measurementType\": \"Length\"\n },\n {\n \"id\": 12345,\n \"parameterId\": 12345,\n \"taxTypeGroupId\": \"EWaste\",\n \"visibility\": \"Required\",\n \"attributeType\": \"Product\",\n \"name\": \"ScreenSize\",\n \"dataType\": \"NumericMeasured\",\n \"helpText\": \"A diagonal length measure of a rectangular screen along it's surface; indicative of it's total surface area.\",\n \"label\": \"Screen Size\",\n \"measurementType\": \"Length\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] } ] }, { "name": "communications", "item": [ { "name": "transactiontypes", "item": [ { "name": "{id}", "item": [ { "name": "servicetypes", "item": [ { "name": "Retrieve the full list of communications service types", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/communications/transactiontypes/:id/servicetypes?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "communications", "transactiontypes", ":id", "servicetypes" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* requiredParameters" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "id", "value": "451", "description": "The transaction type ID to examine" } ] }, "description": "Returns full list of service types for a given transaction type ID." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/communications/transactiontypes/:id/servicetypes?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "communications", "transactiontypes", ":id", "servicetypes" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* requiredParameters", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "id", "value": "451", "description": "The transaction type ID to examine" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 4163,\n \"value\": [\n {\n \"transactionTypeId\": 13,\n \"serviceTypeId\": 6,\n \"AvaTax.Communications.TransactionType\": \"Cellular\",\n \"AvaTax.Communications.ServiceType\": \"Access Charge\",\n \"description\": \"Basic monthly flat-rate charge for cellular/wireless service.\",\n \"requiredParameters\": [\n \"AvaTax.Communications.Charge\",\n \"AvaTax.Communications.Minutes\"\n ]\n },\n {\n \"transactionTypeId\": 13,\n \"serviceTypeId\": 6,\n \"AvaTax.Communications.TransactionType\": \"Cellular\",\n \"AvaTax.Communications.ServiceType\": \"Access Charge\",\n \"description\": \"Basic monthly flat-rate charge for cellular/wireless service.\",\n \"requiredParameters\": [\n \"AvaTax.Communications.Charge\",\n \"AvaTax.Communications.Minutes\"\n ]\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] } ] }, { "name": "Retrieve the full list of communications transactiontypes", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/communications/transactiontypes?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "communications", "transactiontypes" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/)." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Returns full list of communications transaction types which\r\nare accepted in communication tax calculation requests." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/communications/transactiontypes?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "communications", "transactiontypes" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 6144,\n \"value\": [\n {\n \"transactionTypeId\": 13,\n \"AvaTax.Communications.TransactionType\": \"Cellular\"\n },\n {\n \"transactionTypeId\": 13,\n \"AvaTax.Communications.TransactionType\": \"Cellular\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "tspairs", "item": [ { "name": "Retrieve the full list of communications transaction/service type pairs", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/communications/tspairs?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "communications", "tspairs" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* requiredParameters" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Returns full list of communications transaction/service type pairs which\r\nare accepted in communication tax calculation requests." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/communications/tspairs?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "communications", "tspairs" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* requiredParameters", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 4163,\n \"value\": [\n {\n \"transactionTypeId\": 13,\n \"serviceTypeId\": 6,\n \"AvaTax.Communications.TransactionType\": \"Cellular\",\n \"AvaTax.Communications.ServiceType\": \"Access Charge\",\n \"description\": \"Basic monthly flat-rate charge for cellular/wireless service.\",\n \"requiredParameters\": [\n \"AvaTax.Communications.Charge\",\n \"AvaTax.Communications.Minutes\"\n ]\n },\n {\n \"transactionTypeId\": 13,\n \"serviceTypeId\": 6,\n \"AvaTax.Communications.TransactionType\": \"Cellular\",\n \"AvaTax.Communications.ServiceType\": \"Access Charge\",\n \"description\": \"Basic monthly flat-rate charge for cellular/wireless service.\",\n \"requiredParameters\": [\n \"AvaTax.Communications.Charge\",\n \"AvaTax.Communications.Minutes\"\n ]\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] } ] }, { "name": "companies", "item": [ { "name": "{companyId}", "item": [ { "name": "countries", "item": [ { "name": "{country}", "item": [ { "name": "regions", "item": [ { "name": "taxtypes", "item": [ { "name": "{taxTypeId}", "item": [ { "name": "taxsubtypes", "item": [ { "name": "{taxSubTypeId}", "item": [ { "name": "rateTypeId", "item": [ { "name": "{rateTypeId}", "item": [ { "name": "jurisdictionTypeId", "item": [ { "name": "{jurisdictionTypeId}", "item": [ { "name": "Retrieve the list of applicable regions by country tax type, tax sub type, and rate type for a given JurisdictionTypeId", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/companies/:companyId/countries/:country/regions/taxtypes/:taxTypeId/taxsubtypes/:taxSubTypeId/rateTypeId/:rateTypeId/jurisdictionTypeId/:jurisdictionTypeId?$top=451&$skip=451&$orderBy=string&$scope=All", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "companies", ":companyId", "countries", ":country", "regions", "taxtypes", ":taxTypeId", "taxsubtypes", ":taxSubTypeId", "rateTypeId", ":rateTypeId", "jurisdictionTypeId", ":jurisdictionTypeId" ], "query": [ { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." }, { "key": "$scope", "value": "All", "description": "Optional query parameter to filter system, custom content or all regions (default: System)" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company for which you want to retrieve the applicable regions" }, { "key": "country", "value": "string", "description": "The country for which you want to retrieve the regions" }, { "key": "taxTypeId", "value": "string", "description": "The taxTypeId for which you want to retrieve the regions. Example values include Autimotive, tires, Lodging, S, U, I, O, All, etc. Run the \"/api/v2/definitions/taxtypes/countries/{country}?companyId=\" endpoint for a list of taxTypeId values." }, { "key": "taxSubTypeId", "value": "string", "description": "The taxSubType for which you want to retrieve the regions. Example values include Accommodations, BikeTax, IGST, S, U, All, etc. Run the \"api/v2/definitions/taxsubtypes\" endpoint for a list of taxSubTypes values." }, { "key": "rateTypeId", "value": "451", "description": "The rateTypeId for which you want to retrieve the regions.\r\n Note: The rateTypeId is an integer. Run the \"/api/v2/definitions/countries/{country}/taxtypes/{taxTypeId}/taxsubtypes/{taxSubTypeId}/ratetypes\" endpoint for a list of rateTypeId values.\"" }, { "key": "jurisdictionTypeId", "value": "string", "description": "The JurisdictionTypeId for which you want to retrieve the regions.\r\n This is a three-character string. Accepted values are ```CNT``` (country), ```STA``` (state), ```CTY``` (county), ```CIT``` (city), or ```STJ``` (special jurisdiction)." } ] }, "description": "Returns a list of all ISO 3166 region codes for a specific country code and their US English friendly names.\r\nThis API is intended to be used as a way to provide a dropdown box in your website to allow customers to select a region\r\nwithin the country for shipping addresses." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/companies/:companyId/countries/:country/regions/taxtypes/:taxTypeId/taxsubtypes/:taxSubTypeId/rateTypeId/:rateTypeId/jurisdictionTypeId/:jurisdictionTypeId?$top=451&$skip=451&$orderBy=string&$scope=All", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "companies", ":companyId", "countries", ":country", "regions", "taxtypes", ":taxTypeId", "taxsubtypes", ":taxSubTypeId", "rateTypeId", ":rateTypeId", "jurisdictionTypeId", ":jurisdictionTypeId" ], "query": [ { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" }, { "description": "Optional query parameter to filter system, custom content or all regions (default: System)", "key": "$scope", "value": "All" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID of the company for which you want to retrieve the applicable regions" }, { "key": "country", "value": "string", "description": "The country for which you want to retrieve the regions" }, { "key": "taxTypeId", "value": "string", "description": "The taxTypeId for which you want to retrieve the regions. Example values include Autimotive, tires, Lodging, S, U, I, O, All, etc. Run the \"/api/v2/definitions/taxtypes/countries/{country}?companyId=\" endpoint for a list of taxTypeId values." }, { "key": "taxSubTypeId", "value": "string", "description": "The taxSubType for which you want to retrieve the regions. Example values include Accommodations, BikeTax, IGST, S, U, All, etc. Run the \"api/v2/definitions/taxsubtypes\" endpoint for a list of taxSubTypes values." }, { "key": "rateTypeId", "value": "451", "description": "The rateTypeId for which you want to retrieve the regions.\r\n Note: The rateTypeId is an integer. Run the \"/api/v2/definitions/countries/{country}/taxtypes/{taxTypeId}/taxsubtypes/{taxSubTypeId}/ratetypes\" endpoint for a list of rateTypeId values.\"" }, { "key": "jurisdictionTypeId", "value": "string", "description": "The JurisdictionTypeId for which you want to retrieve the regions.\r\n This is a three-character string. Accepted values are ```CNT``` (country), ```STA``` (state), ```CTY``` (county), ```CIT``` (city), or ```STJ``` (special jurisdiction)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 1956,\n \"value\": [\n {\n \"countryCode\": \"US\",\n \"code\": \"CA\",\n \"name\": \"California\",\n \"classification\": \"State\"\n },\n {\n \"countryCode\": \"US\",\n \"code\": \"CA\",\n \"name\": \"California\",\n \"classification\": \"State\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] } ] } ] } ] } ] } ] } ] } ] } ] } ] } ] }, { "name": "items", "item": [ { "name": "{itemId}", "item": [ { "name": "parameters", "item": [ { "name": "Retrieve the parameters by companyId and itemId.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/companies/:companyId/items/:itemId/parameters?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "companies", ":companyId", "items", ":itemId", "parameters" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* serviceTypes, regularExpression, attributeSubType, values" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "companyId", "value": "451", "description": "Company Identifier." }, { "key": "itemId", "value": "155", "description": "Item Identifier." } ] }, "description": "Returns the list of parameters based on the company's service types and the item code.\r\nIgnores nexus if a service type is configured in the 'IgnoreNexusForServiceTypes' configuration section.\r\nIgnores nexus for the AvaAlcohol service type.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/companies/:companyId/items/:itemId/parameters?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "companies", ":companyId", "items", ":itemId", "parameters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* serviceTypes, regularExpression, attributeSubType, values", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "Company Identifier." }, { "key": "itemId", "value": "155", "description": "Item Identifier." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 4629,\n \"value\": [\n {\n \"id\": 12345,\n \"category\": \"Lodging\",\n \"name\": \"NumberOfNights\",\n \"dataType\": \"NumericMeasured\",\n \"helpText\": \"Please enter the number of nights the customer stayed in your lodging; whole numbers only.\",\n \"serviceTypes\": [\n \"AvaLodging\"\n ],\n \"prompt\": \"Lodging Number of Nights\",\n \"regularExpression\": \"\\\\d*\",\n \"label\": \"lodging\",\n \"helpUrl\": \"www.example.com/lodging\",\n \"isNeededForCalculation\": true,\n \"isNeededForReturns\": false,\n \"isNeededForClassification\": false\n },\n {\n \"id\": 12345,\n \"category\": \"Lodging\",\n \"name\": \"NumberOfNights\",\n \"dataType\": \"NumericMeasured\",\n \"helpText\": \"Please enter the number of nights the customer stayed in your lodging; whole numbers only.\",\n \"serviceTypes\": [\n \"AvaLodging\"\n ],\n \"prompt\": \"Lodging Number of Nights\",\n \"regularExpression\": \"\\\\d*\",\n \"label\": \"lodging\",\n \"helpUrl\": \"www.example.com/lodging\",\n \"isNeededForCalculation\": true,\n \"isNeededForReturns\": false,\n \"isNeededForClassification\": false\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] } ] } ] } ] } ] }, { "name": "countries", "item": [ { "name": "{country}", "item": [ { "name": "ratetypes", "item": [ { "name": "Retrieve the full list of rate types for each country", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/countries/:country/ratetypes?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "countries", ":country", "ratetypes" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* country" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "country", "value": "string", "description": "The country to examine for rate types" } ] }, "description": "Returns the full list of Avalara-supported rate type file types\r\nThis API is intended to be useful to identify all the different rate types." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/countries/:country/ratetypes?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "countries", ":country", "ratetypes" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* country", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "country", "value": "string", "description": "The country to examine for rate types" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 1088,\n \"value\": [\n {\n \"description\": \"test\",\n \"country\": \"US\"\n },\n {\n \"description\": \"test\",\n \"country\": \"US\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "regions", "item": [ { "name": "List all ISO 3166 regions for a country", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/countries/:country/regions?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "countries", ":country", "regions" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* localizedNames" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "country", "value": "string", "description": "The country of which you want to fetch ISO 3166 regions" } ] }, "description": "Returns a list of all ISO 3166 region codes for a specific country code, and their US English friendly names.\r\nThis API is intended to be useful when presenting a dropdown box in your website to allow customers to select a region\r\nwithin the country for a shipping addresses." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/countries/:country/regions?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "countries", ":country", "regions" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* localizedNames", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "country", "value": "string", "description": "The country of which you want to fetch ISO 3166 regions" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 1956,\n \"value\": [\n {\n \"countryCode\": \"US\",\n \"code\": \"CA\",\n \"name\": \"California\",\n \"classification\": \"State\"\n },\n {\n \"countryCode\": \"US\",\n \"code\": \"CA\",\n \"name\": \"California\",\n \"classification\": \"State\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "taxtypes", "item": [ { "name": "{taxTypeId}", "item": [ { "name": "taxsubtypes", "item": [ { "name": "{taxSubTypeId}", "item": [ { "name": "ratetypes", "item": [ { "name": "Retrieve the list of rate types by country, TaxType and by TaxSubType", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/countries/:country/taxtypes/:taxTypeId/taxsubtypes/:taxSubTypeId/ratetypes?$filter=string&$top=451&$skip=451&$orderBy=string&$includeCustomContent=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "countries", ":country", "taxtypes", ":taxTypeId", "taxsubtypes", ":taxSubTypeId", "ratetypes" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* id, rateType, description" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." }, { "key": "$includeCustomContent", "value": "false", "description": "Optional query parameter to include custom content rate types (default: false)" } ], "variable": [ { "key": "country", "value": "string", "description": "The country to examine for rate types" }, { "key": "taxTypeId", "value": "string", "description": "The taxType for the country to examine for rate types" }, { "key": "taxSubTypeId", "value": "string", "description": "The taxSubType for the country and taxType to examine for rate types" } ] }, "description": "Returns the list of Avalara-supported rate type file types\r\nThis API is intended to be useful to identify all the different rate types." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/countries/:country/taxtypes/:taxTypeId/taxsubtypes/:taxSubTypeId/ratetypes?$filter=string&$top=451&$skip=451&$orderBy=string&$includeCustomContent=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "countries", ":country", "taxtypes", ":taxTypeId", "taxsubtypes", ":taxSubTypeId", "ratetypes" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* id, rateType, description", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" }, { "description": "Optional query parameter to include custom content rate types (default: false)", "key": "$includeCustomContent", "value": "false" } ], "variable": [ { "key": "country", "value": "string", "description": "The country to examine for rate types" }, { "key": "taxTypeId", "value": "string", "description": "The taxType for the country to examine for rate types" }, { "key": "taxSubTypeId", "value": "string", "description": "The taxSubType for the country and taxType to examine for rate types" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 7763,\n \"value\": [\n {\n \"id\": 503,\n \"rateType\": \"Alcohol\",\n \"description\": \"Alcohol\"\n },\n {\n \"id\": 503,\n \"rateType\": \"Alcohol\",\n \"description\": \"Alcohol\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] } ] } ] } ] } ] } ] }, { "name": "List all ISO 3166 countries", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/countries?$filter=string&$top=451&$skip=451&$orderBy=string&$scope=All", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "countries" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* alpha3Code, isEuropeanUnion, localizedNames, addressesRequireRegion" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." }, { "key": "$scope", "value": "All", "description": "Optional query parameter to filter by Custom or All countries (default: All)" } ] }, "description": "Returns a list of ISO 3166 country codes based on the scope filter.\r\nThis API is intended to be useful when presenting a dropdown box in your website to allow customers to select a country for\r\na shipping address.\r\n \r\nScope options:\r\n- Custom: Return only countries for which there is a TaxTypeMapping with IsCustomContent = true (requires subscription)\r\n- All (default): Return all ISO 3166 countries" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/countries?$filter=string&$top=451&$skip=451&$orderBy=string&$scope=All", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "countries" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* alpha3Code, isEuropeanUnion, localizedNames, addressesRequireRegion", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" }, { "description": "Optional query parameter to filter by Custom or All countries (default: All)", "key": "$scope", "value": "All" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 6494,\n \"value\": [\n {\n \"code\": \"FR\",\n \"name\": \"France\",\n \"isEuropeanUnion\": true,\n \"addressesRequireRegion\": false\n },\n {\n \"code\": \"FR\",\n \"name\": \"France\",\n \"isEuropeanUnion\": true,\n \"addressesRequireRegion\": false\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "coverletters", "item": [ { "name": "List certificate exposure zones used by a company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/coverletters?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "coverletters" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* id, companyId, subject, description, createdDate, modifiedDate, pageCount, templateFilename, version" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "List available cover letters that can be used when sending invitation to use CertExpress to upload certificates.\r\n \r\nThe CoverLetter model represents a message sent along with an invitation to use CertExpress to\r\nupload certificates. An invitation allows customers to use CertExpress to upload their exemption\r\ncertificates directly; this cover letter explains why the invitation was sent.\r\n \r\nIf you see the 'CertCaptureNotConfiguredError', please use CheckProvision and RequestProvision endpoints to\r\ncheck and provision account." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/coverletters?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "coverletters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* id, companyId, subject, description, createdDate, modifiedDate, pageCount, templateFilename, version", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 8784,\n \"value\": [\n {\n \"title\": \"STANDARD_REQUEST\",\n \"subject\": \"Please submit your exemption certificate\",\n \"description\": \"Please upload your certificate to CertCapture\",\n \"createdDate\": \"0001-01-01T00:00:00\",\n \"modifiedDate\": \"0001-01-01T00:00:00\",\n \"version\": 0\n },\n {\n \"title\": \"STANDARD_REQUEST\",\n \"subject\": \"Please submit your exemption certificate\",\n \"description\": \"Please upload your certificate to CertCapture\",\n \"createdDate\": \"0001-01-01T00:00:00\",\n \"modifiedDate\": \"0001-01-01T00:00:00\",\n \"version\": 0\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "crossborder", "item": [ { "name": "{country}", "item": [ { "name": "{hsCode}", "item": [ { "name": "hierarchy", "item": [ { "name": "Lists all parents of an HS Code.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/crossborder/:country/:hsCode/hierarchy", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "crossborder", ":country", ":hsCode", "hierarchy" ], "variable": [ { "key": "country", "value": "string", "description": "The name or code of the destination country." }, { "key": "hsCode", "value": "string", "description": "The partial or full HS Code for which you would like to view all of the parents." } ] }, "description": "Retrieves the specified HS code and all of its parents, reflecting all sections, chapters, headings, and subheadings\r\n \r\na list of HS Codes that are the parents and information branches of the HS Code for the given\r\ndestination country, if lower detail is available.\r\n \r\nThis API will include information branches if applicable. These do not have HS Codes and cannot be referenced,\r\nbut can contain information relevant to deciding the correct HS Code.\r\n \r\nThis API is intended to be useful to review the descriptive hierarchy of an HS Code, which can be particularly helpful\r\nwhen HS Codes can have multiple levels of generic descriptions.\n\n### Security Policies\n\n* This API depends on the following active services:*Required* (all): AvaTaxGlobal.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/crossborder/:country/:hsCode/hierarchy", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "crossborder", ":country", ":hsCode", "hierarchy" ], "variable": [ { "key": "country", "value": "string", "description": "The name or code of the destination country." }, { "key": "hsCode", "value": "string", "description": "The partial or full HS Code for which you would like to view all of the parents." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 9541,\n \"value\": [\n {\n \"hsCode\": \"hsCode\",\n \"id\": 12345,\n \"parentHsCodeId\": 0,\n \"description\": \"HSCode\",\n \"system\": \"system\",\n \"destinationCountry\": \"US\"\n },\n {\n \"hsCode\": \"hsCode\",\n \"id\": 12345,\n \"parentHsCodeId\": 0,\n \"description\": \"HSCode\",\n \"system\": \"system\",\n \"destinationCountry\": \"US\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "Lists the next level of HS Codes given a destination country and HS Code prefix.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/crossborder/:country/:hsCode?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "crossborder", ":country", ":hsCode" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* hsCodeSource, system, destinationCountry, isDecisionNode, zeroPaddingCount, isSystemDefined, isTaxable, effDate, endDate, hsCodeSourceLength" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "country", "value": "string", "description": "The name or code of the destination country." }, { "key": "hsCode", "value": "string", "description": "The Section or partial HS Code for which you would like to view the next level of HS Code detail, if more detail is available." } ] }, "description": "Retrieves a list of HS Codes that are the children of the prefix for the given destination country, if\r\nadditional children are available.\r\n \r\nHS Code is interchangeable with \"tariff code\" and definitions are generally unique to a destination country.\r\nAn HS Code describes an item and its eligibility/rate for tariffs. HS Codes are organized by\r\nSection/Chapter/Heading/Subheading/Classification.\r\n \r\nThis API is intended to be useful to identify the correct HS Code to use for your item.\n\n### Security Policies\n\n* This API depends on the following active services:*Required* (all): AvaTaxGlobal.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/crossborder/:country/:hsCode?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "crossborder", ":country", ":hsCode" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* hsCodeSource, system, destinationCountry, isDecisionNode, zeroPaddingCount, isSystemDefined, isTaxable, effDate, endDate, hsCodeSourceLength", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "country", "value": "string", "description": "The name or code of the destination country." }, { "key": "hsCode", "value": "string", "description": "The Section or partial HS Code for which you would like to view the next level of HS Code detail, if more detail is available." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 9541,\n \"value\": [\n {\n \"hsCode\": \"hsCode\",\n \"id\": 12345,\n \"parentHsCodeId\": 0,\n \"description\": \"HSCode\",\n \"system\": \"system\",\n \"destinationCountry\": \"US\"\n },\n {\n \"hsCode\": \"hsCode\",\n \"id\": 12345,\n \"parentHsCodeId\": 0,\n \"description\": \"HSCode\",\n \"system\": \"system\",\n \"destinationCountry\": \"US\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] } ] }, { "name": "sections", "item": [ { "name": "List top level HS Code Sections.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/crossborder/sections", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "crossborder", "sections" ] }, "description": "Returns the full list of top level HS Code Sections. Sections are the broadest level of detail for\r\nclassifying tariff codes and the items to which they apply. HS Codes are organized\r\nby Section/Chapter/Heading/Subheading/Classification.\r\n \r\nThis API is intended to be useful to identify the top level Sections for\r\nfurther LandedCost HS Code lookups.\n\n### Security Policies\n\n* This API depends on the following active services:*Required* (all): AvaTaxGlobal.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/crossborder/sections", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "crossborder", "sections" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 9541,\n \"value\": [\n {\n \"hsCode\": \"hsCode\",\n \"id\": 12345,\n \"parentHsCodeId\": 0,\n \"description\": \"HSCode\",\n \"system\": \"system\",\n \"destinationCountry\": \"US\"\n },\n {\n \"hsCode\": \"hsCode\",\n \"id\": 12345,\n \"parentHsCodeId\": 0,\n \"description\": \"HSCode\",\n \"system\": \"system\",\n \"destinationCountry\": \"US\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] } ] }, { "name": "currencies", "item": [ { "name": "List all ISO 4217 currencies supported by AvaTax.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/currencies?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "currencies" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/)." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Lists all ISO 4217 currencies supported by AvaTax.\r\n \r\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\r\n`currencyCode` field in a `CreateTransactionModel`." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/currencies?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "currencies" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 2084,\n \"value\": [\n {\n \"code\": \"AED\",\n \"description\": \"UAE Dirham\",\n \"decimalDigits\": 2\n },\n {\n \"code\": \"AED\",\n \"description\": \"UAE Dirham\",\n \"decimalDigits\": 2\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "entityusecodes", "item": [ { "name": "Retrieve the full list of Avalara-supported entity use codes", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/entityusecodes?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "entityusecodes" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* validCountries" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Returns the full list of Avalara-supported entity use codes.\r\nEntity/Use Codes are definitions of the entity who is purchasing something, or the purpose for which the transaction\r\nis occurring. This information is generally used to determine taxability of the product.\r\nIn order to facilitate correct reporting of your taxes, you are encouraged to select the proper entity use codes for\r\nall transactions that are exempt." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/entityusecodes?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "entityusecodes" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* validCountries", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 3753,\n \"value\": [\n {\n \"code\": \"A\",\n \"name\": \"FEDERAL GOV\",\n \"description\": \"\",\n \"validCountries\": [\n \"US\"\n ]\n },\n {\n \"code\": \"A\",\n \"name\": \"FEDERAL GOV\",\n \"description\": \"\",\n \"validCountries\": [\n \"US\"\n ]\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "filingcalendars", "item": [ { "name": "loginverifiers", "item": [ { "name": "{form}", "item": [ { "name": "Test whether a form supports online login verification", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/filingcalendars/loginverifiers/:form?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "filingcalendars", "loginverifiers", ":form" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxFormCodes, scraperType, expectedResponseTime, requiredFilingCalendarDataFields" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "form", "value": "string", "description": "The name of the form you would like to verify. This is the tax form code" } ] }, "description": "This API is intended to be useful to identify whether the user should be allowed\r\nto automatically verify their login and password. This API will provide a result only if the form supports automatic online login verification." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/filingcalendars/loginverifiers/:form?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "filingcalendars", "loginverifiers", ":form" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxFormCodes, scraperType, expectedResponseTime, requiredFilingCalendarDataFields", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "form", "value": "string", "description": "The name of the form you would like to verify. This is the tax form code" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 8823,\n \"value\": [\n {\n \"name\": \"AL\",\n \"taxFormCodes\": [\n \"USAL21009501\"\n ],\n \"country\": \"US\",\n \"scraperType\": \"Login\",\n \"isAvailable\": true,\n \"expectedResponseTime\": \"00:30:00\",\n \"message\": \"Message\",\n \"requiredFilingCalendarDataFields\": [\n {\n \"name\": \"RegistrationId\",\n \"description\": \"Id Used for Registration\"\n }\n ]\n },\n {\n \"name\": \"AL\",\n \"taxFormCodes\": [\n \"USAL21009501\"\n ],\n \"country\": \"US\",\n \"scraperType\": \"Login\",\n \"isAvailable\": true,\n \"expectedResponseTime\": \"00:30:00\",\n \"message\": \"Message\",\n \"requiredFilingCalendarDataFields\": [\n {\n \"name\": \"RegistrationId\",\n \"description\": \"Id Used for Registration\"\n }\n ]\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "List all forms where logins can be verified automatically", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/filingcalendars/loginverifiers?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "filingcalendars", "loginverifiers" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxFormCodes, scraperType, expectedResponseTime, requiredFilingCalendarDataFields" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "List all forms where logins can be verified automatically.\r\nThis API is intended to be useful to identify whether the user should be allowed\r\nto automatically verify their login and password." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/filingcalendars/loginverifiers?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "filingcalendars", "loginverifiers" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxFormCodes, scraperType, expectedResponseTime, requiredFilingCalendarDataFields", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 8823,\n \"value\": [\n {\n \"name\": \"AL\",\n \"taxFormCodes\": [\n \"USAL21009501\"\n ],\n \"country\": \"US\",\n \"scraperType\": \"Login\",\n \"isAvailable\": true,\n \"expectedResponseTime\": \"00:30:00\",\n \"message\": \"Message\",\n \"requiredFilingCalendarDataFields\": [\n {\n \"name\": \"RegistrationId\",\n \"description\": \"Id Used for Registration\"\n }\n ]\n },\n {\n \"name\": \"AL\",\n \"taxFormCodes\": [\n \"USAL21009501\"\n ],\n \"country\": \"US\",\n \"scraperType\": \"Login\",\n \"isAvailable\": true,\n \"expectedResponseTime\": \"00:30:00\",\n \"message\": \"Message\",\n \"requiredFilingCalendarDataFields\": [\n {\n \"name\": \"RegistrationId\",\n \"description\": \"Id Used for Registration\"\n }\n ]\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] } ] }, { "name": "filingfrequencies", "item": [ { "name": "Retrieve the full list of Avalara-supported filing frequencies.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/filingfrequencies?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "filingfrequencies" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/)." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Returns the full list of Avalara-supported filing frequencies.\r\nThis API is intended to be useful to identify all the different filing frequencies that can be used in notices." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/filingfrequencies?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "filingfrequencies" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 3224,\n \"value\": [\n {\n \"id\": 1,\n \"description\": \"Monthly\"\n },\n {\n \"id\": 1,\n \"description\": \"Monthly\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "items", "item": [ { "name": "hscode-classification-status", "item": [ { "name": "List of all HS code classification statuses that can be assigned to an Item.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/items/hscode-classification-status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "items", "hscode-classification-status" ] }, "description": "\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/items/hscode-classification-status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "items", "hscode-classification-status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"name\": \"ClassificationInProgress\",\n \"description\": \"Classification In Progress.\"\n },\n {\n \"name\": \"ClassificationInProgress\",\n \"description\": \"Classification In Progress.\"\n }\n]" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/items/hscode-classification-status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "items", "hscode-classification-status" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/items/hscode-classification-status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "items", "hscode-classification-status" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "recommendationstatus", "item": [ { "name": "List of all recommendation status which can be assigned to an item", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/items/recommendationstatus", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "items", "recommendationstatus" ] }, "description": "\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/items/recommendationstatus", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "items", "recommendationstatus" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"name\": \"RecommendationInProgress\",\n \"description\": \"\"\n },\n {\n \"name\": \"RecommendationInProgress\",\n \"description\": \"\"\n }\n]" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/items/recommendationstatus", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "items", "recommendationstatus" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/items/recommendationstatus", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "items", "recommendationstatus" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "status", "item": [ { "name": "List of all possible status which can be assigned to an item", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/items/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "items", "status" ] }, "description": "\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/items/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "items", "status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"name\": \"MissingItemDetails\",\n \"description\": \"\"\n },\n {\n \"name\": \"MissingItemDetails\",\n \"description\": \"\"\n }\n]" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/items/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "items", "status" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/items/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "items", "status" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "jurisdictions", "item": [ { "name": "countries", "item": [ { "name": "{country}", "item": [ { "name": "taxtypes", "item": [ { "name": "{taxTypeId}", "item": [ { "name": "taxsubtypes", "item": [ { "name": "{taxSubTypeId}", "item": [ { "name": "List jurisdictions based on the provided taxTypeId, taxSubTypeId, country, and rateTypeId", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/jurisdictions/countries/:country/taxtypes/:taxTypeId/taxsubtypes/:taxSubTypeId?rateTypeId=451®ion=string&$filter=string&$top=451&$skip=451&$orderBy=string&$includeCustomContent=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "jurisdictions", "countries", ":country", "taxtypes", ":taxTypeId", "taxsubtypes", ":taxSubTypeId" ], "query": [ { "key": "rateTypeId", "value": "451", "description": "The ratetype for which you want to retrieve the jurisdiction information" }, { "key": "region", "value": "string", "description": "The region for which you want to retrieve the jurisdiction information" }, { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* id, country, state, jurisdictionCode, longName, taxTypeId, taxSubTypeId, taxTypeGroupId, rateTypeId, stateFips" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." }, { "key": "$includeCustomContent", "value": "false", "description": "Optional query parameter to include custom content jurisdictions (default: false)" } ], "variable": [ { "key": "country", "value": "string", "description": "The country for which you want to retrieve the jurisdiction information" }, { "key": "taxTypeId", "value": "string", "description": "The taxtype for which you want to retrieve the jurisdiction information" }, { "key": "taxSubTypeId", "value": "string", "description": "The taxsubtype for which you want to retrieve the jurisdiction information" } ] }, "description": "Returns a list of all Avalara-supported taxing jurisdictions filtered by taxTypeId, taxSubTypeId, country, and rateTypeId.\r\n \r\nYou can optionally pass region as a query parameter to retrieve jurisdictions that are under that region.\r\n \r\nThis API allows you to examine all Avalara-supported jurisdictions. You can filter your search by supplying\r\nSQL-like query for fetching only the ones you concerned about. For example: effectiveDate > '2016-01-01'\r\n \r\nThe jurisdictionType, effectiveDate, and endDate are filterable fields available on the JurisdictionRateTypeTaxTypeMappingModels returned by this API." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/jurisdictions/countries/:country/taxtypes/:taxTypeId/taxsubtypes/:taxSubTypeId?rateTypeId=451®ion=string&$filter=string&$top=451&$skip=451&$orderBy=string&$includeCustomContent=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "jurisdictions", "countries", ":country", "taxtypes", ":taxTypeId", "taxsubtypes", ":taxSubTypeId" ], "query": [ { "description": "The ratetype for which you want to retrieve the jurisdiction information", "key": "rateTypeId", "value": "451" }, { "description": "The region for which you want to retrieve the jurisdiction information", "key": "region", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* id, country, state, jurisdictionCode, longName, taxTypeId, taxSubTypeId, taxTypeGroupId, rateTypeId, stateFips", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" }, { "description": "Optional query parameter to include custom content jurisdictions (default: false)", "key": "$includeCustomContent", "value": "false" } ], "variable": [ { "key": "country", "value": "string", "description": "The country for which you want to retrieve the jurisdiction information" }, { "key": "taxTypeId", "value": "string", "description": "The taxtype for which you want to retrieve the jurisdiction information" }, { "key": "taxSubTypeId", "value": "string", "description": "The taxsubtype for which you want to retrieve the jurisdiction information" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 4327,\n \"value\": [\n {\n \"id\": 0,\n \"country\": \"US\",\n \"state\": \"AL\",\n \"jurisdictionType\": \"STA\",\n \"jurisdictionCode\": \"01\",\n \"longName\": \"ALABAMA\",\n \"taxTypeId\": \"S\",\n \"taxSubTypeId\": \"S\",\n \"taxTypeGroupId\": \"SalesAndUse\",\n \"rateTypeId\": \"G\",\n \"effectiveDate\": \"2026-04-02T10:55:08.9958817+00:00\",\n \"endDate\": \"2027-04-02T10:55:08.9958822+00:00\"\n },\n {\n \"id\": 0,\n \"country\": \"US\",\n \"state\": \"AL\",\n \"jurisdictionType\": \"STA\",\n \"jurisdictionCode\": \"01\",\n \"longName\": \"ALABAMA\",\n \"taxTypeId\": \"S\",\n \"taxSubTypeId\": \"S\",\n \"taxTypeGroupId\": \"SalesAndUse\",\n \"rateTypeId\": \"G\",\n \"effectiveDate\": \"2026-04-02T10:55:08.9958817+00:00\",\n \"endDate\": \"2027-04-02T10:55:08.9958822+00:00\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] } ] } ] } ] } ] } ] }, { "name": "hierarchy", "item": [ { "name": "List jurisdictions hierarchy based on the filter provided", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/jurisdictions/hierarchy?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "jurisdictions", "hierarchy" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* parentId, nexus, rate, salesRate, signatureCode, useRate, isAcm, isSst, createDate, isLocalAdmin, taxAuthorityTypeId" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Returns a list of all Avalara-supported taxing jurisdictions hirearchy.\r\n \r\nThis API Lists the hierarchical relationship of jurisdictions for US states, identifying the cities and special taxing jurisdictions (STJs) for a given county within a state.\r\n \r\nThe rate, salesRate, and useRate fields are not available on the JurisdictionHirearchyModels returned by this API." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/jurisdictions/hierarchy?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "jurisdictions", "hierarchy" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* parentId, nexus, rate, salesRate, signatureCode, useRate, isAcm, isSst, createDate, isLocalAdmin, taxAuthorityTypeId", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 5725,\n \"value\": [\n {\n \"code\": \"53\",\n \"name\": \"WASHINGTON\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"parentId\": 1,\n \"nexus\": [\n {\n \"taxTypeGroupId\": \"Alcohol\",\n \"nexusTaxTypeGroupId\": \"Excise\",\n \"taxName\": \"Excise Tax\",\n \"taxableNexus\": true\n }\n ],\n \"rate\": 0.06,\n \"salesRate\": 0.06,\n \"region\": \"WA\",\n \"useRate\": 0.06,\n \"city\": \"string\",\n \"county\": \"string\",\n \"country\": \"string\",\n \"shortName\": \"string\",\n \"stateFips\": \"string\",\n \"countyFips\": \"string\",\n \"placeFips\": \"string\",\n \"id\": 5716,\n \"effectiveDate\": \"1974-09-19T00:55:00.128Z\",\n \"endDate\": \"2009-03-18T00:11:26.228Z\",\n \"isAcm\": true,\n \"isSst\": false,\n \"createDate\": \"1984-07-15T22:16:17.253Z\",\n \"isLocalAdmin\": false,\n \"modifiedDate\": \"0001-01-01T00:00:00\",\n \"taxAuthorityTypeId\": 7475\n },\n {\n \"code\": \"53\",\n \"name\": \"WASHINGTON\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"parentId\": 1,\n \"nexus\": [\n {\n \"taxTypeGroupId\": \"Alcohol\",\n \"nexusTaxTypeGroupId\": \"Excise\",\n \"taxName\": \"Excise Tax\",\n \"taxableNexus\": true\n }\n ],\n \"rate\": 0.06,\n \"salesRate\": 0.06,\n \"region\": \"WA\",\n \"useRate\": 0.06,\n \"city\": \"string\",\n \"county\": \"string\",\n \"country\": \"string\",\n \"shortName\": \"string\",\n \"stateFips\": \"string\",\n \"countyFips\": \"string\",\n \"placeFips\": \"string\",\n \"id\": 374,\n \"effectiveDate\": \"2004-09-09T12:37:23.830Z\",\n \"endDate\": \"1990-09-07T02:56:06.175Z\",\n \"isAcm\": false,\n \"isSst\": true,\n \"createDate\": \"1958-05-13T14:15:37.427Z\",\n \"isLocalAdmin\": false,\n \"modifiedDate\": \"0001-01-01T00:00:00\",\n \"taxAuthorityTypeId\": 6594\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "List jurisdictions based on the filter provided", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/jurisdictions?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "jurisdictions" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* rate, salesRate, signatureCode, useRate, isAcm, isSst, createDate, isLocalAdmin, taxAuthorityTypeId" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Returns a list of all Avalara-supported taxing jurisdictions.\r\n \r\nThis API allows you to examine all Avalara-supported jurisdictions. You can filter your search by supplying\r\nSQL-like query for fetching only the ones you concerned about. For example: effectiveDate > '2016-01-01'\r\n \r\nThe rate, salesRate, and useRate fields are not available on the JurisdictionModels returned by this API." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/jurisdictions?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "jurisdictions" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* rate, salesRate, signatureCode, useRate, isAcm, isSst, createDate, isLocalAdmin, taxAuthorityTypeId", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 1904,\n \"value\": [\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 8467.525732232156,\n \"salesRate\": 907.6770884498209,\n \"region\": \"AR\",\n \"useRate\": 9133.705821997219,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true,\n \"createDate\": \"1956-08-05T06:07:31.994Z\",\n \"isLocalAdmin\": true,\n \"modifiedDate\": \"0001-01-01T00:00:00\",\n \"taxAuthorityTypeId\": 9135\n },\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 833.3310426274587,\n \"salesRate\": 5804.209712355324,\n \"region\": \"AR\",\n \"useRate\": 5800.53735167042,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true,\n \"createDate\": \"1968-09-22T04:54:05.079Z\",\n \"isLocalAdmin\": false,\n \"modifiedDate\": \"0001-01-01T00:00:00\",\n \"taxAuthorityTypeId\": 8919\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "jurisdictionsnearaddress", "item": [ { "name": "List jurisdictions near a specific address", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/jurisdictionsnearaddress?line1=string&line2=string&line3=string&city=string®ion=&postalCode=string&country=s&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "jurisdictionsnearaddress" ], "query": [ { "key": "line1", "value": "string", "description": "The first address line portion of this address." }, { "key": "line2", "value": "string", "description": "The second address line portion of this address." }, { "key": "line3", "value": "string", "description": "The third address line portion of this address." }, { "key": "city", "value": "string", "description": "The city portion of this address." }, { "key": "region", "value": "", "description": "The region, state, or province code portion of this address." }, { "key": "postalCode", "value": "string", "description": "The postal code or zip code portion of this address." }, { "key": "country", "value": "s", "description": "The two-character ISO-3166 code of the country portion of this address." }, { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* country, Jurisdictions" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Returns a list of all Avalara-supported taxing jurisdictions that apply to this address.\r\n \r\nThis API allows you to identify which jurisdictions are nearby a specific address according to the best available geocoding information.\r\nIt is intended to allow you to create a \"Jurisdiction Override\", which allows an address to be configured as belonging to a nearby\r\njurisdiction in AvaTax.\r\n \r\nThe results of this API call can be passed to the `CreateJurisdictionOverride` API call." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/jurisdictionsnearaddress?line1=string&line2=string&line3=string&city=string®ion=&postalCode=string&country=s&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "jurisdictionsnearaddress" ], "query": [ { "description": "The first address line portion of this address.", "key": "line1", "value": "string" }, { "description": "The second address line portion of this address.", "key": "line2", "value": "string" }, { "description": "The third address line portion of this address.", "key": "line3", "value": "string" }, { "description": "The city portion of this address.", "key": "city", "value": "string" }, { "description": "The region, state, or province code portion of this address.", "key": "region", "value": "" }, { "description": "The postal code or zip code portion of this address.", "key": "postalCode", "value": "string" }, { "description": "The two-character ISO-3166 code of the country portion of this address.", "key": "country", "value": "s" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* country, Jurisdictions", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 4339,\n \"value\": [\n {\n \"description\": \"a test JO\",\n \"jurisdictions\": [\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 7434.001262750061,\n \"salesRate\": 157.10809959449844,\n \"region\": \"AR\",\n \"useRate\": 3116.1549977000714,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true,\n \"createDate\": \"2022-07-21T11:54:06.283Z\",\n \"isLocalAdmin\": false,\n \"modifiedDate\": \"0001-01-01T00:00:00\",\n \"taxAuthorityTypeId\": 1930\n },\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 6893.114877833215,\n \"salesRate\": 1388.7288213531801,\n \"region\": \"AR\",\n \"useRate\": 8819.808735847833,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true,\n \"createDate\": \"2015-03-31T01:57:48.787Z\",\n \"isLocalAdmin\": false,\n \"modifiedDate\": \"0001-01-01T00:00:00\",\n \"taxAuthorityTypeId\": 4031\n }\n ],\n \"postalCode\": \"92618\",\n \"region\": \"CA\",\n \"taxRegionId\": 0,\n \"id\": 0,\n \"accountId\": 0,\n \"line1\": \"5500 Irvine Center Dr\",\n \"city\": \"Irvine\",\n \"country\": \"US\",\n \"effectiveDate\": \"1975-09-07\",\n \"endDate\": \"1951-02-22\",\n \"createdDate\": \"1981-04-21T06:15:33.985Z\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2015-01-04T01:39:29.948Z\",\n \"modifiedUserId\": 0,\n \"boundaryLevel\": \"Address\",\n \"isDefault\": true\n },\n {\n \"description\": \"a test JO\",\n \"jurisdictions\": [\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 5103.872027961538,\n \"salesRate\": 9688.552832697666,\n \"region\": \"AR\",\n \"useRate\": 7145.500234004396,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true,\n \"createDate\": \"1952-12-06T04:55:22.594Z\",\n \"isLocalAdmin\": true,\n \"modifiedDate\": \"0001-01-01T00:00:00\",\n \"taxAuthorityTypeId\": 1053\n },\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 8997.610989995706,\n \"salesRate\": 6515.321052544796,\n \"region\": \"AR\",\n \"useRate\": 7832.759133100276,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true,\n \"createDate\": \"1968-08-11T15:23:10.914Z\",\n \"isLocalAdmin\": false,\n \"modifiedDate\": \"0001-01-01T00:00:00\",\n \"taxAuthorityTypeId\": 9463\n }\n ],\n \"postalCode\": \"92618\",\n \"region\": \"CA\",\n \"taxRegionId\": 0,\n \"id\": 0,\n \"accountId\": 0,\n \"line1\": \"5500 Irvine Center Dr\",\n \"city\": \"Irvine\",\n \"country\": \"US\",\n \"effectiveDate\": \"2007-08-28\",\n \"endDate\": \"1981-01-26\",\n \"createdDate\": \"1957-10-28T20:47:07.758Z\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2018-06-22T23:27:36.684Z\",\n \"modifiedUserId\": 0,\n \"boundaryLevel\": \"Address\",\n \"isDefault\": true\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "jurisdictionTypes", "item": [ { "name": "countries", "item": [ { "name": "{country}", "item": [ { "name": "taxtypes", "item": [ { "name": "{taxTypeId}", "item": [ { "name": "taxsubtypes", "item": [ { "name": "{taxSubTypeId}", "item": [ { "name": "List jurisdiction types based on the provided taxTypeId, taxSubTypeId, country, and rateTypeId", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/jurisdictionTypes/countries/:country/taxtypes/:taxTypeId/taxsubtypes/:taxSubTypeId?rateTypeId=string&$includeCustomContent=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "jurisdictionTypes", "countries", ":country", "taxtypes", ":taxTypeId", "taxsubtypes", ":taxSubTypeId" ], "query": [ { "key": "rateTypeId", "value": "string", "description": "The ratetype for which you want to retrieve the jurisdiction information" }, { "key": "$includeCustomContent", "value": "false", "description": "Optional query parameter to include custom content jurisdiction types (default: false)" } ], "variable": [ { "key": "country", "value": "string", "description": "The country for which you want to retrieve the jurisdiction information" }, { "key": "taxTypeId", "value": "string", "description": "The taxtype for which you want to retrieve the jurisdiction information" }, { "key": "taxSubTypeId", "value": "string", "description": "The taxsubtype for which you want to retrieve the jurisdiction information" } ] }, "description": "Returns a list of all applicable jurisdiction types based on country, taxTypeId, taxSubTypeId, and rateTypeId" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/jurisdictionTypes/countries/:country/taxtypes/:taxTypeId/taxsubtypes/:taxSubTypeId?rateTypeId=string&$includeCustomContent=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "jurisdictionTypes", "countries", ":country", "taxtypes", ":taxTypeId", "taxsubtypes", ":taxSubTypeId" ], "query": [ { "description": "The ratetype for which you want to retrieve the jurisdiction information", "key": "rateTypeId", "value": "string" }, { "description": "Optional query parameter to include custom content jurisdiction types (default: false)", "key": "$includeCustomContent", "value": "false" } ], "variable": [ { "key": "country", "value": "string", "description": "The country for which you want to retrieve the jurisdiction information" }, { "key": "taxTypeId", "value": "string", "description": "The taxtype for which you want to retrieve the jurisdiction information" }, { "key": "taxSubTypeId", "value": "string", "description": "The taxsubtype for which you want to retrieve the jurisdiction information" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n \"string\",\n \"string\"\n]" } ] } ] } ] } ] } ] } ] } ] } ] }, { "name": "listallmarketplacelocations", "item": [ { "name": "List all market place locations.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/listallmarketplacelocations?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "listallmarketplacelocations" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/)." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "List all market place locations." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/listallmarketplacelocations?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "listallmarketplacelocations" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 9717,\n \"value\": [\n {\n \"marketplaceId\": \"a0n0b00000ODPh2AAH\",\n \"marketplace\": \"Amazon\"\n },\n {\n \"marketplaceId\": \"a0n0b00000ODPh2AAH\",\n \"marketplace\": \"Amazon\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/listallmarketplacelocations?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "listallmarketplacelocations" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/listallmarketplacelocations?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "listallmarketplacelocations" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "locationquestions", "item": [ { "name": "Retrieve the list of questions that are required for a tax location", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/locationquestions?line1=string&line2=string&line3=string&city=string®ion=string&postalCode=string&country=string&latitude=3917.886979867986&longitude=3917.886979867986&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "locationquestions" ], "query": [ { "key": "line1", "value": "string", "description": "The first line of this location's address." }, { "key": "line2", "value": "string", "description": "The second line of this location's address." }, { "key": "line3", "value": "string", "description": "The third line of this location's address." }, { "key": "city", "value": "string", "description": "The city part of this location's address." }, { "key": "region", "value": "string", "description": "The region, state, or province part of this location's address." }, { "key": "postalCode", "value": "string", "description": "The postal code of this location's address." }, { "key": "country", "value": "string", "description": "The country part of this location's address." }, { "key": "latitude", "value": "3917.886979867986", "description": "Optionally identify the location via latitude/longitude instead of via address." }, { "key": "longitude", "value": "3917.886979867986", "description": "Optionally identify the location via latitude/longitude instead of via address." }, { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/)." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Returns the list of additional questions you must answer when declaring a location in certain taxing jurisdictions.\r\nSome tax jurisdictions require that you register or provide additional information to configure each physical place where\r\nyour company does business.\r\nThis information is not usually required in order to calculate tax correctly, but is almost always required to file your tax correctly.\r\nYou can call this API call for any address and obtain information about what questions must be answered in order to properly\r\nfile tax in that location." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/locationquestions?line1=string&line2=string&line3=string&city=string®ion=string&postalCode=string&country=string&latitude=3917.886979867986&longitude=3917.886979867986&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "locationquestions" ], "query": [ { "description": "The first line of this location's address.", "key": "line1", "value": "string" }, { "description": "The second line of this location's address.", "key": "line2", "value": "string" }, { "description": "The third line of this location's address.", "key": "line3", "value": "string" }, { "description": "The city part of this location's address.", "key": "city", "value": "string" }, { "description": "The region, state, or province part of this location's address.", "key": "region", "value": "string" }, { "description": "The postal code of this location's address.", "key": "postalCode", "value": "string" }, { "description": "The country part of this location's address.", "key": "country", "value": "string" }, { "description": "Optionally identify the location via latitude/longitude instead of via address.", "key": "latitude", "value": "3917.886979867986" }, { "description": "Optionally identify the location via latitude/longitude instead of via address.", "key": "longitude", "value": "3917.886979867986" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 208,\n \"value\": [\n {\n \"description\": \"string\",\n \"id\": 1,\n \"question\": \"State Assigned Code\",\n \"regularExpression\": \"string\",\n \"exampleValue\": \"string\",\n \"jurisdictionName\": \"string\",\n \"jurisdictionType\": \"Country\",\n \"jurisdictionCountry\": \"string\",\n \"jurisdictionRegion\": \"string\",\n \"helpText\": \"string\",\n \"maxLength\": 9438,\n \"required\": false,\n \"dataType\": \"string\",\n \"staticOptions\": \"string\",\n \"unique\": false\n },\n {\n \"description\": \"string\",\n \"id\": 1,\n \"question\": \"State Assigned Code\",\n \"regularExpression\": \"string\",\n \"exampleValue\": \"string\",\n \"jurisdictionName\": \"string\",\n \"jurisdictionType\": \"Country\",\n \"jurisdictionCountry\": \"string\",\n \"jurisdictionRegion\": \"string\",\n \"helpText\": \"string\",\n \"maxLength\": 8898,\n \"required\": false,\n \"dataType\": \"string\",\n \"staticOptions\": \"string\",\n \"unique\": false\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "marketplacelocations", "item": [ { "name": "Retrieve the list of locations for a marketplace.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/marketplacelocations?marketplaceId=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "marketplacelocations" ], "query": [ { "key": "marketplaceId", "value": "string", "description": "MarketplaceId of a marketplace" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Retrieves the list of suggested locations for a marketplace." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/marketplacelocations?marketplaceId=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "marketplacelocations" ], "query": [ { "description": "MarketplaceId of a marketplace", "key": "marketplaceId", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 1149,\n \"value\": [\n {\n \"region\": \"AL\",\n \"country\": \"US\",\n \"marketplaceId\": \"a0n0b00000ODPh2AAH\",\n \"marketplace\": \"Amazon\",\n \"marketplaceAdoptionDate\": \"2019-01-01T00:00:00\",\n \"marketplaceEndDate\": \"9999-12-31T00:00:00\",\n \"enforcementDate\": \"2019-10-01T00:00:00\",\n \"createdDate\": \"2019-11-21T00:00:00\",\n \"modifiedDate\": \"2019-11-21T00:00:00\"\n },\n {\n \"region\": \"AL\",\n \"country\": \"US\",\n \"marketplaceId\": \"a0n0b00000ODPh2AAH\",\n \"marketplace\": \"Amazon\",\n \"marketplaceAdoptionDate\": \"2019-01-01T00:00:00\",\n \"marketplaceEndDate\": \"9999-12-31T00:00:00\",\n \"enforcementDate\": \"2019-10-01T00:00:00\",\n \"createdDate\": \"2019-11-21T00:00:00\",\n \"modifiedDate\": \"2019-11-21T00:00:00\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/marketplacelocations?marketplaceId=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "marketplacelocations" ], "query": [ { "description": "MarketplaceId of a marketplace", "key": "marketplaceId", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/marketplacelocations?marketplaceId=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "marketplacelocations" ], "query": [ { "description": "MarketplaceId of a marketplace", "key": "marketplaceId", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/marketplacelocations?marketplaceId=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "marketplacelocations" ], "query": [ { "description": "MarketplaceId of a marketplace", "key": "marketplaceId", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "nexus", "item": [ { "name": "{country}", "item": [ { "name": "{region}", "item": [ { "name": "Retrieve the full list of Avalara-supported nexus for a country and region.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/nexus/:country/:region?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "nexus", ":country", ":region" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "country", "value": "string", "description": "The two-character ISO-3166 code for the country." }, { "key": "region", "value": "string", "description": "The two or three character region code for the region." } ] }, "description": "Returns all Avalara-supported nexus for the specified country and region.\r\n \r\nThis API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country and region." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/nexus/:country/:region?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "nexus", ":country", ":region" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "country", "value": "string", "description": "The two-character ISO-3166 code for the country." }, { "key": "region", "value": "string", "description": "The two or three character region code for the region." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 1459,\n \"value\": [\n {\n \"id\": 0,\n \"companyId\": 0,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"State\",\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"effectiveDate\": \"2017-04-01\",\n \"endDate\": \"2017-03-31\",\n \"shortName\": \"CALIFORNIA\",\n \"signatureCode\": \"\",\n \"stateAssignedNo\": \"\",\n \"nexusTypeId\": \"SalesOrSellersUseTax\",\n \"sourcing\": \"Destination\",\n \"hasLocalNexus\": false,\n \"hasPermanentEstablishment\": true,\n \"streamlinedSalesTax\": false,\n \"isSSTActive\": false,\n \"createdDate\": \"2017-06-30T05:14:06.003\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2022-04-20T01:34:46.39\",\n \"modifiedUserId\": 0,\n \"taxTypeGroup\": \"EWaste\",\n \"nexusTaxTypeGroup\": \"SalesAndUse\",\n \"isSellerImporterOfRecord\": false,\n \"taxName\": \"Tire Fee\",\n \"taxableNexus\": true\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"State\",\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"effectiveDate\": \"2017-04-01\",\n \"endDate\": \"2017-03-31\",\n \"shortName\": \"CALIFORNIA\",\n \"signatureCode\": \"\",\n \"stateAssignedNo\": \"\",\n \"nexusTypeId\": \"SalesOrSellersUseTax\",\n \"sourcing\": \"Destination\",\n \"hasLocalNexus\": false,\n \"hasPermanentEstablishment\": true,\n \"streamlinedSalesTax\": false,\n \"isSSTActive\": false,\n \"createdDate\": \"2017-06-30T05:14:06.003\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2022-04-20T01:34:46.39\",\n \"modifiedUserId\": 0,\n \"taxTypeGroup\": \"EWaste\",\n \"nexusTaxTypeGroup\": \"SalesAndUse\",\n \"isSellerImporterOfRecord\": false,\n \"taxName\": \"Tire Fee\",\n \"taxableNexus\": true\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "Retrieve the full list of Avalara-supported nexus for a country.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/nexus/:country?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "nexus", ":country" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "country", "value": "string", "description": "The country in which you want to fetch the system nexus" } ] }, "description": "Returns all Avalara-supported nexus for the specified country.\r\n \r\nThis API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by country." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/nexus/:country?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "nexus", ":country" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "country", "value": "string", "description": "The country in which you want to fetch the system nexus" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 1459,\n \"value\": [\n {\n \"id\": 0,\n \"companyId\": 0,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"State\",\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"effectiveDate\": \"2017-04-01\",\n \"endDate\": \"2017-03-31\",\n \"shortName\": \"CALIFORNIA\",\n \"signatureCode\": \"\",\n \"stateAssignedNo\": \"\",\n \"nexusTypeId\": \"SalesOrSellersUseTax\",\n \"sourcing\": \"Destination\",\n \"hasLocalNexus\": false,\n \"hasPermanentEstablishment\": true,\n \"streamlinedSalesTax\": false,\n \"isSSTActive\": false,\n \"createdDate\": \"2017-06-30T05:14:06.003\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2022-04-20T01:34:46.39\",\n \"modifiedUserId\": 0,\n \"taxTypeGroup\": \"EWaste\",\n \"nexusTaxTypeGroup\": \"SalesAndUse\",\n \"isSellerImporterOfRecord\": false,\n \"taxName\": \"Tire Fee\",\n \"taxableNexus\": true\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"State\",\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"effectiveDate\": \"2017-04-01\",\n \"endDate\": \"2017-03-31\",\n \"shortName\": \"CALIFORNIA\",\n \"signatureCode\": \"\",\n \"stateAssignedNo\": \"\",\n \"nexusTypeId\": \"SalesOrSellersUseTax\",\n \"sourcing\": \"Destination\",\n \"hasLocalNexus\": false,\n \"hasPermanentEstablishment\": true,\n \"streamlinedSalesTax\": false,\n \"isSSTActive\": false,\n \"createdDate\": \"2017-06-30T05:14:06.003\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2022-04-20T01:34:46.39\",\n \"modifiedUserId\": 0,\n \"taxTypeGroup\": \"EWaste\",\n \"nexusTaxTypeGroup\": \"SalesAndUse\",\n \"isSellerImporterOfRecord\": false,\n \"taxName\": \"Tire Fee\",\n \"taxableNexus\": true\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "byaddress", "item": [ { "name": "List all nexus that apply to a specific address.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/nexus/byaddress?line1=string&line2=string&line3=string&city=string®ion=string&postalCode=string&country=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "nexus", "byaddress" ], "query": [ { "key": "line1", "value": "string", "description": "The first address line portion of this address." }, { "key": "line2", "value": "string", "description": "The first address line portion of this address." }, { "key": "line3", "value": "string", "description": "The first address line portion of this address." }, { "key": "city", "value": "string", "description": "The city portion of this address." }, { "key": "region", "value": "string", "description": "Name or ISO 3166 code identifying the region portion of the address.\r\n \r\n This field supports many different region identifiers:\r\n * Two and three character ISO 3166 region codes\r\n * Fully spelled out names of the region in ISO supported languages\r\n * Common alternative spellings for many regions\r\n \r\n For a full list of all supported codes and names, please see the Definitions API `ListRegions`." }, { "key": "postalCode", "value": "string", "description": "The postal code or zip code portion of this address." }, { "key": "country", "value": "string", "description": "Name or ISO 3166 code identifying the country portion of this address.\r\n \r\n This field supports many different country identifiers:\r\n * Two character ISO 3166 codes\r\n * Three character ISO 3166 codes\r\n * Fully spelled out names of the country in ISO supported languages\r\n * Common alternative spellings for many countries\r\n \r\n For a full list of all supported codes and names, please see the Definitions API `ListCountries`." }, { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Returns a list of all Avalara-supported taxing jurisdictions that apply to this address.\r\nThis API allows you to identify which tax authorities apply to a physical location, salesperson address, or point of sale.\r\nIn general, it is usually expected that a company will declare nexus in all the jurisdictions that apply to each physical address\r\nwhere the company does business.\r\nThe results of this API call can be passed to the 'Create Nexus' API call to declare nexus for this address." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/nexus/byaddress?line1=string&line2=string&line3=string&city=string®ion=string&postalCode=string&country=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "nexus", "byaddress" ], "query": [ { "description": "The first address line portion of this address.", "key": "line1", "value": "string" }, { "description": "The first address line portion of this address.", "key": "line2", "value": "string" }, { "description": "The first address line portion of this address.", "key": "line3", "value": "string" }, { "description": "The city portion of this address.", "key": "city", "value": "string" }, { "description": "Name or ISO 3166 code identifying the region portion of the address.\r\n \r\n This field supports many different region identifiers:\r\n * Two and three character ISO 3166 region codes\r\n * Fully spelled out names of the region in ISO supported languages\r\n * Common alternative spellings for many regions\r\n \r\n For a full list of all supported codes and names, please see the Definitions API `ListRegions`.", "key": "region", "value": "string" }, { "description": "The postal code or zip code portion of this address.", "key": "postalCode", "value": "string" }, { "description": "Name or ISO 3166 code identifying the country portion of this address.\r\n \r\n This field supports many different country identifiers:\r\n * Two character ISO 3166 codes\r\n * Three character ISO 3166 codes\r\n * Fully spelled out names of the country in ISO supported languages\r\n * Common alternative spellings for many countries\r\n \r\n For a full list of all supported codes and names, please see the Definitions API `ListCountries`.", "key": "country", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 1459,\n \"value\": [\n {\n \"id\": 0,\n \"companyId\": 0,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"State\",\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"effectiveDate\": \"2017-04-01\",\n \"endDate\": \"2017-03-31\",\n \"shortName\": \"CALIFORNIA\",\n \"signatureCode\": \"\",\n \"stateAssignedNo\": \"\",\n \"nexusTypeId\": \"SalesOrSellersUseTax\",\n \"sourcing\": \"Destination\",\n \"hasLocalNexus\": false,\n \"hasPermanentEstablishment\": true,\n \"streamlinedSalesTax\": false,\n \"isSSTActive\": false,\n \"createdDate\": \"2017-06-30T05:14:06.003\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2022-04-20T01:34:46.39\",\n \"modifiedUserId\": 0,\n \"taxTypeGroup\": \"EWaste\",\n \"nexusTaxTypeGroup\": \"SalesAndUse\",\n \"isSellerImporterOfRecord\": false,\n \"taxName\": \"Tire Fee\",\n \"taxableNexus\": true\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"State\",\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"effectiveDate\": \"2017-04-01\",\n \"endDate\": \"2017-03-31\",\n \"shortName\": \"CALIFORNIA\",\n \"signatureCode\": \"\",\n \"stateAssignedNo\": \"\",\n \"nexusTypeId\": \"SalesOrSellersUseTax\",\n \"sourcing\": \"Destination\",\n \"hasLocalNexus\": false,\n \"hasPermanentEstablishment\": true,\n \"streamlinedSalesTax\": false,\n \"isSSTActive\": false,\n \"createdDate\": \"2017-06-30T05:14:06.003\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2022-04-20T01:34:46.39\",\n \"modifiedUserId\": 0,\n \"taxTypeGroup\": \"EWaste\",\n \"nexusTaxTypeGroup\": \"SalesAndUse\",\n \"isSellerImporterOfRecord\": false,\n \"taxName\": \"Tire Fee\",\n \"taxableNexus\": true\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "byform", "item": [ { "name": "{formCode}", "item": [ { "name": "List nexus related to a tax form", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/nexus/byform/:formCode", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "nexus", "byform", ":formCode" ], "variable": [ { "key": "formCode", "value": "string", "description": "The form code that we are looking up the nexus for" } ] }, "description": "Retrieves a list of nexus related to a tax form.\r\n \r\nThe concept of `Nexus` indicates a place where your company has sufficient physical presence and is obligated\r\nto collect and remit transaction-based taxes.\r\n \r\nWhen defining companies in AvaTax, you must declare nexus for your company in order to correctly calculate tax\r\nin all jurisdictions affected by your transactions.\r\n \r\nThis API is intended to provide useful information when examining a tax form. If you are about to begin filing\r\na tax form, you may want to know whether you have declared nexus in all the jurisdictions related to that tax\r\nform in order to better understand how the form will be filled out.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/nexus/byform/:formCode", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "nexus", "byform", ":formCode" ], "variable": [ { "key": "formCode", "value": "string", "description": "The form code that we are looking up the nexus for" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"formCode\": \"UNKNOWNFORM\",\n \"companyId\": 12345,\n \"nexusDefinitions\": [],\n \"companyNexus\": []\n}" } ] } ] } ] }, { "name": "bytaxtypegroup", "item": [ { "name": "{taxTypeGroup}", "item": [ { "name": "Retrieve the full list of Avalara-supported nexus for a tax type group.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/nexus/bytaxtypegroup/:taxTypeGroup?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "nexus", "bytaxtypegroup", ":taxTypeGroup" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "taxTypeGroup", "value": "string", "description": "The tax type group to fetch the supporting system nexus for." } ] }, "description": "Returns all Avalara-supported nexus for the specified specified tax type group.\r\n \r\nThis API is intended to be useful if your user interface needs to display a selectable list of nexus filtered by tax type group." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/nexus/bytaxtypegroup/:taxTypeGroup?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "nexus", "bytaxtypegroup", ":taxTypeGroup" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "taxTypeGroup", "value": "string", "description": "The tax type group to fetch the supporting system nexus for." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 1459,\n \"value\": [\n {\n \"id\": 0,\n \"companyId\": 0,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"State\",\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"effectiveDate\": \"2017-04-01\",\n \"endDate\": \"2017-03-31\",\n \"shortName\": \"CALIFORNIA\",\n \"signatureCode\": \"\",\n \"stateAssignedNo\": \"\",\n \"nexusTypeId\": \"SalesOrSellersUseTax\",\n \"sourcing\": \"Destination\",\n \"hasLocalNexus\": false,\n \"hasPermanentEstablishment\": true,\n \"streamlinedSalesTax\": false,\n \"isSSTActive\": false,\n \"createdDate\": \"2017-06-30T05:14:06.003\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2022-04-20T01:34:46.39\",\n \"modifiedUserId\": 0,\n \"taxTypeGroup\": \"EWaste\",\n \"nexusTaxTypeGroup\": \"SalesAndUse\",\n \"isSellerImporterOfRecord\": false,\n \"taxName\": \"Tire Fee\",\n \"taxableNexus\": true\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"State\",\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"effectiveDate\": \"2017-04-01\",\n \"endDate\": \"2017-03-31\",\n \"shortName\": \"CALIFORNIA\",\n \"signatureCode\": \"\",\n \"stateAssignedNo\": \"\",\n \"nexusTypeId\": \"SalesOrSellersUseTax\",\n \"sourcing\": \"Destination\",\n \"hasLocalNexus\": false,\n \"hasPermanentEstablishment\": true,\n \"streamlinedSalesTax\": false,\n \"isSSTActive\": false,\n \"createdDate\": \"2017-06-30T05:14:06.003\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2022-04-20T01:34:46.39\",\n \"modifiedUserId\": 0,\n \"taxTypeGroup\": \"EWaste\",\n \"nexusTaxTypeGroup\": \"SalesAndUse\",\n \"isSellerImporterOfRecord\": false,\n \"taxName\": \"Tire Fee\",\n \"taxableNexus\": true\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] } ] }, { "name": "Retrieve the full list of Avalara-supported nexus for all countries and regions.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/nexus?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "nexus" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Returns the full list of all Avalara-supported nexus for all countries and regions.\r\n \r\nThis API is intended to be useful if your user interface needs to display a selectable list of nexus." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/nexus?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "nexus" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 1459,\n \"value\": [\n {\n \"id\": 0,\n \"companyId\": 0,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"State\",\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"effectiveDate\": \"2017-04-01\",\n \"endDate\": \"2017-03-31\",\n \"shortName\": \"CALIFORNIA\",\n \"signatureCode\": \"\",\n \"stateAssignedNo\": \"\",\n \"nexusTypeId\": \"SalesOrSellersUseTax\",\n \"sourcing\": \"Destination\",\n \"hasLocalNexus\": false,\n \"hasPermanentEstablishment\": true,\n \"streamlinedSalesTax\": false,\n \"isSSTActive\": false,\n \"createdDate\": \"2017-06-30T05:14:06.003\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2022-04-20T01:34:46.39\",\n \"modifiedUserId\": 0,\n \"taxTypeGroup\": \"EWaste\",\n \"nexusTaxTypeGroup\": \"SalesAndUse\",\n \"isSellerImporterOfRecord\": false,\n \"taxName\": \"Tire Fee\",\n \"taxableNexus\": true\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"State\",\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"effectiveDate\": \"2017-04-01\",\n \"endDate\": \"2017-03-31\",\n \"shortName\": \"CALIFORNIA\",\n \"signatureCode\": \"\",\n \"stateAssignedNo\": \"\",\n \"nexusTypeId\": \"SalesOrSellersUseTax\",\n \"sourcing\": \"Destination\",\n \"hasLocalNexus\": false,\n \"hasPermanentEstablishment\": true,\n \"streamlinedSalesTax\": false,\n \"isSSTActive\": false,\n \"createdDate\": \"2017-06-30T05:14:06.003\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2022-04-20T01:34:46.39\",\n \"modifiedUserId\": 0,\n \"taxTypeGroup\": \"EWaste\",\n \"nexusTaxTypeGroup\": \"SalesAndUse\",\n \"isSellerImporterOfRecord\": false,\n \"taxName\": \"Tire Fee\",\n \"taxableNexus\": true\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "nexustaxtypegroups", "item": [ { "name": "Retrieve the full list of nexus tax type groups", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/nexustaxtypegroups?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "nexustaxtypegroups" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* subscriptionTypeId, subscriptionDescription, tabName, showColumn" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Returns the full list of Avalara-supported nexus tax type groups\r\nThis API is intended to be useful to identify all the different tax sub-types." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/nexustaxtypegroups?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "nexustaxtypegroups" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* subscriptionTypeId, subscriptionDescription, tabName, showColumn", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 702,\n \"value\": [\n {\n \"id\": 1,\n \"nexusTaxTypeGroupId\": \"SalesAndUse\",\n \"description\": \"Sales and Use\"\n },\n {\n \"id\": 1,\n \"nexusTaxTypeGroupId\": \"SalesAndUse\",\n \"description\": \"Sales and Use\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "noticecustomerfundingoptions", "item": [ { "name": "Retrieve the full list of Avalara-supported tax notice customer funding options.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/noticecustomerfundingoptions?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "noticecustomerfundingoptions" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* activeFlag, sortOrder" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Returns the full list of Avalara-supported tax notice customer funding options.\r\nThis API is intended to be useful to identify all the different notice customer funding options that can be used in notices." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/noticecustomerfundingoptions?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "noticecustomerfundingoptions" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* activeFlag, sortOrder", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 3035,\n \"value\": [\n {\n \"id\": 1,\n \"description\": \"Pull\",\n \"activeFlag\": true,\n \"sortOrder\": 5\n },\n {\n \"id\": 1,\n \"description\": \"Pull\",\n \"activeFlag\": true,\n \"sortOrder\": 5\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "noticecustomertypes", "item": [ { "name": "Retrieve the full list of Avalara-supported tax notice customer types.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/noticecustomertypes?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "noticecustomertypes" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* activeFlag, sortOrder" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Returns the full list of Avalara-supported tax notice customer types.\r\nThis API is intended to be useful to identify all the different notice customer types." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/noticecustomertypes?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "noticecustomertypes" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* activeFlag, sortOrder", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 4654,\n \"value\": [\n {\n \"id\": 12345,\n \"description\": \"City\",\n \"activeFlag\": true,\n \"sortOrder\": 5\n },\n {\n \"id\": 12345,\n \"description\": \"City\",\n \"activeFlag\": true,\n \"sortOrder\": 5\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "noticefilingtypes", "item": [ { "name": "Retrieve the full list of Avalara-supported tax notice filing types.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/noticefilingtypes?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "noticefilingtypes" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* description, activeFlag, sortOrder" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Returns the full list of Avalara-supported tax notice filing types.\r\nThis API is intended to be useful to identify all the different notice filing types that can be used in notices." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/noticefilingtypes?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "noticefilingtypes" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* description, activeFlag, sortOrder", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 7630,\n \"value\": [\n {\n \"id\": 1,\n \"description\": \"Electronic Return \",\n \"activeFlag\": true,\n \"sortOrder\": 5\n },\n {\n \"id\": 1,\n \"description\": \"Electronic Return \",\n \"activeFlag\": true,\n \"sortOrder\": 5\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "noticepriorities", "item": [ { "name": "Retrieve the full list of Avalara-supported tax notice priorities.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/noticepriorities?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "noticepriorities" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* activeFlag, sortOrder" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Returns the full list of Avalara-supported tax notice priorities.\r\nThis API is intended to be useful to identify all the different notice priorities that can be used in notices." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/noticepriorities?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "noticepriorities" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* activeFlag, sortOrder", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 5977,\n \"value\": [\n {\n \"id\": 2,\n \"description\": \"High\",\n \"activeFlag\": true,\n \"sortOrder\": 10\n },\n {\n \"id\": 2,\n \"description\": \"High\",\n \"activeFlag\": true,\n \"sortOrder\": 10\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "noticereasons", "item": [ { "name": "Retrieve the full list of Avalara-supported tax notice reasons.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/noticereasons?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "noticereasons" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* description, activeFlag, sortOrder" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Returns the full list of Avalara-supported tax notice reasons.\r\nThis API is intended to be useful to identify all the different tax notice reasons." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/noticereasons?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "noticereasons" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* description, activeFlag, sortOrder", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 8317,\n \"value\": [\n {\n \"id\": 1,\n \"description\": \"AvaTax Returns\",\n \"activeFlag\": true,\n \"sortOrder\": 5\n },\n {\n \"id\": 1,\n \"description\": \"AvaTax Returns\",\n \"activeFlag\": true,\n \"sortOrder\": 5\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "noticeresponsibilities", "item": [ { "name": "Retrieve the full list of Avalara-supported tax notice responsibility ids", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/noticeresponsibilities?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "noticeresponsibilities" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* sortOrder" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Returns the full list of Avalara-supported tax notice responsibility ids\r\nThis API is intended to be useful to identify all the different tax notice responsibilities." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/noticeresponsibilities?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "noticeresponsibilities" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* sortOrder", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 5786,\n \"value\": [\n {\n \"id\": 11,\n \"description\": \"Customer-Invalid login (Return filed manual)\",\n \"isActive\": true,\n \"sortOrder\": 55\n },\n {\n \"id\": 11,\n \"description\": \"Customer-Invalid login (Return filed manual)\",\n \"isActive\": true,\n \"sortOrder\": 55\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "noticerootcauses", "item": [ { "name": "Retrieve the full list of Avalara-supported tax notice root causes", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/noticerootcauses?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "noticerootcauses" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* sortOrder" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Returns the full list of Avalara-supported tax notice root causes\r\nThis API is intended to be useful to identify all the different tax notice root causes." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/noticerootcauses?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "noticerootcauses" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* sortOrder", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 800,\n \"value\": [\n {\n \"id\": 11,\n \"description\": \"Customer-Invalid login (Return filed manual)\",\n \"isActive\": true,\n \"sortOrder\": 55\n },\n {\n \"id\": 11,\n \"description\": \"Customer-Invalid login (Return filed manual)\",\n \"isActive\": true,\n \"sortOrder\": 55\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "noticestatuses", "item": [ { "name": "Retrieve the full list of Avalara-supported tax notice statuses.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/noticestatuses?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "noticestatuses" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* isOpen, sortOrder, activeFlag" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Returns the full list of Avalara-supported tax notice statuses.\r\nThis API is intended to be useful to identify all the different tax notice statuses." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/noticestatuses?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "noticestatuses" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* isOpen, sortOrder, activeFlag", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 269,\n \"value\": [\n {\n \"id\": 12345,\n \"description\": \"City\",\n \"isOpen\": false,\n \"sortOrder\": 0,\n \"activeFlag\": false\n },\n {\n \"id\": 12345,\n \"description\": \"City\",\n \"isOpen\": false,\n \"sortOrder\": 0,\n \"activeFlag\": false\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "noticetypes", "item": [ { "name": "Retrieve the full list of Avalara-supported tax notice types.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/noticetypes?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "noticetypes" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* activeFlag, sortOrder" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Returns the full list of Avalara-supported tax notice types.\r\nThis API is intended to be useful to identify all the different notice types that can be used in notices." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/noticetypes?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "noticetypes" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* activeFlag, sortOrder", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 4991,\n \"value\": [\n {\n \"id\": 2,\n \"description\": \"Notices\",\n \"activeFlag\": true,\n \"sortOrder\": 10\n },\n {\n \"id\": 2,\n \"description\": \"Notices\",\n \"activeFlag\": true,\n \"sortOrder\": 10\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "parameters", "item": [ { "name": "byitem", "item": [ { "name": "{companyCode}", "item": [ { "name": "{itemCode}", "item": [ { "name": "Retrieve the parameters by companyCode and itemCode.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/parameters/byitem/:companyCode/:itemCode?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "parameters", "byitem", ":companyCode", ":itemCode" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* serviceTypes, regularExpression, attributeSubType, values" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "companyCode", "value": "string", "description": "Company code." }, { "key": "itemCode", "value": "string", "description": "Item code." } ] }, "description": "Returns the list of parameters based on the company's service types and the item code.\r\nIgnores nexus if a service type is configured in the 'IgnoreNexusForServiceTypes' configuration section.\r\nIgnores nexus for the AvaAlcohol service type.\r\n \r\nNOTE: If your company code or item code contains any of these characters /, +, ? or a space, please use the following encoding before making a request:\r\n* Replace '/' with '\\_-ava2f-\\_' For example: 'Company/Code' becomes 'Company_-ava2f-_Code'\r\n* Replace '+' with '\\_-ava2b-\\_' For example: 'Company+Code' becomes 'Company_-ava2b-_Code'\r\n* Replace '?' with '\\_-ava3f-\\_' For example: 'Company?Code' becomes 'Company_-ava3f-_Code'\r\n* Replace '%' with '\\_-ava25-\\_' For example: 'Company%Code' becomes 'Company_-ava25-_Code'\r\n* Replace '#' with '\\_-ava23-\\_' For example: 'Company#Code' becomes 'Company_-ava23-_Code'\r\n \r\nFor Item Code other than the five given above below two should also be used\r\n* Replace ''' with '\\_-ava27-\\_' For example: 'Item'Code' becomes 'Item_-ava27-_Code'\r\n* Replace '\"' with '\\_-ava22-\\_' For example: 'Item\"Code' becomes 'Item_-ava22-_Code'\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/parameters/byitem/:companyCode/:itemCode?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "parameters", "byitem", ":companyCode", ":itemCode" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* serviceTypes, regularExpression, attributeSubType, values", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "Company code." }, { "key": "itemCode", "value": "string", "description": "Item code." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 4629,\n \"value\": [\n {\n \"id\": 12345,\n \"category\": \"Lodging\",\n \"name\": \"NumberOfNights\",\n \"dataType\": \"NumericMeasured\",\n \"helpText\": \"Please enter the number of nights the customer stayed in your lodging; whole numbers only.\",\n \"serviceTypes\": [\n \"AvaLodging\"\n ],\n \"prompt\": \"Lodging Number of Nights\",\n \"regularExpression\": \"\\\\d*\",\n \"label\": \"lodging\",\n \"helpUrl\": \"www.example.com/lodging\",\n \"isNeededForCalculation\": true,\n \"isNeededForReturns\": false,\n \"isNeededForClassification\": false\n },\n {\n \"id\": 12345,\n \"category\": \"Lodging\",\n \"name\": \"NumberOfNights\",\n \"dataType\": \"NumericMeasured\",\n \"helpText\": \"Please enter the number of nights the customer stayed in your lodging; whole numbers only.\",\n \"serviceTypes\": [\n \"AvaLodging\"\n ],\n \"prompt\": \"Lodging Number of Nights\",\n \"regularExpression\": \"\\\\d*\",\n \"label\": \"lodging\",\n \"helpUrl\": \"www.example.com/lodging\",\n \"isNeededForCalculation\": true,\n \"isNeededForReturns\": false,\n \"isNeededForClassification\": false\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] } ] } ] }, { "name": "Retrieve the full list of Avalara-supported extra parameters for creating transactions.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/parameters?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "parameters" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* serviceTypes, regularExpression, attributeSubType, values" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Returns the full list of Avalara-supported extra parameters for the 'Create Transaction' API call.\r\nThis list of parameters is available for use when configuring your transaction.\r\nSome parameters are only available for use if you have subscribed to certain features of AvaTax." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/parameters?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "parameters" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* serviceTypes, regularExpression, attributeSubType, values", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 4629,\n \"value\": [\n {\n \"id\": 12345,\n \"category\": \"Lodging\",\n \"name\": \"NumberOfNights\",\n \"dataType\": \"NumericMeasured\",\n \"helpText\": \"Please enter the number of nights the customer stayed in your lodging; whole numbers only.\",\n \"serviceTypes\": [\n \"AvaLodging\"\n ],\n \"prompt\": \"Lodging Number of Nights\",\n \"regularExpression\": \"\\\\d*\",\n \"label\": \"lodging\",\n \"helpUrl\": \"www.example.com/lodging\",\n \"isNeededForCalculation\": true,\n \"isNeededForReturns\": false,\n \"isNeededForClassification\": false\n },\n {\n \"id\": 12345,\n \"category\": \"Lodging\",\n \"name\": \"NumberOfNights\",\n \"dataType\": \"NumericMeasured\",\n \"helpText\": \"Please enter the number of nights the customer stayed in your lodging; whole numbers only.\",\n \"serviceTypes\": [\n \"AvaLodging\"\n ],\n \"prompt\": \"Lodging Number of Nights\",\n \"regularExpression\": \"\\\\d*\",\n \"label\": \"lodging\",\n \"helpUrl\": \"www.example.com/lodging\",\n \"isNeededForCalculation\": true,\n \"isNeededForReturns\": false,\n \"isNeededForClassification\": false\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "parametersusage", "item": [ { "name": "Retrieve the full list of Avalara-supported usage of extra parameters for creating transactions.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/parametersusage?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "parametersusage" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* attributeSubType, values, valueDescriptions" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Returns the full list of Avalara-supported usage of extra parameters for the 'Create Transaction' API call.\r\nThis list of parameters is available for use when configuring your transaction.\r\nSome parameters are only available for use if you have subscribed to certain features of AvaTax." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/parametersusage?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "parametersusage" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* attributeSubType, values, valueDescriptions", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 5217,\n \"value\": [\n {\n \"id\": 12345,\n \"parameterId\": 12345,\n \"productCode\": \"PC080100\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"systemId\": 0,\n \"taxTypeId\": \"EWaste\",\n \"attributeType\": \"Product\",\n \"name\": \"ScreenSize\",\n \"dataType\": \"NumericMeasured\",\n \"helpText\": \"A diagonal length measure of a rectangular screen along it's surface; indicative of it's total surface area.\",\n \"label\": \"Screen Size\",\n \"measurementType\": \"Length\"\n },\n {\n \"id\": 12345,\n \"parameterId\": 12345,\n \"productCode\": \"PC080100\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"systemId\": 0,\n \"taxTypeId\": \"EWaste\",\n \"attributeType\": \"Product\",\n \"name\": \"ScreenSize\",\n \"dataType\": \"NumericMeasured\",\n \"helpText\": \"A diagonal length measure of a rectangular screen along it's surface; indicative of it's total surface area.\",\n \"label\": \"Screen Size\",\n \"measurementType\": \"Length\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "permissions", "item": [ { "name": "Retrieve the full list of Avalara-supported permissions", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/permissions?$top=451&$skip=451", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "permissions" ], "query": [ { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." } ] }, "description": "Returns the full list of Avalara-supported permission types.\r\nThis API is intended to be useful to identify the capabilities of a particular user logon." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/permissions?$top=451&$skip=451", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "permissions" ], "query": [ { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 3061,\n \"value\": [\n \"string\",\n \"string\"\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "postalcodes", "item": [ { "name": "Retrieve the full list of Avalara-supported postal codes.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/postalcodes?$filter=string&$top=451&$skip=451&$orderBy=string&includeExpiredPostalCodes=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "postalcodes" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/)." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." }, { "key": "includeExpiredPostalCodes", "value": "false", "description": "If set to true, returns expired postal codes. Defaults to false" } ] }, "description": "Retrieves the list of Avalara-supported postal codes." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/postalcodes?$filter=string&$top=451&$skip=451&$orderBy=string&includeExpiredPostalCodes=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "postalcodes" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" }, { "description": "If set to true, returns expired postal codes. Defaults to false", "key": "includeExpiredPostalCodes", "value": "false" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 5124,\n \"value\": [\n {\n \"country\": \"US\",\n \"region\": \"WA\",\n \"taxRegionId\": 0,\n \"effDate\": \"2005-04-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"postalCode\": \"98104\"\n },\n {\n \"country\": \"US\",\n \"region\": \"WA\",\n \"taxRegionId\": 0,\n \"effDate\": \"2005-04-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"postalCode\": \"98104\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "preferredprograms", "item": [ { "name": "List all customs duty programs recognized by AvaTax", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/preferredprograms?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "preferredprograms" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* effectiveDate, endDate" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "List all preferred customs duty programs recognized by AvaTax.\r\n \r\nA customs duty program is an optional program you can use to obtain favorable treatment from customs and duty agents.\r\nAn example of a preferred program is NAFTA, which provides preferential rates for products being shipped from neighboring\r\ncountries.\r\n \r\nTo select a preferred program for calculating customs and duty rates, call this API to find the appropriate code for your\r\npreferred program. Next, set the parameter `AvaTax.LC.PreferredProgram` in your `CreateTransaction` call to the code of\r\nthe program." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/preferredprograms?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "preferredprograms" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* effectiveDate, endDate", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 4509,\n \"value\": [\n {\n \"id\": 99,\n \"code\": \"NAFTA\",\n \"originCountry\": \"US\",\n \"destinationCountry\": \"MX\",\n \"effectiveDate\": \"2018-01-01\",\n \"endDate\": \"9999-12-31\"\n },\n {\n \"id\": 99,\n \"code\": \"NAFTA\",\n \"originCountry\": \"US\",\n \"destinationCountry\": \"MX\",\n \"effectiveDate\": \"2018-01-01\",\n \"endDate\": \"9999-12-31\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "productclassificationsystems", "item": [ { "name": "bycompany", "item": [ { "name": "{companyCode}", "item": [ { "name": "List all product classification systems available to a company based on its nexus.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/productclassificationsystems/bycompany/:companyCode?$filter=string&$top=451&$skip=451&$orderBy=string&$countryCode=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "productclassificationsystems", "bycompany", ":companyCode" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* countries" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." }, { "key": "$countryCode", "value": "string", "description": "If not null, return all records with this code." } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code." } ] }, "description": "Lists all product classification systems available to a company based on its nexus.\r\n \r\nTax authorities use product classification systems as a way to identify products and associate them with a tax rate.\r\nMore than one tax authority might use the same product classification system, but they might charge different tax rates for products.\r\n \r\n \r\nNOTE: If your company code contains any of these characters /, +, ? or a space, please use the following encoding before making a request:\r\n* Replace '/' with '\\_-ava2f-\\_' For example: 'Company/Code' becomes 'Company_-ava2f-_Code'\r\n* Replace '+' with '\\_-ava2b-\\_' For example: 'Company+Code' becomes 'Company_-ava2b-_Code'\r\n* Replace '?' with '\\_-ava3f-\\_' For example: 'Company?Code' becomes 'Company_-ava3f-_Code'\r\n* Replace '%' with '\\_-ava25-\\_' For example: 'Company%Code' becomes 'Company_-ava25-_Code'\r\n* Replace '#' with '\\_-ava23-\\_' For example: 'Company#Code' becomes 'Company_-ava23-_Code'" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/productclassificationsystems/bycompany/:companyCode?$filter=string&$top=451&$skip=451&$orderBy=string&$countryCode=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "productclassificationsystems", "bycompany", ":companyCode" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* countries", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" }, { "description": "If not null, return all records with this code.", "key": "$countryCode", "value": "string" } ], "variable": [ { "key": "companyCode", "value": "string", "description": "The company code." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 351,\n \"value\": [\n {\n \"systemId\": 1,\n \"systemCode\": \"abc\",\n \"description\": \"xyz\",\n \"customsValue\": \"pqr\"\n },\n {\n \"systemId\": 1,\n \"systemCode\": \"abc\",\n \"description\": \"xyz\",\n \"customsValue\": \"pqr\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] } ] }, { "name": "List all available product classification systems.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/productclassificationsystems?$filter=string&$top=451&$skip=451&$orderBy=string&$countryCode=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "productclassificationsystems" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* countries" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." }, { "key": "$countryCode", "value": "string", "description": "If not null, return all records with this code." } ] }, "description": "List all available product classification systems.\r\n \r\nTax authorities use product classification systems as a way to identify products and associate them with a tax rate.\r\nMore than one tax authority might use the same product classification system, but they might charge different tax rates for products." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/productclassificationsystems?$filter=string&$top=451&$skip=451&$orderBy=string&$countryCode=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "productclassificationsystems" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* countries", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" }, { "description": "If not null, return all records with this code.", "key": "$countryCode", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 351,\n \"value\": [\n {\n \"systemId\": 1,\n \"systemCode\": \"abc\",\n \"description\": \"xyz\",\n \"customsValue\": \"pqr\"\n },\n {\n \"systemId\": 1,\n \"systemCode\": \"abc\",\n \"description\": \"xyz\",\n \"customsValue\": \"pqr\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "regions", "item": [ { "name": "List all ISO 3166 regions", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/regions?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "regions" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* localizedNames" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Returns a list of all ISO 3166 region codes and their US English friendly names.\r\nThis API is intended to be useful when presenting a dropdown box in your website to allow customers to select a region\r\nwithin the country for a shipping addresses." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/regions?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "regions" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* localizedNames", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 1956,\n \"value\": [\n {\n \"countryCode\": \"US\",\n \"code\": \"CA\",\n \"name\": \"California\",\n \"classification\": \"State\"\n },\n {\n \"countryCode\": \"US\",\n \"code\": \"CA\",\n \"name\": \"California\",\n \"classification\": \"State\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "returns", "item": [ { "name": "parametersusage", "item": [ { "name": "Retrieve the full list of Avalara-supported usage of parameters used for returns.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/returns/parametersusage?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "returns", "parametersusage" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* attributeSubType, values" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Returns the full list of Avalara-supported usage of extra parameters for the returns.\r\nThis list of parameters is available for use with Returns.\r\nSome parameters are only available for use if you have subscribed to certain features of AvaTax." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/returns/parametersusage?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "returns", "parametersusage" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* attributeSubType, values", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 4406,\n \"value\": [\n {\n \"id\": 12345,\n \"parameterId\": 12345,\n \"productCode\": \"PC080100\",\n \"taxTypeId\": \"LandedCost\",\n \"attributeType\": \"Product\",\n \"name\": \"ScreenSize\",\n \"dataType\": \"NumericMeasured\",\n \"helpText\": \"A diagonal length measure of a rectangular screen along it's surface; indicative of it's total surface area.\",\n \"label\": \"Screen Size\",\n \"measurementType\": \"Length\"\n },\n {\n \"id\": 12345,\n \"parameterId\": 12345,\n \"productCode\": \"PC080100\",\n \"taxTypeId\": \"LandedCost\",\n \"attributeType\": \"Product\",\n \"name\": \"ScreenSize\",\n \"dataType\": \"NumericMeasured\",\n \"helpText\": \"A diagonal length measure of a rectangular screen along it's surface; indicative of it's total surface area.\",\n \"label\": \"Screen Size\",\n \"measurementType\": \"Length\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] } ] }, { "name": "securityroles", "item": [ { "name": "Retrieve the full list of Avalara-supported permissions", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/securityroles?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "securityroles" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/)." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Returns the full list of Avalara-supported permission types.\r\nThis API is intended to be useful when designing a user interface for selecting the security role of a user account.\r\nSome security roles are restricted for Avalara internal use." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/securityroles?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "securityroles" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 8914,\n \"value\": [\n {\n \"id\": 3,\n \"description\": \"AccountAdmin\"\n },\n {\n \"id\": 3,\n \"description\": \"AccountAdmin\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "subscriptiontypes", "item": [ { "name": "Retrieve the full list of Avalara-supported subscription types", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/subscriptiontypes?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "subscriptiontypes" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* system, taxTypeGroupIdSK" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Returns the full list of Avalara-supported subscription types.\r\nThis API is intended to be useful for identifying which features you have added to your account.\r\nYou may always contact Avalara's sales department for information on available products or services.\r\nYou cannot change your subscriptions directly through the API." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/subscriptiontypes?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "subscriptiontypes" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* system, taxTypeGroupIdSK", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 623,\n \"value\": [\n {\n \"id\": 2,\n \"description\": \"AvaTaxPro\",\n \"system\": \"AvaTax\",\n \"taxTypeGroupIdSK\": 0\n },\n {\n \"id\": 2,\n \"description\": \"AvaTaxPro\",\n \"system\": \"AvaTax\",\n \"taxTypeGroupIdSK\": 0\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "tags", "item": [ { "name": "Retrieve the list all tags supported by avalara", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/tags?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "tags" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/)." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Retrieves the list of suggested locations for a marketplace." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/tags?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "tags" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 6452,\n \"value\": [\n {\n \"id\": 1,\n \"tagName\": \"Import_Restricted\"\n },\n {\n \"id\": 1,\n \"tagName\": \"Import_Restricted\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "taxauthorities", "item": [ { "name": "Retrieve the full list of Avalara-supported tax authorities.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/taxauthorities?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "taxauthorities" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/)." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Returns the full list of Avalara-supported tax authorities.\r\nThis API is intended to be useful to identify all the different authorities that receive tax." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/taxauthorities?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "taxauthorities" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 300,\n \"value\": [\n {\n \"id\": 12345,\n \"name\": \"COLORADO\",\n \"taxAuthorityTypeId\": 45,\n \"jurisdictionId\": 12345\n },\n {\n \"id\": 12345,\n \"name\": \"COLORADO\",\n \"taxAuthorityTypeId\": 45,\n \"jurisdictionId\": 12345\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "taxauthorityforms", "item": [ { "name": "Retrieve the full list of Avalara-supported forms for each tax authority.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/taxauthorityforms?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "taxauthorityforms" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/)." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Returns the full list of Avalara-supported forms for each tax authority.\r\nThis list represents tax forms that Avalara recognizes.\r\nCustomers who subscribe to Avalara Managed Returns Service can request these forms to be filed automatically\r\nbased on the customer's AvaTax data." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/taxauthorityforms?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "taxauthorityforms" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 5560,\n \"value\": [\n {\n \"taxAuthorityId\": 69,\n \"formName\": \"CABOE401A2\"\n },\n {\n \"taxAuthorityId\": 69,\n \"formName\": \"CABOE401A2\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "taxauthoritytypes", "item": [ { "name": "Retrieve the full list of Avalara-supported tax authority types.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/taxauthoritytypes?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "taxauthoritytypes" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/)." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Returns the full list of Avalara-supported tax authority types.\r\nThis API is intended to be useful to identify all the different authority types." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/taxauthoritytypes?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "taxauthoritytypes" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 1619,\n \"value\": [\n {\n \"id\": 0,\n \"description\": \"County\",\n \"taxAuthorityGroup\": \"LocalCounty\"\n },\n {\n \"id\": 0,\n \"description\": \"County\",\n \"taxAuthorityGroup\": \"LocalCounty\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "taxcodes", "item": [ { "name": "Retrieve the full list of Avalara-supported tax codes.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/taxcodes?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "taxcodes" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/)." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Retrieves the list of Avalara-supported system tax codes.\r\nA 'TaxCode' represents a uniquely identified type of product, good, or service.\r\nAvalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.\r\nIf you identify your products by tax code in your 'Create Transaction' API calls, Avalara will correctly calculate tax rates and\r\ntaxability rules for this product in all supported jurisdictions.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/taxcodes?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "taxcodes" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 6614,\n \"value\": [\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"taxCode\": \"PS081282\",\n \"taxCodeTypeId\": \"P\",\n \"description\": \"Yarn\",\n \"parentTaxCode\": \"PS080100\",\n \"isPhysical\": true,\n \"goodsServiceCode\": 0,\n \"entityUseCode\": \"\",\n \"isActive\": true,\n \"isSSTCertified\": false\n },\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"taxCode\": \"PS081282\",\n \"taxCodeTypeId\": \"P\",\n \"description\": \"Yarn\",\n \"parentTaxCode\": \"PS080100\",\n \"isPhysical\": true,\n \"goodsServiceCode\": 0,\n \"entityUseCode\": \"\",\n \"isActive\": true,\n \"isSSTCertified\": false\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "taxcodetypes", "item": [ { "name": "Retrieve the full list of Avalara-supported tax code types.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/taxcodetypes?$top=451&$skip=451", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "taxcodetypes" ], "query": [ { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." } ] }, "description": "Returns the full list of recognized tax code types.\r\nA 'Tax Code Type' represents a broad category of tax codes, and is less detailed than a single TaxCode.\r\nThis API is intended to be useful for broadly searching for tax codes by tax code type." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/taxcodetypes?$top=451&$skip=451", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "taxcodetypes" ], "query": [ { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"types\": {\n \"D\": \"Digital\",\n \"F\": \"Freight\",\n \"O\": \"Other\",\n \"P\": \"Product\",\n \"S\": \"Service\",\n \"U\": \"Unknown\"\n }\n}" } ] } ] }, { "name": "taxforms", "item": [ { "name": "Retrieve the full list of the Tax Forms available", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/taxforms?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "taxforms" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/)." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Returns the full list of Avalara-supported Tax Forms\r\nThis API is intended to be useful to identify all the different Tax Forms" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/taxforms?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "taxforms" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 2628,\n \"value\": [\n {\n \"id\": 2415,\n \"formTypeId\": 0,\n \"legacyReturnName\": \"CABOE401A2\",\n \"taxFormName\": \"CA BOE 401 A2\",\n \"description\": \"State, Local, and District Sales and Use Tax Return\",\n \"isEffective\": true,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"dueDay\": 20,\n \"hasMultiFrequencies\": false,\n \"isPOARequired\": false,\n \"isRegistrationRequired\": false,\n \"hasMultiRegistrationMethods\": false,\n \"hasSchedules\": false,\n \"hasMultiFilingMethods\": false,\n \"hasMultiPayMethods\": false,\n \"isEFTRequired\": false,\n \"isFilePayMethodLinked\": false,\n \"mailingReceivedRuleId\": 0,\n \"proofOfMailingId\": 0,\n \"isNegAmountAllowed\": false,\n \"allowNegativeOverallTax\": false,\n \"isNettingRequired\": false,\n \"roundingMethodId\": 0,\n \"vendorDiscountAnnualMax\": 0,\n \"versionsRequireAuthorityApproval\": false,\n \"outletReportingMethodId\": 0,\n \"hasReportingCodes\": false,\n \"hasPrepayments\": false,\n \"grossIncludesInterstateSales\": false,\n \"hasEfileFee\": false,\n \"hasEpayFee\": false,\n \"hasDependencies\": false,\n \"vendorDiscountEfile\": false,\n \"vendorDiscountPaper\": false,\n \"createdUserId\": 0,\n \"createdDate\": \"0001-01-01T00:00:00\",\n \"modifiedUserId\": 0,\n \"modifiedDate\": \"0001-01-01T00:00:00\",\n \"onlineBackFiling\": false,\n \"onlineAmendedReturns\": false,\n \"fileForAllOutlets\": false,\n \"paperFormsDoNotHaveDiscounts\": false,\n \"stackAggregation\": false,\n \"effDate\": \"2005-04-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"visibleToCustomers\": false,\n \"requiresOutletSetup\": false,\n \"achCreditAllowed\": false,\n \"postOfficeValidated\": false,\n \"filterZeroRatedLineDetails\": false,\n \"allowsBulkFilingAccounts\": false\n },\n {\n \"id\": 2415,\n \"formTypeId\": 0,\n \"legacyReturnName\": \"CABOE401A2\",\n \"taxFormName\": \"CA BOE 401 A2\",\n \"description\": \"State, Local, and District Sales and Use Tax Return\",\n \"isEffective\": true,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"dueDay\": 20,\n \"hasMultiFrequencies\": false,\n \"isPOARequired\": false,\n \"isRegistrationRequired\": false,\n \"hasMultiRegistrationMethods\": false,\n \"hasSchedules\": false,\n \"hasMultiFilingMethods\": false,\n \"hasMultiPayMethods\": false,\n \"isEFTRequired\": false,\n \"isFilePayMethodLinked\": false,\n \"mailingReceivedRuleId\": 0,\n \"proofOfMailingId\": 0,\n \"isNegAmountAllowed\": false,\n \"allowNegativeOverallTax\": false,\n \"isNettingRequired\": false,\n \"roundingMethodId\": 0,\n \"vendorDiscountAnnualMax\": 0,\n \"versionsRequireAuthorityApproval\": false,\n \"outletReportingMethodId\": 0,\n \"hasReportingCodes\": false,\n \"hasPrepayments\": false,\n \"grossIncludesInterstateSales\": false,\n \"hasEfileFee\": false,\n \"hasEpayFee\": false,\n \"hasDependencies\": false,\n \"vendorDiscountEfile\": false,\n \"vendorDiscountPaper\": false,\n \"createdUserId\": 0,\n \"createdDate\": \"0001-01-01T00:00:00\",\n \"modifiedUserId\": 0,\n \"modifiedDate\": \"0001-01-01T00:00:00\",\n \"onlineBackFiling\": false,\n \"onlineAmendedReturns\": false,\n \"fileForAllOutlets\": false,\n \"paperFormsDoNotHaveDiscounts\": false,\n \"stackAggregation\": false,\n \"effDate\": \"2005-04-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"visibleToCustomers\": false,\n \"requiresOutletSetup\": false,\n \"achCreditAllowed\": false,\n \"postOfficeValidated\": false,\n \"filterZeroRatedLineDetails\": false,\n \"allowsBulkFilingAccounts\": false\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "taxsubtypes", "item": [ { "name": "{jurisdictionCode}", "item": [ { "name": "{region}", "item": [ { "name": "Retrieve the full list of tax sub types by jurisdiction code and region", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/taxsubtypes/:jurisdictionCode/:region?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "taxsubtypes", ":jurisdictionCode", ":region" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/)." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "jurisdictionCode", "value": "string", "description": "The jurisdiction code of the tax sub type." }, { "key": "region", "value": "string", "description": "The region of the tax sub type." } ] }, "description": "Returns the full list of Avalara-supported tax sub-types by jurisdiction and region\r\nThis API is intended to be useful to identify all the different tax sub-types." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/taxsubtypes/:jurisdictionCode/:region?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "taxsubtypes", ":jurisdictionCode", ":region" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "jurisdictionCode", "value": "string", "description": "The jurisdiction code of the tax sub type." }, { "key": "region", "value": "string", "description": "The region of the tax sub type." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 9191,\n \"value\": [\n {\n \"description\": \"ALL\",\n \"id\": 1,\n \"taxSubType\": \"*\",\n \"taxTypeGroup\": \"string\"\n },\n {\n \"description\": \"ALL\",\n \"id\": 1,\n \"taxSubType\": \"*\",\n \"taxTypeGroup\": \"string\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] } ] }, { "name": "countries", "item": [ { "name": "{country}", "item": [ { "name": "taxtypes", "item": [ { "name": "{taxTypeId}", "item": [ { "name": "Retrieve the full list of tax sub types by Country and TaxType", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/taxsubtypes/countries/:country/taxtypes/:taxTypeId?companyId=451&$filter=string&$top=451&$skip=451&$orderBy=string&$scope=All", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "taxsubtypes", "countries", ":country", "taxtypes", ":taxTypeId" ], "query": [ { "key": "companyId", "value": "451", "description": "Id of the company the user wish to fetch the applicable tax sub types" }, { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/)." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." }, { "key": "$scope", "value": "All", "description": "Optional query parameter to filter by System, Custom or All tax sub types (default: System)" } ], "variable": [ { "key": "country", "value": "string", "description": "The country to examine for taxsubtype" }, { "key": "taxTypeId", "value": "string", "description": "The taxType for the country to examine for taxsubtype" } ] }, "description": "Returns the full list of Avalara-supported tax sub-types\r\nThis API is intended to be useful to identify all the different tax sub-types for given country and TaxType." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/taxsubtypes/countries/:country/taxtypes/:taxTypeId?companyId=451&$filter=string&$top=451&$skip=451&$orderBy=string&$scope=All", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "taxsubtypes", "countries", ":country", "taxtypes", ":taxTypeId" ], "query": [ { "description": "Id of the company the user wish to fetch the applicable tax sub types", "key": "companyId", "value": "451" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" }, { "description": "Optional query parameter to filter by System, Custom or All tax sub types (default: System)", "key": "$scope", "value": "All" } ], "variable": [ { "key": "country", "value": "string", "description": "The country to examine for taxsubtype" }, { "key": "taxTypeId", "value": "string", "description": "The taxType for the country to examine for taxsubtype" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 9191,\n \"value\": [\n {\n \"description\": \"ALL\",\n \"id\": 1,\n \"taxSubType\": \"*\",\n \"taxTypeGroup\": \"string\"\n },\n {\n \"description\": \"ALL\",\n \"id\": 1,\n \"taxSubType\": \"*\",\n \"taxTypeGroup\": \"string\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] } ] } ] } ] }, { "name": "Retrieve the full list of tax sub types", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/taxsubtypes?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "taxsubtypes" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/)." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Returns the full list of Avalara-supported tax sub-types\r\nThis API is intended to be useful to identify all the different tax sub-types." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/taxsubtypes?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "taxsubtypes" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 9191,\n \"value\": [\n {\n \"description\": \"ALL\",\n \"id\": 1,\n \"taxSubType\": \"*\",\n \"taxTypeGroup\": \"string\"\n },\n {\n \"description\": \"ALL\",\n \"id\": 1,\n \"taxSubType\": \"*\",\n \"taxTypeGroup\": \"string\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "taxtypegroups", "item": [ { "name": "Retrieve the full list of tax type groups", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/taxtypegroups?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "taxtypegroups" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* subscriptionTypeId, subscriptionDescription, tabName, showColumn, displaySequence" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Returns the full list of Avalara-supported tax type groups\r\nThis API is intended to be useful to identify all the different tax type groups." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/taxtypegroups?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "taxtypegroups" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* subscriptionTypeId, subscriptionDescription, tabName, showColumn, displaySequence", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 9177,\n \"value\": [\n {\n \"id\": 1,\n \"taxTypeGroup\": \"SalesAndUse\",\n \"description\": \"Sales and Use\",\n \"displaySequence\": 0\n },\n {\n \"id\": 1,\n \"taxTypeGroup\": \"SalesAndUse\",\n \"description\": \"Sales and Use\",\n \"displaySequence\": 0\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "taxtypes", "item": [ { "name": "countries", "item": [ { "name": "{country}", "item": [ { "name": "Retrieve the list of applicable TaxTypes", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/taxtypes/countries/:country?companyId=451&$top=451&$skip=451&$orderBy=string&$scope=All", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "taxtypes", "countries", ":country" ], "query": [ { "key": "companyId", "value": "451", "description": "Your companyId to retrieve the applicable taxtypes" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." }, { "key": "$scope", "value": "All", "description": "Optional query parameter to filter by System, Custom or All tax types (default: System)" } ], "variable": [ { "key": "country", "value": "string", "description": "The country for which you want to retrieve the unitofbasis information" } ] }, "description": "Retrieves the list of applicable TaxTypes based on Nexus of the company." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/taxtypes/countries/:country?companyId=451&$top=451&$skip=451&$orderBy=string&$scope=All", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "taxtypes", "countries", ":country" ], "query": [ { "description": "Your companyId to retrieve the applicable taxtypes", "key": "companyId", "value": "451" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" }, { "description": "Optional query parameter to filter by System, Custom or All tax types (default: System)", "key": "$scope", "value": "All" } ], "variable": [ { "key": "country", "value": "string", "description": "The country for which you want to retrieve the unitofbasis information" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 2012,\n \"value\": [\n {\n \"id\": 1,\n \"taxType\": \"Bottle\",\n \"description\": \"Bottle\"\n },\n {\n \"id\": 1,\n \"taxType\": \"Bottle\",\n \"description\": \"Bottle\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] } ] } ] }, { "name": "unitofbasis", "item": [ { "name": "countries", "item": [ { "name": "{country}", "item": [ { "name": "taxtypes", "item": [ { "name": "{taxTypeId}", "item": [ { "name": "taxsubtypes", "item": [ { "name": "{taxSubTypeId}", "item": [ { "name": "Retrieve the list of applicable UnitOfBasis", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/unitofbasis/countries/:country/taxtypes/:taxTypeId/taxsubtypes/:taxSubTypeId?rateTypeId=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "unitofbasis", "countries", ":country", "taxtypes", ":taxTypeId", "taxsubtypes", ":taxSubTypeId" ], "query": [ { "key": "rateTypeId", "value": "string", "description": "The ratetype for which you want to retrieve the unitofbasis information" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "country", "value": "string", "description": "The country for which you want to retrieve the unitofbasis information" }, { "key": "taxTypeId", "value": "string", "description": "The taxtype for which you want to retrieve the unitofbasis information" }, { "key": "taxSubTypeId", "value": "string", "description": "The taxsubtype for which you want to retrieve the unitofbasis information" } ] }, "description": "Retrieves the list of applicable UnitOfBasis" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/unitofbasis/countries/:country/taxtypes/:taxTypeId/taxsubtypes/:taxSubTypeId?rateTypeId=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "unitofbasis", "countries", ":country", "taxtypes", ":taxTypeId", "taxsubtypes", ":taxSubTypeId" ], "query": [ { "description": "The ratetype for which you want to retrieve the unitofbasis information", "key": "rateTypeId", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "country", "value": "string", "description": "The country for which you want to retrieve the unitofbasis information" }, { "key": "taxTypeId", "value": "string", "description": "The taxtype for which you want to retrieve the unitofbasis information" }, { "key": "taxSubTypeId", "value": "string", "description": "The taxsubtype for which you want to retrieve the unitofbasis information" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 6598,\n \"value\": [\n {\n \"unitOfBasisId\": 40,\n \"unitOfBasis\": \"NumberOfBulbs\",\n \"measurementTypeId\": 8,\n \"measurementTypeCode\": \"Quantity\",\n \"attributesUsed\": [\n \"PackSize\",\n \"Qty\"\n ],\n \"isFee\": true\n },\n {\n \"unitOfBasisId\": 40,\n \"unitOfBasis\": \"NumberOfBulbs\",\n \"measurementTypeId\": 8,\n \"measurementTypeCode\": \"Quantity\",\n \"attributesUsed\": [\n \"PackSize\",\n \"Qty\"\n ],\n \"isFee\": true\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] } ] } ] } ] } ] } ] }, { "name": "Retrieve the list of all valid unit of basis", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/unitofbasis?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "unitofbasis" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* attributesUsed" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/unitofbasis?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "unitofbasis" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* attributesUsed", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 6598,\n \"value\": [\n {\n \"unitOfBasisId\": 40,\n \"unitOfBasis\": \"NumberOfBulbs\",\n \"measurementTypeId\": 8,\n \"measurementTypeCode\": \"Quantity\",\n \"attributesUsed\": [\n \"PackSize\",\n \"Qty\"\n ],\n \"isFee\": true\n },\n {\n \"unitOfBasisId\": 40,\n \"unitOfBasis\": \"NumberOfBulbs\",\n \"measurementTypeId\": 8,\n \"measurementTypeCode\": \"Quantity\",\n \"attributesUsed\": [\n \"PackSize\",\n \"Qty\"\n ],\n \"isFee\": true\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] }, { "name": "unitofmeasurements", "item": [ { "name": "List all defined units of measurement", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/unitofmeasurements?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "unitofmeasurements" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* id" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "List all units of measurement systems defined by Avalara.\r\n \r\nA unit of measurement system is a method of measuring a quantity, such as distance, mass, or others." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/definitions/unitofmeasurements?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "definitions", "unitofmeasurements" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* id", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 1743,\n \"value\": [\n {\n \"id\": 2,\n \"code\": \"British thermal unit (International Table)\",\n \"shortDesc\": \"British thermal unit (International Table)\",\n \"description\": \"British thermal unit (International Table)\",\n \"measurementTypeId\": 1,\n \"measurementTypeCode\": \"Energy\",\n \"siUOM\": \"374\",\n \"measurementTypeDescription\": \"Energy\",\n \"isSiUom\": false\n },\n {\n \"id\": 2,\n \"code\": \"British thermal unit (International Table)\",\n \"shortDesc\": \"British thermal unit (International Table)\",\n \"description\": \"British thermal unit (International Table)\",\n \"measurementTypeId\": 1,\n \"measurementTypeCode\": \"Energy\",\n \"siUOM\": \"374\",\n \"measurementTypeDescription\": \"Energy\",\n \"isSiUom\": false\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] } ] }, { "name": "distancethresholds", "item": [ { "name": "Retrieve all DistanceThreshold objects", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/distancethresholds?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "distancethresholds" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/)." }, { "key": "$include", "value": "string", "description": "A comma separated list of additional data to retrieve." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Lists all DistanceThreshold objects that belong to this account.\r\n \r\nA company-distance-threshold model indicates the distance between a company\r\nand the taxing borders of various countries. Distance thresholds are necessary\r\nto correctly calculate some value-added taxes.\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/distancethresholds?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "distancethresholds" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 2482,\n \"value\": [\n {\n \"id\": 0,\n \"companyId\": 0,\n \"originCountry\": \"FR\",\n \"destinationCountry\": \"BR\",\n \"thresholdExceeded\": false,\n \"type\": \"Sale\"\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"originCountry\": \"FR\",\n \"destinationCountry\": \"BR\",\n \"thresholdExceeded\": false,\n \"type\": \"Sale\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/distancethresholds?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "distancethresholds" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/distancethresholds?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "distancethresholds" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "domain-control-verifications", "item": [ { "name": "{domainControlVerificationId}", "item": [ { "name": "Get domain control verification by domainControlVerificationId", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/domain-control-verifications/:domainControlVerificationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "domain-control-verifications", ":domainControlVerificationId" ], "variable": [ { "key": "domainControlVerificationId", "value": "string" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/domain-control-verifications/:domainControlVerificationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "domain-control-verifications", ":domainControlVerificationId" ], "variable": [ { "key": "domainControlVerificationId", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"645dd445811111\",\n \"domainName\": \"Test1.com\",\n \"context\": {\n \"id\": \"198763333\",\n \"system\": \"urn:avalara:systems:TestSystem\"\n },\n \"token\": \"CAD2ADBA071FFFFFFFFFFFFFFFFFFFFFFFFFF\",\n \"status\": \"VERIFIED\",\n \"emailId\": \"TestUser@avalara.com\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/domain-control-verifications/:domainControlVerificationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "domain-control-verifications", ":domainControlVerificationId" ], "variable": [ { "key": "domainControlVerificationId", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": 400,\n \"message\": \"The server cannot process the request due to something wrong at client side\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/domain-control-verifications/:domainControlVerificationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "domain-control-verifications", ":domainControlVerificationId" ], "variable": [ { "key": "domainControlVerificationId", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": 401,\n \"message\": \"The client is not authorized to perform this activity\"\n}" }, { "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/domain-control-verifications/:domainControlVerificationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "domain-control-verifications", ":domainControlVerificationId" ], "variable": [ { "key": "domainControlVerificationId", "value": "string" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": 403,\n \"message\": \"The client don't have enough permissions to execute the request\"\n}" }, { "name": "NotFound", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/domain-control-verifications/:domainControlVerificationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "domain-control-verifications", ":domainControlVerificationId" ], "variable": [ { "key": "domainControlVerificationId", "value": "string" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": 404,\n \"message\": \"No records matched with the search criteria\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/domain-control-verifications/:domainControlVerificationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "domain-control-verifications", ":domainControlVerificationId" ], "variable": [ { "key": "domainControlVerificationId", "value": "string" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": 500,\n \"message\": \"An exception occurred, please connect with support team for help\"\n}" } ] } ] }, { "name": "Create Domain control verification", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"domainName\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/domain-control-verifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "domain-control-verifications" ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"domainName\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/domain-control-verifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "domain-control-verifications" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"message\": \"Domain control verification created successfully\",\n \"dcvViewModel\": {\n \"id\": \"645dd445811111\",\n \"domainName\": \"Test1.com\",\n \"context\": {\n \"id\": \"198763333\",\n \"system\": \"urn:avalara:systems:TestSystem\"\n },\n \"token\": \"CAD2ADBA071FFFFFFFFFFFFFFFFFFFFFFFFFF\",\n \"status\": \"VERIFIED\",\n \"emailId\": \"TestUser@avalara.com\"\n }\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"domainName\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/domain-control-verifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "domain-control-verifications" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": 400,\n \"message\": \"The server cannot process the request due to something wrong at client side\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"domainName\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/domain-control-verifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "domain-control-verifications" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": 401,\n \"message\": \"The client is not authorized to perform this activity\"\n}" }, { "name": "Forbidden", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"domainName\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/domain-control-verifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "domain-control-verifications" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": 403,\n \"message\": \"The client don't have enough permissions to execute the request\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"domainName\": \"string\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/domain-control-verifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "domain-control-verifications" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": 500,\n \"message\": \"An exception occurred, please connect with support team for help\"\n}" } ] }, { "name": "Get domain control verifications by logged in user/domain name.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/domain-control-verifications?$filter=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "domain-control-verifications" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* Id, Context, Token, Status, EmailId" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/domain-control-verifications?$filter=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "domain-control-verifications" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* Id, Context, Token, Status, EmailId", "key": "$filter", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"domainName\": \"Test1.com\",\n \"context\": {\n \"system\": \"urn:avalara:systems:TestSystem\"\n },\n \"token\": \"CAD2ADBA071FFFFFFFFFFFFFFFFFFFFFFFFFF\",\n \"status\": \"VERIFIED\",\n \"emailId\": \"TestUser@avalara.com\"\n },\n {\n \"domainName\": \"Test1.com\",\n \"context\": {\n \"system\": \"urn:avalara:systems:TestSystem\"\n },\n \"token\": \"CAD2ADBA071FFFFFFFFFFFFFFFFFFFFFFFFFF\",\n \"status\": \"VERIFIED\",\n \"emailId\": \"TestUser@avalara.com\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/domain-control-verifications?$filter=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "domain-control-verifications" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* Id, Context, Token, Status, EmailId", "key": "$filter", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": 400,\n \"message\": \"The server cannot process the request due to something wrong at client side\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/domain-control-verifications?$filter=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "domain-control-verifications" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* Id, Context, Token, Status, EmailId", "key": "$filter", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": 401,\n \"message\": \"The client is not authorized to perform this activity\"\n}" }, { "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/domain-control-verifications?$filter=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "domain-control-verifications" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* Id, Context, Token, Status, EmailId", "key": "$filter", "value": "string" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": 403,\n \"message\": \"The client don't have enough permissions to execute the request\"\n}" }, { "name": "NotFound", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/domain-control-verifications?$filter=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "domain-control-verifications" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* Id, Context, Token, Status, EmailId", "key": "$filter", "value": "string" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": 404,\n \"message\": \"No records matched with the search criteria\"\n}" }, { "name": "Internal Server Error", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/domain-control-verifications?$filter=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "domain-control-verifications" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* Id, Context, Token, Status, EmailId", "key": "$filter", "value": "string" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": 500,\n \"message\": \"An exception occurred, please connect with support team for help\"\n}" } ] } ] }, { "name": "event-notifications", "item": [ { "name": "afc", "item": [ { "name": "Retrieve AFC event notifications", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/event-notifications/afc?isDlq=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "event-notifications", "afc" ], "query": [ { "key": "isDlq", "value": "false", "description": "Specify `true` to retrieve event notifications from the dead letter queue; otherwise, specify `false`." } ] }, "description": "\n\n### Security Policies\n\n* This API depends on the following active services:*Required* (all): ECMPremiumComms, ECMProComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/event-notifications/afc?isDlq=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "event-notifications", "afc" ], "query": [ { "description": "Specify `true` to retrieve event notifications from the dead letter queue; otherwise, specify `false`.", "key": "isDlq", "value": "false" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 4730,\n \"value\": [\n {\n \"body\": \"{'CertificateId':3797,'AvataxAccountId':2090523307,'AvataxCompanyId':3658868,'ClientId':112250,'Action':'update'}\",\n \"messageId\": \"af89d42c-1ca5-44b9-b7d3-8deb2d1a7c81\",\n \"receiptHandle\": \"AQEBrHAjW6HFye9RksJnZhnwBx4cHIxft7X7GVaL2bZBu2GkMdaVhqFiC5kunpK11grIhty5QVWJ3xdIs1cCjW6lxCM1hmsjllYU5TCo5LbIG/80nKSX+I2tejoo1TXGQDSIjFSeAp29UsiCEvyBnhxBnLChMY1VycqzEb0i2hhO/k7MsEkpjw6/NUfoGGuRQBatbUtc3bXl4dt2UQI6HGhbX7LwWfs8JVSavRkDapc3PqO8C0ox9ogxW7yUw8R54S8HFA6YalYjWLwtEgRILm0Ylqx25XmdipTyNq1gJdLy5LI=\"\n },\n {\n \"body\": \"{'CertificateId':3797,'AvataxAccountId':2090523307,'AvataxCompanyId':3658868,'ClientId':112250,'Action':'update'}\",\n \"messageId\": \"af89d42c-1ca5-44b9-b7d3-8deb2d1a7c81\",\n \"receiptHandle\": \"AQEBrHAjW6HFye9RksJnZhnwBx4cHIxft7X7GVaL2bZBu2GkMdaVhqFiC5kunpK11grIhty5QVWJ3xdIs1cCjW6lxCM1hmsjllYU5TCo5LbIG/80nKSX+I2tejoo1TXGQDSIjFSeAp29UsiCEvyBnhxBnLChMY1VycqzEb0i2hhO/k7MsEkpjw6/NUfoGGuRQBatbUtc3bXl4dt2UQI6HGhbX7LwWfs8JVSavRkDapc3PqO8C0ox9ogxW7yUw8R54S8HFA6YalYjWLwtEgRILm0Ylqx25XmdipTyNq1gJdLy5LI=\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/event-notifications/afc?isDlq=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "event-notifications", "afc" ], "query": [ { "description": "Specify `true` to retrieve event notifications from the dead letter queue; otherwise, specify `false`.", "key": "isDlq", "value": "false" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/event-notifications/afc?isDlq=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "event-notifications", "afc" ], "query": [ { "description": "Specify `true` to retrieve event notifications from the dead letter queue; otherwise, specify `false`.", "key": "isDlq", "value": "false" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/event-notifications/afc?isDlq=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "event-notifications", "afc" ], "query": [ { "description": "Specify `true` to retrieve event notifications from the dead letter queue; otherwise, specify `false`.", "key": "isDlq", "value": "false" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete AFC event notifications.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"eventDeleteBatchMessageCommands\": [\n {\n \"receiptHandle\": \"AQEBrHAjW6HFye9RksJnZhnwBx4cHIxft7X7GVaL2bZBu2GkMdaVhqFiC5kunpK11grIhty5QVWJ3xdIs1cCjW6lxCM1hmsjllYU5TCo5LbIG/80nKSX+I2tejoo1TXGQDSIjFSeAp29UsiCEvyBnhxBnLChMY1VycqzEb0i2hhO/k7MsEkpjw6/NUfoGGuRQBatbUtc3bXl4dt2UQI6HGhbX7LwWfs8JVSavRkDapc3PqO8C0ox9ogxW7yUw8R54S8HFA6YalYjWLwtEgRILm0Ylqx25XmdipTyNq1gJdLy5LI=\",\n \"messageId\": \"af89d42c-1ca5-44b9-b7d3-8deb2d1a7c81\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/event-notifications/afc?isDlq=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "event-notifications", "afc" ], "query": [ { "key": "isDlq", "value": "false", "description": "Specify `true` to delete event notifications from the dead letter queue; otherwise, specify `false`." } ] }, "description": "\n\n### Security Policies\n\n* This API depends on the following active services:*Required* (all): ECMPremiumComms, ECMProComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"eventDeleteBatchMessageCommands\": [\n {\n \"receiptHandle\": \"AQEBrHAjW6HFye9RksJnZhnwBx4cHIxft7X7GVaL2bZBu2GkMdaVhqFiC5kunpK11grIhty5QVWJ3xdIs1cCjW6lxCM1hmsjllYU5TCo5LbIG/80nKSX+I2tejoo1TXGQDSIjFSeAp29UsiCEvyBnhxBnLChMY1VycqzEb0i2hhO/k7MsEkpjw6/NUfoGGuRQBatbUtc3bXl4dt2UQI6HGhbX7LwWfs8JVSavRkDapc3PqO8C0ox9ogxW7yUw8R54S8HFA6YalYjWLwtEgRILm0Ylqx25XmdipTyNq1gJdLy5LI=\",\n \"messageId\": \"af89d42c-1ca5-44b9-b7d3-8deb2d1a7c81\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/event-notifications/afc?isDlq=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "event-notifications", "afc" ], "query": [ { "description": "Specify `true` to delete event notifications from the dead letter queue; otherwise, specify `false`.", "key": "isDlq", "value": "false" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 4730,\n \"value\": [\n {\n \"body\": \"{'CertificateId':3797,'AvataxAccountId':2090523307,'AvataxCompanyId':3658868,'ClientId':112250,'Action':'update'}\",\n \"messageId\": \"af89d42c-1ca5-44b9-b7d3-8deb2d1a7c81\",\n \"receiptHandle\": \"AQEBrHAjW6HFye9RksJnZhnwBx4cHIxft7X7GVaL2bZBu2GkMdaVhqFiC5kunpK11grIhty5QVWJ3xdIs1cCjW6lxCM1hmsjllYU5TCo5LbIG/80nKSX+I2tejoo1TXGQDSIjFSeAp29UsiCEvyBnhxBnLChMY1VycqzEb0i2hhO/k7MsEkpjw6/NUfoGGuRQBatbUtc3bXl4dt2UQI6HGhbX7LwWfs8JVSavRkDapc3PqO8C0ox9ogxW7yUw8R54S8HFA6YalYjWLwtEgRILm0Ylqx25XmdipTyNq1gJdLy5LI=\"\n },\n {\n \"body\": \"{'CertificateId':3797,'AvataxAccountId':2090523307,'AvataxCompanyId':3658868,'ClientId':112250,'Action':'update'}\",\n \"messageId\": \"af89d42c-1ca5-44b9-b7d3-8deb2d1a7c81\",\n \"receiptHandle\": \"AQEBrHAjW6HFye9RksJnZhnwBx4cHIxft7X7GVaL2bZBu2GkMdaVhqFiC5kunpK11grIhty5QVWJ3xdIs1cCjW6lxCM1hmsjllYU5TCo5LbIG/80nKSX+I2tejoo1TXGQDSIjFSeAp29UsiCEvyBnhxBnLChMY1VycqzEb0i2hhO/k7MsEkpjw6/NUfoGGuRQBatbUtc3bXl4dt2UQI6HGhbX7LwWfs8JVSavRkDapc3PqO8C0ox9ogxW7yUw8R54S8HFA6YalYjWLwtEgRILm0Ylqx25XmdipTyNq1gJdLy5LI=\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"eventDeleteBatchMessageCommands\": [\n {\n \"receiptHandle\": \"AQEBrHAjW6HFye9RksJnZhnwBx4cHIxft7X7GVaL2bZBu2GkMdaVhqFiC5kunpK11grIhty5QVWJ3xdIs1cCjW6lxCM1hmsjllYU5TCo5LbIG/80nKSX+I2tejoo1TXGQDSIjFSeAp29UsiCEvyBnhxBnLChMY1VycqzEb0i2hhO/k7MsEkpjw6/NUfoGGuRQBatbUtc3bXl4dt2UQI6HGhbX7LwWfs8JVSavRkDapc3PqO8C0ox9ogxW7yUw8R54S8HFA6YalYjWLwtEgRILm0Ylqx25XmdipTyNq1gJdLy5LI=\",\n \"messageId\": \"af89d42c-1ca5-44b9-b7d3-8deb2d1a7c81\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/event-notifications/afc?isDlq=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "event-notifications", "afc" ], "query": [ { "description": "Specify `true` to delete event notifications from the dead letter queue; otherwise, specify `false`.", "key": "isDlq", "value": "false" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"eventDeleteBatchMessageCommands\": [\n {\n \"receiptHandle\": \"AQEBrHAjW6HFye9RksJnZhnwBx4cHIxft7X7GVaL2bZBu2GkMdaVhqFiC5kunpK11grIhty5QVWJ3xdIs1cCjW6lxCM1hmsjllYU5TCo5LbIG/80nKSX+I2tejoo1TXGQDSIjFSeAp29UsiCEvyBnhxBnLChMY1VycqzEb0i2hhO/k7MsEkpjw6/NUfoGGuRQBatbUtc3bXl4dt2UQI6HGhbX7LwWfs8JVSavRkDapc3PqO8C0ox9ogxW7yUw8R54S8HFA6YalYjWLwtEgRILm0Ylqx25XmdipTyNq1gJdLy5LI=\",\n \"messageId\": \"af89d42c-1ca5-44b9-b7d3-8deb2d1a7c81\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/event-notifications/afc?isDlq=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "event-notifications", "afc" ], "query": [ { "description": "Specify `true` to delete event notifications from the dead letter queue; otherwise, specify `false`.", "key": "isDlq", "value": "false" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"eventDeleteBatchMessageCommands\": [\n {\n \"receiptHandle\": \"AQEBrHAjW6HFye9RksJnZhnwBx4cHIxft7X7GVaL2bZBu2GkMdaVhqFiC5kunpK11grIhty5QVWJ3xdIs1cCjW6lxCM1hmsjllYU5TCo5LbIG/80nKSX+I2tejoo1TXGQDSIjFSeAp29UsiCEvyBnhxBnLChMY1VycqzEb0i2hhO/k7MsEkpjw6/NUfoGGuRQBatbUtc3bXl4dt2UQI6HGhbX7LwWfs8JVSavRkDapc3PqO8C0ox9ogxW7yUw8R54S8HFA6YalYjWLwtEgRILm0Ylqx25XmdipTyNq1gJdLy5LI=\",\n \"messageId\": \"af89d42c-1ca5-44b9-b7d3-8deb2d1a7c81\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/event-notifications/afc?isDlq=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "event-notifications", "afc" ], "query": [ { "description": "Specify `true` to delete event notifications from the dead letter queue; otherwise, specify `false`.", "key": "isDlq", "value": "false" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "companies", "item": [ { "name": "{companyId}", "item": [ { "name": "Retrieve company event notifications.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/event-notifications/companies/:companyId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "event-notifications", "companies", ":companyId" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded these event notifications." } ] }, "description": "\n\n### Security Policies\n\n* This API depends on the following active services:*Required* (all): ECMPro, ECMPremium.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/event-notifications/companies/:companyId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "event-notifications", "companies", ":companyId" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded these event notifications." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 4730,\n \"value\": [\n {\n \"body\": \"{'CertificateId':3797,'AvataxAccountId':2090523307,'AvataxCompanyId':3658868,'ClientId':112250,'Action':'update'}\",\n \"messageId\": \"af89d42c-1ca5-44b9-b7d3-8deb2d1a7c81\",\n \"receiptHandle\": \"AQEBrHAjW6HFye9RksJnZhnwBx4cHIxft7X7GVaL2bZBu2GkMdaVhqFiC5kunpK11grIhty5QVWJ3xdIs1cCjW6lxCM1hmsjllYU5TCo5LbIG/80nKSX+I2tejoo1TXGQDSIjFSeAp29UsiCEvyBnhxBnLChMY1VycqzEb0i2hhO/k7MsEkpjw6/NUfoGGuRQBatbUtc3bXl4dt2UQI6HGhbX7LwWfs8JVSavRkDapc3PqO8C0ox9ogxW7yUw8R54S8HFA6YalYjWLwtEgRILm0Ylqx25XmdipTyNq1gJdLy5LI=\"\n },\n {\n \"body\": \"{'CertificateId':3797,'AvataxAccountId':2090523307,'AvataxCompanyId':3658868,'ClientId':112250,'Action':'update'}\",\n \"messageId\": \"af89d42c-1ca5-44b9-b7d3-8deb2d1a7c81\",\n \"receiptHandle\": \"AQEBrHAjW6HFye9RksJnZhnwBx4cHIxft7X7GVaL2bZBu2GkMdaVhqFiC5kunpK11grIhty5QVWJ3xdIs1cCjW6lxCM1hmsjllYU5TCo5LbIG/80nKSX+I2tejoo1TXGQDSIjFSeAp29UsiCEvyBnhxBnLChMY1VycqzEb0i2hhO/k7MsEkpjw6/NUfoGGuRQBatbUtc3bXl4dt2UQI6HGhbX7LwWfs8JVSavRkDapc3PqO8C0ox9ogxW7yUw8R54S8HFA6YalYjWLwtEgRILm0Ylqx25XmdipTyNq1gJdLy5LI=\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/event-notifications/companies/:companyId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "event-notifications", "companies", ":companyId" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded these event notifications." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/event-notifications/companies/:companyId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "event-notifications", "companies", ":companyId" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded these event notifications." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/event-notifications/companies/:companyId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "event-notifications", "companies", ":companyId" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded these event notifications." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete company event notifications", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"eventDeleteBatchMessageCommands\": [\n {\n \"receiptHandle\": \"AQEBrHAjW6HFye9RksJnZhnwBx4cHIxft7X7GVaL2bZBu2GkMdaVhqFiC5kunpK11grIhty5QVWJ3xdIs1cCjW6lxCM1hmsjllYU5TCo5LbIG/80nKSX+I2tejoo1TXGQDSIjFSeAp29UsiCEvyBnhxBnLChMY1VycqzEb0i2hhO/k7MsEkpjw6/NUfoGGuRQBatbUtc3bXl4dt2UQI6HGhbX7LwWfs8JVSavRkDapc3PqO8C0ox9ogxW7yUw8R54S8HFA6YalYjWLwtEgRILm0Ylqx25XmdipTyNq1gJdLy5LI=\",\n \"messageId\": \"af89d42c-1ca5-44b9-b7d3-8deb2d1a7c81\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/event-notifications/companies/:companyId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "event-notifications", "companies", ":companyId" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded these event notifications." } ] }, "description": "\n\n### Security Policies\n\n* This API depends on the following active services:*Required* (all): ECMPro, ECMPremium.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"eventDeleteBatchMessageCommands\": [\n {\n \"receiptHandle\": \"AQEBrHAjW6HFye9RksJnZhnwBx4cHIxft7X7GVaL2bZBu2GkMdaVhqFiC5kunpK11grIhty5QVWJ3xdIs1cCjW6lxCM1hmsjllYU5TCo5LbIG/80nKSX+I2tejoo1TXGQDSIjFSeAp29UsiCEvyBnhxBnLChMY1VycqzEb0i2hhO/k7MsEkpjw6/NUfoGGuRQBatbUtc3bXl4dt2UQI6HGhbX7LwWfs8JVSavRkDapc3PqO8C0ox9ogxW7yUw8R54S8HFA6YalYjWLwtEgRILm0Ylqx25XmdipTyNq1gJdLy5LI=\",\n \"messageId\": \"af89d42c-1ca5-44b9-b7d3-8deb2d1a7c81\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/event-notifications/companies/:companyId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "event-notifications", "companies", ":companyId" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded these event notifications." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 4730,\n \"value\": [\n {\n \"body\": \"{'CertificateId':3797,'AvataxAccountId':2090523307,'AvataxCompanyId':3658868,'ClientId':112250,'Action':'update'}\",\n \"messageId\": \"af89d42c-1ca5-44b9-b7d3-8deb2d1a7c81\",\n \"receiptHandle\": \"AQEBrHAjW6HFye9RksJnZhnwBx4cHIxft7X7GVaL2bZBu2GkMdaVhqFiC5kunpK11grIhty5QVWJ3xdIs1cCjW6lxCM1hmsjllYU5TCo5LbIG/80nKSX+I2tejoo1TXGQDSIjFSeAp29UsiCEvyBnhxBnLChMY1VycqzEb0i2hhO/k7MsEkpjw6/NUfoGGuRQBatbUtc3bXl4dt2UQI6HGhbX7LwWfs8JVSavRkDapc3PqO8C0ox9ogxW7yUw8R54S8HFA6YalYjWLwtEgRILm0Ylqx25XmdipTyNq1gJdLy5LI=\"\n },\n {\n \"body\": \"{'CertificateId':3797,'AvataxAccountId':2090523307,'AvataxCompanyId':3658868,'ClientId':112250,'Action':'update'}\",\n \"messageId\": \"af89d42c-1ca5-44b9-b7d3-8deb2d1a7c81\",\n \"receiptHandle\": \"AQEBrHAjW6HFye9RksJnZhnwBx4cHIxft7X7GVaL2bZBu2GkMdaVhqFiC5kunpK11grIhty5QVWJ3xdIs1cCjW6lxCM1hmsjllYU5TCo5LbIG/80nKSX+I2tejoo1TXGQDSIjFSeAp29UsiCEvyBnhxBnLChMY1VycqzEb0i2hhO/k7MsEkpjw6/NUfoGGuRQBatbUtc3bXl4dt2UQI6HGhbX7LwWfs8JVSavRkDapc3PqO8C0ox9ogxW7yUw8R54S8HFA6YalYjWLwtEgRILm0Ylqx25XmdipTyNq1gJdLy5LI=\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"eventDeleteBatchMessageCommands\": [\n {\n \"receiptHandle\": \"AQEBrHAjW6HFye9RksJnZhnwBx4cHIxft7X7GVaL2bZBu2GkMdaVhqFiC5kunpK11grIhty5QVWJ3xdIs1cCjW6lxCM1hmsjllYU5TCo5LbIG/80nKSX+I2tejoo1TXGQDSIjFSeAp29UsiCEvyBnhxBnLChMY1VycqzEb0i2hhO/k7MsEkpjw6/NUfoGGuRQBatbUtc3bXl4dt2UQI6HGhbX7LwWfs8JVSavRkDapc3PqO8C0ox9ogxW7yUw8R54S8HFA6YalYjWLwtEgRILm0Ylqx25XmdipTyNq1gJdLy5LI=\",\n \"messageId\": \"af89d42c-1ca5-44b9-b7d3-8deb2d1a7c81\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/event-notifications/companies/:companyId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "event-notifications", "companies", ":companyId" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded these event notifications." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"eventDeleteBatchMessageCommands\": [\n {\n \"receiptHandle\": \"AQEBrHAjW6HFye9RksJnZhnwBx4cHIxft7X7GVaL2bZBu2GkMdaVhqFiC5kunpK11grIhty5QVWJ3xdIs1cCjW6lxCM1hmsjllYU5TCo5LbIG/80nKSX+I2tejoo1TXGQDSIjFSeAp29UsiCEvyBnhxBnLChMY1VycqzEb0i2hhO/k7MsEkpjw6/NUfoGGuRQBatbUtc3bXl4dt2UQI6HGhbX7LwWfs8JVSavRkDapc3PqO8C0ox9ogxW7yUw8R54S8HFA6YalYjWLwtEgRILm0Ylqx25XmdipTyNq1gJdLy5LI=\",\n \"messageId\": \"af89d42c-1ca5-44b9-b7d3-8deb2d1a7c81\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/event-notifications/companies/:companyId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "event-notifications", "companies", ":companyId" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded these event notifications." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"eventDeleteBatchMessageCommands\": [\n {\n \"receiptHandle\": \"AQEBrHAjW6HFye9RksJnZhnwBx4cHIxft7X7GVaL2bZBu2GkMdaVhqFiC5kunpK11grIhty5QVWJ3xdIs1cCjW6lxCM1hmsjllYU5TCo5LbIG/80nKSX+I2tejoo1TXGQDSIjFSeAp29UsiCEvyBnhxBnLChMY1VycqzEb0i2hhO/k7MsEkpjw6/NUfoGGuRQBatbUtc3bXl4dt2UQI6HGhbX7LwWfs8JVSavRkDapc3PqO8C0ox9ogxW7yUw8R54S8HFA6YalYjWLwtEgRILm0Ylqx25XmdipTyNq1gJdLy5LI=\",\n \"messageId\": \"af89d42c-1ca5-44b9-b7d3-8deb2d1a7c81\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/event-notifications/companies/:companyId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "event-notifications", "companies", ":companyId" ], "variable": [ { "key": "companyId", "value": "451", "description": "The unique ID number of the company that recorded these event notifications." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] } ] }, { "name": "firmclientlinkages", "item": [ { "name": "{id}", "item": [ { "name": "approve", "item": [ { "name": "Approves linkage to a firm for a client account", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/:id/approve", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", ":id", "approve" ], "variable": [ { "key": "id", "value": "451" } ] }, "description": "This API enables the account admin of a client account to approve linkage request by a firm.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/:id/approve", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", ":id", "approve" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 123456,\n \"firmAccountId\": 23982571,\n \"firmAccountName\": \"Firm Account\",\n \"clientAccountId\": 24958289,\n \"clientAccountName\": \"Client Account\",\n \"createdDate\": \"2026-04-02T10:55:12.5206975+00:00\",\n \"createdUserId\": 213,\n \"modifiedDate\": \"2026-04-02T10:55:12.5206983+00:00\",\n \"modifiedUserId\": 213,\n \"status\": \"Requested\",\n \"isDeleted\": false\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/:id/approve", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", ":id", "approve" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/:id/approve", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", ":id", "approve" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/:id/approve", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", ":id", "approve" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "reject", "item": [ { "name": "Rejects linkage to a firm for a client account", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/:id/reject", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", ":id", "reject" ], "variable": [ { "key": "id", "value": "451" } ] }, "description": "This API enables the account admin of a client account to reject linkage request by a firm.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/:id/reject", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", ":id", "reject" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 123456,\n \"firmAccountId\": 23982571,\n \"firmAccountName\": \"Firm Account\",\n \"clientAccountId\": 24958289,\n \"clientAccountName\": \"Client Account\",\n \"createdDate\": \"2026-04-02T10:55:12.5206975+00:00\",\n \"createdUserId\": 213,\n \"modifiedDate\": \"2026-04-02T10:55:12.5206983+00:00\",\n \"modifiedUserId\": 213,\n \"status\": \"Requested\",\n \"isDeleted\": false\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/:id/reject", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", ":id", "reject" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/:id/reject", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", ":id", "reject" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/:id/reject", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", ":id", "reject" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "reset", "item": [ { "name": "Reset linkage status between a client and firm back to requested", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/:id/reset", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", ":id", "reset" ], "variable": [ { "key": "id", "value": "451" } ] }, "description": "This API enables the firm admin of a client account to reset a previously created linkage request by a firm.\n\n### Security Policies\n\n* This API requires one of the following user roles: BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/:id/reset", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", ":id", "reset" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 123456,\n \"firmAccountId\": 23982571,\n \"firmAccountName\": \"Firm Account\",\n \"clientAccountId\": 24958289,\n \"clientAccountName\": \"Client Account\",\n \"createdDate\": \"2026-04-02T10:55:12.5206975+00:00\",\n \"createdUserId\": 213,\n \"modifiedDate\": \"2026-04-02T10:55:12.5206983+00:00\",\n \"modifiedUserId\": 213,\n \"status\": \"Requested\",\n \"isDeleted\": false\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/:id/reset", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", ":id", "reset" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/:id/reset", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", ":id", "reset" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/:id/reset", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", ":id", "reset" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "revoke", "item": [ { "name": "Revokes previously approved linkage to a firm for a client account", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/:id/revoke", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", ":id", "revoke" ], "variable": [ { "key": "id", "value": "451" } ] }, "description": "This API enables the account admin of a client account to revoke a previously approved linkage request by a firm.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/:id/revoke", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", ":id", "revoke" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 123456,\n \"firmAccountId\": 23982571,\n \"firmAccountName\": \"Firm Account\",\n \"clientAccountId\": 24958289,\n \"clientAccountName\": \"Client Account\",\n \"createdDate\": \"2026-04-02T10:55:12.5206975+00:00\",\n \"createdUserId\": 213,\n \"modifiedDate\": \"2026-04-02T10:55:12.5206983+00:00\",\n \"modifiedUserId\": 213,\n \"status\": \"Requested\",\n \"isDeleted\": false\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/:id/revoke", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", ":id", "revoke" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/:id/revoke", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", ":id", "revoke" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/:id/revoke", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", ":id", "revoke" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Get linkage between a firm and client by id", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", ":id" ], "variable": [ { "key": "id", "value": "451" } ] }, "description": "This API enables the firm admins/firm users to request the linkage of a firm account and a client account.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", ":id" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 123456,\n \"firmAccountId\": 23982571,\n \"firmAccountName\": \"Firm Account\",\n \"clientAccountId\": 24958289,\n \"clientAccountName\": \"Client Account\",\n \"createdDate\": \"2026-04-02T10:55:12.5206975+00:00\",\n \"createdUserId\": 213,\n \"modifiedDate\": \"2026-04-02T10:55:12.5206983+00:00\",\n \"modifiedUserId\": 213,\n \"status\": \"Requested\",\n \"isDeleted\": false\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", ":id" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", ":id" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", ":id" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete a linkage", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", ":id" ], "variable": [ { "key": "id", "value": "451" } ] }, "description": "This API marks a linkage between a firm and client as deleted.\n\n### Security Policies\n\n* This API requires one of the following user roles: BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", ":id" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", ":id" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", ":id" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", ":id" ], "variable": [ { "key": "id", "value": "451" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "createandlinkclient", "item": [ { "name": "Request a new FirmClient account and create an approved linkage to it", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"accountName\": \"BizTech Company Inc.\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Example\",\n \"email\": \"bob@example.org\",\n \"companyCode\": \"DEFAULT\",\n \"companyAddress\": {\n \"line\": \"100 Ravine Ln\",\n \"region\": \"WA\",\n \"country\": \"US\",\n \"postalCode\": \"98010\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/createandlinkclient", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", "createandlinkclient" ] }, "description": "This API is for use by Firms only.\r\n \r\nAvalara allows firms to manage returns for clients without the clients needing to use AvaTax service.\r\nFirms can create accounts of FirmClient for customers they are managing using this API.\r\n \r\nCalling this API creates an account with the specified product subscriptions, but without a new user for account.\r\nAccount is then linked to the Firm so they can managed their returns.\r\nYou should call this API when a customer does not have an AvaTax account and is to be managed only by the firm.\r\n \r\nThe created account will be created in `Active` status but there will be no user or license key associated with account.\n\n### Security Policies\n\n* This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SystemAdmin.\n" }, "response": [ { "name": "Created", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"accountName\": \"BizTech Company Inc.\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Example\",\n \"email\": \"bob@example.org\",\n \"companyCode\": \"DEFAULT\",\n \"companyAddress\": {\n \"line\": \"100 Ravine Ln\",\n \"region\": \"WA\",\n \"country\": \"US\",\n \"postalCode\": \"98010\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/createandlinkclient", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", "createandlinkclient" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 123456,\n \"firmAccountId\": 23982571,\n \"firmAccountName\": \"Firm Account\",\n \"clientAccountId\": 24958289,\n \"clientAccountName\": \"Client Account\",\n \"createdDate\": \"2026-04-02T10:55:12.5206975+00:00\",\n \"createdUserId\": 213,\n \"modifiedDate\": \"2026-04-02T10:55:12.5206983+00:00\",\n \"modifiedUserId\": 213,\n \"status\": \"Requested\",\n \"isDeleted\": false\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"accountName\": \"BizTech Company Inc.\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Example\",\n \"email\": \"bob@example.org\",\n \"companyCode\": \"DEFAULT\",\n \"companyAddress\": {\n \"line\": \"100 Ravine Ln\",\n \"region\": \"WA\",\n \"country\": \"US\",\n \"postalCode\": \"98010\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/createandlinkclient", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", "createandlinkclient" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"accountName\": \"BizTech Company Inc.\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Example\",\n \"email\": \"bob@example.org\",\n \"companyCode\": \"DEFAULT\",\n \"companyAddress\": {\n \"line\": \"100 Ravine Ln\",\n \"region\": \"WA\",\n \"country\": \"US\",\n \"postalCode\": \"98010\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/createandlinkclient", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", "createandlinkclient" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "insert", "item": [ { "name": "Insert a full FirmClientLinkage record", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 123456,\n \"firmAccountId\": 23982571,\n \"firmAccountName\": \"Firm Account\",\n \"clientAccountId\": 24958289,\n \"clientAccountName\": \"Client Account\",\n \"createdDate\": \"2026-04-02T10:55:12.5756658+00:00\",\n \"createdUserId\": 213,\n \"modifiedDate\": \"2026-04-02T10:55:12.5756665+00:00\",\n \"modifiedUserId\": 213,\n \"status\": \"Requested\",\n \"isDeleted\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/insert", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", "insert" ] }, "description": "Avalara allows firms to manage returns for clients without the clients needing to use AvaTax service.\r\nFirms can create accounts of FirmClient for customers they are managing using this API.\n\n### Security Policies\n\n* This API requires one of the following user roles: BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Created", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 123456,\n \"firmAccountId\": 23982571,\n \"firmAccountName\": \"Firm Account\",\n \"clientAccountId\": 24958289,\n \"clientAccountName\": \"Client Account\",\n \"createdDate\": \"2026-04-02T10:55:12.5756658+00:00\",\n \"createdUserId\": 213,\n \"modifiedDate\": \"2026-04-02T10:55:12.5756665+00:00\",\n \"modifiedUserId\": 213,\n \"status\": \"Requested\",\n \"isDeleted\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/insert", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", "insert" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 123456,\n \"firmAccountId\": 23982571,\n \"firmAccountName\": \"Firm Account\",\n \"clientAccountId\": 24958289,\n \"clientAccountName\": \"Client Account\",\n \"createdDate\": \"2026-04-02T10:55:12.5206975+00:00\",\n \"createdUserId\": 213,\n \"modifiedDate\": \"2026-04-02T10:55:12.5206983+00:00\",\n \"modifiedUserId\": 213,\n \"status\": \"Requested\",\n \"isDeleted\": false\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 123456,\n \"firmAccountId\": 23982571,\n \"firmAccountName\": \"Firm Account\",\n \"clientAccountId\": 24958289,\n \"clientAccountName\": \"Client Account\",\n \"createdDate\": \"2026-04-02T10:55:12.5756658+00:00\",\n \"createdUserId\": 213,\n \"modifiedDate\": \"2026-04-02T10:55:12.5756665+00:00\",\n \"modifiedUserId\": 213,\n \"status\": \"Requested\",\n \"isDeleted\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/insert", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", "insert" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 123456,\n \"firmAccountId\": 23982571,\n \"firmAccountName\": \"Firm Account\",\n \"clientAccountId\": 24958289,\n \"clientAccountName\": \"Client Account\",\n \"createdDate\": \"2026-04-02T10:55:12.5756658+00:00\",\n \"createdUserId\": 213,\n \"modifiedDate\": \"2026-04-02T10:55:12.5756665+00:00\",\n \"modifiedUserId\": 213,\n \"status\": \"Requested\",\n \"isDeleted\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages/insert", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages", "insert" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "List client linkages for a firm or client", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages?$filter=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* firmAccountName, clientAccountName" } ] }, "description": "This API enables the firm or account users to request the associated linkages to the account.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages?$filter=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* firmAccountName, clientAccountName", "key": "$filter", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 9396,\n \"value\": [\n {\n \"id\": 123456,\n \"firmAccountId\": 23982571,\n \"firmAccountName\": \"Firm Account\",\n \"clientAccountId\": 24958289,\n \"clientAccountName\": \"Client Account\",\n \"createdDate\": \"2026-04-02T10:55:12.5206975+00:00\",\n \"createdUserId\": 213,\n \"modifiedDate\": \"2026-04-02T10:55:12.5206983+00:00\",\n \"modifiedUserId\": 213,\n \"status\": \"Requested\",\n \"isDeleted\": false\n },\n {\n \"id\": 123456,\n \"firmAccountId\": 23982571,\n \"firmAccountName\": \"Firm Account\",\n \"clientAccountId\": 24958289,\n \"clientAccountName\": \"Client Account\",\n \"createdDate\": \"2026-04-02T10:55:12.5206975+00:00\",\n \"createdUserId\": 213,\n \"modifiedDate\": \"2026-04-02T10:55:12.5206983+00:00\",\n \"modifiedUserId\": 213,\n \"status\": \"Requested\",\n \"isDeleted\": false\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages?$filter=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* firmAccountName, clientAccountName", "key": "$filter", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages?$filter=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* firmAccountName, clientAccountName", "key": "$filter", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Links a firm account with the client account", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"clientAccountId\": 24958289,\n \"clientAccountName\": \"client account\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages" ] }, "description": "This API enables the firm admins/firm users to request the linkage of a firm account and a client account.\n\n### Security Policies\n\n* This API requires one of the following user roles: BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Created", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"clientAccountId\": 24958289,\n \"clientAccountName\": \"client account\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 123456,\n \"firmAccountId\": 23982571,\n \"firmAccountName\": \"Firm Account\",\n \"clientAccountId\": 24958289,\n \"clientAccountName\": \"Client Account\",\n \"createdDate\": \"2026-04-02T10:55:12.5206975+00:00\",\n \"createdUserId\": 213,\n \"modifiedDate\": \"2026-04-02T10:55:12.5206983+00:00\",\n \"modifiedUserId\": 213,\n \"status\": \"Requested\",\n \"isDeleted\": false\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"clientAccountId\": 24958289,\n \"clientAccountName\": \"client account\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"clientAccountId\": 24958289,\n \"clientAccountName\": \"client account\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Update a full FirmClientLinkage record", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 123456,\n \"firmAccountId\": 23982571,\n \"firmAccountName\": \"Firm Account\",\n \"clientAccountId\": 24958289,\n \"clientAccountName\": \"Client Account\",\n \"createdDate\": \"2026-04-02T10:55:12.5756658+00:00\",\n \"createdUserId\": 213,\n \"modifiedDate\": \"2026-04-02T10:55:12.5756665+00:00\",\n \"modifiedUserId\": 213,\n \"status\": \"Requested\",\n \"isDeleted\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages" ] }, "description": "Avalara allow updating the firm client linkage as a pass thru call.\r\nFirms can create accounts of FirmClient for customers they are managing using this API.\n\n### Security Policies\n\n* This API requires one of the following user roles: BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Created", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 123456,\n \"firmAccountId\": 23982571,\n \"firmAccountName\": \"Firm Account\",\n \"clientAccountId\": 24958289,\n \"clientAccountName\": \"Client Account\",\n \"createdDate\": \"2026-04-02T10:55:12.5756658+00:00\",\n \"createdUserId\": 213,\n \"modifiedDate\": \"2026-04-02T10:55:12.5756665+00:00\",\n \"modifiedUserId\": 213,\n \"status\": \"Requested\",\n \"isDeleted\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 123456,\n \"firmAccountId\": 23982571,\n \"firmAccountName\": \"Firm Account\",\n \"clientAccountId\": 24958289,\n \"clientAccountName\": \"Client Account\",\n \"createdDate\": \"2026-04-02T10:55:12.5206975+00:00\",\n \"createdUserId\": 213,\n \"modifiedDate\": \"2026-04-02T10:55:12.5206983+00:00\",\n \"modifiedUserId\": 213,\n \"status\": \"Requested\",\n \"isDeleted\": false\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 123456,\n \"firmAccountId\": 23982571,\n \"firmAccountName\": \"Firm Account\",\n \"clientAccountId\": 24958289,\n \"clientAccountName\": \"Client Account\",\n \"createdDate\": \"2026-04-02T10:55:12.5756658+00:00\",\n \"createdUserId\": 213,\n \"modifiedDate\": \"2026-04-02T10:55:12.5756665+00:00\",\n \"modifiedUserId\": 213,\n \"status\": \"Requested\",\n \"isDeleted\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 123456,\n \"firmAccountId\": 23982571,\n \"firmAccountName\": \"Firm Account\",\n \"clientAccountId\": 24958289,\n \"clientAccountName\": \"Client Account\",\n \"createdDate\": \"2026-04-02T10:55:12.5756658+00:00\",\n \"createdUserId\": 213,\n \"modifiedDate\": \"2026-04-02T10:55:12.5756665+00:00\",\n \"modifiedUserId\": 213,\n \"status\": \"Requested\",\n \"isDeleted\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/firmclientlinkages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "firmclientlinkages" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "fundingrequests", "item": [ { "name": "{id}", "item": [ { "name": "widget", "item": [ { "name": "Request the javascript for a funding setup widget", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/fundingrequests/:id/widget?businessUnit=Telecom&subscriptionType=AvaComms¤cy=USD&agreementType=ACHDebit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "fundingrequests", ":id", "widget" ], "query": [ { "key": "businessUnit", "value": "Telecom", "description": "The company's business unit" }, { "key": "subscriptionType", "value": "AvaComms", "description": "The company's subscription type" }, { "key": "currency", "value": "USD", "description": "Currency" }, { "key": "agreementType", "value": "ACHDebit", "description": "Agreement Type" } ], "variable": [ { "key": "id", "value": "451", "description": "The unique ID number of this funding request" } ] }, "description": "This API is available by invitation only.\r\nCompanies that use the Avalara Managed Returns or the SST Certified Service Provider services are\r\nrequired to setup their funding configuration before Avalara can begin filing tax returns on their\r\nbehalf.\r\nFunding configuration for each company is set up by submitting a funding setup request, which can\r\nbe sent either via email or via an embedded HTML widget.\r\nWhen the funding configuration is submitted to Avalara, it will be reviewed by treasury team members\r\nbefore approval.\r\nThis API returns back the actual javascript code to insert into your application to render the\r\nJavaScript funding setup widget inline.\r\nUse the 'methodReturn.javaScript' return value to insert this widget into your HTML page.\r\nThis API requires a subscription to Avalara Managed Returns or SST Certified Service Provider.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n* This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/fundingrequests/:id/widget?businessUnit=Telecom&subscriptionType=AvaComms¤cy=USD&agreementType=ACHDebit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "fundingrequests", ":id", "widget" ], "query": [ { "description": "The company's business unit", "key": "businessUnit", "value": "Telecom" }, { "description": "The company's subscription type", "key": "subscriptionType", "value": "AvaComms" }, { "description": "Currency", "key": "currency", "value": "USD" }, { "description": "Agreement Type", "key": "agreementType", "value": "ACHDebit" } ], "variable": [ { "key": "id", "value": "451", "description": "The unique ID number of this funding request" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"requestId\": 12345,\n \"subledgerProfileID\": 12345,\n \"companyID\": \"123456\",\n \"domain\": \"AvaTax15\",\n \"recipient\": \"bob@example.org\",\n \"sender\": \"treasury@avalara.com\",\n \"documentKey\": \"RTdIy3AAABLblqZhBCV9kul4F1qC -\",\n \"documentType\": \"ACH\",\n \"documentName\": \"New Customer - Avalara Returns Funding Power of Attorney\",\n \"methodReturn\": {\n \"javaScriptReady\": false\n },\n \"status\": \"Expired\",\n \"lastPolled\": \"2016-01-01T20:16:17\",\n \"lastActivated\": \"2016-01-01T19:16:17\",\n \"currency\": \"USD\",\n \"agreementType\": \"ACHDebit\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/fundingrequests/:id/widget?businessUnit=Telecom&subscriptionType=AvaComms¤cy=USD&agreementType=ACHDebit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "fundingrequests", ":id", "widget" ], "query": [ { "description": "The company's business unit", "key": "businessUnit", "value": "Telecom" }, { "description": "The company's subscription type", "key": "subscriptionType", "value": "AvaComms" }, { "description": "Currency", "key": "currency", "value": "USD" }, { "description": "Agreement Type", "key": "agreementType", "value": "ACHDebit" } ], "variable": [ { "key": "id", "value": "451", "description": "The unique ID number of this funding request" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/fundingrequests/:id/widget?businessUnit=Telecom&subscriptionType=AvaComms¤cy=USD&agreementType=ACHDebit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "fundingrequests", ":id", "widget" ], "query": [ { "description": "The company's business unit", "key": "businessUnit", "value": "Telecom" }, { "description": "The company's subscription type", "key": "subscriptionType", "value": "AvaComms" }, { "description": "Currency", "key": "currency", "value": "USD" }, { "description": "Agreement Type", "key": "agreementType", "value": "ACHDebit" } ], "variable": [ { "key": "id", "value": "451", "description": "The unique ID number of this funding request" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/fundingrequests/:id/widget?businessUnit=Telecom&subscriptionType=AvaComms¤cy=USD&agreementType=ACHDebit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "fundingrequests", ":id", "widget" ], "query": [ { "description": "The company's business unit", "key": "businessUnit", "value": "Telecom" }, { "description": "The company's subscription type", "key": "subscriptionType", "value": "AvaComms" }, { "description": "Currency", "key": "currency", "value": "USD" }, { "description": "Agreement Type", "key": "agreementType", "value": "ACHDebit" } ], "variable": [ { "key": "id", "value": "451", "description": "The unique ID number of this funding request" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Retrieve status about a funding setup request", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/fundingrequests/:id?businessUnit=Telecom&subscriptionType=AvaComms", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "fundingrequests", ":id" ], "query": [ { "key": "businessUnit", "value": "Telecom", "description": "The company's business unit" }, { "key": "subscriptionType", "value": "AvaComms", "description": "The company's subscription type" } ], "variable": [ { "key": "id", "value": "451", "description": "The unique ID number of this funding request" } ] }, "description": "This API is available by invitation only.\r\nCompanies that use the Avalara Managed Returns or the SST Certified Service Provider services are\r\nrequired to setup their funding configuration before Avalara can begin filing tax returns on their\r\nbehalf.\r\nFunding configuration for each company is set up by submitting a funding setup request, which can\r\nbe sent either via email or via an embedded HTML widget.\r\nWhen the funding configuration is submitted to Avalara, it will be reviewed by treasury team members\r\nbefore approval.\r\nThis API checks the status on an existing funding request.\r\nThis API requires a subscription to Avalara Managed Returns or SST Certified Service Provider.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n* This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/fundingrequests/:id?businessUnit=Telecom&subscriptionType=AvaComms", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "fundingrequests", ":id" ], "query": [ { "description": "The company's business unit", "key": "businessUnit", "value": "Telecom" }, { "description": "The company's subscription type", "key": "subscriptionType", "value": "AvaComms" } ], "variable": [ { "key": "id", "value": "451", "description": "The unique ID number of this funding request" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"requestId\": 12345,\n \"subledgerProfileID\": 12345,\n \"companyID\": \"123456\",\n \"domain\": \"AvaTax15\",\n \"recipient\": \"bob@example.org\",\n \"sender\": \"treasury@avalara.com\",\n \"documentKey\": \"RTdIy3AAABLblqZhBCV9kul4F1qC -\",\n \"documentType\": \"ACH\",\n \"documentName\": \"New Customer - Avalara Returns Funding Power of Attorney\",\n \"methodReturn\": {\n \"javaScriptReady\": false\n },\n \"status\": \"Expired\",\n \"lastPolled\": \"2016-01-01T20:16:17\",\n \"lastActivated\": \"2016-01-01T19:16:17\",\n \"currency\": \"USD\",\n \"agreementType\": \"ACHDebit\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/fundingrequests/:id?businessUnit=Telecom&subscriptionType=AvaComms", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "fundingrequests", ":id" ], "query": [ { "description": "The company's business unit", "key": "businessUnit", "value": "Telecom" }, { "description": "The company's subscription type", "key": "subscriptionType", "value": "AvaComms" } ], "variable": [ { "key": "id", "value": "451", "description": "The unique ID number of this funding request" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/fundingrequests/:id?businessUnit=Telecom&subscriptionType=AvaComms", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "fundingrequests", ":id" ], "query": [ { "description": "The company's business unit", "key": "businessUnit", "value": "Telecom" }, { "description": "The company's subscription type", "key": "subscriptionType", "value": "AvaComms" } ], "variable": [ { "key": "id", "value": "451", "description": "The unique ID number of this funding request" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/fundingrequests/:id?businessUnit=Telecom&subscriptionType=AvaComms", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "fundingrequests", ":id" ], "query": [ { "description": "The company's business unit", "key": "businessUnit", "value": "Telecom" }, { "description": "The company's subscription type", "key": "subscriptionType", "value": "AvaComms" } ], "variable": [ { "key": "id", "value": "451", "description": "The unique ID number of this funding request" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "items", "item": [ { "name": "Retrieve all items", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/items?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "items" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, customParameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations, taxCodeDetails, hsCodeClassificationStatus, image" }, { "key": "$include", "value": "string", "description": "A comma separated list of additional data to retrieve." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Get multiple item objects across all companies.\r\n \r\nItems are a way of separating your tax calculation process from your tax configuration details. If you choose, you\r\ncan provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions,\r\nand other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters\r\nfrom the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance\r\nteam can manage your item catalog and adjust the tax behavior of items without having to modify your software.\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\n \r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/items?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "items" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, customParameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations, taxCodeDetails, hsCodeClassificationStatus, image", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 16,\n \"value\": [\n {\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CERMUG\",\n \"taxCode\": \"P0000000\",\n \"description\": \"Ceramic Mug\",\n \"itemGroup\": \"Mugs\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"source\": \"MTCC\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ],\n \"properties\": {\n \"color\": \"white\"\n }\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"itemCode\": \"CERMUG\",\n \"taxCode\": \"P0000000\",\n \"description\": \"Ceramic Mug\",\n \"itemGroup\": \"Mugs\",\n \"category\": \"Home > Kitchen > Mugs\",\n \"source\": \"MTCC\",\n \"classifications\": [\n {\n \"id\": 12212,\n \"productCode\": \"9011900000\",\n \"systemCode\": \"TARIC\",\n \"country\": \"DE\",\n \"isPremium\": false\n }\n ],\n \"parameters\": [\n {\n \"id\": 0,\n \"name\": \"ScreenSize\",\n \"value\": \"24\",\n \"unit\": \"inch\"\n },\n {\n \"id\": 0,\n \"name\": \"UPC\",\n \"value\": \"123456789012\"\n },\n {\n \"id\": 0,\n \"name\": \"Summary\",\n \"value\": \"Ceramic mugs are popular vessels for enjoying hot beverages like coffee, tea, or hot chocolate. They're made from clay that's fired at high temperatures, which gives them durability and heat retention properties\"\n }\n ],\n \"customParameters\": [\n {\n \"id\": 0,\n \"name\": \"Material Used\",\n \"value\": \"Nylon\"\n }\n ],\n \"properties\": {\n \"color\": \"white\"\n }\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/items?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "items" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, customParameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations, taxCodeDetails, hsCodeClassificationStatus, image", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/items?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "items" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, customParameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations, taxCodeDetails, hsCodeClassificationStatus, image", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "jurisdictionoverrides", "item": [ { "name": "Retrieve all overrides", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/jurisdictionoverrides?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "jurisdictionoverrides" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* country, Jurisdictions" }, { "key": "$include", "value": "string", "description": "A comma separated list of additional data to retrieve." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Get multiple jurisdiction override objects across all companies.\r\n \r\nA Jurisdiction Override is a configuration setting that allows you to select the taxing\r\njurisdiction for a specific address. If you encounter an address that is on the boundary\r\nbetween two different jurisdictions, you can choose to set up a jurisdiction override\r\nto switch this address to use different taxing jurisdictions.\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/jurisdictionoverrides?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "jurisdictionoverrides" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* country, Jurisdictions", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 4339,\n \"value\": [\n {\n \"description\": \"a test JO\",\n \"jurisdictions\": [\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 7434.001262750061,\n \"salesRate\": 157.10809959449844,\n \"region\": \"AR\",\n \"useRate\": 3116.1549977000714,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true,\n \"createDate\": \"2022-07-21T11:54:06.283Z\",\n \"isLocalAdmin\": false,\n \"modifiedDate\": \"0001-01-01T00:00:00\",\n \"taxAuthorityTypeId\": 1930\n },\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 6893.114877833215,\n \"salesRate\": 1388.7288213531801,\n \"region\": \"AR\",\n \"useRate\": 8819.808735847833,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true,\n \"createDate\": \"2015-03-31T01:57:48.787Z\",\n \"isLocalAdmin\": false,\n \"modifiedDate\": \"0001-01-01T00:00:00\",\n \"taxAuthorityTypeId\": 4031\n }\n ],\n \"postalCode\": \"92618\",\n \"region\": \"CA\",\n \"taxRegionId\": 0,\n \"id\": 0,\n \"accountId\": 0,\n \"line1\": \"5500 Irvine Center Dr\",\n \"city\": \"Irvine\",\n \"country\": \"US\",\n \"effectiveDate\": \"1975-09-07\",\n \"endDate\": \"1951-02-22\",\n \"createdDate\": \"1981-04-21T06:15:33.985Z\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2015-01-04T01:39:29.948Z\",\n \"modifiedUserId\": 0,\n \"boundaryLevel\": \"Address\",\n \"isDefault\": true\n },\n {\n \"description\": \"a test JO\",\n \"jurisdictions\": [\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 5103.872027961538,\n \"salesRate\": 9688.552832697666,\n \"region\": \"AR\",\n \"useRate\": 7145.500234004396,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true,\n \"createDate\": \"1952-12-06T04:55:22.594Z\",\n \"isLocalAdmin\": true,\n \"modifiedDate\": \"0001-01-01T00:00:00\",\n \"taxAuthorityTypeId\": 1053\n },\n {\n \"code\": \"075\",\n \"name\": \"LAWRENCE\",\n \"signatureCode\": \"string\",\n \"type\": \"Country\",\n \"rate\": 8997.610989995706,\n \"salesRate\": 6515.321052544796,\n \"region\": \"AR\",\n \"useRate\": 7832.759133100276,\n \"city\": \"string\",\n \"county\": \"LAWRENCE\",\n \"country\": \"US\",\n \"shortName\": \"LAWRENCE\",\n \"stateFips\": \"05\",\n \"countyFips\": \"075\",\n \"placeFips\": \"string\",\n \"id\": 5075,\n \"effectiveDate\": \"1999-09-01T00:00:00\",\n \"endDate\": \"9999-12-31T00:00:00\",\n \"isAcm\": true,\n \"isSst\": true,\n \"createDate\": \"1968-08-11T15:23:10.914Z\",\n \"isLocalAdmin\": false,\n \"modifiedDate\": \"0001-01-01T00:00:00\",\n \"taxAuthorityTypeId\": 9463\n }\n ],\n \"postalCode\": \"92618\",\n \"region\": \"CA\",\n \"taxRegionId\": 0,\n \"id\": 0,\n \"accountId\": 0,\n \"line1\": \"5500 Irvine Center Dr\",\n \"city\": \"Irvine\",\n \"country\": \"US\",\n \"effectiveDate\": \"2007-08-28\",\n \"endDate\": \"1981-01-26\",\n \"createdDate\": \"1957-10-28T20:47:07.758Z\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2018-06-22T23:27:36.684Z\",\n \"modifiedUserId\": 0,\n \"boundaryLevel\": \"Address\",\n \"isDefault\": true\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/jurisdictionoverrides?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "jurisdictionoverrides" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* country, Jurisdictions", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/jurisdictionoverrides?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "jurisdictionoverrides" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* country, Jurisdictions", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/jurisdictionoverrides?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "jurisdictionoverrides" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* country, Jurisdictions", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "locations", "item": [ { "name": "Retrieve all locations", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/locations?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "locations" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* isMarketplaceOutsideUsa, settings, parameters" }, { "key": "$include", "value": "string", "description": "A comma separated list of additional data to retrieve. You may specify `LocationSettings` to retrieve location settings." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Get multiple location objects across all companies.\r\nAn 'Location' represents a physical address where a company does business.\r\nMany taxing authorities require that you define a list of all locations where your company does business.\r\nThese locations may require additional custom configuration or tax registration with these authorities.\r\nFor more information on metadata requirements, see the '/api/v2/definitions/locationquestions' API.\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\r\n \r\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:\r\n \r\n* LocationSettings\r\n* parameters\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/locations?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "locations" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* isMarketplaceOutsideUsa, settings, parameters", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve. You may specify `LocationSettings` to retrieve location settings.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 6355,\n \"value\": [\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"locationCode\": \"DEFAULT\",\n \"description\": \"Bob's Artisan Pottery\",\n \"addressTypeId\": \"Location\",\n \"addressCategoryId\": \"MainOffice\",\n \"isMarketplaceOutsideUsa\": false,\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"county\": \"Orange\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"latitude\": 33.6846,\n \"longitude\": -117.8265,\n \"isDefault\": true,\n \"isRegistered\": true,\n \"dbaName\": \"Bob's Artisan Pottery\",\n \"outletName\": \"Main Office\",\n \"registeredDate\": \"2015-01-01T00:00:00\",\n \"settings\": [\n {\n \"questionId\": 17,\n \"value\": \"abcdefghij\"\n }\n ]\n },\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"locationCode\": \"DEFAULT\",\n \"description\": \"Bob's Artisan Pottery\",\n \"addressTypeId\": \"Location\",\n \"addressCategoryId\": \"MainOffice\",\n \"isMarketplaceOutsideUsa\": false,\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"county\": \"Orange\",\n \"region\": \"CA\",\n \"postalCode\": \"92614\",\n \"country\": \"US\",\n \"latitude\": 33.6846,\n \"longitude\": -117.8265,\n \"isDefault\": true,\n \"isRegistered\": true,\n \"dbaName\": \"Bob's Artisan Pottery\",\n \"outletName\": \"Main Office\",\n \"registeredDate\": \"2015-01-01T00:00:00\",\n \"settings\": [\n {\n \"questionId\": 17,\n \"value\": \"abcdefghij\"\n }\n ]\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/locations?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "locations" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* isMarketplaceOutsideUsa, settings, parameters", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve. You may specify `LocationSettings` to retrieve location settings.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/locations?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "locations" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* isMarketplaceOutsideUsa, settings, parameters", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve. You may specify `LocationSettings` to retrieve location settings.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "transactions", "item": [ { "name": "multidocument", "item": [ { "name": "{code}", "item": [ { "name": "type", "item": [ { "name": "{type}", "item": [ { "name": "adjust", "item": [ { "name": "Adjust a MultiDocument transaction", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"adjustmentReason\": \"PriceAdjusted\",\n \"adjustDescription\": \"Price was dropped.\",\n \"newTransaction\": {\n \"lines\": [\n {\n \"companyCode\": \"DEFAULT\",\n \"reportingLocationCode\": \"ReportLocation111\",\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 100,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/:code/type/:type/adjust?include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", ":code", "type", ":type", "adjust" ], "query": [ { "key": "include", "value": "string", "description": "Specifies objects to include in this fetch call" } ], "variable": [ { "key": "code", "value": "string", "description": "The transaction code for this MultiDocument transaction" }, { "key": "type", "value": "PurchaseOrder", "description": "The transaction type for this MultiDocument transaction" } ] }, "description": "Adjusts the current MultiDocument transaction uniquely identified by this URL.\r\n \r\nA transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\r\nsales, purchases, inventory transfer, and returns (also called refunds).\r\n \r\nWhen you adjust a transaction, that transaction's status is recorded as `Adjusted`.\r\n \r\nBoth 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.\r\n \r\nTransactions that have been previously reported to a tax authority by Avalara Managed Returns are considered locked and are no longer available for adjustments.\r\n \r\nNOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:\r\n* Replace '/' with '\\_-ava2f-\\_' For example: document/Code becomes document_-ava2f-_Code\r\n* Replace '+' with '\\_-ava2b-\\_' For example: document+Code becomes document_-ava2b-_Code\r\n* Replace '?' with '\\_-ava3f-\\_' For example: document?Code becomes document_-ava3f-_Code\r\n* Replace '%' with '\\_-ava25-\\_' For example: document%Code becomes document_-ava25-_Code\r\n* Replace '#' with '\\_-ava23-\\_' For example: document#Code becomes document_-ava23-_Code\r\n* Replace ' ' with '%20' For example: document Code becomes document%20Code\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"adjustmentReason\": \"PriceAdjusted\",\n \"adjustDescription\": \"Price was dropped.\",\n \"newTransaction\": {\n \"lines\": [\n {\n \"companyCode\": \"DEFAULT\",\n \"reportingLocationCode\": \"ReportLocation111\",\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 100,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/:code/type/:type/adjust?include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", ":code", "type", ":type", "adjust" ], "query": [ { "description": "Specifies objects to include in this fetch call", "key": "include", "value": "string" } ], "variable": [ { "key": "code", "value": "string", "description": "The transaction code for this MultiDocument transaction" }, { "key": "type", "value": "PurchaseOrder", "description": "The transaction type for this MultiDocument transaction" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 12,\n \"accountId\": 123456,\n \"code\": \"9e199121-684c-4628-88af-477100699e0f\",\n \"type\": \"SalesInvoice\",\n \"createdUserId\": 87954,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 66783,\n \"documents\": [\n {\n \"id\": 123456789,\n \"code\": \"b994b117-f788-41a0-a1bf-3aa22e1aba00\",\n \"companyId\": 12345,\n \"date\": \"2026-04-02\",\n \"status\": \"Committed\",\n \"type\": \"SalesInvoice\",\n \"currencyCode\": \"USD\",\n \"exchangeRateCurrencyCode\": \"USD\",\n \"entityUseCode\": \"\",\n \"customerVendorCode\": \"ABC\",\n \"customerCode\": \"ABC\",\n \"exemptNo\": \"\",\n \"reconciled\": true,\n \"locationCode\": \"DEFAULT\",\n \"salespersonCode\": \"DEF\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"totalAmount\": 1000,\n \"totalExempt\": 0,\n \"totalDiscount\": 0,\n \"totalTax\": 62.5,\n \"totalTaxable\": 1000,\n \"totalTaxCalculated\": 62.5,\n \"adjustmentReason\": \"NotAdjusted\",\n \"adjustmentDescription\": \"\",\n \"locked\": false,\n \"region\": \"CA\",\n \"country\": \"US\",\n \"version\": 0,\n \"originAddressId\": 123456789,\n \"destinationAddressId\": 123456789,\n \"exchangeRateEffectiveDate\": \"2026-04-02\",\n \"exchangeRate\": 2,\n \"isSellerImporterOfRecord\": false,\n \"description\": \"Yarn\",\n \"taxDate\": \"2026-04-02T00:00:00+00:00\",\n \"lines\": [\n {\n \"id\": 123456789,\n \"transactionId\": 123456789,\n \"lineNumber\": \"1\",\n \"boundaryOverrideId\": 0,\n \"entityUseCode\": \"\",\n \"description\": \"Yarn\",\n \"destinationAddressId\": 12345,\n \"originAddressId\": 123456789,\n \"discountAmount\": 100,\n \"discountTypeId\": 0,\n \"exemptAmount\": 0,\n \"exemptCertId\": 0,\n \"exemptNo\": \"\",\n \"isItemTaxable\": true,\n \"isSSTP\": false,\n \"itemCode\": \"116292\",\n \"lineAmount\": 1000,\n \"quantity\": 1,\n \"ref1\": \"Note: Deliver to Bob\",\n \"reportingDate\": \"2026-04-02\",\n \"revAccount\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxCalculated\": 62.5,\n \"taxCode\": \"PS081282\",\n \"taxDate\": \"2026-04-02\",\n \"taxEngine\": \"\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"taxIncluded\": false,\n \"details\": [\n {\n \"id\": 123456789,\n \"transactionLineId\": 123456789,\n \"transactionId\": 123456789,\n \"addressId\": 12345,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"stateFIPS\": \"06\",\n \"exemptAmount\": 0,\n \"exemptReasonId\": 4,\n \"exemptRuleId\": 0,\n \"inState\": false,\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"jurisdictionId\": 5000531,\n \"signatureCode\": \"AGAM\",\n \"stateAssignedNo\": \"\",\n \"jurisType\": \"STA\",\n \"nonTaxableAmount\": 0,\n \"nonTaxableRuleId\": 0,\n \"nonTaxableType\": \"BaseRule\",\n \"rate\": 0.0625,\n \"rateRuleId\": 1321915,\n \"rateSourceId\": 3,\n \"serCode\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxType\": \"Sales\",\n \"taxName\": \"CA STATE TAX\",\n \"taxAuthorityTypeId\": 45,\n \"taxRegionId\": 2127184,\n \"taxCalculated\": 62.5,\n \"taxOverride\": 0,\n \"rateType\": \"General\",\n \"taxableUnits\": 62.5,\n \"nonTaxableUnits\": 1000,\n \"exemptUnits\": 62.5,\n \"reportingTaxableUnits\": 125,\n \"reportingNonTaxableUnits\": 2000,\n \"reportingExemptUnits\": 125,\n \"reportingTax\": 125,\n \"reportingTaxCalculated\": 125,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0,\n \"vatCode\": \"\",\n \"granularDutyDetails\": [\n {\n \"dutyType\": \"ImportDuty\",\n \"rate\": \"10.5\",\n \"amount\": \"105.00\"\n }\n ]\n }\n ],\n \"vatNumberTypeId\": 0,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0\n }\n ],\n \"addresses\": [\n {\n \"id\": 0,\n \"transactionId\": 0,\n \"boundaryLevel\": \"Address\",\n \"line1\": \"100 Ravine Lane Northeast #220\",\n \"city\": \"Bainbridge Island\",\n \"region\": \"WA\",\n \"postalCode\": \"98110\",\n \"country\": \"US\",\n \"taxRegionId\": 0\n }\n ],\n \"taxDetailsByTaxType\": [\n {\n \"taxType\": \"SalesAndUse\",\n \"totalTaxable\": 100,\n \"totalExempt\": 0.05,\n \"totalNonTaxable\": 0,\n \"totalTax\": 0.625\n }\n ]\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"adjustmentReason\": \"PriceAdjusted\",\n \"adjustDescription\": \"Price was dropped.\",\n \"newTransaction\": {\n \"lines\": [\n {\n \"companyCode\": \"DEFAULT\",\n \"reportingLocationCode\": \"ReportLocation111\",\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 100,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/:code/type/:type/adjust?include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", ":code", "type", ":type", "adjust" ], "query": [ { "description": "Specifies objects to include in this fetch call", "key": "include", "value": "string" } ], "variable": [ { "key": "code", "value": "string", "description": "The transaction code for this MultiDocument transaction" }, { "key": "type", "value": "PurchaseOrder", "description": "The transaction type for this MultiDocument transaction" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"adjustmentReason\": \"PriceAdjusted\",\n \"adjustDescription\": \"Price was dropped.\",\n \"newTransaction\": {\n \"lines\": [\n {\n \"companyCode\": \"DEFAULT\",\n \"reportingLocationCode\": \"ReportLocation111\",\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 100,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/:code/type/:type/adjust?include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", ":code", "type", ":type", "adjust" ], "query": [ { "description": "Specifies objects to include in this fetch call", "key": "include", "value": "string" } ], "variable": [ { "key": "code", "value": "string", "description": "The transaction code for this MultiDocument transaction" }, { "key": "type", "value": "PurchaseOrder", "description": "The transaction type for this MultiDocument transaction" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"adjustmentReason\": \"PriceAdjusted\",\n \"adjustDescription\": \"Price was dropped.\",\n \"newTransaction\": {\n \"lines\": [\n {\n \"companyCode\": \"DEFAULT\",\n \"reportingLocationCode\": \"ReportLocation111\",\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 100,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/:code/type/:type/adjust?include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", ":code", "type", ":type", "adjust" ], "query": [ { "description": "Specifies objects to include in this fetch call", "key": "include", "value": "string" } ], "variable": [ { "key": "code", "value": "string", "description": "The transaction code for this MultiDocument transaction" }, { "key": "type", "value": "PurchaseOrder", "description": "The transaction type for this MultiDocument transaction" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "audit", "item": [ { "name": "Get audit information about a MultiDocument transaction", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/:code/type/:type/audit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", ":code", "type", ":type", "audit" ], "variable": [ { "key": "code", "value": "string", "description": "The transaction code for this MultiDocument transaction" }, { "key": "type", "value": "PurchaseOrder", "description": "The transaction type for this MultiDocument transaction" } ] }, "description": "Retrieve audit information about a MultiDocument transaction stored in AvaTax.\r\n \r\nThe audit API retrieves audit information related to a specific MultiDocument transaction. This audit\r\ninformation includes the following:\r\n \r\n* The `code` of the MultiDocument transaction\r\n* The `type` of the MultiDocument transaction\r\n* The server timestamp representing the exact server time when the transaction was created\r\n* The server duration - how long it took to process this transaction\r\n* Whether exact API call details were logged\r\n* A reconstructed API call showing what the original create call looked like\r\n \r\nA transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\r\nsales, purchases, inventory transfer, and returns (also called refunds).\r\n \r\nNOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:\r\n* Replace '/' with '\\_-ava2f-\\_' For example: document/Code becomes document_-ava2f-_Code\r\n* Replace '+' with '\\_-ava2b-\\_' For example: document+Code becomes document_-ava2b-_Code\r\n* Replace '?' with '\\_-ava3f-\\_' For example: document?Code becomes document_-ava3f-_Code\r\n* Replace '%' with '\\_-ava25-\\_' For example: document%Code becomes document_-ava25-_Code\r\n* Replace '#' with '\\_-ava23-\\_' For example: document#Code becomes document_-ava23-_Code\r\n* Replace ' ' with '%20' For example: document Code becomes document%20Code\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/:code/type/:type/audit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", ":code", "type", ":type", "audit" ], "variable": [ { "key": "code", "value": "string", "description": "The transaction code for this MultiDocument transaction" }, { "key": "type", "value": "PurchaseOrder", "description": "The transaction type for this MultiDocument transaction" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"reconstructed\": {\n \"request\": {\n \"lines\": [\n {\n \"companyCode\": \"DEFAULT\",\n \"reportingLocationCode\": \"ReportLocation111\",\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 100,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n }\n },\n \"type\": \"SalesOrder\",\n \"serverTimestamp\": \"2026-04-02T10:55:16.5898183Z\",\n \"apiCallStatus\": \"ReconstructedApiCallAvailable\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/:code/type/:type/audit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", ":code", "type", ":type", "audit" ], "variable": [ { "key": "code", "value": "string", "description": "The transaction code for this MultiDocument transaction" }, { "key": "type", "value": "PurchaseOrder", "description": "The transaction type for this MultiDocument transaction" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/:code/type/:type/audit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", ":code", "type", ":type", "audit" ], "variable": [ { "key": "code", "value": "string", "description": "The transaction code for this MultiDocument transaction" }, { "key": "type", "value": "PurchaseOrder", "description": "The transaction type for this MultiDocument transaction" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/:code/type/:type/audit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", ":code", "type", ":type", "audit" ], "variable": [ { "key": "code", "value": "string", "description": "The transaction code for this MultiDocument transaction" }, { "key": "type", "value": "PurchaseOrder", "description": "The transaction type for this MultiDocument transaction" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "refund", "item": [ { "name": "Create a refund for a MultiDocument transaction", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"refundTransactionCode\": \"7b543d25-4240-4137-b95a-d0e42d8692cf\",\n \"refundDate\": \"2026-04-02\",\n \"refundType\": \"Full\",\n \"referenceCode\": \"Refund for a committed transaction\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/:code/type/:type/refund?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", ":code", "type", ":type", "refund" ], "query": [ { "key": "$include", "value": "string", "description": "Specifies objects to include in the response after transaction is created" } ], "variable": [ { "key": "code", "value": "string", "description": "The code of this MultiDocument transaction" }, { "key": "type", "value": "PurchaseOrder", "description": "The type of this MultiDocument transaction" } ] }, "description": "Create a refund for a MultiDocument transaction.\r\n \r\nA traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can\r\ninvolve a marketplace of vendors, each of which contributes some portion of the final transaction. Within\r\na MultiDocument transaction, each individual buyer and seller pair are matched up and converted to a separate\r\ndocument. This separation of documents allows each seller to file their taxes separately.\r\n \r\nThe `RefundTransaction` API allows you to quickly and easily create a `ReturnInvoice` representing a refund\r\nfor a previously created `SalesInvoice` transaction. You can choose to create a full or partial refund, and\r\nspecify individual line items from the original sale for refund.\r\n \r\nThe `RefundTransaction` API ensures that the tax amount you refund to the customer exactly matches the tax that\r\nwas calculated during the original transaction, regardless of any changes to your company's configuration, rules,\r\nnexus, or any other setting.\r\n \r\nThis API is intended to be a shortcut to allow you to quickly and accurately generate a refund for the following\r\ncommon refund scenarios:\r\n \r\n* A full refund of a previous sale\r\n* Refunding the tax that was charged on a previous sale, when the customer provides an exemption certificate after the purchase\r\n* Refunding one or more items (lines) from a previous sale\r\n* Granting a customer a percentage refund of a previous sale\r\n \r\nFor more complex scenarios than the ones above, please use `CreateTransaction` with document type `ReturnInvoice` to\r\ncreate a custom refund transaction.\r\n \r\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:\r\n \r\n* Lines\r\n* Details (implies lines)\r\n* Summary (implies details)\r\n* Addresses\r\n* SummaryOnly (omit lines and details - reduces API response size)\r\n* LinesOnly (omit details - reduces API response size)\r\n \r\nIf you omit the `$include` parameter, the API will assume you want `Summary,Addresses`.\r\n\r\nNOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:\r\n* Replace '/' with '\\_-ava2f-\\_' For example: document/Code becomes document_-ava2f-_Code\r\n* Replace '+' with '\\_-ava2b-\\_' For example: document+Code becomes document_-ava2b-_Code\r\n* Replace '?' with '\\_-ava3f-\\_' For example: document?Code becomes document_-ava3f-_Code\r\n* Replace '%' with '\\_-ava25-\\_' For example: document%Code becomes document_-ava25-_Code\r\n* Replace '#' with '\\_-ava23-\\_' For example: document#Code becomes document_-ava23-_Code\r\n* Replace ' ' with '%20' For example: document Code becomes document%20Code\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"refundTransactionCode\": \"7b543d25-4240-4137-b95a-d0e42d8692cf\",\n \"refundDate\": \"2026-04-02\",\n \"refundType\": \"Full\",\n \"referenceCode\": \"Refund for a committed transaction\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/:code/type/:type/refund?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", ":code", "type", ":type", "refund" ], "query": [ { "description": "Specifies objects to include in the response after transaction is created", "key": "$include", "value": "string" } ], "variable": [ { "key": "code", "value": "string", "description": "The code of this MultiDocument transaction" }, { "key": "type", "value": "PurchaseOrder", "description": "The type of this MultiDocument transaction" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 12,\n \"accountId\": 123456,\n \"code\": \"9e199121-684c-4628-88af-477100699e0f\",\n \"type\": \"SalesInvoice\",\n \"createdUserId\": 87954,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 66783,\n \"documents\": [\n {\n \"id\": 123456789,\n \"code\": \"b994b117-f788-41a0-a1bf-3aa22e1aba00\",\n \"companyId\": 12345,\n \"date\": \"2026-04-02\",\n \"status\": \"Committed\",\n \"type\": \"SalesInvoice\",\n \"currencyCode\": \"USD\",\n \"exchangeRateCurrencyCode\": \"USD\",\n \"entityUseCode\": \"\",\n \"customerVendorCode\": \"ABC\",\n \"customerCode\": \"ABC\",\n \"exemptNo\": \"\",\n \"reconciled\": true,\n \"locationCode\": \"DEFAULT\",\n \"salespersonCode\": \"DEF\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"totalAmount\": 1000,\n \"totalExempt\": 0,\n \"totalDiscount\": 0,\n \"totalTax\": 62.5,\n \"totalTaxable\": 1000,\n \"totalTaxCalculated\": 62.5,\n \"adjustmentReason\": \"NotAdjusted\",\n \"adjustmentDescription\": \"\",\n \"locked\": false,\n \"region\": \"CA\",\n \"country\": \"US\",\n \"version\": 0,\n \"originAddressId\": 123456789,\n \"destinationAddressId\": 123456789,\n \"exchangeRateEffectiveDate\": \"2026-04-02\",\n \"exchangeRate\": 2,\n \"isSellerImporterOfRecord\": false,\n \"description\": \"Yarn\",\n \"taxDate\": \"2026-04-02T00:00:00+00:00\",\n \"lines\": [\n {\n \"id\": 123456789,\n \"transactionId\": 123456789,\n \"lineNumber\": \"1\",\n \"boundaryOverrideId\": 0,\n \"entityUseCode\": \"\",\n \"description\": \"Yarn\",\n \"destinationAddressId\": 12345,\n \"originAddressId\": 123456789,\n \"discountAmount\": 100,\n \"discountTypeId\": 0,\n \"exemptAmount\": 0,\n \"exemptCertId\": 0,\n \"exemptNo\": \"\",\n \"isItemTaxable\": true,\n \"isSSTP\": false,\n \"itemCode\": \"116292\",\n \"lineAmount\": 1000,\n \"quantity\": 1,\n \"ref1\": \"Note: Deliver to Bob\",\n \"reportingDate\": \"2026-04-02\",\n \"revAccount\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxCalculated\": 62.5,\n \"taxCode\": \"PS081282\",\n \"taxDate\": \"2026-04-02\",\n \"taxEngine\": \"\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"taxIncluded\": false,\n \"details\": [\n {\n \"id\": 123456789,\n \"transactionLineId\": 123456789,\n \"transactionId\": 123456789,\n \"addressId\": 12345,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"stateFIPS\": \"06\",\n \"exemptAmount\": 0,\n \"exemptReasonId\": 4,\n \"exemptRuleId\": 0,\n \"inState\": false,\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"jurisdictionId\": 5000531,\n \"signatureCode\": \"AGAM\",\n \"stateAssignedNo\": \"\",\n \"jurisType\": \"STA\",\n \"nonTaxableAmount\": 0,\n \"nonTaxableRuleId\": 0,\n \"nonTaxableType\": \"BaseRule\",\n \"rate\": 0.0625,\n \"rateRuleId\": 1321915,\n \"rateSourceId\": 3,\n \"serCode\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxType\": \"Sales\",\n \"taxName\": \"CA STATE TAX\",\n \"taxAuthorityTypeId\": 45,\n \"taxRegionId\": 2127184,\n \"taxCalculated\": 62.5,\n \"taxOverride\": 0,\n \"rateType\": \"General\",\n \"taxableUnits\": 62.5,\n \"nonTaxableUnits\": 1000,\n \"exemptUnits\": 62.5,\n \"reportingTaxableUnits\": 125,\n \"reportingNonTaxableUnits\": 2000,\n \"reportingExemptUnits\": 125,\n \"reportingTax\": 125,\n \"reportingTaxCalculated\": 125,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0,\n \"vatCode\": \"\",\n \"granularDutyDetails\": [\n {\n \"dutyType\": \"ImportDuty\",\n \"rate\": \"10.5\",\n \"amount\": \"105.00\"\n }\n ]\n }\n ],\n \"vatNumberTypeId\": 0,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0\n }\n ],\n \"addresses\": [\n {\n \"id\": 0,\n \"transactionId\": 0,\n \"boundaryLevel\": \"Address\",\n \"line1\": \"100 Ravine Lane Northeast #220\",\n \"city\": \"Bainbridge Island\",\n \"region\": \"WA\",\n \"postalCode\": \"98110\",\n \"country\": \"US\",\n \"taxRegionId\": 0\n }\n ],\n \"taxDetailsByTaxType\": [\n {\n \"taxType\": \"SalesAndUse\",\n \"totalTaxable\": 100,\n \"totalExempt\": 0.05,\n \"totalNonTaxable\": 0,\n \"totalTax\": 0.625\n }\n ]\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"refundTransactionCode\": \"7b543d25-4240-4137-b95a-d0e42d8692cf\",\n \"refundDate\": \"2026-04-02\",\n \"refundType\": \"Full\",\n \"referenceCode\": \"Refund for a committed transaction\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/:code/type/:type/refund?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", ":code", "type", ":type", "refund" ], "query": [ { "description": "Specifies objects to include in the response after transaction is created", "key": "$include", "value": "string" } ], "variable": [ { "key": "code", "value": "string", "description": "The code of this MultiDocument transaction" }, { "key": "type", "value": "PurchaseOrder", "description": "The type of this MultiDocument transaction" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"refundTransactionCode\": \"7b543d25-4240-4137-b95a-d0e42d8692cf\",\n \"refundDate\": \"2026-04-02\",\n \"refundType\": \"Full\",\n \"referenceCode\": \"Refund for a committed transaction\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/:code/type/:type/refund?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", ":code", "type", ":type", "refund" ], "query": [ { "description": "Specifies objects to include in the response after transaction is created", "key": "$include", "value": "string" } ], "variable": [ { "key": "code", "value": "string", "description": "The code of this MultiDocument transaction" }, { "key": "type", "value": "PurchaseOrder", "description": "The type of this MultiDocument transaction" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"refundTransactionCode\": \"7b543d25-4240-4137-b95a-d0e42d8692cf\",\n \"refundDate\": \"2026-04-02\",\n \"refundType\": \"Full\",\n \"referenceCode\": \"Refund for a committed transaction\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/:code/type/:type/refund?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", ":code", "type", ":type", "refund" ], "query": [ { "description": "Specifies objects to include in the response after transaction is created", "key": "$include", "value": "string" } ], "variable": [ { "key": "code", "value": "string", "description": "The code of this MultiDocument transaction" }, { "key": "type", "value": "PurchaseOrder", "description": "The type of this MultiDocument transaction" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "void", "item": [ { "name": "Void a MultiDocument transaction", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"DocVoided\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/:code/type/:type/void", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", ":code", "type", ":type", "void" ], "variable": [ { "key": "code", "value": "string", "description": "The transaction code for this MultiDocument transaction" }, { "key": "type", "value": "PurchaseOrder", "description": "The transaction type for this MultiDocument transaction" } ] }, "description": "Voids the current transaction uniquely identified by this URL.\r\n \r\nA transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\r\nsales, purchases, inventory transfer, and returns (also called refunds).\r\n \r\nWhen you void a transaction, that transaction's status is recorded as `DocVoided`.\r\n \r\nTransactions that have been previously reported to a tax authority by Avalara Managed Returns Service are considered `locked`,\r\nand they are no longer available to be voided.\r\n \r\nNOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:\r\n* Replace '/' with '\\_-ava2f-\\_' For example: document/Code becomes document_-ava2f-_Code\r\n* Replace '+' with '\\_-ava2b-\\_' For example: document+Code becomes document_-ava2b-_Code\r\n* Replace '?' with '\\_-ava3f-\\_' For example: document?Code becomes document_-ava3f-_Code\r\n* Replace '%' with '\\_-ava25-\\_' For example: document%Code becomes document_-ava25-_Code\r\n* Replace '#' with '\\_-ava23-\\_' For example: document#Code becomes document_-ava23-_Code\r\n* Replace ' ' with '%20' For example: document Code becomes document%20Code\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.\n* This API depends on the following active services:*Required* (all): AvaTaxPro.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"DocVoided\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/:code/type/:type/void", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", ":code", "type", ":type", "void" ], "variable": [ { "key": "code", "value": "string", "description": "The transaction code for this MultiDocument transaction" }, { "key": "type", "value": "PurchaseOrder", "description": "The transaction type for this MultiDocument transaction" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 12,\n \"accountId\": 123456,\n \"code\": \"9e199121-684c-4628-88af-477100699e0f\",\n \"type\": \"SalesInvoice\",\n \"createdUserId\": 87954,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 66783,\n \"documents\": [\n {\n \"id\": 123456789,\n \"code\": \"b994b117-f788-41a0-a1bf-3aa22e1aba00\",\n \"companyId\": 12345,\n \"date\": \"2026-04-02\",\n \"status\": \"Committed\",\n \"type\": \"SalesInvoice\",\n \"currencyCode\": \"USD\",\n \"exchangeRateCurrencyCode\": \"USD\",\n \"entityUseCode\": \"\",\n \"customerVendorCode\": \"ABC\",\n \"customerCode\": \"ABC\",\n \"exemptNo\": \"\",\n \"reconciled\": true,\n \"locationCode\": \"DEFAULT\",\n \"salespersonCode\": \"DEF\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"totalAmount\": 1000,\n \"totalExempt\": 0,\n \"totalDiscount\": 0,\n \"totalTax\": 62.5,\n \"totalTaxable\": 1000,\n \"totalTaxCalculated\": 62.5,\n \"adjustmentReason\": \"NotAdjusted\",\n \"adjustmentDescription\": \"\",\n \"locked\": false,\n \"region\": \"CA\",\n \"country\": \"US\",\n \"version\": 0,\n \"originAddressId\": 123456789,\n \"destinationAddressId\": 123456789,\n \"exchangeRateEffectiveDate\": \"2026-04-02\",\n \"exchangeRate\": 2,\n \"isSellerImporterOfRecord\": false,\n \"description\": \"Yarn\",\n \"taxDate\": \"2026-04-02T00:00:00+00:00\",\n \"lines\": [\n {\n \"id\": 123456789,\n \"transactionId\": 123456789,\n \"lineNumber\": \"1\",\n \"boundaryOverrideId\": 0,\n \"entityUseCode\": \"\",\n \"description\": \"Yarn\",\n \"destinationAddressId\": 12345,\n \"originAddressId\": 123456789,\n \"discountAmount\": 100,\n \"discountTypeId\": 0,\n \"exemptAmount\": 0,\n \"exemptCertId\": 0,\n \"exemptNo\": \"\",\n \"isItemTaxable\": true,\n \"isSSTP\": false,\n \"itemCode\": \"116292\",\n \"lineAmount\": 1000,\n \"quantity\": 1,\n \"ref1\": \"Note: Deliver to Bob\",\n \"reportingDate\": \"2026-04-02\",\n \"revAccount\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxCalculated\": 62.5,\n \"taxCode\": \"PS081282\",\n \"taxDate\": \"2026-04-02\",\n \"taxEngine\": \"\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"taxIncluded\": false,\n \"details\": [\n {\n \"id\": 123456789,\n \"transactionLineId\": 123456789,\n \"transactionId\": 123456789,\n \"addressId\": 12345,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"stateFIPS\": \"06\",\n \"exemptAmount\": 0,\n \"exemptReasonId\": 4,\n \"exemptRuleId\": 0,\n \"inState\": false,\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"jurisdictionId\": 5000531,\n \"signatureCode\": \"AGAM\",\n \"stateAssignedNo\": \"\",\n \"jurisType\": \"STA\",\n \"nonTaxableAmount\": 0,\n \"nonTaxableRuleId\": 0,\n \"nonTaxableType\": \"BaseRule\",\n \"rate\": 0.0625,\n \"rateRuleId\": 1321915,\n \"rateSourceId\": 3,\n \"serCode\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxType\": \"Sales\",\n \"taxName\": \"CA STATE TAX\",\n \"taxAuthorityTypeId\": 45,\n \"taxRegionId\": 2127184,\n \"taxCalculated\": 62.5,\n \"taxOverride\": 0,\n \"rateType\": \"General\",\n \"taxableUnits\": 62.5,\n \"nonTaxableUnits\": 1000,\n \"exemptUnits\": 62.5,\n \"reportingTaxableUnits\": 125,\n \"reportingNonTaxableUnits\": 2000,\n \"reportingExemptUnits\": 125,\n \"reportingTax\": 125,\n \"reportingTaxCalculated\": 125,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0,\n \"vatCode\": \"\",\n \"granularDutyDetails\": [\n {\n \"dutyType\": \"ImportDuty\",\n \"rate\": \"10.5\",\n \"amount\": \"105.00\"\n }\n ]\n }\n ],\n \"vatNumberTypeId\": 0,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0\n }\n ],\n \"addresses\": [\n {\n \"id\": 0,\n \"transactionId\": 0,\n \"boundaryLevel\": \"Address\",\n \"line1\": \"100 Ravine Lane Northeast #220\",\n \"city\": \"Bainbridge Island\",\n \"region\": \"WA\",\n \"postalCode\": \"98110\",\n \"country\": \"US\",\n \"taxRegionId\": 0\n }\n ],\n \"taxDetailsByTaxType\": [\n {\n \"taxType\": \"SalesAndUse\",\n \"totalTaxable\": 100,\n \"totalExempt\": 0.05,\n \"totalNonTaxable\": 0,\n \"totalTax\": 0.625\n }\n ]\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"DocVoided\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/:code/type/:type/void", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", ":code", "type", ":type", "void" ], "variable": [ { "key": "code", "value": "string", "description": "The transaction code for this MultiDocument transaction" }, { "key": "type", "value": "PurchaseOrder", "description": "The transaction type for this MultiDocument transaction" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"DocVoided\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/:code/type/:type/void", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", ":code", "type", ":type", "void" ], "variable": [ { "key": "code", "value": "string", "description": "The transaction code for this MultiDocument transaction" }, { "key": "type", "value": "PurchaseOrder", "description": "The transaction type for this MultiDocument transaction" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"DocVoided\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/:code/type/:type/void", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", ":code", "type", ":type", "void" ], "variable": [ { "key": "code", "value": "string", "description": "The transaction code for this MultiDocument transaction" }, { "key": "type", "value": "PurchaseOrder", "description": "The transaction type for this MultiDocument transaction" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Retrieve a MultiDocument transaction", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/:code/type/:type?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", ":code", "type", ":type" ], "query": [ { "key": "$include", "value": "string", "description": "Specifies objects to include in the response after transaction is created" } ], "variable": [ { "key": "code", "value": "string", "description": "The multidocument code to retrieve" }, { "key": "type", "value": "PurchaseOrder", "description": "The transaction type to retrieve" } ] }, "description": "Get the current MultiDocument transaction identified by this URL.\r\n \r\nIf this transaction was adjusted, the return value of this API will be the current transaction with this code.\r\n \r\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:\r\n \r\n* Lines\r\n* Details (implies lines)\r\n* Summary (implies details)\r\n* Addresses\r\n* SummaryOnly (omit lines and details - reduces API response size)\r\n* LinesOnly (omit details - reduces API response size)\r\n \r\nNOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:\r\n* Replace '/' with '\\_-ava2f-\\_' For example: document/Code becomes document_-ava2f-_Code\r\n* Replace '+' with '\\_-ava2b-\\_' For example: document+Code becomes document_-ava2b-_Code\r\n* Replace '?' with '\\_-ava3f-\\_' For example: document?Code becomes document_-ava3f-_Code\r\n* Replace '%' with '\\_-ava25-\\_' For example: document%Code becomes document_-ava25-_Code\r\n* Replace '#' with '\\_-ava23-\\_' For example: document#Code becomes document_-ava23-_Code\r\n* Replace ' ' with '%20' For example: document Code becomes document%20Code\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/:code/type/:type?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", ":code", "type", ":type" ], "query": [ { "description": "Specifies objects to include in the response after transaction is created", "key": "$include", "value": "string" } ], "variable": [ { "key": "code", "value": "string", "description": "The multidocument code to retrieve" }, { "key": "type", "value": "PurchaseOrder", "description": "The transaction type to retrieve" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 12,\n \"accountId\": 123456,\n \"code\": \"9e199121-684c-4628-88af-477100699e0f\",\n \"type\": \"SalesInvoice\",\n \"createdUserId\": 87954,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 66783,\n \"documents\": [\n {\n \"id\": 123456789,\n \"code\": \"b994b117-f788-41a0-a1bf-3aa22e1aba00\",\n \"companyId\": 12345,\n \"date\": \"2026-04-02\",\n \"status\": \"Committed\",\n \"type\": \"SalesInvoice\",\n \"currencyCode\": \"USD\",\n \"exchangeRateCurrencyCode\": \"USD\",\n \"entityUseCode\": \"\",\n \"customerVendorCode\": \"ABC\",\n \"customerCode\": \"ABC\",\n \"exemptNo\": \"\",\n \"reconciled\": true,\n \"locationCode\": \"DEFAULT\",\n \"salespersonCode\": \"DEF\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"totalAmount\": 1000,\n \"totalExempt\": 0,\n \"totalDiscount\": 0,\n \"totalTax\": 62.5,\n \"totalTaxable\": 1000,\n \"totalTaxCalculated\": 62.5,\n \"adjustmentReason\": \"NotAdjusted\",\n \"adjustmentDescription\": \"\",\n \"locked\": false,\n \"region\": \"CA\",\n \"country\": \"US\",\n \"version\": 0,\n \"originAddressId\": 123456789,\n \"destinationAddressId\": 123456789,\n \"exchangeRateEffectiveDate\": \"2026-04-02\",\n \"exchangeRate\": 2,\n \"isSellerImporterOfRecord\": false,\n \"description\": \"Yarn\",\n \"taxDate\": \"2026-04-02T00:00:00+00:00\",\n \"lines\": [\n {\n \"id\": 123456789,\n \"transactionId\": 123456789,\n \"lineNumber\": \"1\",\n \"boundaryOverrideId\": 0,\n \"entityUseCode\": \"\",\n \"description\": \"Yarn\",\n \"destinationAddressId\": 12345,\n \"originAddressId\": 123456789,\n \"discountAmount\": 100,\n \"discountTypeId\": 0,\n \"exemptAmount\": 0,\n \"exemptCertId\": 0,\n \"exemptNo\": \"\",\n \"isItemTaxable\": true,\n \"isSSTP\": false,\n \"itemCode\": \"116292\",\n \"lineAmount\": 1000,\n \"quantity\": 1,\n \"ref1\": \"Note: Deliver to Bob\",\n \"reportingDate\": \"2026-04-02\",\n \"revAccount\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxCalculated\": 62.5,\n \"taxCode\": \"PS081282\",\n \"taxDate\": \"2026-04-02\",\n \"taxEngine\": \"\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"taxIncluded\": false,\n \"details\": [\n {\n \"id\": 123456789,\n \"transactionLineId\": 123456789,\n \"transactionId\": 123456789,\n \"addressId\": 12345,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"stateFIPS\": \"06\",\n \"exemptAmount\": 0,\n \"exemptReasonId\": 4,\n \"exemptRuleId\": 0,\n \"inState\": false,\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"jurisdictionId\": 5000531,\n \"signatureCode\": \"AGAM\",\n \"stateAssignedNo\": \"\",\n \"jurisType\": \"STA\",\n \"nonTaxableAmount\": 0,\n \"nonTaxableRuleId\": 0,\n \"nonTaxableType\": \"BaseRule\",\n \"rate\": 0.0625,\n \"rateRuleId\": 1321915,\n \"rateSourceId\": 3,\n \"serCode\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxType\": \"Sales\",\n \"taxName\": \"CA STATE TAX\",\n \"taxAuthorityTypeId\": 45,\n \"taxRegionId\": 2127184,\n \"taxCalculated\": 62.5,\n \"taxOverride\": 0,\n \"rateType\": \"General\",\n \"taxableUnits\": 62.5,\n \"nonTaxableUnits\": 1000,\n \"exemptUnits\": 62.5,\n \"reportingTaxableUnits\": 125,\n \"reportingNonTaxableUnits\": 2000,\n \"reportingExemptUnits\": 125,\n \"reportingTax\": 125,\n \"reportingTaxCalculated\": 125,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0,\n \"vatCode\": \"\",\n \"granularDutyDetails\": [\n {\n \"dutyType\": \"ImportDuty\",\n \"rate\": \"10.5\",\n \"amount\": \"105.00\"\n }\n ]\n }\n ],\n \"vatNumberTypeId\": 0,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0\n }\n ],\n \"addresses\": [\n {\n \"id\": 0,\n \"transactionId\": 0,\n \"boundaryLevel\": \"Address\",\n \"line1\": \"100 Ravine Lane Northeast #220\",\n \"city\": \"Bainbridge Island\",\n \"region\": \"WA\",\n \"postalCode\": \"98110\",\n \"country\": \"US\",\n \"taxRegionId\": 0\n }\n ],\n \"taxDetailsByTaxType\": [\n {\n \"taxType\": \"SalesAndUse\",\n \"totalTaxable\": 100,\n \"totalExempt\": 0.05,\n \"totalNonTaxable\": 0,\n \"totalTax\": 0.625\n }\n ]\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/:code/type/:type?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", ":code", "type", ":type" ], "query": [ { "description": "Specifies objects to include in the response after transaction is created", "key": "$include", "value": "string" } ], "variable": [ { "key": "code", "value": "string", "description": "The multidocument code to retrieve" }, { "key": "type", "value": "PurchaseOrder", "description": "The transaction type to retrieve" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/:code/type/:type?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", ":code", "type", ":type" ], "query": [ { "description": "Specifies objects to include in the response after transaction is created", "key": "$include", "value": "string" } ], "variable": [ { "key": "code", "value": "string", "description": "The multidocument code to retrieve" }, { "key": "type", "value": "PurchaseOrder", "description": "The transaction type to retrieve" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/:code/type/:type?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", ":code", "type", ":type" ], "query": [ { "description": "Specifies objects to include in the response after transaction is created", "key": "$include", "value": "string" } ], "variable": [ { "key": "code", "value": "string", "description": "The multidocument code to retrieve" }, { "key": "type", "value": "PurchaseOrder", "description": "The transaction type to retrieve" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] } ] }, { "name": "{id}", "item": [ { "name": "Retrieve a MultiDocument transaction by ID", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", ":id" ], "query": [ { "key": "$include", "value": "string", "description": "Specifies objects to include in the response after transaction is created" } ], "variable": [ { "key": "id", "value": "155", "description": "The unique ID number of the MultiDocument transaction to retrieve" } ] }, "description": "Get the unique MultiDocument transaction identified by this URL.\r\n \r\nA traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can\r\ninvolve a marketplace of vendors, each of which contributes some portion of the final transaction. Within\r\na MultiDocument transaction, each individual buyer and seller pair are matched up and converted to a separate\r\ndocument. This separation of documents allows each seller to file their taxes separately.\r\n \r\nThis endpoint retrieves the exact transaction identified by this ID number even if that transaction was later adjusted\r\nby using the `AdjustTransaction` endpoint.\r\n \r\nA transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\r\nsales, purchases, inventory transfer, and returns (also called refunds).\r\n \r\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:\r\n \r\n* Lines\r\n* Details (implies lines)\r\n* Summary (implies details)\r\n* Addresses\r\n* SummaryOnly (omit lines and details - reduces API response size)\r\n* LinesOnly (omit details - reduces API response size)\r\n \r\nNOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:\r\n* Replace '/' with '\\_-ava2f-\\_' For example: document/Code becomes document_-ava2f-_Code\r\n* Replace '+' with '\\_-ava2b-\\_' For example: document+Code becomes document_-ava2b-_Code\r\n* Replace '?' with '\\_-ava3f-\\_' For example: document?Code becomes document_-ava3f-_Code\r\n* Replace '%' with '\\_-ava25-\\_' For example: document%Code becomes document_-ava25-_Code\r\n* Replace '#' with '\\_-ava23-\\_' For example: document#Code becomes document_-ava23-_Code\r\n* Replace ' ' with '%20' For example: document Code becomes document%20Code\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", ":id" ], "query": [ { "description": "Specifies objects to include in the response after transaction is created", "key": "$include", "value": "string" } ], "variable": [ { "key": "id", "value": "155", "description": "The unique ID number of the MultiDocument transaction to retrieve" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 12,\n \"accountId\": 123456,\n \"code\": \"9e199121-684c-4628-88af-477100699e0f\",\n \"type\": \"SalesInvoice\",\n \"createdUserId\": 87954,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 66783,\n \"documents\": [\n {\n \"id\": 123456789,\n \"code\": \"b994b117-f788-41a0-a1bf-3aa22e1aba00\",\n \"companyId\": 12345,\n \"date\": \"2026-04-02\",\n \"status\": \"Committed\",\n \"type\": \"SalesInvoice\",\n \"currencyCode\": \"USD\",\n \"exchangeRateCurrencyCode\": \"USD\",\n \"entityUseCode\": \"\",\n \"customerVendorCode\": \"ABC\",\n \"customerCode\": \"ABC\",\n \"exemptNo\": \"\",\n \"reconciled\": true,\n \"locationCode\": \"DEFAULT\",\n \"salespersonCode\": \"DEF\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"totalAmount\": 1000,\n \"totalExempt\": 0,\n \"totalDiscount\": 0,\n \"totalTax\": 62.5,\n \"totalTaxable\": 1000,\n \"totalTaxCalculated\": 62.5,\n \"adjustmentReason\": \"NotAdjusted\",\n \"adjustmentDescription\": \"\",\n \"locked\": false,\n \"region\": \"CA\",\n \"country\": \"US\",\n \"version\": 0,\n \"originAddressId\": 123456789,\n \"destinationAddressId\": 123456789,\n \"exchangeRateEffectiveDate\": \"2026-04-02\",\n \"exchangeRate\": 2,\n \"isSellerImporterOfRecord\": false,\n \"description\": \"Yarn\",\n \"taxDate\": \"2026-04-02T00:00:00+00:00\",\n \"lines\": [\n {\n \"id\": 123456789,\n \"transactionId\": 123456789,\n \"lineNumber\": \"1\",\n \"boundaryOverrideId\": 0,\n \"entityUseCode\": \"\",\n \"description\": \"Yarn\",\n \"destinationAddressId\": 12345,\n \"originAddressId\": 123456789,\n \"discountAmount\": 100,\n \"discountTypeId\": 0,\n \"exemptAmount\": 0,\n \"exemptCertId\": 0,\n \"exemptNo\": \"\",\n \"isItemTaxable\": true,\n \"isSSTP\": false,\n \"itemCode\": \"116292\",\n \"lineAmount\": 1000,\n \"quantity\": 1,\n \"ref1\": \"Note: Deliver to Bob\",\n \"reportingDate\": \"2026-04-02\",\n \"revAccount\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxCalculated\": 62.5,\n \"taxCode\": \"PS081282\",\n \"taxDate\": \"2026-04-02\",\n \"taxEngine\": \"\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"taxIncluded\": false,\n \"details\": [\n {\n \"id\": 123456789,\n \"transactionLineId\": 123456789,\n \"transactionId\": 123456789,\n \"addressId\": 12345,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"stateFIPS\": \"06\",\n \"exemptAmount\": 0,\n \"exemptReasonId\": 4,\n \"exemptRuleId\": 0,\n \"inState\": false,\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"jurisdictionId\": 5000531,\n \"signatureCode\": \"AGAM\",\n \"stateAssignedNo\": \"\",\n \"jurisType\": \"STA\",\n \"nonTaxableAmount\": 0,\n \"nonTaxableRuleId\": 0,\n \"nonTaxableType\": \"BaseRule\",\n \"rate\": 0.0625,\n \"rateRuleId\": 1321915,\n \"rateSourceId\": 3,\n \"serCode\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxType\": \"Sales\",\n \"taxName\": \"CA STATE TAX\",\n \"taxAuthorityTypeId\": 45,\n \"taxRegionId\": 2127184,\n \"taxCalculated\": 62.5,\n \"taxOverride\": 0,\n \"rateType\": \"General\",\n \"taxableUnits\": 62.5,\n \"nonTaxableUnits\": 1000,\n \"exemptUnits\": 62.5,\n \"reportingTaxableUnits\": 125,\n \"reportingNonTaxableUnits\": 2000,\n \"reportingExemptUnits\": 125,\n \"reportingTax\": 125,\n \"reportingTaxCalculated\": 125,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0,\n \"vatCode\": \"\",\n \"granularDutyDetails\": [\n {\n \"dutyType\": \"ImportDuty\",\n \"rate\": \"10.5\",\n \"amount\": \"105.00\"\n }\n ]\n }\n ],\n \"vatNumberTypeId\": 0,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0\n }\n ],\n \"addresses\": [\n {\n \"id\": 0,\n \"transactionId\": 0,\n \"boundaryLevel\": \"Address\",\n \"line1\": \"100 Ravine Lane Northeast #220\",\n \"city\": \"Bainbridge Island\",\n \"region\": \"WA\",\n \"postalCode\": \"98110\",\n \"country\": \"US\",\n \"taxRegionId\": 0\n }\n ],\n \"taxDetailsByTaxType\": [\n {\n \"taxType\": \"SalesAndUse\",\n \"totalTaxable\": 100,\n \"totalExempt\": 0.05,\n \"totalNonTaxable\": 0,\n \"totalTax\": 0.625\n }\n ]\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", ":id" ], "query": [ { "description": "Specifies objects to include in the response after transaction is created", "key": "$include", "value": "string" } ], "variable": [ { "key": "id", "value": "155", "description": "The unique ID number of the MultiDocument transaction to retrieve" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", ":id" ], "query": [ { "description": "Specifies objects to include in the response after transaction is created", "key": "$include", "value": "string" } ], "variable": [ { "key": "id", "value": "155", "description": "The unique ID number of the MultiDocument transaction to retrieve" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", ":id" ], "query": [ { "description": "Specifies objects to include in the response after transaction is created", "key": "$include", "value": "string" } ], "variable": [ { "key": "id", "value": "155", "description": "The unique ID number of the MultiDocument transaction to retrieve" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "commit", "item": [ { "name": "Commit a MultiDocument transaction", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"7e5fa884-ca0d-460b-af5a-44ae43784d53\",\n \"type\": \"SalesInvoice\",\n \"commit\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/commit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", "commit" ] }, "description": "Marks a list of transactions by changing its status to `Committed`.\r\n \r\nTransactions that are committed are available to be reported to a tax authority by Avalara Managed Returns.\r\n \r\nA transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\r\nsales, purchases, inventory transfer, and returns (also called refunds).\r\n \r\nAny changes made to a committed transaction will generate a transaction history.\r\n\r\nNOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:\r\n* Replace '/' with '\\_-ava2f-\\_' For example: document/Code becomes document_-ava2f-_Code\r\n* Replace '+' with '\\_-ava2b-\\_' For example: document+Code becomes document_-ava2b-_Code\r\n* Replace '?' with '\\_-ava3f-\\_' For example: document?Code becomes document_-ava3f-_Code\r\n* Replace '%' with '\\_-ava25-\\_' For example: document%Code becomes document_-ava25-_Code\r\n* Replace '#' with '\\_-ava23-\\_' For example: document#Code becomes document_-ava23-_Code\r\n* Replace ' ' with '%20' For example: document Code becomes document%20Code\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.\n* This API depends on the following active services:*Required* (all): AvaTaxPro.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"7e5fa884-ca0d-460b-af5a-44ae43784d53\",\n \"type\": \"SalesInvoice\",\n \"commit\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/commit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", "commit" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 12,\n \"accountId\": 123456,\n \"code\": \"9e199121-684c-4628-88af-477100699e0f\",\n \"type\": \"SalesInvoice\",\n \"createdUserId\": 87954,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 66783,\n \"documents\": [\n {\n \"id\": 123456789,\n \"code\": \"b994b117-f788-41a0-a1bf-3aa22e1aba00\",\n \"companyId\": 12345,\n \"date\": \"2026-04-02\",\n \"status\": \"Committed\",\n \"type\": \"SalesInvoice\",\n \"currencyCode\": \"USD\",\n \"exchangeRateCurrencyCode\": \"USD\",\n \"entityUseCode\": \"\",\n \"customerVendorCode\": \"ABC\",\n \"customerCode\": \"ABC\",\n \"exemptNo\": \"\",\n \"reconciled\": true,\n \"locationCode\": \"DEFAULT\",\n \"salespersonCode\": \"DEF\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"totalAmount\": 1000,\n \"totalExempt\": 0,\n \"totalDiscount\": 0,\n \"totalTax\": 62.5,\n \"totalTaxable\": 1000,\n \"totalTaxCalculated\": 62.5,\n \"adjustmentReason\": \"NotAdjusted\",\n \"adjustmentDescription\": \"\",\n \"locked\": false,\n \"region\": \"CA\",\n \"country\": \"US\",\n \"version\": 0,\n \"originAddressId\": 123456789,\n \"destinationAddressId\": 123456789,\n \"exchangeRateEffectiveDate\": \"2026-04-02\",\n \"exchangeRate\": 2,\n \"isSellerImporterOfRecord\": false,\n \"description\": \"Yarn\",\n \"taxDate\": \"2026-04-02T00:00:00+00:00\",\n \"lines\": [\n {\n \"id\": 123456789,\n \"transactionId\": 123456789,\n \"lineNumber\": \"1\",\n \"boundaryOverrideId\": 0,\n \"entityUseCode\": \"\",\n \"description\": \"Yarn\",\n \"destinationAddressId\": 12345,\n \"originAddressId\": 123456789,\n \"discountAmount\": 100,\n \"discountTypeId\": 0,\n \"exemptAmount\": 0,\n \"exemptCertId\": 0,\n \"exemptNo\": \"\",\n \"isItemTaxable\": true,\n \"isSSTP\": false,\n \"itemCode\": \"116292\",\n \"lineAmount\": 1000,\n \"quantity\": 1,\n \"ref1\": \"Note: Deliver to Bob\",\n \"reportingDate\": \"2026-04-02\",\n \"revAccount\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxCalculated\": 62.5,\n \"taxCode\": \"PS081282\",\n \"taxDate\": \"2026-04-02\",\n \"taxEngine\": \"\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"taxIncluded\": false,\n \"details\": [\n {\n \"id\": 123456789,\n \"transactionLineId\": 123456789,\n \"transactionId\": 123456789,\n \"addressId\": 12345,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"stateFIPS\": \"06\",\n \"exemptAmount\": 0,\n \"exemptReasonId\": 4,\n \"exemptRuleId\": 0,\n \"inState\": false,\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"jurisdictionId\": 5000531,\n \"signatureCode\": \"AGAM\",\n \"stateAssignedNo\": \"\",\n \"jurisType\": \"STA\",\n \"nonTaxableAmount\": 0,\n \"nonTaxableRuleId\": 0,\n \"nonTaxableType\": \"BaseRule\",\n \"rate\": 0.0625,\n \"rateRuleId\": 1321915,\n \"rateSourceId\": 3,\n \"serCode\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxType\": \"Sales\",\n \"taxName\": \"CA STATE TAX\",\n \"taxAuthorityTypeId\": 45,\n \"taxRegionId\": 2127184,\n \"taxCalculated\": 62.5,\n \"taxOverride\": 0,\n \"rateType\": \"General\",\n \"taxableUnits\": 62.5,\n \"nonTaxableUnits\": 1000,\n \"exemptUnits\": 62.5,\n \"reportingTaxableUnits\": 125,\n \"reportingNonTaxableUnits\": 2000,\n \"reportingExemptUnits\": 125,\n \"reportingTax\": 125,\n \"reportingTaxCalculated\": 125,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0,\n \"vatCode\": \"\",\n \"granularDutyDetails\": [\n {\n \"dutyType\": \"ImportDuty\",\n \"rate\": \"10.5\",\n \"amount\": \"105.00\"\n }\n ]\n }\n ],\n \"vatNumberTypeId\": 0,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0\n }\n ],\n \"addresses\": [\n {\n \"id\": 0,\n \"transactionId\": 0,\n \"boundaryLevel\": \"Address\",\n \"line1\": \"100 Ravine Lane Northeast #220\",\n \"city\": \"Bainbridge Island\",\n \"region\": \"WA\",\n \"postalCode\": \"98110\",\n \"country\": \"US\",\n \"taxRegionId\": 0\n }\n ],\n \"taxDetailsByTaxType\": [\n {\n \"taxType\": \"SalesAndUse\",\n \"totalTaxable\": 100,\n \"totalExempt\": 0.05,\n \"totalNonTaxable\": 0,\n \"totalTax\": 0.625\n }\n ]\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"7e5fa884-ca0d-460b-af5a-44ae43784d53\",\n \"type\": \"SalesInvoice\",\n \"commit\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/commit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", "commit" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"7e5fa884-ca0d-460b-af5a-44ae43784d53\",\n \"type\": \"SalesInvoice\",\n \"commit\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/commit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", "commit" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "verify", "item": [ { "name": "Verify a MultiDocument transaction", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"ABC\",\n \"type\": \"SalesInvoice\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/verify", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", "verify" ] }, "description": "Verifies that the MultiDocument transaction uniquely identified by this URL matches certain expected values.\r\n \r\nIf the transaction does not match these expected values, this API will return an error code indicating which value did not match.\r\n \r\nA transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\r\nsales, purchases, inventory transfer, and returns (also called refunds).\r\n \r\nNOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:\r\n* Replace '/' with '\\_-ava2f-\\_' For example: document/Code becomes document_-ava2f-_Code\r\n* Replace '+' with '\\_-ava2b-\\_' For example: document+Code becomes document_-ava2b-_Code\r\n* Replace '?' with '\\_-ava3f-\\_' For example: document?Code becomes document_-ava3f-_Code\r\n* Replace '%' with '\\_-ava25-\\_' For example: document%Code becomes document_-ava25-_Code\r\n* Replace '#' with '\\_-ava23-\\_' For example: document#Code becomes document_-ava23-_Code\r\n* Replace ' ' with '%20' For example: document Code becomes document%20Code\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"ABC\",\n \"type\": \"SalesInvoice\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/verify", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", "verify" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 12,\n \"accountId\": 123456,\n \"code\": \"9e199121-684c-4628-88af-477100699e0f\",\n \"type\": \"SalesInvoice\",\n \"createdUserId\": 87954,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 66783,\n \"documents\": [\n {\n \"id\": 123456789,\n \"code\": \"b994b117-f788-41a0-a1bf-3aa22e1aba00\",\n \"companyId\": 12345,\n \"date\": \"2026-04-02\",\n \"status\": \"Committed\",\n \"type\": \"SalesInvoice\",\n \"currencyCode\": \"USD\",\n \"exchangeRateCurrencyCode\": \"USD\",\n \"entityUseCode\": \"\",\n \"customerVendorCode\": \"ABC\",\n \"customerCode\": \"ABC\",\n \"exemptNo\": \"\",\n \"reconciled\": true,\n \"locationCode\": \"DEFAULT\",\n \"salespersonCode\": \"DEF\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"totalAmount\": 1000,\n \"totalExempt\": 0,\n \"totalDiscount\": 0,\n \"totalTax\": 62.5,\n \"totalTaxable\": 1000,\n \"totalTaxCalculated\": 62.5,\n \"adjustmentReason\": \"NotAdjusted\",\n \"adjustmentDescription\": \"\",\n \"locked\": false,\n \"region\": \"CA\",\n \"country\": \"US\",\n \"version\": 0,\n \"originAddressId\": 123456789,\n \"destinationAddressId\": 123456789,\n \"exchangeRateEffectiveDate\": \"2026-04-02\",\n \"exchangeRate\": 2,\n \"isSellerImporterOfRecord\": false,\n \"description\": \"Yarn\",\n \"taxDate\": \"2026-04-02T00:00:00+00:00\",\n \"lines\": [\n {\n \"id\": 123456789,\n \"transactionId\": 123456789,\n \"lineNumber\": \"1\",\n \"boundaryOverrideId\": 0,\n \"entityUseCode\": \"\",\n \"description\": \"Yarn\",\n \"destinationAddressId\": 12345,\n \"originAddressId\": 123456789,\n \"discountAmount\": 100,\n \"discountTypeId\": 0,\n \"exemptAmount\": 0,\n \"exemptCertId\": 0,\n \"exemptNo\": \"\",\n \"isItemTaxable\": true,\n \"isSSTP\": false,\n \"itemCode\": \"116292\",\n \"lineAmount\": 1000,\n \"quantity\": 1,\n \"ref1\": \"Note: Deliver to Bob\",\n \"reportingDate\": \"2026-04-02\",\n \"revAccount\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxCalculated\": 62.5,\n \"taxCode\": \"PS081282\",\n \"taxDate\": \"2026-04-02\",\n \"taxEngine\": \"\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"taxIncluded\": false,\n \"details\": [\n {\n \"id\": 123456789,\n \"transactionLineId\": 123456789,\n \"transactionId\": 123456789,\n \"addressId\": 12345,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"stateFIPS\": \"06\",\n \"exemptAmount\": 0,\n \"exemptReasonId\": 4,\n \"exemptRuleId\": 0,\n \"inState\": false,\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"jurisdictionId\": 5000531,\n \"signatureCode\": \"AGAM\",\n \"stateAssignedNo\": \"\",\n \"jurisType\": \"STA\",\n \"nonTaxableAmount\": 0,\n \"nonTaxableRuleId\": 0,\n \"nonTaxableType\": \"BaseRule\",\n \"rate\": 0.0625,\n \"rateRuleId\": 1321915,\n \"rateSourceId\": 3,\n \"serCode\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxType\": \"Sales\",\n \"taxName\": \"CA STATE TAX\",\n \"taxAuthorityTypeId\": 45,\n \"taxRegionId\": 2127184,\n \"taxCalculated\": 62.5,\n \"taxOverride\": 0,\n \"rateType\": \"General\",\n \"taxableUnits\": 62.5,\n \"nonTaxableUnits\": 1000,\n \"exemptUnits\": 62.5,\n \"reportingTaxableUnits\": 125,\n \"reportingNonTaxableUnits\": 2000,\n \"reportingExemptUnits\": 125,\n \"reportingTax\": 125,\n \"reportingTaxCalculated\": 125,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0,\n \"vatCode\": \"\",\n \"granularDutyDetails\": [\n {\n \"dutyType\": \"ImportDuty\",\n \"rate\": \"10.5\",\n \"amount\": \"105.00\"\n }\n ]\n }\n ],\n \"vatNumberTypeId\": 0,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0\n }\n ],\n \"addresses\": [\n {\n \"id\": 0,\n \"transactionId\": 0,\n \"boundaryLevel\": \"Address\",\n \"line1\": \"100 Ravine Lane Northeast #220\",\n \"city\": \"Bainbridge Island\",\n \"region\": \"WA\",\n \"postalCode\": \"98110\",\n \"country\": \"US\",\n \"taxRegionId\": 0\n }\n ],\n \"taxDetailsByTaxType\": [\n {\n \"taxType\": \"SalesAndUse\",\n \"totalTaxable\": 100,\n \"totalExempt\": 0.05,\n \"totalNonTaxable\": 0,\n \"totalTax\": 0.625\n }\n ]\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"ABC\",\n \"type\": \"SalesInvoice\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/verify", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", "verify" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"ABC\",\n \"type\": \"SalesInvoice\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument/verify", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument", "verify" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Create a new MultiDocument transaction", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"lines\": [\n {\n \"companyCode\": \"DEFAULT\",\n \"reportingLocationCode\": \"ReportLocation111\",\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 100,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument" ], "query": [ { "key": "$include", "value": "string", "description": "Specifies objects to include in the response after transaction is created" } ] }, "description": "Records a new MultiDocument transaction in AvaTax.\r\n \r\nA traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can\r\ninvolve a marketplace of vendors, each of which contributes some portion of the final transaction. Within\r\na MultiDocument transaction, each individual buyer and seller pair are matched up and converted to a separate\r\ndocument. This separation of documents allows each seller to file their taxes separately.\r\n \r\nThis API will report an error if you attempt to create a transaction when one already exists with the specified `code`.\r\nIf you would like the API to automatically update the transaction when it already exists, please set the `allowAdjust`\r\nvalue to `true`.\r\n \r\nTo generate a refund for a transaction, use the `RefundTransaction` API.\r\n \r\nThe field `type` identifies the kind of transaction - for example, a sale, purchase, or refund. If you do not specify\r\na `type` value, you will receive an estimate of type `SalesOrder`, which will not be recorded.\r\n \r\nThe origin and destination locations for a transaction must be identified by either address or geocode. For address-based transactions, please\r\nprovide addresses in the fields `line`, `city`, `region`, `country` and `postalCode`. For geocode-based transactions, please provide the geocode\r\ninformation in the fields `latitude` and `longitude`. If either `latitude` or `longitude` or both are null, the transaction will be calculated\r\nusing the best available address location information.\r\n \r\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:\r\n \r\n* Lines\r\n* Details (implies lines)\r\n* Summary (implies details)\r\n* Addresses\r\n* SummaryOnly (omit lines and details - reduces API response size)\r\n* LinesOnly (omit details - reduces API response size)\r\n* ForceTimeout - Simulates a timeout. This adds a 30 second delay and error to your API call. This can be used to test your code to ensure it can respond correctly in the case of a dropped connection.\r\n \r\nIf you omit the `$include` parameter, the API will assume you want `Summary,Addresses`.\r\n \r\nNOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:\r\n* Replace '/' with '\\_-ava2f-\\_' For example: document/Code becomes document_-ava2f-_Code\r\n* Replace '+' with '\\_-ava2b-\\_' For example: document+Code becomes document_-ava2b-_Code\r\n* Replace '?' with '\\_-ava3f-\\_' For example: document?Code becomes document_-ava3f-_Code\r\n* Replace '%' with '\\_-ava25-\\_' For example: document%Code becomes document_-ava25-_Code\r\n* Replace '#' with '\\_-ava23-\\_' For example: document#Code becomes document_-ava23-_Code\r\n* Replace ' ' with '%20' For example: document Code becomes document%20Code\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"lines\": [\n {\n \"companyCode\": \"DEFAULT\",\n \"reportingLocationCode\": \"ReportLocation111\",\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 100,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument" ], "query": [ { "description": "Specifies objects to include in the response after transaction is created", "key": "$include", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 12,\n \"accountId\": 123456,\n \"code\": \"9e199121-684c-4628-88af-477100699e0f\",\n \"type\": \"SalesInvoice\",\n \"createdUserId\": 87954,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 66783,\n \"documents\": [\n {\n \"id\": 123456789,\n \"code\": \"b994b117-f788-41a0-a1bf-3aa22e1aba00\",\n \"companyId\": 12345,\n \"date\": \"2026-04-02\",\n \"status\": \"Committed\",\n \"type\": \"SalesInvoice\",\n \"currencyCode\": \"USD\",\n \"exchangeRateCurrencyCode\": \"USD\",\n \"entityUseCode\": \"\",\n \"customerVendorCode\": \"ABC\",\n \"customerCode\": \"ABC\",\n \"exemptNo\": \"\",\n \"reconciled\": true,\n \"locationCode\": \"DEFAULT\",\n \"salespersonCode\": \"DEF\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"totalAmount\": 1000,\n \"totalExempt\": 0,\n \"totalDiscount\": 0,\n \"totalTax\": 62.5,\n \"totalTaxable\": 1000,\n \"totalTaxCalculated\": 62.5,\n \"adjustmentReason\": \"NotAdjusted\",\n \"adjustmentDescription\": \"\",\n \"locked\": false,\n \"region\": \"CA\",\n \"country\": \"US\",\n \"version\": 0,\n \"originAddressId\": 123456789,\n \"destinationAddressId\": 123456789,\n \"exchangeRateEffectiveDate\": \"2026-04-02\",\n \"exchangeRate\": 2,\n \"isSellerImporterOfRecord\": false,\n \"description\": \"Yarn\",\n \"taxDate\": \"2026-04-02T00:00:00+00:00\",\n \"lines\": [\n {\n \"id\": 123456789,\n \"transactionId\": 123456789,\n \"lineNumber\": \"1\",\n \"boundaryOverrideId\": 0,\n \"entityUseCode\": \"\",\n \"description\": \"Yarn\",\n \"destinationAddressId\": 12345,\n \"originAddressId\": 123456789,\n \"discountAmount\": 100,\n \"discountTypeId\": 0,\n \"exemptAmount\": 0,\n \"exemptCertId\": 0,\n \"exemptNo\": \"\",\n \"isItemTaxable\": true,\n \"isSSTP\": false,\n \"itemCode\": \"116292\",\n \"lineAmount\": 1000,\n \"quantity\": 1,\n \"ref1\": \"Note: Deliver to Bob\",\n \"reportingDate\": \"2026-04-02\",\n \"revAccount\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxCalculated\": 62.5,\n \"taxCode\": \"PS081282\",\n \"taxDate\": \"2026-04-02\",\n \"taxEngine\": \"\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"taxIncluded\": false,\n \"details\": [\n {\n \"id\": 123456789,\n \"transactionLineId\": 123456789,\n \"transactionId\": 123456789,\n \"addressId\": 12345,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"stateFIPS\": \"06\",\n \"exemptAmount\": 0,\n \"exemptReasonId\": 4,\n \"exemptRuleId\": 0,\n \"inState\": false,\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"jurisdictionId\": 5000531,\n \"signatureCode\": \"AGAM\",\n \"stateAssignedNo\": \"\",\n \"jurisType\": \"STA\",\n \"nonTaxableAmount\": 0,\n \"nonTaxableRuleId\": 0,\n \"nonTaxableType\": \"BaseRule\",\n \"rate\": 0.0625,\n \"rateRuleId\": 1321915,\n \"rateSourceId\": 3,\n \"serCode\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxType\": \"Sales\",\n \"taxName\": \"CA STATE TAX\",\n \"taxAuthorityTypeId\": 45,\n \"taxRegionId\": 2127184,\n \"taxCalculated\": 62.5,\n \"taxOverride\": 0,\n \"rateType\": \"General\",\n \"taxableUnits\": 62.5,\n \"nonTaxableUnits\": 1000,\n \"exemptUnits\": 62.5,\n \"reportingTaxableUnits\": 125,\n \"reportingNonTaxableUnits\": 2000,\n \"reportingExemptUnits\": 125,\n \"reportingTax\": 125,\n \"reportingTaxCalculated\": 125,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0,\n \"vatCode\": \"\",\n \"granularDutyDetails\": [\n {\n \"dutyType\": \"ImportDuty\",\n \"rate\": \"10.5\",\n \"amount\": \"105.00\"\n }\n ]\n }\n ],\n \"vatNumberTypeId\": 0,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0\n }\n ],\n \"addresses\": [\n {\n \"id\": 0,\n \"transactionId\": 0,\n \"boundaryLevel\": \"Address\",\n \"line1\": \"100 Ravine Lane Northeast #220\",\n \"city\": \"Bainbridge Island\",\n \"region\": \"WA\",\n \"postalCode\": \"98110\",\n \"country\": \"US\",\n \"taxRegionId\": 0\n }\n ],\n \"taxDetailsByTaxType\": [\n {\n \"taxType\": \"SalesAndUse\",\n \"totalTaxable\": 100,\n \"totalExempt\": 0.05,\n \"totalNonTaxable\": 0,\n \"totalTax\": 0.625\n }\n ]\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"lines\": [\n {\n \"companyCode\": \"DEFAULT\",\n \"reportingLocationCode\": \"ReportLocation111\",\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 100,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument" ], "query": [ { "description": "Specifies objects to include in the response after transaction is created", "key": "$include", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"lines\": [\n {\n \"companyCode\": \"DEFAULT\",\n \"reportingLocationCode\": \"ReportLocation111\",\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 100,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument" ], "query": [ { "description": "Specifies objects to include in the response after transaction is created", "key": "$include", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"lines\": [\n {\n \"companyCode\": \"DEFAULT\",\n \"reportingLocationCode\": \"ReportLocation111\",\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 100,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument" ], "query": [ { "description": "Specifies objects to include in the response after transaction is created", "key": "$include", "value": "string" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Retrieve all MultiDocument transactions", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* documents" }, { "key": "$include", "value": "string", "description": "Specifies objects to include in the response after transaction is created" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "List all MultiDocument transactions within this account.\r\n \r\nThis endpoint is limited to returning 1,000 MultiDocument transactions at a time. To retrieve more than 1,000 MultiDocument\r\ntransactions, please use the pagination features of the API.\r\n \r\nA transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\r\nsales, purchases, inventory transfer, and returns (also called refunds).\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\r\n \r\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:\r\n \r\n* Lines\r\n* Details (implies lines)\r\n* Summary (implies details)\r\n* Addresses\r\n* SummaryOnly (omit lines and details - reduces API response size)\r\n* LinesOnly (omit details - reduces API response size)\r\n \r\nNOTE: If your companyCode or transactionCode contains any of these characters /, +, ? or a space please use the following encoding before making a request:\r\n* Replace '/' with '\\_-ava2f-\\_' For example: document/Code becomes document_-ava2f-_Code\r\n* Replace '+' with '\\_-ava2b-\\_' For example: document+Code becomes document_-ava2b-_Code\r\n* Replace '?' with '\\_-ava3f-\\_' For example: document?Code becomes document_-ava3f-_Code\r\n* Replace '%' with '\\_-ava25-\\_' For example: document%Code becomes document_-ava25-_Code\r\n* Replace '#' with '\\_-ava23-\\_' For example: document#Code becomes document_-ava23-_Code\r\n* Replace ' ' with '%20' For example: document Code becomes document%20Code\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* documents", "key": "$filter", "value": "string" }, { "description": "Specifies objects to include in the response after transaction is created", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 547,\n \"value\": [\n {\n \"id\": 12,\n \"accountId\": 123456,\n \"code\": \"9e199121-684c-4628-88af-477100699e0f\",\n \"type\": \"SalesInvoice\",\n \"createdUserId\": 87954,\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedDate\": \"2026-04-02T00:00:00+00:00\",\n \"modifiedUserId\": 66783,\n \"documents\": [\n {\n \"id\": 123456789,\n \"code\": \"b994b117-f788-41a0-a1bf-3aa22e1aba00\",\n \"companyId\": 12345,\n \"date\": \"2026-04-02\",\n \"status\": \"Committed\",\n \"type\": \"SalesInvoice\",\n \"currencyCode\": \"USD\",\n \"exchangeRateCurrencyCode\": \"USD\",\n \"entityUseCode\": \"\",\n \"customerVendorCode\": \"ABC\",\n \"customerCode\": \"ABC\",\n \"exemptNo\": \"\",\n \"reconciled\": true,\n \"locationCode\": \"DEFAULT\",\n \"salespersonCode\": \"DEF\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"totalAmount\": 1000,\n \"totalExempt\": 0,\n \"totalDiscount\": 0,\n \"totalTax\": 62.5,\n \"totalTaxable\": 1000,\n \"totalTaxCalculated\": 62.5,\n \"adjustmentReason\": \"NotAdjusted\",\n \"adjustmentDescription\": \"\",\n \"locked\": false,\n \"region\": \"CA\",\n \"country\": \"US\",\n \"version\": 0,\n \"originAddressId\": 123456789,\n \"destinationAddressId\": 123456789,\n \"exchangeRateEffectiveDate\": \"2026-04-02\",\n \"exchangeRate\": 2,\n \"isSellerImporterOfRecord\": false,\n \"description\": \"Yarn\",\n \"taxDate\": \"2026-04-02T00:00:00+00:00\",\n \"lines\": [\n {\n \"id\": 123456789,\n \"transactionId\": 123456789,\n \"lineNumber\": \"1\",\n \"boundaryOverrideId\": 0,\n \"entityUseCode\": \"\",\n \"description\": \"Yarn\",\n \"destinationAddressId\": 12345,\n \"originAddressId\": 123456789,\n \"discountAmount\": 100,\n \"discountTypeId\": 0,\n \"exemptAmount\": 0,\n \"exemptCertId\": 0,\n \"exemptNo\": \"\",\n \"isItemTaxable\": true,\n \"isSSTP\": false,\n \"itemCode\": \"116292\",\n \"lineAmount\": 1000,\n \"quantity\": 1,\n \"ref1\": \"Note: Deliver to Bob\",\n \"reportingDate\": \"2026-04-02\",\n \"revAccount\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxCalculated\": 62.5,\n \"taxCode\": \"PS081282\",\n \"taxDate\": \"2026-04-02\",\n \"taxEngine\": \"\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"taxIncluded\": false,\n \"details\": [\n {\n \"id\": 123456789,\n \"transactionLineId\": 123456789,\n \"transactionId\": 123456789,\n \"addressId\": 12345,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"stateFIPS\": \"06\",\n \"exemptAmount\": 0,\n \"exemptReasonId\": 4,\n \"exemptRuleId\": 0,\n \"inState\": false,\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"jurisdictionId\": 5000531,\n \"signatureCode\": \"AGAM\",\n \"stateAssignedNo\": \"\",\n \"jurisType\": \"STA\",\n \"nonTaxableAmount\": 0,\n \"nonTaxableRuleId\": 0,\n \"nonTaxableType\": \"BaseRule\",\n \"rate\": 0.0625,\n \"rateRuleId\": 1321915,\n \"rateSourceId\": 3,\n \"serCode\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxType\": \"Sales\",\n \"taxName\": \"CA STATE TAX\",\n \"taxAuthorityTypeId\": 45,\n \"taxRegionId\": 2127184,\n \"taxCalculated\": 62.5,\n \"taxOverride\": 0,\n \"rateType\": \"General\",\n \"taxableUnits\": 62.5,\n \"nonTaxableUnits\": 1000,\n \"exemptUnits\": 62.5,\n \"reportingTaxableUnits\": 125,\n \"reportingNonTaxableUnits\": 2000,\n \"reportingExemptUnits\": 125,\n \"reportingTax\": 125,\n \"reportingTaxCalculated\": 125,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0,\n \"vatCode\": \"\",\n \"granularDutyDetails\": [\n {\n \"dutyType\": \"ImportDuty\",\n \"rate\": \"10.5\",\n \"amount\": \"105.00\"\n }\n ]\n }\n ],\n \"vatNumberTypeId\": 0,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0\n }\n ],\n \"addresses\": [\n {\n \"id\": 0,\n \"transactionId\": 0,\n \"boundaryLevel\": \"Address\",\n \"line1\": \"100 Ravine Lane Northeast #220\",\n \"city\": \"Bainbridge Island\",\n \"region\": \"WA\",\n \"postalCode\": \"98110\",\n \"country\": \"US\",\n \"taxRegionId\": 0\n }\n ],\n \"taxDetailsByTaxType\": [\n {\n \"taxType\": \"SalesAndUse\",\n \"totalTaxable\": 100,\n \"totalExempt\": 0.05,\n \"totalNonTaxable\": 0,\n \"totalTax\": 0.625\n }\n ]\n }\n ]\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* documents", "key": "$filter", "value": "string" }, { "description": "Specifies objects to include in the response after transaction is created", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/transactions/multidocument?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "multidocument" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* documents", "key": "$filter", "value": "string" }, { "description": "Specifies objects to include in the response after transaction is created", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "{id}", "item": [ { "name": "Retrieve a single transaction by ID", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/transactions/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", ":id" ], "query": [ { "key": "$include", "value": "string", "description": "Specifies objects to include in this fetch call" } ], "variable": [ { "key": "id", "value": "155", "description": "The unique ID number of the transaction to retrieve" } ] }, "description": "Get the unique transaction identified by this URL.\r\n \r\nThis endpoint retrieves the exact transaction identified by this ID number, as long as it is the most version of the transaction.\r\n \r\nA transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\r\nsales, purchases, inventory transfer, and returns (also called refunds).\r\n \r\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:\r\n \r\n* Lines\r\n* Details (implies lines)\r\n* AccountPayableSalesTaxDetails (implies lines - only for Account Payable transaction)\r\n* Summary (implies details)\r\n* Addresses\r\n* SummaryOnly (omit lines and details - reduces API response size)\r\n* LinesOnly (omit details - reduces API response size)\r\n* TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/transactions/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", ":id" ], "query": [ { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "id", "value": "155", "description": "The unique ID number of the transaction to retrieve" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 123456789,\n \"code\": \"ed92c353-a94c-4fe2-a32f-0d52f4f5ccf6\",\n \"companyId\": 12345,\n \"date\": \"2026-04-02\",\n \"status\": \"Committed\",\n \"type\": \"SalesInvoice\",\n \"currencyCode\": \"USD\",\n \"exchangeRateCurrencyCode\": \"USD\",\n \"entityUseCode\": \"\",\n \"customerVendorCode\": \"ABC\",\n \"customerCode\": \"ABC\",\n \"exemptNo\": \"\",\n \"reconciled\": true,\n \"locationCode\": \"DEFAULT\",\n \"salespersonCode\": \"DEF\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"totalAmount\": 1000,\n \"totalExempt\": 0,\n \"totalDiscount\": 0,\n \"totalTax\": 62.5,\n \"totalTaxable\": 1000,\n \"totalTaxCalculated\": 62.5,\n \"adjustmentReason\": \"NotAdjusted\",\n \"adjustmentDescription\": \"\",\n \"locked\": false,\n \"region\": \"CA\",\n \"country\": \"US\",\n \"version\": 0,\n \"originAddressId\": 123456789,\n \"destinationAddressId\": 123456789,\n \"exchangeRateEffectiveDate\": \"2026-04-02\",\n \"exchangeRate\": 2,\n \"isSellerImporterOfRecord\": false,\n \"description\": \"Yarn\",\n \"taxDate\": \"2026-04-02T00:00:00+00:00\",\n \"lines\": [\n {\n \"id\": 123456789,\n \"transactionId\": 123456789,\n \"lineNumber\": \"1\",\n \"boundaryOverrideId\": 0,\n \"entityUseCode\": \"\",\n \"description\": \"Yarn\",\n \"destinationAddressId\": 12345,\n \"originAddressId\": 123456789,\n \"discountAmount\": 100,\n \"discountTypeId\": 0,\n \"exemptAmount\": 0,\n \"exemptCertId\": 0,\n \"exemptNo\": \"\",\n \"isItemTaxable\": true,\n \"isSSTP\": false,\n \"itemCode\": \"116292\",\n \"lineAmount\": 1000,\n \"quantity\": 1,\n \"ref1\": \"Note: Deliver to Bob\",\n \"reportingDate\": \"2026-04-02\",\n \"revAccount\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxCalculated\": 62.5,\n \"taxCode\": \"PS081282\",\n \"taxDate\": \"2026-04-02\",\n \"taxEngine\": \"\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"taxIncluded\": false,\n \"details\": [\n {\n \"id\": 123456789,\n \"transactionLineId\": 123456789,\n \"transactionId\": 123456789,\n \"addressId\": 12345,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"stateFIPS\": \"06\",\n \"exemptAmount\": 0,\n \"exemptReasonId\": 4,\n \"exemptRuleId\": 0,\n \"inState\": false,\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"jurisdictionId\": 5000531,\n \"signatureCode\": \"AGAM\",\n \"stateAssignedNo\": \"\",\n \"jurisType\": \"STA\",\n \"nonTaxableAmount\": 0,\n \"nonTaxableRuleId\": 0,\n \"nonTaxableType\": \"BaseRule\",\n \"rate\": 0.0625,\n \"rateRuleId\": 1321915,\n \"rateSourceId\": 3,\n \"serCode\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxType\": \"Sales\",\n \"taxName\": \"CA STATE TAX\",\n \"taxAuthorityTypeId\": 45,\n \"taxRegionId\": 2127184,\n \"taxCalculated\": 62.5,\n \"taxOverride\": 0,\n \"rateType\": \"General\",\n \"taxableUnits\": 62.5,\n \"nonTaxableUnits\": 1000,\n \"exemptUnits\": 62.5,\n \"reportingTaxableUnits\": 125,\n \"reportingNonTaxableUnits\": 2000,\n \"reportingExemptUnits\": 125,\n \"reportingTax\": 125,\n \"reportingTaxCalculated\": 125,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0,\n \"vatCode\": \"\",\n \"granularDutyDetails\": [\n {\n \"dutyType\": \"ImportDuty\",\n \"rate\": \"10.5\",\n \"amount\": \"105.00\"\n }\n ]\n }\n ],\n \"vatNumberTypeId\": 0,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0\n }\n ],\n \"addresses\": [\n {\n \"id\": 0,\n \"transactionId\": 0,\n \"boundaryLevel\": \"Address\",\n \"line1\": \"100 Ravine Lane Northeast #220\",\n \"city\": \"Bainbridge Island\",\n \"region\": \"WA\",\n \"postalCode\": \"98110\",\n \"country\": \"US\",\n \"taxRegionId\": 0\n }\n ],\n \"taxDetailsByTaxType\": [\n {\n \"taxType\": \"SalesAndUse\",\n \"totalTaxable\": 100,\n \"totalExempt\": 0.05,\n \"totalNonTaxable\": 0,\n \"totalTax\": 0.625\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/transactions/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", ":id" ], "query": [ { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "id", "value": "155", "description": "The unique ID number of the transaction to retrieve" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/transactions/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", ":id" ], "query": [ { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "id", "value": "155", "description": "The unique ID number of the transaction to retrieve" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/transactions/:id?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", ":id" ], "query": [ { "description": "Specifies objects to include in this fetch call", "key": "$include", "value": "string" } ], "variable": [ { "key": "id", "value": "155", "description": "The unique ID number of the transaction to retrieve" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "create", "item": [ { "name": "Create a new transaction", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"lines\": [\n {\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 100,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/create?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "create" ], "query": [ { "key": "$include", "value": "string", "description": "Specifies objects to include in the response after transaction is created" } ] }, "description": "Records a new transaction in AvaTax.\r\n \r\nA transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\r\nsales, purchases, inventory transfer, and returns (also called refunds).\r\n \r\nThe `CreateTransaction` endpoint uses the tax profile of your company to identify the correct tax rules\r\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\r\ncompany's configuration and the data provided in this API call.\r\n \r\nThe `CreateTransaction` API will report an error if a committed transaction already exists with the same `code`. To\r\navoid this error, use the `CreateOrAdjustTransaction` API - it will create the transaction if it does not exist, or\r\nupdate it if it does exist.\r\n \r\nTo generate a refund for a transaction, use the `RefundTransaction` API.\r\n \r\nAn address is required for calculation. If no address is provided at the line level, the document level address will be used.\r\n\r\nThe field `type` identifies the kind of transaction - for example, a sale, purchase, or refund. If you do not specify\r\na `type` value, you will receive an estimate of type `SalesOrder`, which will not be recorded.\r\n \r\nThe origin and destination locations for a transaction must be identified by either address or geocode. For address-based transactions, please\r\nprovide addresses in the fields `line`, `city`, `region`, `country` and `postalCode`. For geocode-based transactions, please provide the geocode\r\ninformation in the fields `latitude` and `longitude`. If either `latitude` or `longitude` or both are null, the transaction will be calculated\r\nusing the best available address location information.\r\n \r\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:\r\n \r\n* Lines\r\n* Details (implies lines)\r\n* AccountPayableSalesTaxDetails (implies lines - only for Account Payable transaction)\r\n* Summary (implies details)\r\n* Addresses\r\n* SummaryOnly (omit lines and details - reduces API response size)\r\n* LinesOnly (omit details - reduces API response size)\r\n* ForceTimeout - Simulates a timeout. This adds a 30 second delay and error to your API call. This can be used to test your code to ensure it can respond correctly in the case of a dropped connection.\r\n* TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary.\r\n \r\nIf you omit the `$include` parameter, the API will assume you want `Summary,Addresses`.\r\n \r\nNOTE: Avoid using the following strings in your transaction codes as they are encoding strings and will be interpreted differently:\r\n* \\_-ava2f-\\_\r\n* \\_-ava2b-\\_\r\n* \\_-ava3f-\\_\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.\n" }, "response": [ { "name": "Created", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"lines\": [\n {\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 100,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/create?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "create" ], "query": [ { "description": "Specifies objects to include in the response after transaction is created", "key": "$include", "value": "string" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 123456789,\n \"code\": \"ed92c353-a94c-4fe2-a32f-0d52f4f5ccf6\",\n \"companyId\": 12345,\n \"date\": \"2026-04-02\",\n \"status\": \"Committed\",\n \"type\": \"SalesInvoice\",\n \"currencyCode\": \"USD\",\n \"exchangeRateCurrencyCode\": \"USD\",\n \"entityUseCode\": \"\",\n \"customerVendorCode\": \"ABC\",\n \"customerCode\": \"ABC\",\n \"exemptNo\": \"\",\n \"reconciled\": true,\n \"locationCode\": \"DEFAULT\",\n \"salespersonCode\": \"DEF\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"totalAmount\": 1000,\n \"totalExempt\": 0,\n \"totalDiscount\": 0,\n \"totalTax\": 62.5,\n \"totalTaxable\": 1000,\n \"totalTaxCalculated\": 62.5,\n \"adjustmentReason\": \"NotAdjusted\",\n \"adjustmentDescription\": \"\",\n \"locked\": false,\n \"region\": \"CA\",\n \"country\": \"US\",\n \"version\": 0,\n \"originAddressId\": 123456789,\n \"destinationAddressId\": 123456789,\n \"exchangeRateEffectiveDate\": \"2026-04-02\",\n \"exchangeRate\": 2,\n \"isSellerImporterOfRecord\": false,\n \"description\": \"Yarn\",\n \"taxDate\": \"2026-04-02T00:00:00+00:00\",\n \"lines\": [\n {\n \"id\": 123456789,\n \"transactionId\": 123456789,\n \"lineNumber\": \"1\",\n \"boundaryOverrideId\": 0,\n \"entityUseCode\": \"\",\n \"description\": \"Yarn\",\n \"destinationAddressId\": 12345,\n \"originAddressId\": 123456789,\n \"discountAmount\": 100,\n \"discountTypeId\": 0,\n \"exemptAmount\": 0,\n \"exemptCertId\": 0,\n \"exemptNo\": \"\",\n \"isItemTaxable\": true,\n \"isSSTP\": false,\n \"itemCode\": \"116292\",\n \"lineAmount\": 1000,\n \"quantity\": 1,\n \"ref1\": \"Note: Deliver to Bob\",\n \"reportingDate\": \"2026-04-02\",\n \"revAccount\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxCalculated\": 62.5,\n \"taxCode\": \"PS081282\",\n \"taxDate\": \"2026-04-02\",\n \"taxEngine\": \"\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"taxIncluded\": false,\n \"details\": [\n {\n \"id\": 123456789,\n \"transactionLineId\": 123456789,\n \"transactionId\": 123456789,\n \"addressId\": 12345,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"stateFIPS\": \"06\",\n \"exemptAmount\": 0,\n \"exemptReasonId\": 4,\n \"exemptRuleId\": 0,\n \"inState\": false,\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"jurisdictionId\": 5000531,\n \"signatureCode\": \"AGAM\",\n \"stateAssignedNo\": \"\",\n \"jurisType\": \"STA\",\n \"nonTaxableAmount\": 0,\n \"nonTaxableRuleId\": 0,\n \"nonTaxableType\": \"BaseRule\",\n \"rate\": 0.0625,\n \"rateRuleId\": 1321915,\n \"rateSourceId\": 3,\n \"serCode\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxType\": \"Sales\",\n \"taxName\": \"CA STATE TAX\",\n \"taxAuthorityTypeId\": 45,\n \"taxRegionId\": 2127184,\n \"taxCalculated\": 62.5,\n \"taxOverride\": 0,\n \"rateType\": \"General\",\n \"taxableUnits\": 62.5,\n \"nonTaxableUnits\": 1000,\n \"exemptUnits\": 62.5,\n \"reportingTaxableUnits\": 125,\n \"reportingNonTaxableUnits\": 2000,\n \"reportingExemptUnits\": 125,\n \"reportingTax\": 125,\n \"reportingTaxCalculated\": 125,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0,\n \"vatCode\": \"\",\n \"granularDutyDetails\": [\n {\n \"dutyType\": \"ImportDuty\",\n \"rate\": \"10.5\",\n \"amount\": \"105.00\"\n }\n ]\n }\n ],\n \"vatNumberTypeId\": 0,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0\n }\n ],\n \"addresses\": [\n {\n \"id\": 0,\n \"transactionId\": 0,\n \"boundaryLevel\": \"Address\",\n \"line1\": \"100 Ravine Lane Northeast #220\",\n \"city\": \"Bainbridge Island\",\n \"region\": \"WA\",\n \"postalCode\": \"98110\",\n \"country\": \"US\",\n \"taxRegionId\": 0\n }\n ],\n \"taxDetailsByTaxType\": [\n {\n \"taxType\": \"SalesAndUse\",\n \"totalTaxable\": 100,\n \"totalExempt\": 0.05,\n \"totalNonTaxable\": 0,\n \"totalTax\": 0.625\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"lines\": [\n {\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 100,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/create?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "create" ], "query": [ { "description": "Specifies objects to include in the response after transaction is created", "key": "$include", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"lines\": [\n {\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 100,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/create?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "create" ], "query": [ { "description": "Specifies objects to include in the response after transaction is created", "key": "$include", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "createoradjust", "item": [ { "name": "Create or adjust a transaction", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"adjustmentReason\": \"Other\",\n \"adjustmentDescription\": \"Test Description\",\n \"createTransactionModel\": {\n \"lines\": [\n {\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 100,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/createoradjust?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "createoradjust" ], "query": [ { "key": "$include", "value": "string", "description": "Specifies objects to include in the response after transaction is created" } ] }, "description": "Records a new transaction or adjust an existing transaction in AvaTax.\r\n \r\nThe `CreateOrAdjustTransaction` endpoint is used to create a new transaction or update an existing one. This API\r\ncan help you create an idempotent service that creates transactions\r\nIf there exists a transaction identified by code, the original transaction will be adjusted by using the meta data\r\nin the input transaction.\r\n \r\nThe `CreateOrAdjustTransaction` API cannot modify any transaction that has been reported to a tax authority using\r\nthe Avalara Managed Returns Service or any other tax filing service. If you call this API to attempt to modify\r\na transaction that has been reported on a tax filing, you will receive the error `CannotModifyLockedTransaction`.\r\n \r\nTo generate a refund for a transaction, use the `RefundTransaction` API.\r\n \r\nAn address is required for calculation. If no address is provided at the line level, the document level address will be used.\r\n\r\nIf 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.\r\n \r\nA transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\r\nsales, purchases, inventory transfer, and returns (also called refunds).\r\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:\r\n \r\n* Lines\r\n* Details (implies lines)\r\n* AccountPayableSalesTaxDetails (implies lines - only for Account Payable transaction)\r\n* Summary (implies details)\r\n* Addresses\r\n* SummaryOnly (omit lines and details - reduces API response size)\r\n* LinesOnly (omit details - reduces API response size)\r\n* ForceTimeout - Simulates a timeout. This adds a 30 second delay and error to your API call. This can be used to test your code to ensure it can respond correctly in the case of a dropped connection.\r\n \r\nIf you omit the `$include` parameter, the API will assume you want `Summary,Addresses`.\r\n \r\nNOTE: Avoid using the following strings in your transaction codes as they are encoding strings and will be interpreted differently:\r\n* \\_-ava2f-\\_\r\n* \\_-ava2b-\\_\r\n* \\_-ava3f-\\_\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyCompanyAdmin, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"adjustmentReason\": \"Other\",\n \"adjustmentDescription\": \"Test Description\",\n \"createTransactionModel\": {\n \"lines\": [\n {\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 100,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/createoradjust?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "createoradjust" ], "query": [ { "description": "Specifies objects to include in the response after transaction is created", "key": "$include", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 123456789,\n \"code\": \"ed92c353-a94c-4fe2-a32f-0d52f4f5ccf6\",\n \"companyId\": 12345,\n \"date\": \"2026-04-02\",\n \"status\": \"Committed\",\n \"type\": \"SalesInvoice\",\n \"currencyCode\": \"USD\",\n \"exchangeRateCurrencyCode\": \"USD\",\n \"entityUseCode\": \"\",\n \"customerVendorCode\": \"ABC\",\n \"customerCode\": \"ABC\",\n \"exemptNo\": \"\",\n \"reconciled\": true,\n \"locationCode\": \"DEFAULT\",\n \"salespersonCode\": \"DEF\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"totalAmount\": 1000,\n \"totalExempt\": 0,\n \"totalDiscount\": 0,\n \"totalTax\": 62.5,\n \"totalTaxable\": 1000,\n \"totalTaxCalculated\": 62.5,\n \"adjustmentReason\": \"NotAdjusted\",\n \"adjustmentDescription\": \"\",\n \"locked\": false,\n \"region\": \"CA\",\n \"country\": \"US\",\n \"version\": 0,\n \"originAddressId\": 123456789,\n \"destinationAddressId\": 123456789,\n \"exchangeRateEffectiveDate\": \"2026-04-02\",\n \"exchangeRate\": 2,\n \"isSellerImporterOfRecord\": false,\n \"description\": \"Yarn\",\n \"taxDate\": \"2026-04-02T00:00:00+00:00\",\n \"lines\": [\n {\n \"id\": 123456789,\n \"transactionId\": 123456789,\n \"lineNumber\": \"1\",\n \"boundaryOverrideId\": 0,\n \"entityUseCode\": \"\",\n \"description\": \"Yarn\",\n \"destinationAddressId\": 12345,\n \"originAddressId\": 123456789,\n \"discountAmount\": 100,\n \"discountTypeId\": 0,\n \"exemptAmount\": 0,\n \"exemptCertId\": 0,\n \"exemptNo\": \"\",\n \"isItemTaxable\": true,\n \"isSSTP\": false,\n \"itemCode\": \"116292\",\n \"lineAmount\": 1000,\n \"quantity\": 1,\n \"ref1\": \"Note: Deliver to Bob\",\n \"reportingDate\": \"2026-04-02\",\n \"revAccount\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxCalculated\": 62.5,\n \"taxCode\": \"PS081282\",\n \"taxDate\": \"2026-04-02\",\n \"taxEngine\": \"\",\n \"taxOverrideType\": \"None\",\n \"taxOverrideAmount\": 0,\n \"taxOverrideReason\": \"\",\n \"taxIncluded\": false,\n \"details\": [\n {\n \"id\": 123456789,\n \"transactionLineId\": 123456789,\n \"transactionId\": 123456789,\n \"addressId\": 12345,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"stateFIPS\": \"06\",\n \"exemptAmount\": 0,\n \"exemptReasonId\": 4,\n \"exemptRuleId\": 0,\n \"inState\": false,\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"jurisdictionId\": 5000531,\n \"signatureCode\": \"AGAM\",\n \"stateAssignedNo\": \"\",\n \"jurisType\": \"STA\",\n \"nonTaxableAmount\": 0,\n \"nonTaxableRuleId\": 0,\n \"nonTaxableType\": \"BaseRule\",\n \"rate\": 0.0625,\n \"rateRuleId\": 1321915,\n \"rateSourceId\": 3,\n \"serCode\": \"\",\n \"sourcing\": \"Destination\",\n \"tax\": 62.5,\n \"taxableAmount\": 1000,\n \"taxType\": \"Sales\",\n \"taxName\": \"CA STATE TAX\",\n \"taxAuthorityTypeId\": 45,\n \"taxRegionId\": 2127184,\n \"taxCalculated\": 62.5,\n \"taxOverride\": 0,\n \"rateType\": \"General\",\n \"taxableUnits\": 62.5,\n \"nonTaxableUnits\": 1000,\n \"exemptUnits\": 62.5,\n \"reportingTaxableUnits\": 125,\n \"reportingNonTaxableUnits\": 2000,\n \"reportingExemptUnits\": 125,\n \"reportingTax\": 125,\n \"reportingTaxCalculated\": 125,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0,\n \"vatCode\": \"\",\n \"granularDutyDetails\": [\n {\n \"dutyType\": \"ImportDuty\",\n \"rate\": \"10.5\",\n \"amount\": \"105.00\"\n }\n ]\n }\n ],\n \"vatNumberTypeId\": 0,\n \"recoverabilityPercentage\": 1,\n \"recoverableAmount\": 62.5,\n \"nonRecoverableAmount\": 0\n }\n ],\n \"addresses\": [\n {\n \"id\": 0,\n \"transactionId\": 0,\n \"boundaryLevel\": \"Address\",\n \"line1\": \"100 Ravine Lane Northeast #220\",\n \"city\": \"Bainbridge Island\",\n \"region\": \"WA\",\n \"postalCode\": \"98110\",\n \"country\": \"US\",\n \"taxRegionId\": 0\n }\n ],\n \"taxDetailsByTaxType\": [\n {\n \"taxType\": \"SalesAndUse\",\n \"totalTaxable\": 100,\n \"totalExempt\": 0.05,\n \"totalNonTaxable\": 0,\n \"totalTax\": 0.625\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"adjustmentReason\": \"Other\",\n \"adjustmentDescription\": \"Test Description\",\n \"createTransactionModel\": {\n \"lines\": [\n {\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 100,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/createoradjust?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "createoradjust" ], "query": [ { "description": "Specifies objects to include in the response after transaction is created", "key": "$include", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"adjustmentReason\": \"Other\",\n \"adjustmentDescription\": \"Test Description\",\n \"createTransactionModel\": {\n \"lines\": [\n {\n \"number\": \"1\",\n \"quantity\": 1,\n \"amount\": 100,\n \"taxCode\": \"PS081282\",\n \"itemCode\": \"Y0001\",\n \"description\": \"Yarn\"\n }\n ],\n \"type\": \"SalesInvoice\",\n \"companyCode\": \"DEFAULT\",\n \"date\": \"2026-04-02\",\n \"customerCode\": \"ABC\",\n \"purchaseOrderNo\": \"2026-04-02-001\",\n \"addresses\": {\n \"singleLocation\": {\n \"line1\": \"2000 Main Street\",\n \"city\": \"Irvine\",\n \"region\": \"CA\",\n \"country\": \"US\",\n \"postalCode\": \"92614\"\n }\n },\n \"commit\": true,\n \"currencyCode\": \"USD\",\n \"description\": \"Yarn\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/createoradjust?$include=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "createoradjust" ], "query": [ { "description": "Specifies objects to include in the response after transaction is created", "key": "$include", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "lock", "item": [ { "name": "Lock a set of documents", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"documentIds\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ],\n \"isLocked\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/lock", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "lock" ] }, "description": "This API is available by invitation only.\r\n \r\nLock a set of transactions uniquely identified by DocumentIds provided. This API allows locking multiple documents at once.\r\nAfter this API call succeeds, documents will be locked and can't be voided.\r\n \r\nA transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like\r\nsales, purchases, inventory transfer, and returns (also called refunds).\n\n### Security Policies\n\n* This API requires the user role Compliance Root User.\n* This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"documentIds\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ],\n \"isLocked\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/lock", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "lock" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"numberOfRecords\": 42\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"documentIds\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ],\n \"isLocked\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/lock", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "lock" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"documentIds\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ],\n \"isLocked\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/transactions/lock", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "transactions", "lock" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "nexus", "item": [ { "name": "Retrieve all nexus", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/nexus?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "nexus" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters" }, { "key": "$include", "value": "string", "description": "A comma separated list of additional data to retrieve." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Get multiple nexus objects across all companies.\r\n \r\nThe concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional\r\ntaxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your\r\naccountant or lawyer prior to declaring nexus.\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\r\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:\r\n \r\n * Parameters\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/nexus?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "nexus" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 1459,\n \"value\": [\n {\n \"id\": 0,\n \"companyId\": 0,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"State\",\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"effectiveDate\": \"2017-04-01\",\n \"endDate\": \"2017-03-31\",\n \"shortName\": \"CALIFORNIA\",\n \"signatureCode\": \"\",\n \"stateAssignedNo\": \"\",\n \"nexusTypeId\": \"SalesOrSellersUseTax\",\n \"sourcing\": \"Destination\",\n \"hasLocalNexus\": false,\n \"hasPermanentEstablishment\": true,\n \"streamlinedSalesTax\": false,\n \"isSSTActive\": false,\n \"createdDate\": \"2017-06-30T05:14:06.003\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2022-04-20T01:34:46.39\",\n \"modifiedUserId\": 0,\n \"taxTypeGroup\": \"EWaste\",\n \"nexusTaxTypeGroup\": \"SalesAndUse\",\n \"isSellerImporterOfRecord\": false,\n \"taxName\": \"Tire Fee\",\n \"taxableNexus\": true\n },\n {\n \"id\": 0,\n \"companyId\": 0,\n \"country\": \"US\",\n \"region\": \"CA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"State\",\n \"jurisCode\": \"06\",\n \"jurisName\": \"CALIFORNIA\",\n \"effectiveDate\": \"2017-04-01\",\n \"endDate\": \"2017-03-31\",\n \"shortName\": \"CALIFORNIA\",\n \"signatureCode\": \"\",\n \"stateAssignedNo\": \"\",\n \"nexusTypeId\": \"SalesOrSellersUseTax\",\n \"sourcing\": \"Destination\",\n \"hasLocalNexus\": false,\n \"hasPermanentEstablishment\": true,\n \"streamlinedSalesTax\": false,\n \"isSSTActive\": false,\n \"createdDate\": \"2017-06-30T05:14:06.003\",\n \"createdUserId\": 0,\n \"modifiedDate\": \"2022-04-20T01:34:46.39\",\n \"modifiedUserId\": 0,\n \"taxTypeGroup\": \"EWaste\",\n \"nexusTaxTypeGroup\": \"SalesAndUse\",\n \"isSellerImporterOfRecord\": false,\n \"taxName\": \"Tire Fee\",\n \"taxableNexus\": true\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/nexus?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "nexus" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/nexus?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "nexus" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "notices", "item": [ { "name": "responsibilities", "item": [ { "name": "{responsibilityId}", "item": [ { "name": "Delete a tax notice responsibility type.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/notices/responsibilities/:responsibilityId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notices", "responsibilities", ":responsibilityId" ], "variable": [ { "key": "responsibilityId", "value": "451", "description": "The unique ID of the responsibility type" } ] }, "description": "This API is available by invitation only and only available for users with Compliance admin access.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/notices/responsibilities/:responsibilityId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notices", "responsibilities", ":responsibilityId" ], "variable": [ { "key": "responsibilityId", "value": "451", "description": "The unique ID of the responsibility type" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/notices/responsibilities/:responsibilityId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notices", "responsibilities", ":responsibilityId" ], "variable": [ { "key": "responsibilityId", "value": "451", "description": "The unique ID of the responsibility type" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/notices/responsibilities/:responsibilityId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notices", "responsibilities", ":responsibilityId" ], "variable": [ { "key": "responsibilityId", "value": "451", "description": "The unique ID of the responsibility type" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/notices/responsibilities/:responsibilityId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notices", "responsibilities", ":responsibilityId" ], "variable": [ { "key": "responsibilityId", "value": "451", "description": "The unique ID of the responsibility type" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Creates a new tax notice responsibility type.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"Customer-Invalid login (Return filed manual)\",\n \"isActive\": true,\n \"sortOrder\": 175\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notices/responsibilities", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notices", "responsibilities" ] }, "description": "This API is available by invitation only and only available for users with Compliance admin access.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n* This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"Customer-Invalid login (Return filed manual)\",\n \"isActive\": true,\n \"sortOrder\": 175\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notices/responsibilities", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notices", "responsibilities" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 11,\n \"description\": \"Customer-Invalid login (Return filed manual)\",\n \"isActive\": true,\n \"sortOrder\": 55\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"Customer-Invalid login (Return filed manual)\",\n \"isActive\": true,\n \"sortOrder\": 175\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notices/responsibilities", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notices", "responsibilities" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"Customer-Invalid login (Return filed manual)\",\n \"isActive\": true,\n \"sortOrder\": 175\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notices/responsibilities", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notices", "responsibilities" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"Customer-Invalid login (Return filed manual)\",\n \"isActive\": true,\n \"sortOrder\": 175\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notices/responsibilities", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notices", "responsibilities" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "rootcauses", "item": [ { "name": "{rootCauseId}", "item": [ { "name": "Delete a tax notice root cause type.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/notices/rootcauses/:rootCauseId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notices", "rootcauses", ":rootCauseId" ], "variable": [ { "key": "rootCauseId", "value": "451", "description": "The unique ID of the root cause type" } ] }, "description": "This API is available by invitation only and only available for users with Compliance admin access.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/notices/rootcauses/:rootCauseId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notices", "rootcauses", ":rootCauseId" ], "variable": [ { "key": "rootCauseId", "value": "451", "description": "The unique ID of the root cause type" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/notices/rootcauses/:rootCauseId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notices", "rootcauses", ":rootCauseId" ], "variable": [ { "key": "rootCauseId", "value": "451", "description": "The unique ID of the root cause type" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/notices/rootcauses/:rootCauseId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notices", "rootcauses", ":rootCauseId" ], "variable": [ { "key": "rootCauseId", "value": "451", "description": "The unique ID of the root cause type" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/notices/rootcauses/:rootCauseId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notices", "rootcauses", ":rootCauseId" ], "variable": [ { "key": "rootCauseId", "value": "451", "description": "The unique ID of the root cause type" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Creates a new tax notice root cause type.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"Customer-Invalid login (Return filed manual)\",\n \"isActive\": true,\n \"sortOrder\": 55\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notices/rootcauses", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notices", "rootcauses" ] }, "description": "This API is available by invitation only and only available for users with Compliance admin access.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyCompanyAdmin, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n* This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"Customer-Invalid login (Return filed manual)\",\n \"isActive\": true,\n \"sortOrder\": 55\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notices/rootcauses", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notices", "rootcauses" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 11,\n \"description\": \"Customer-Invalid login (Return filed manual)\",\n \"isActive\": true,\n \"sortOrder\": 55\n}" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"Customer-Invalid login (Return filed manual)\",\n \"isActive\": true,\n \"sortOrder\": 55\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notices/rootcauses", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notices", "rootcauses" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"Customer-Invalid login (Return filed manual)\",\n \"isActive\": true,\n \"sortOrder\": 55\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notices/rootcauses", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notices", "rootcauses" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"Customer-Invalid login (Return filed manual)\",\n \"isActive\": true,\n \"sortOrder\": 55\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notices/rootcauses", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notices", "rootcauses" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "notifications", "item": [ { "name": "{id}", "item": [ { "name": "dismiss", "item": [ { "name": "Mark a single notification as dismissed.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/notifications/:id/dismiss", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", ":id", "dismiss" ], "variable": [ { "key": "id", "value": "155", "description": "The id of the notification you wish to mark as dismissed." } ] }, "description": "Marks the notification identified by this URL as dismissed.\r\n \r\nA notification is a message from Avalara that may have relevance to your business. You may want\r\nto regularly review notifications and then dismiss them when you are certain that you have addressed\r\nany relevant concerns raised by this notification.\r\n \r\nAn example of a notification would be a message about new software, or a change to AvaTax that may\r\naffect you, or a potential issue with your company's tax profile.\r\n \r\nWhen you dismiss a notification, the notification will track the user and time when it was\r\ndismissed. You can then later review which employees of your company dismissed notifications to\r\ndetermine if they were resolved appropriately.\r\n \r\nA Global notification with null accountId and companyId cannot be dismissed and will expire within a given time span.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/notifications/:id/dismiss", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", ":id", "dismiss" ], "variable": [ { "key": "id", "value": "155", "description": "The id of the notification you wish to mark as dismissed." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 123,\n \"accountId\": 202011901,\n \"companyId\": 34345,\n \"referenceObject\": \"Company Return\",\n \"referenceId\": 692,\n \"severityLevelId\": \"Neutral\",\n \"category\": \"Certificate Expiration\",\n \"message\": \"The certificate of your company is nearing its expiration, please consider renewing it.\",\n \"needsAction\": true,\n \"actionName\": \"Certificate Renewal\",\n \"actionLink\": \"www.xyz.com\",\n \"dismissed\": false,\n \"expireDate\": \"2026-04-02T00:00:00+00:00\",\n \"createdUserId\": 442323,\n \"createdDate\": \"2018-05-05T00:00:00\",\n \"modifiedUserId\": 442323,\n \"modifiedDate\": \"2018-05-07T00:00:00\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/notifications/:id/dismiss", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", ":id", "dismiss" ], "variable": [ { "key": "id", "value": "155", "description": "The id of the notification you wish to mark as dismissed." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/notifications/:id/dismiss", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", ":id", "dismiss" ], "variable": [ { "key": "id", "value": "155", "description": "The id of the notification you wish to mark as dismissed." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/notifications/:id/dismiss", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", ":id", "dismiss" ], "variable": [ { "key": "id", "value": "155", "description": "The id of the notification you wish to mark as dismissed." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Retrieve a single notification.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/notifications/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", ":id" ], "variable": [ { "key": "id", "value": "155", "description": "The id of the notification to retrieve." } ] }, "description": "Retrieve a single notification by its unique ID number.\r\n \r\nA notification is a message from Avalara that may have relevance to your business. You may want\r\nto regularly review notifications and then dismiss them when you are certain that you have addressed\r\nany relevant concerns raised by this notification.\r\n \r\nAn example of a notification would be a message about new software, or a change to AvaTax that may\r\naffect you, or a potential issue with your company's tax profile.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/notifications/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", ":id" ], "variable": [ { "key": "id", "value": "155", "description": "The id of the notification to retrieve." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 123,\n \"accountId\": 202011901,\n \"companyId\": 34345,\n \"referenceObject\": \"Company Return\",\n \"referenceId\": 692,\n \"severityLevelId\": \"Neutral\",\n \"category\": \"Certificate Expiration\",\n \"message\": \"The certificate of your company is nearing its expiration, please consider renewing it.\",\n \"needsAction\": true,\n \"actionName\": \"Certificate Renewal\",\n \"actionLink\": \"www.xyz.com\",\n \"dismissed\": false,\n \"expireDate\": \"2026-04-02T00:00:00+00:00\",\n \"createdUserId\": 442323,\n \"createdDate\": \"2018-05-05T00:00:00\",\n \"modifiedUserId\": 442323,\n \"modifiedDate\": \"2018-05-07T00:00:00\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/notifications/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", ":id" ], "variable": [ { "key": "id", "value": "155", "description": "The id of the notification to retrieve." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/notifications/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", ":id" ], "variable": [ { "key": "id", "value": "155", "description": "The id of the notification to retrieve." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/notifications/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", ":id" ], "variable": [ { "key": "id", "value": "155", "description": "The id of the notification to retrieve." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Update a single notification.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": 123,\n \"accountId\": 202011901,\n \"companyId\": 34345,\n \"referenceObject\": \"Company Return\",\n \"referenceId\": 692,\n \"severityLevelId\": \"Neutral\",\n \"category\": \"Certificate Expiration\",\n \"message\": \"The certificate of your company is nearing its expiration, please consider renewing it.\",\n \"needsAction\": true,\n \"actionName\": \"Certificate Renewal\",\n \"actionLink\": \"www.xyz.com\",\n \"dismissed\": false,\n \"expireDate\": \"2026-04-02T00:00:00+00:00\",\n \"createdUserId\": 442323,\n \"createdDate\": \"2018-05-05T00:00:00\",\n \"modifiedUserId\": 442323,\n \"modifiedDate\": \"2018-05-07T00:00:00\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notifications/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", ":id" ], "variable": [ { "key": "id", "value": "155", "description": "The id of the notification you wish to update." } ] }, "description": "This API is available by invitation only.\r\n \r\nReplaces the notification identified by this URL with a new notification.\r\n \r\nA notification is a message from Avalara that may have relevance to your business. You may want\r\nto regularly review notifications and then dismiss them when you are certain that you have addressed\r\nany relevant concerns raised by this notification.\r\n \r\nAn example of a notification would be a message about new software, or a change to AvaTax that may\r\naffect you, or a potential issue with your company's tax profile.\n\n### Security Policies\n\n* This API requires one of the following user roles: BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [NotificationsAPI:Create].\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 123,\n \"accountId\": 202011901,\n \"companyId\": 34345,\n \"referenceObject\": \"Company Return\",\n \"referenceId\": 692,\n \"severityLevelId\": \"Neutral\",\n \"category\": \"Certificate Expiration\",\n \"message\": \"The certificate of your company is nearing its expiration, please consider renewing it.\",\n \"needsAction\": true,\n \"actionName\": \"Certificate Renewal\",\n \"actionLink\": \"www.xyz.com\",\n \"dismissed\": false,\n \"expireDate\": \"2026-04-02T00:00:00+00:00\",\n \"createdUserId\": 442323,\n \"createdDate\": \"2018-05-05T00:00:00\",\n \"modifiedUserId\": 442323,\n \"modifiedDate\": \"2018-05-07T00:00:00\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notifications/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", ":id" ], "variable": [ { "key": "id", "value": "155", "description": "The id of the notification you wish to update." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 123,\n \"accountId\": 202011901,\n \"companyId\": 34345,\n \"referenceObject\": \"Company Return\",\n \"referenceId\": 692,\n \"severityLevelId\": \"Neutral\",\n \"category\": \"Certificate Expiration\",\n \"message\": \"The certificate of your company is nearing its expiration, please consider renewing it.\",\n \"needsAction\": true,\n \"actionName\": \"Certificate Renewal\",\n \"actionLink\": \"www.xyz.com\",\n \"dismissed\": false,\n \"expireDate\": \"2026-04-02T00:00:00+00:00\",\n \"createdUserId\": 442323,\n \"createdDate\": \"2018-05-05T00:00:00\",\n \"modifiedUserId\": 442323,\n \"modifiedDate\": \"2018-05-07T00:00:00\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 123,\n \"accountId\": 202011901,\n \"companyId\": 34345,\n \"referenceObject\": \"Company Return\",\n \"referenceId\": 692,\n \"severityLevelId\": \"Neutral\",\n \"category\": \"Certificate Expiration\",\n \"message\": \"The certificate of your company is nearing its expiration, please consider renewing it.\",\n \"needsAction\": true,\n \"actionName\": \"Certificate Renewal\",\n \"actionLink\": \"www.xyz.com\",\n \"dismissed\": false,\n \"expireDate\": \"2026-04-02T00:00:00+00:00\",\n \"createdUserId\": 442323,\n \"createdDate\": \"2018-05-05T00:00:00\",\n \"modifiedUserId\": 442323,\n \"modifiedDate\": \"2018-05-07T00:00:00\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notifications/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", ":id" ], "variable": [ { "key": "id", "value": "155", "description": "The id of the notification you wish to update." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 123,\n \"accountId\": 202011901,\n \"companyId\": 34345,\n \"referenceObject\": \"Company Return\",\n \"referenceId\": 692,\n \"severityLevelId\": \"Neutral\",\n \"category\": \"Certificate Expiration\",\n \"message\": \"The certificate of your company is nearing its expiration, please consider renewing it.\",\n \"needsAction\": true,\n \"actionName\": \"Certificate Renewal\",\n \"actionLink\": \"www.xyz.com\",\n \"dismissed\": false,\n \"expireDate\": \"2026-04-02T00:00:00+00:00\",\n \"createdUserId\": 442323,\n \"createdDate\": \"2018-05-05T00:00:00\",\n \"modifiedUserId\": 442323,\n \"modifiedDate\": \"2018-05-07T00:00:00\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notifications/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", ":id" ], "variable": [ { "key": "id", "value": "155", "description": "The id of the notification you wish to update." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"id\": 123,\n \"accountId\": 202011901,\n \"companyId\": 34345,\n \"referenceObject\": \"Company Return\",\n \"referenceId\": 692,\n \"severityLevelId\": \"Neutral\",\n \"category\": \"Certificate Expiration\",\n \"message\": \"The certificate of your company is nearing its expiration, please consider renewing it.\",\n \"needsAction\": true,\n \"actionName\": \"Certificate Renewal\",\n \"actionLink\": \"www.xyz.com\",\n \"dismissed\": false,\n \"expireDate\": \"2026-04-02T00:00:00+00:00\",\n \"createdUserId\": 442323,\n \"createdDate\": \"2018-05-05T00:00:00\",\n \"modifiedUserId\": 442323,\n \"modifiedDate\": \"2018-05-07T00:00:00\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notifications/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", ":id" ], "variable": [ { "key": "id", "value": "155", "description": "The id of the notification you wish to update." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Delete a single notification.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/notifications/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", ":id" ], "variable": [ { "key": "id", "value": "155", "description": "The id of the notification you wish to delete." } ] }, "description": "This API is available by invitation only.\r\n \r\nDelete the existing notification identified by this URL.\r\n \r\nA notification is a message from Avalara that may have relevance to your business. You may want\r\nto regularly review notifications and then dismiss them when you are certain that you have addressed\r\nany relevant concerns raised by this notification.\r\n \r\nAn example of a notification would be a message about new software, or a change to AvaTax that may\r\naffect you, or a potential issue with your company's tax profile.\n\n### Security Policies\n\n* This API requires one of the following user roles: BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [NotificationsAPI:Create].\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/notifications/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", ":id" ], "variable": [ { "key": "id", "value": "155", "description": "The id of the notification you wish to delete." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n },\n {\n \"code\": \"DeleteInformation\",\n \"number\": 142,\n \"message\": \"The entity was marked as deleted.\",\n \"description\": \"Object successfully marked as deleted.\",\n \"faultCode\": \"Client\",\n \"helpLink\": \"http://developer.avalara.com/avatax/errors/DeleteInformation\",\n \"severity\": \"Success\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/notifications/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", ":id" ], "variable": [ { "key": "id", "value": "155", "description": "The id of the notification you wish to delete." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/notifications/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", ":id" ], "variable": [ { "key": "id", "value": "155", "description": "The id of the notification you wish to delete." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/notifications/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications", ":id" ], "variable": [ { "key": "id", "value": "155", "description": "The id of the notification you wish to delete." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "List all notifications.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/notifications?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/)." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "List all notifications.\r\n \r\nA notification is a message from Avalara that may have relevance to your business. You may want\r\nto regularly review notifications and then dismiss them when you are certain that you have addressed\r\nany relevant concerns raised by this notification.\r\n \r\nAn example of a notification would be a message about new software, or a change to AvaTax that may\r\naffect you, or a potential issue with your company's tax profile.\r\n \r\nYou may search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/notifications?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 9013,\n \"value\": [\n {\n \"id\": 123,\n \"accountId\": 202011901,\n \"companyId\": 34345,\n \"referenceObject\": \"Company Return\",\n \"referenceId\": 692,\n \"severityLevelId\": \"Neutral\",\n \"category\": \"Certificate Expiration\",\n \"message\": \"The certificate of your company is nearing its expiration, please consider renewing it.\",\n \"needsAction\": true,\n \"actionName\": \"Certificate Renewal\",\n \"actionLink\": \"www.xyz.com\",\n \"dismissed\": false,\n \"expireDate\": \"2026-04-02T00:00:00+00:00\",\n \"createdUserId\": 442323,\n \"createdDate\": \"2018-05-05T00:00:00\",\n \"modifiedUserId\": 442323,\n \"modifiedDate\": \"2018-05-07T00:00:00\"\n },\n {\n \"id\": 123,\n \"accountId\": 202011901,\n \"companyId\": 34345,\n \"referenceObject\": \"Company Return\",\n \"referenceId\": 692,\n \"severityLevelId\": \"Neutral\",\n \"category\": \"Certificate Expiration\",\n \"message\": \"The certificate of your company is nearing its expiration, please consider renewing it.\",\n \"needsAction\": true,\n \"actionName\": \"Certificate Renewal\",\n \"actionLink\": \"www.xyz.com\",\n \"dismissed\": false,\n \"expireDate\": \"2026-04-02T00:00:00+00:00\",\n \"createdUserId\": 442323,\n \"createdDate\": \"2018-05-05T00:00:00\",\n \"modifiedUserId\": 442323,\n \"modifiedDate\": \"2018-05-07T00:00:00\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/notifications?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/notifications?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Create new notifications.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 123,\n \"accountId\": 202011901,\n \"companyId\": 34345,\n \"referenceObject\": \"Company Return\",\n \"referenceId\": 692,\n \"severityLevelId\": \"Neutral\",\n \"category\": \"Certificate Expiration\",\n \"message\": \"The certificate of your company is nearing its expiration, please consider renewing it.\",\n \"needsAction\": true,\n \"actionName\": \"Certificate Renewal\",\n \"actionLink\": \"www.xyz.com\",\n \"dismissed\": false,\n \"expireDate\": \"2026-04-02T00:00:00+00:00\",\n \"createdUserId\": 442323,\n \"createdDate\": \"2018-05-05T00:00:00\",\n \"modifiedUserId\": 442323,\n \"modifiedDate\": \"2018-05-07T00:00:00\"\n },\n {\n \"id\": 123,\n \"accountId\": 202011901,\n \"companyId\": 34345,\n \"referenceObject\": \"Company Return\",\n \"referenceId\": 692,\n \"severityLevelId\": \"Neutral\",\n \"category\": \"Certificate Expiration\",\n \"message\": \"The certificate of your company is nearing its expiration, please consider renewing it.\",\n \"needsAction\": true,\n \"actionName\": \"Certificate Renewal\",\n \"actionLink\": \"www.xyz.com\",\n \"dismissed\": false,\n \"expireDate\": \"2026-04-02T00:00:00+00:00\",\n \"createdUserId\": 442323,\n \"createdDate\": \"2018-05-05T00:00:00\",\n \"modifiedUserId\": 442323,\n \"modifiedDate\": \"2018-05-07T00:00:00\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications" ] }, "description": "This API is available by invitation only.\r\n \r\nCreate a single notification.\r\n \r\nA notification is a message from Avalara that may have relevance to your business. You may want\r\nto regularly review notifications and then dismiss them when you are certain that you have addressed\r\nany relevant concerns raised by this notification.\r\n \r\nA Global notification is a message which is directed to all the accounts and is set to expire within\r\na certain time and cannot be dismissed by the user. Make accountId and companyId null to create a global notification.\r\n \r\nAn example of a notification would be a message about new software, or a change to AvaTax that may\r\naffect you, or a potential issue with your company's tax profile.\n\n### Security Policies\n\n* This API requires one of the following user roles: BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [NotificationsAPI:Create].\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 123,\n \"accountId\": 202011901,\n \"companyId\": 34345,\n \"referenceObject\": \"Company Return\",\n \"referenceId\": 692,\n \"severityLevelId\": \"Neutral\",\n \"category\": \"Certificate Expiration\",\n \"message\": \"The certificate of your company is nearing its expiration, please consider renewing it.\",\n \"needsAction\": true,\n \"actionName\": \"Certificate Renewal\",\n \"actionLink\": \"www.xyz.com\",\n \"dismissed\": false,\n \"expireDate\": \"2026-04-02T00:00:00+00:00\",\n \"createdUserId\": 442323,\n \"createdDate\": \"2018-05-05T00:00:00\",\n \"modifiedUserId\": 442323,\n \"modifiedDate\": \"2018-05-07T00:00:00\"\n },\n {\n \"id\": 123,\n \"accountId\": 202011901,\n \"companyId\": 34345,\n \"referenceObject\": \"Company Return\",\n \"referenceId\": 692,\n \"severityLevelId\": \"Neutral\",\n \"category\": \"Certificate Expiration\",\n \"message\": \"The certificate of your company is nearing its expiration, please consider renewing it.\",\n \"needsAction\": true,\n \"actionName\": \"Certificate Renewal\",\n \"actionLink\": \"www.xyz.com\",\n \"dismissed\": false,\n \"expireDate\": \"2026-04-02T00:00:00+00:00\",\n \"createdUserId\": 442323,\n \"createdDate\": \"2018-05-05T00:00:00\",\n \"modifiedUserId\": 442323,\n \"modifiedDate\": \"2018-05-07T00:00:00\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"id\": 123,\n \"accountId\": 202011901,\n \"companyId\": 34345,\n \"referenceObject\": \"Company Return\",\n \"referenceId\": 692,\n \"severityLevelId\": \"Neutral\",\n \"category\": \"Certificate Expiration\",\n \"message\": \"The certificate of your company is nearing its expiration, please consider renewing it.\",\n \"needsAction\": true,\n \"actionName\": \"Certificate Renewal\",\n \"actionLink\": \"www.xyz.com\",\n \"dismissed\": false,\n \"expireDate\": \"2026-04-02T00:00:00+00:00\",\n \"createdUserId\": 442323,\n \"createdDate\": \"2018-05-05T00:00:00\",\n \"modifiedUserId\": 442323,\n \"modifiedDate\": \"2018-05-07T00:00:00\"\n },\n {\n \"id\": 123,\n \"accountId\": 202011901,\n \"companyId\": 34345,\n \"referenceObject\": \"Company Return\",\n \"referenceId\": 692,\n \"severityLevelId\": \"Neutral\",\n \"category\": \"Certificate Expiration\",\n \"message\": \"The certificate of your company is nearing its expiration, please consider renewing it.\",\n \"needsAction\": true,\n \"actionName\": \"Certificate Renewal\",\n \"actionLink\": \"www.xyz.com\",\n \"dismissed\": false,\n \"expireDate\": \"2026-04-02T00:00:00+00:00\",\n \"createdUserId\": 442323,\n \"createdDate\": \"2018-05-05T00:00:00\",\n \"modifiedUserId\": 442323,\n \"modifiedDate\": \"2018-05-07T00:00:00\"\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 123,\n \"accountId\": 202011901,\n \"companyId\": 34345,\n \"referenceObject\": \"Company Return\",\n \"referenceId\": 692,\n \"severityLevelId\": \"Neutral\",\n \"category\": \"Certificate Expiration\",\n \"message\": \"The certificate of your company is nearing its expiration, please consider renewing it.\",\n \"needsAction\": true,\n \"actionName\": \"Certificate Renewal\",\n \"actionLink\": \"www.xyz.com\",\n \"dismissed\": false,\n \"expireDate\": \"2026-04-02T00:00:00+00:00\",\n \"createdUserId\": 442323,\n \"createdDate\": \"2018-05-05T00:00:00\",\n \"modifiedUserId\": 442323,\n \"modifiedDate\": \"2018-05-07T00:00:00\"\n },\n {\n \"id\": 123,\n \"accountId\": 202011901,\n \"companyId\": 34345,\n \"referenceObject\": \"Company Return\",\n \"referenceId\": 692,\n \"severityLevelId\": \"Neutral\",\n \"category\": \"Certificate Expiration\",\n \"message\": \"The certificate of your company is nearing its expiration, please consider renewing it.\",\n \"needsAction\": true,\n \"actionName\": \"Certificate Renewal\",\n \"actionLink\": \"www.xyz.com\",\n \"dismissed\": false,\n \"expireDate\": \"2026-04-02T00:00:00+00:00\",\n \"createdUserId\": 442323,\n \"createdDate\": \"2018-05-05T00:00:00\",\n \"modifiedUserId\": 442323,\n \"modifiedDate\": \"2018-05-07T00:00:00\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "[\n {\n \"id\": 123,\n \"accountId\": 202011901,\n \"companyId\": 34345,\n \"referenceObject\": \"Company Return\",\n \"referenceId\": 692,\n \"severityLevelId\": \"Neutral\",\n \"category\": \"Certificate Expiration\",\n \"message\": \"The certificate of your company is nearing its expiration, please consider renewing it.\",\n \"needsAction\": true,\n \"actionName\": \"Certificate Renewal\",\n \"actionLink\": \"www.xyz.com\",\n \"dismissed\": false,\n \"expireDate\": \"2026-04-02T00:00:00+00:00\",\n \"createdUserId\": 442323,\n \"createdDate\": \"2018-05-05T00:00:00\",\n \"modifiedUserId\": 442323,\n \"modifiedDate\": \"2018-05-07T00:00:00\"\n },\n {\n \"id\": 123,\n \"accountId\": 202011901,\n \"companyId\": 34345,\n \"referenceObject\": \"Company Return\",\n \"referenceId\": 692,\n \"severityLevelId\": \"Neutral\",\n \"category\": \"Certificate Expiration\",\n \"message\": \"The certificate of your company is nearing its expiration, please consider renewing it.\",\n \"needsAction\": true,\n \"actionName\": \"Certificate Renewal\",\n \"actionLink\": \"www.xyz.com\",\n \"dismissed\": false,\n \"expireDate\": \"2026-04-02T00:00:00+00:00\",\n \"createdUserId\": 442323,\n \"createdDate\": \"2018-05-05T00:00:00\",\n \"modifiedUserId\": 442323,\n \"modifiedDate\": \"2018-05-07T00:00:00\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/notifications", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "notifications" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "passwords", "item": [ { "name": "{userId}", "item": [ { "name": "reset", "item": [ { "name": "Reset a user's password programmatically", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"newPassword\": \"NewPassword789~~!\",\n \"suppressResetPasswordEmail\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/passwords/:userId/reset?isUndoMigrateRequest=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "passwords", ":userId", "reset" ], "query": [ { "key": "isUndoMigrateRequest", "value": "false", "description": "If user's password was migrated to AI, undo this." } ], "variable": [ { "key": "userId", "value": "451", "description": "The unique ID of the user whose password will be changed" } ] }, "description": "# For Registrar Use Only\r\nThis API is for use by Avalara Registrar administrative users only.\r\n \r\nAllows a system admin to reset the password for a specific user via the API.\r\nThis API is only available for Avalara Registrar Admins, and can be used to reset the password of any\r\nuser based on internal Avalara business processes.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n* This API is available to Avalara system-level (registrar-level) users only.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"newPassword\": \"NewPassword789~~!\",\n \"suppressResetPasswordEmail\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/passwords/:userId/reset?isUndoMigrateRequest=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "passwords", ":userId", "reset" ], "query": [ { "description": "If user's password was migrated to AI, undo this.", "key": "isUndoMigrateRequest", "value": "false" } ], "variable": [ { "key": "userId", "value": "451", "description": "The unique ID of the user whose password will be changed" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "string" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"newPassword\": \"NewPassword789~~!\",\n \"suppressResetPasswordEmail\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/passwords/:userId/reset?isUndoMigrateRequest=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "passwords", ":userId", "reset" ], "query": [ { "description": "If user's password was migrated to AI, undo this.", "key": "isUndoMigrateRequest", "value": "false" } ], "variable": [ { "key": "userId", "value": "451", "description": "The unique ID of the user whose password will be changed" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"newPassword\": \"NewPassword789~~!\",\n \"suppressResetPasswordEmail\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/passwords/:userId/reset?isUndoMigrateRequest=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "passwords", ":userId", "reset" ], "query": [ { "description": "If user's password was migrated to AI, undo this.", "key": "isUndoMigrateRequest", "value": "false" } ], "variable": [ { "key": "userId", "value": "451", "description": "The unique ID of the user whose password will be changed" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"newPassword\": \"NewPassword789~~!\",\n \"suppressResetPasswordEmail\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/passwords/:userId/reset?isUndoMigrateRequest=false", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "passwords", ":userId", "reset" ], "query": [ { "description": "If user's password was migrated to AI, undo this.", "key": "isUndoMigrateRequest", "value": "false" } ], "variable": [ { "key": "userId", "value": "451", "description": "The unique ID of the user whose password will be changed" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "Change Password", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"oldPassword\": \"MyOldPassword123!\",\n \"newPassword\": \"ANewPassword567:)\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/passwords", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "passwords" ] }, "description": "Allows a user to change their password via an API call.\r\n \r\nThis API allows an authenticated user to change their password via an API call. This feature is only available\r\nfor accounts that do not use SAML integrated password validation.\r\n \r\nThis API only allows the currently authenticated user to change their password; it cannot be used to apply to a\r\ndifferent user than the one authenticating the current API call.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"oldPassword\": \"MyOldPassword123!\",\n \"newPassword\": \"ANewPassword567:)\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/passwords", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "passwords" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "string" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"oldPassword\": \"MyOldPassword123!\",\n \"newPassword\": \"ANewPassword567:)\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/passwords", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "passwords" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"oldPassword\": \"MyOldPassword123!\",\n \"newPassword\": \"ANewPassword567:)\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/passwords", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "passwords" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "servicetypes", "item": [ { "name": "servicetypes", "item": [ { "name": "Retrieve the full list of Avalara-supported subscription (ServiceTypes)", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/servicetypes/servicetypes?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "servicetypes", "servicetypes" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* system, taxTypeGroupIdSK" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "For Registrar Use Only\r\nThis API is for use by Avalara Registrar administrative users only.\r\n \r\nReturns the full list of Avalara-supported subscription types.\r\nThis API is intended to be useful for identifying which features you have added to your account.\r\nYou may always contact Avalara's sales department for information on available products or services.\r\nYou cannot change your subscriptions/service directly through the API.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/servicetypes/servicetypes?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "servicetypes", "servicetypes" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* system, taxTypeGroupIdSK", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 623,\n \"value\": [\n {\n \"id\": 2,\n \"description\": \"AvaTaxPro\",\n \"system\": \"AvaTax\",\n \"taxTypeGroupIdSK\": 0\n },\n {\n \"id\": 2,\n \"description\": \"AvaTaxPro\",\n \"system\": \"AvaTax\",\n \"taxTypeGroupIdSK\": 0\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" } ] } ] } ] }, { "name": "reports", "item": [ { "name": "{id}", "item": [ { "name": "attachment", "item": [ { "name": "Download a report", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/reports/:id/attachment", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "reports", ":id", "attachment" ], "variable": [ { "key": "id", "value": "155", "description": "The unique ID number of this report" } ] }, "description": "This API downloads the file associated with a report.\r\n \r\nIf the report is not yet complete, you will receive a `ReportNotFinished` error. To check if a report is complete,\r\nuse the `GetReport` API.\r\n \r\nReports are run as asynchronous report tasks on the server. When complete, the report file will be available for download\r\nfor up to 30 days after completion. To run an asynchronous report, you should follow these steps:\r\n \r\n* Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type.\r\n* In the result of the Initiate API, you receive back a report's `id` value.\r\n* Check the status of a report by calling `GetReport` and passing in the report's `id` value.\r\n* When a report's status is `Completed`, call `DownloadReport` to retrieve the file.\r\n \r\n* We throttle this API. You can only call this API up to 5 times in a minute.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/reports/:id/attachment", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "reports", ":id", "attachment" ], "variable": [ { "key": "id", "value": "155", "description": "The unique ID number of this report" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "string" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/reports/:id/attachment", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "reports", ":id", "attachment" ], "variable": [ { "key": "id", "value": "155", "description": "The unique ID number of this report" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/reports/:id/attachment", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "reports", ":id", "attachment" ], "variable": [ { "key": "id", "value": "155", "description": "The unique ID number of this report" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/reports/:id/attachment", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "reports", ":id", "attachment" ], "variable": [ { "key": "id", "value": "155", "description": "The unique ID number of this report" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Retrieve a single report", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/reports/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "reports", ":id" ], "variable": [ { "key": "id", "value": "155", "description": "The unique ID number of the report to retrieve" } ] }, "description": "Retrieve a single report by its unique ID number.\r\n \r\nReports are run as asynchronous report tasks on the server. When complete, the report file will be available for download\r\nfor up to 30 days after completion. To run an asynchronous report, you should follow these steps:\r\n \r\n* Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type.\r\n* In the result of the Initiate API, you receive back a report's `id` value.\r\n* Check the status of a report by calling `GetReport` and passing in the report's `id` value.\r\n* When a report's status is `Completed`, call `DownloadReport` to retrieve the file.\r\n \r\nThis API call returns information about any report type." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/reports/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "reports", ":id" ], "variable": [ { "key": "id", "value": "155", "description": "The unique ID number of the report to retrieve" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 1,\n \"accountId\": 2087654354,\n \"companyId\": 2087654354,\n \"reportType\": \"ExportDocumentLine\",\n \"parameters\": {\n \"startDate\": \"2026-03-02T00:00:00+00:00\",\n \"endDate\": \"2026-04-02T00:00:00+00:00\",\n \"country\": \"US\",\n \"state\": \"All\",\n \"dateFilter\": \"DD\",\n \"docType\": \"S\",\n \"dateFormat\": \"MM/dd/yyyy\",\n \"currencyCode\": \"USD\",\n \"isLocked\": false,\n \"merchantSellerId\": \"abcd\",\n \"documentStatus\": \"Commited\",\n \"isModifiedDateSameAsDocumentDate\": false,\n \"taxGroup\": \"Alcohol\",\n \"taxName\": \"VAT\",\n \"taxCode\": \"123\",\n \"taxSubType\": \"Amusement\",\n \"compression\": \"NONE\",\n \"includeDocumentLineDetails\": false,\n \"includeMultiTaxLineDetails\": false,\n \"incorrectCurrencyOnly\": false\n },\n \"status\": \"InQueue\",\n \"format\": \"CSV\",\n \"file\": \"2087654354_2087654354_1_ExportDocumentLine.CSV\",\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"createdUserId\": 0\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/reports/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "reports", ":id" ], "variable": [ { "key": "id", "value": "155", "description": "The unique ID number of the report to retrieve" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/reports/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "reports", ":id" ], "variable": [ { "key": "id", "value": "155", "description": "The unique ID number of the report to retrieve" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/reports/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "reports", ":id" ], "variable": [ { "key": "id", "value": "155", "description": "The unique ID number of the report to retrieve" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "List all report tasks for account", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/reports?companyId=451&pageKey=string&$skip=451&$top=25", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "reports" ], "query": [ { "key": "companyId", "value": "451", "description": "The id of the company for which to get reports." }, { "key": "pageKey", "value": "string", "description": "Provide a page key to retrieve the next page of results." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$top", "value": "25", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." } ] }, "description": "List all report tasks for your account.\r\n \r\nReports are run as asynchronous report tasks on the server. When complete, the report file will be available for download\r\nfor up to 30 days after completion. To run an asynchronous report, you should follow these steps:\r\n \r\n* Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type.\r\n* In the result of the Initiate API, you receive back a report's `id` value.\r\n* Check the status of a report by calling `GetReport` and passing in the report's `id` value.\r\n* When a report's status is `Completed`, call `DownloadReport` to retrieve the file.\r\n \r\nThis API call returns information about all report types across your entire account.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/reports?companyId=451&pageKey=string&$skip=451&$top=25", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "reports" ], "query": [ { "description": "The id of the company for which to get reports.", "key": "companyId", "value": "451" }, { "description": "Provide a page key to retrieve the next page of results.", "key": "pageKey", "value": "string" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "25" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 9113,\n \"value\": [\n {\n \"id\": 1,\n \"accountId\": 2087654354,\n \"companyId\": 2087654354,\n \"reportType\": \"ExportDocumentLine\",\n \"parameters\": {\n \"startDate\": \"2026-03-02T00:00:00+00:00\",\n \"endDate\": \"2026-04-02T00:00:00+00:00\",\n \"country\": \"US\",\n \"state\": \"All\",\n \"dateFilter\": \"DD\",\n \"docType\": \"S\",\n \"dateFormat\": \"MM/dd/yyyy\",\n \"currencyCode\": \"USD\",\n \"isLocked\": false,\n \"merchantSellerId\": \"abcd\",\n \"documentStatus\": \"Commited\",\n \"isModifiedDateSameAsDocumentDate\": false,\n \"taxGroup\": \"Alcohol\",\n \"taxName\": \"VAT\",\n \"taxCode\": \"123\",\n \"taxSubType\": \"Amusement\",\n \"compression\": \"NONE\",\n \"includeDocumentLineDetails\": false,\n \"includeMultiTaxLineDetails\": false,\n \"incorrectCurrencyOnly\": false\n },\n \"status\": \"InQueue\",\n \"format\": \"CSV\",\n \"file\": \"2087654354_2087654354_1_ExportDocumentLine.CSV\",\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"createdUserId\": 0\n },\n {\n \"id\": 1,\n \"accountId\": 2087654354,\n \"companyId\": 2087654354,\n \"reportType\": \"ExportDocumentLine\",\n \"parameters\": {\n \"startDate\": \"2026-03-02T00:00:00+00:00\",\n \"endDate\": \"2026-04-02T00:00:00+00:00\",\n \"country\": \"US\",\n \"state\": \"All\",\n \"dateFilter\": \"DD\",\n \"docType\": \"S\",\n \"dateFormat\": \"MM/dd/yyyy\",\n \"currencyCode\": \"USD\",\n \"isLocked\": false,\n \"merchantSellerId\": \"abcd\",\n \"documentStatus\": \"Commited\",\n \"isModifiedDateSameAsDocumentDate\": false,\n \"taxGroup\": \"Alcohol\",\n \"taxName\": \"VAT\",\n \"taxCode\": \"123\",\n \"taxSubType\": \"Amusement\",\n \"compression\": \"NONE\",\n \"includeDocumentLineDetails\": false,\n \"includeMultiTaxLineDetails\": false,\n \"incorrectCurrencyOnly\": false\n },\n \"status\": \"InQueue\",\n \"format\": \"CSV\",\n \"file\": \"2087654354_2087654354_1_ExportDocumentLine.CSV\",\n \"createdDate\": \"2026-04-02T00:00:00+00:00\",\n \"createdUserId\": 0\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/reports?companyId=451&pageKey=string&$skip=451&$top=25", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "reports" ], "query": [ { "description": "The id of the company for which to get reports.", "key": "companyId", "value": "451" }, { "description": "Provide a page key to retrieve the next page of results.", "key": "pageKey", "value": "string" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "25" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/reports?companyId=451&pageKey=string&$skip=451&$top=25", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "reports" ], "query": [ { "description": "The id of the company for which to get reports.", "key": "companyId", "value": "451" }, { "description": "Provide a page key to retrieve the next page of results.", "key": "pageKey", "value": "string" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "25" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/reports?companyId=451&pageKey=string&$skip=451&$top=25", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "reports" ], "query": [ { "description": "The id of the company for which to get reports.", "key": "companyId", "value": "451" }, { "description": "Provide a page key to retrieve the next page of results.", "key": "pageKey", "value": "string" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "25" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "settings", "item": [ { "name": "Retrieve all settings", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/settings?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "settings" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* modifiedDate, ModifiedUserId" }, { "key": "$include", "value": "string", "description": "A comma separated list of additional data to retrieve." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Get multiple setting objects across all companies.\r\n \r\nThe company settings system is a metadata system that you can use to store extra information\r\nabout a company. Your integration or connector could use this data storage to keep track of\r\npreference information, reminders, or any other storage that would need to persist even if\r\nthe customer uninstalls your application.\r\n \r\nA setting can refer to any type of data you need to remember about this company object.\r\nWhen creating this object, you may define your own `set`, `name`, and `value` parameters.\r\nTo define your own values, please choose a `set` name that begins with `X-` to indicate an extension.\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/settings?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "settings" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* modifiedDate, ModifiedUserId", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 9178,\n \"value\": [\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"set\": \"ItemsToRemember\",\n \"name\": \"Texas\",\n \"value\": \"Alamo\"\n },\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"set\": \"ItemsToRemember\",\n \"name\": \"Texas\",\n \"value\": \"Alamo\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/settings?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "settings" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* modifiedDate, ModifiedUserId", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/settings?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "settings" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* modifiedDate, ModifiedUserId", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "subscriptions", "item": [ { "name": "Retrieve all subscriptions", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/subscriptions?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "subscriptions" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* subscriptionDescription" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Get multiple subscription objects across all accounts.\r\nA 'subscription' indicates a licensed subscription to a named Avalara service.\r\nTo request or remove subscriptions, please contact Avalara sales or your customer account manager.\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/subscriptions?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "subscriptions" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* subscriptionDescription", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 5294,\n \"value\": [\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"subscriptionTypeId\": 2,\n \"subscriptionDescription\": \"AvaTaxPro\",\n \"effectiveDate\": \"2015-01-01\"\n },\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"subscriptionTypeId\": 2,\n \"subscriptionDescription\": \"AvaTaxPro\",\n \"effectiveDate\": \"2015-01-01\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/subscriptions?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "subscriptions" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* subscriptionDescription", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/subscriptions?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "subscriptions" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* subscriptionDescription", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "taxcodes", "item": [ { "name": "Retrieve all tax codes", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/taxcodes?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "taxcodes" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/)." }, { "key": "$include", "value": "string", "description": "A comma separated list of additional data to retrieve." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Get multiple taxcode objects across all companies.\r\nA 'TaxCode' represents a uniquely identified type of product, good, or service.\r\nAvalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.\r\nIf you identify your products by tax code in your 'Create Transaction' API calls, Avalara will correctly calculate tax rates and\r\ntaxability rules for this product in all supported jurisdictions.\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/taxcodes?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "taxcodes" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 6614,\n \"value\": [\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"taxCode\": \"PS081282\",\n \"taxCodeTypeId\": \"P\",\n \"description\": \"Yarn\",\n \"parentTaxCode\": \"PS080100\",\n \"isPhysical\": true,\n \"goodsServiceCode\": 0,\n \"entityUseCode\": \"\",\n \"isActive\": true,\n \"isSSTCertified\": false\n },\n {\n \"id\": 56789,\n \"companyId\": 12345,\n \"taxCode\": \"PS081282\",\n \"taxCodeTypeId\": \"P\",\n \"description\": \"Yarn\",\n \"parentTaxCode\": \"PS080100\",\n \"isPhysical\": true,\n \"goodsServiceCode\": 0,\n \"entityUseCode\": \"\",\n \"isActive\": true,\n \"isSSTCertified\": false\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/taxcodes?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "taxcodes" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/taxcodes?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "taxcodes" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "pointofsaledata", "item": [ { "name": "build", "item": [ { "name": "Build a multi-location tax content file", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"companyCode\": \"DEFAULT\",\n \"documentDate\": \"2026-04-02\",\n \"responseType\": \"Json\",\n \"taxCodes\": [\n \"P0000000\"\n ],\n \"itemCodes\": [\n \"TXINCL\"\n ],\n \"locationCodes\": [\n \"DEFAULT\"\n ],\n \"includeJurisCodes\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/pointofsaledata/build", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "pointofsaledata", "build" ] }, "description": "Builds a tax content file containing information useful for a retail point-of-sale solution.\r\n \r\nSince tax rates may change based on decisions made by a variety of tax authorities, we recommend\r\nthat users of this tax content API download new data every day. Many tax authorities may finalize\r\ndecisions on tax changes at unexpected times and may make changes in response to legal issues or\r\ngovernmental priorities. Any tax content downloaded for future time periods is subject to change\r\nif tax rates or tax laws change.\r\n \r\nA TaxContent file contains a matrix of the taxes that would be charged when you sell any of your\r\nItems at any of your Locations. To create items, use `CreateItems()`. To create locations, use\r\n`CreateLocations()`. The file is built by looking up the tax profile for your location and your\r\nitem and calculating taxes for each in turn. To include a custom `TaxCode` in this tax content\r\nfile, first create the custom tax code using `CreateTaxCodes()` to create the custom tax code,\r\nthen use `CreateItems()` to create an item that uses the custom tax code.\r\n \r\nThis data file can be customized for specific partner devices and usage conditions.\r\n \r\nThe result of this API is the file you requested in the format you requested using the `responseType` field.\r\n \r\nThis API builds the file on demand, and is limited to files with no more than 7500 scenarios. To build a tax content\r\nfile for a single location at a time, please use `BuildTaxContentFileForLocation`.\r\n \r\nNOTE: This API does not work for sales tax holiday scenarios.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro.\n" }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"companyCode\": \"DEFAULT\",\n \"documentDate\": \"2026-04-02\",\n \"responseType\": \"Json\",\n \"taxCodes\": [\n \"P0000000\"\n ],\n \"itemCodes\": [\n \"TXINCL\"\n ],\n \"locationCodes\": [\n \"DEFAULT\"\n ],\n \"includeJurisCodes\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/pointofsaledata/build", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "pointofsaledata", "build" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "string" }, { "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"companyCode\": \"DEFAULT\",\n \"documentDate\": \"2026-04-02\",\n \"responseType\": \"Json\",\n \"taxCodes\": [\n \"P0000000\"\n ],\n \"itemCodes\": [\n \"TXINCL\"\n ],\n \"locationCodes\": [\n \"DEFAULT\"\n ],\n \"includeJurisCodes\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/pointofsaledata/build", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "pointofsaledata", "build" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"companyCode\": \"DEFAULT\",\n \"documentDate\": \"2026-04-02\",\n \"responseType\": \"Json\",\n \"taxCodes\": [\n \"P0000000\"\n ],\n \"itemCodes\": [\n \"TXINCL\"\n ],\n \"locationCodes\": [\n \"DEFAULT\"\n ],\n \"includeJurisCodes\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/pointofsaledata/build", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "pointofsaledata", "build" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "taxcontent", "item": [ { "name": "rates", "item": [ { "name": "{country}", "item": [ { "name": "Get VAT rates for a country", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/taxcontent/rates/:country?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "taxcontent", "rates", ":country" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* displayName, jurisCode, jurisdictionTypeId, country, taxTypeGroupId" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "country", "value": "string", "description": "Country code (e.g., \"CA\", \"BE\")" } ] }, "description": "Returns VAT/GST rates for the specified country.\r\nJurisdictionTypeId is always 'CNT' (Country) for this API.\r\nReturns a FetchResult with Rate, DisplayName (formatted as \" ()\"), and other fields.\r\nSupports $filter, $top, $skip, and $orderBy query parameters." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/taxcontent/rates/:country?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "taxcontent", "rates", ":country" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* displayName, jurisCode, jurisdictionTypeId, country, taxTypeGroupId", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "country", "value": "string", "description": "Country code (e.g., \"CA\", \"BE\")" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 6593,\n \"value\": [\n {\n \"rate\": 0.05,\n \"displayName\": \"5.0% (Standard)\",\n \"taxName\": \"Standard\",\n \"jurisCode\": \"CA\",\n \"jurisName\": \"Canada\",\n \"jurisdictionTypeId\": \"CNT\",\n \"country\": \"CA\",\n \"rateTypeId\": \"S\",\n \"taxTypeGroupId\": \"InputAndOutput\",\n \"taxSubType\": \"O\"\n },\n {\n \"rate\": 0.05,\n \"displayName\": \"5.0% (Standard)\",\n \"taxName\": \"Standard\",\n \"jurisCode\": \"CA\",\n \"jurisName\": \"Canada\",\n \"jurisdictionTypeId\": \"CNT\",\n \"country\": \"CA\",\n \"rateTypeId\": \"S\",\n \"taxTypeGroupId\": \"InputAndOutput\",\n \"taxSubType\": \"O\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/taxcontent/rates/:country?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "taxcontent", "rates", ":country" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* displayName, jurisCode, jurisdictionTypeId, country, taxTypeGroupId", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "country", "value": "string", "description": "Country code (e.g., \"CA\", \"BE\")" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/taxcontent/rates/:country?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "taxcontent", "rates", ":country" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* displayName, jurisCode, jurisdictionTypeId, country, taxTypeGroupId", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "country", "value": "string", "description": "Country code (e.g., \"CA\", \"BE\")" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/taxcontent/rates/:country?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "taxcontent", "rates", ":country" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* displayName, jurisCode, jurisdictionTypeId, country, taxTypeGroupId", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "country", "value": "string", "description": "Country code (e.g., \"CA\", \"BE\")" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] } ] }, { "name": "taxrates", "item": [ { "name": "byaddress", "item": [ { "name": "Sales tax rates for a specified address", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/taxrates/byaddress?line1=string&line2=string&line3=string&city=string®ion=string&postalCode=string&country=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "taxrates", "byaddress" ], "query": [ { "key": "line1", "value": "string", "description": "The street address of the location." }, { "key": "line2", "value": "string", "description": "The street address of the location." }, { "key": "line3", "value": "string", "description": "The street address of the location." }, { "key": "city", "value": "string", "description": "The city name of the location." }, { "key": "region", "value": "string", "description": "Name or ISO 3166 code identifying the region within the country.\r\n \r\nThis field supports many different region identifiers:\r\n * Two and three character ISO 3166 region codes\r\n * Fully spelled out names of the region in ISO supported languages\r\n * Common alternative spellings for many regions\r\n \r\nFor a full list of all supported codes and names, please see the Definitions API `ListRegions`." }, { "key": "postalCode", "value": "string", "description": "The postal code of the location." }, { "key": "country", "value": "string", "description": "Name or ISO 3166 code identifying the country.\r\n \r\nThis field supports many different country identifiers:\r\n * Two character ISO 3166 codes\r\n * Three character ISO 3166 codes\r\n * Fully spelled out names of the country in ISO supported languages\r\n * Common alternative spellings for many countries\r\n \r\nFor a full list of all supported codes and names, please see the Definitions API `ListCountries`." } ] }, "description": "This API assumes that you are selling general tangible personal property at a retail point-of-sale\r\nlocation in the United States only.\r\n \r\nPlease be advised that this endpoint is designed for approximate tax rate estimation only and\r\nmay not yield precise results. For a more powerful and accurate tax estimation, upgrade to the\r\n`CreateTransaction` API, which offers a variety of advanced features including, but not limited\r\nto:\r\n \r\n* Nexus declarations\r\n* Taxability based on product/service type\r\n* Sourcing rules affecting origin/destination states\r\n* Customers who are exempt from certain taxes\r\n* States that have dollar value thresholds for tax amounts\r\n* Refunds for products purchased on a different date\r\n* Detailed jurisdiction names and state assigned codes\r\n* And more!\r\n \r\nPlease see [Estimating Tax with REST v2](http://developer.avalara.com/blog/2016/11/04/estimating-tax-with-rest-v2/)\r\nfor information on how to upgrade to the full AvaTax CreateTransaction API." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/taxrates/byaddress?line1=string&line2=string&line3=string&city=string®ion=string&postalCode=string&country=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "taxrates", "byaddress" ], "query": [ { "description": "The street address of the location.", "key": "line1", "value": "string" }, { "description": "The street address of the location.", "key": "line2", "value": "string" }, { "description": "The street address of the location.", "key": "line3", "value": "string" }, { "description": "The city name of the location.", "key": "city", "value": "string" }, { "description": "Name or ISO 3166 code identifying the region within the country.\r\n \r\nThis field supports many different region identifiers:\r\n * Two and three character ISO 3166 region codes\r\n * Fully spelled out names of the region in ISO supported languages\r\n * Common alternative spellings for many regions\r\n \r\nFor a full list of all supported codes and names, please see the Definitions API `ListRegions`.", "key": "region", "value": "string" }, { "description": "The postal code of the location.", "key": "postalCode", "value": "string" }, { "description": "Name or ISO 3166 code identifying the country.\r\n \r\nThis field supports many different country identifiers:\r\n * Two character ISO 3166 codes\r\n * Three character ISO 3166 codes\r\n * Fully spelled out names of the country in ISO supported languages\r\n * Common alternative spellings for many countries\r\n \r\nFor a full list of all supported codes and names, please see the Definitions API `ListCountries`.", "key": "country", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"totalRate\": 0.095,\n \"rates\": [\n {\n \"rate\": 0.06,\n \"name\": \"CA STATE TAX\",\n \"type\": \"State\"\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/taxrates/byaddress?line1=string&line2=string&line3=string&city=string®ion=string&postalCode=string&country=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "taxrates", "byaddress" ], "query": [ { "description": "The street address of the location.", "key": "line1", "value": "string" }, { "description": "The street address of the location.", "key": "line2", "value": "string" }, { "description": "The street address of the location.", "key": "line3", "value": "string" }, { "description": "The city name of the location.", "key": "city", "value": "string" }, { "description": "Name or ISO 3166 code identifying the region within the country.\r\n \r\nThis field supports many different region identifiers:\r\n * Two and three character ISO 3166 region codes\r\n * Fully spelled out names of the region in ISO supported languages\r\n * Common alternative spellings for many regions\r\n \r\nFor a full list of all supported codes and names, please see the Definitions API `ListRegions`.", "key": "region", "value": "string" }, { "description": "The postal code of the location.", "key": "postalCode", "value": "string" }, { "description": "Name or ISO 3166 code identifying the country.\r\n \r\nThis field supports many different country identifiers:\r\n * Two character ISO 3166 codes\r\n * Three character ISO 3166 codes\r\n * Fully spelled out names of the country in ISO supported languages\r\n * Common alternative spellings for many countries\r\n \r\nFor a full list of all supported codes and names, please see the Definitions API `ListCountries`.", "key": "country", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/taxrates/byaddress?line1=string&line2=string&line3=string&city=string®ion=string&postalCode=string&country=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "taxrates", "byaddress" ], "query": [ { "description": "The street address of the location.", "key": "line1", "value": "string" }, { "description": "The street address of the location.", "key": "line2", "value": "string" }, { "description": "The street address of the location.", "key": "line3", "value": "string" }, { "description": "The city name of the location.", "key": "city", "value": "string" }, { "description": "Name or ISO 3166 code identifying the region within the country.\r\n \r\nThis field supports many different region identifiers:\r\n * Two and three character ISO 3166 region codes\r\n * Fully spelled out names of the region in ISO supported languages\r\n * Common alternative spellings for many regions\r\n \r\nFor a full list of all supported codes and names, please see the Definitions API `ListRegions`.", "key": "region", "value": "string" }, { "description": "The postal code of the location.", "key": "postalCode", "value": "string" }, { "description": "Name or ISO 3166 code identifying the country.\r\n \r\nThis field supports many different country identifiers:\r\n * Two character ISO 3166 codes\r\n * Three character ISO 3166 codes\r\n * Fully spelled out names of the country in ISO supported languages\r\n * Common alternative spellings for many countries\r\n \r\nFor a full list of all supported codes and names, please see the Definitions API `ListCountries`.", "key": "country", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "bypostalcode", "item": [ { "name": "Sales tax rates for a specified country and postal code. This API is only available for US postal codes.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/taxrates/bypostalcode?country=string&postalCode=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "taxrates", "bypostalcode" ], "query": [ { "key": "country", "value": "string", "description": "Name or ISO 3166 code identifying the country.\r\n \r\nThis field supports many different country identifiers:\r\n * Two character ISO 3166 codes\r\n * Three character ISO 3166 codes\r\n * Fully spelled out names of the country in ISO supported languages\r\n * Common alternative spellings for many countries\r\n \r\nFor a full list of all supported codes and names, please see the Definitions API `ListCountries`." }, { "key": "postalCode", "value": "string", "description": "The postal code of the location." } ] }, "description": "This API is only available for a US postal codes.\r\n \r\nUsage of this API is subject to rate limits. Users who exceed the rate limit will receive HTTP\r\nresponse code 429 - `Too Many Requests`.\r\n \r\nThis API assumes that you are selling general tangible personal property at a retail point-of-sale\r\nlocation in the United States only.\r\n \r\nPlease be advised that this endpoint is designed for approximate tax rate estimation only and\r\nmay not yield precise results. For a more powerful and accurate tax estimation, upgrade to the\r\n`CreateTransaction` API, which offers a variety of advanced features including, but not limited\r\nto:\r\n \r\n* Nexus declarations\r\n* Taxability based on product/service type\r\n* Sourcing rules affecting origin/destination states\r\n* Customers who are exempt from certain taxes\r\n* States that have dollar value thresholds for tax amounts\r\n* Refunds for products purchased on a different date\r\n* Detailed jurisdiction names and state assigned codes\r\n* And more!\r\n \r\nPlease see [Estimating Tax with REST v2](http://developer.avalara.com/blog/2016/11/04/estimating-tax-with-rest-v2/)\r\nfor information on how to upgrade to the full AvaTax CreateTransaction API." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/taxrates/bypostalcode?country=string&postalCode=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "taxrates", "bypostalcode" ], "query": [ { "description": "Name or ISO 3166 code identifying the country.\r\n \r\nThis field supports many different country identifiers:\r\n * Two character ISO 3166 codes\r\n * Three character ISO 3166 codes\r\n * Fully spelled out names of the country in ISO supported languages\r\n * Common alternative spellings for many countries\r\n \r\nFor a full list of all supported codes and names, please see the Definitions API `ListCountries`.", "key": "country", "value": "string" }, { "description": "The postal code of the location.", "key": "postalCode", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"totalRate\": 0.095,\n \"rates\": [\n {\n \"rate\": 0.06,\n \"name\": \"CA STATE TAX\",\n \"type\": \"State\"\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/taxrates/bypostalcode?country=string&postalCode=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "taxrates", "bypostalcode" ], "query": [ { "description": "Name or ISO 3166 code identifying the country.\r\n \r\nThis field supports many different country identifiers:\r\n * Two character ISO 3166 codes\r\n * Three character ISO 3166 codes\r\n * Fully spelled out names of the country in ISO supported languages\r\n * Common alternative spellings for many countries\r\n \r\nFor a full list of all supported codes and names, please see the Definitions API `ListCountries`.", "key": "country", "value": "string" }, { "description": "The postal code of the location.", "key": "postalCode", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/taxrates/bypostalcode?country=string&postalCode=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "taxrates", "bypostalcode" ], "query": [ { "description": "Name or ISO 3166 code identifying the country.\r\n \r\nThis field supports many different country identifiers:\r\n * Two character ISO 3166 codes\r\n * Three character ISO 3166 codes\r\n * Fully spelled out names of the country in ISO supported languages\r\n * Common alternative spellings for many countries\r\n \r\nFor a full list of all supported codes and names, please see the Definitions API `ListCountries`.", "key": "country", "value": "string" }, { "description": "The postal code of the location.", "key": "postalCode", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "taxratesbyzipcode", "item": [ { "name": "download", "item": [ { "name": "{date}", "item": [ { "name": "Download a file listing tax rates by postal code", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/taxratesbyzipcode/download/:date?region=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "taxratesbyzipcode", "download", ":date" ], "query": [ { "key": "region", "value": "string", "description": "A two character region code which limits results to a specific region." } ], "variable": [ { "key": "date", "value": "1998-02-12T20:23:10.405Z", "description": "The date for which point-of-sale data would be calculated (today by default). Example input: 2016-12-31" } ] }, "description": "Download a CSV file containing all five digit postal codes in the United States and their sales\r\nand use tax rates for tangible personal property.\r\n \r\nSince tax rates may change based on decisions made by a variety of tax authorities, we recommend\r\nthat users of this tax content API download new data every day. Many tax authorities may finalize\r\ndecisions on tax changes at unexpected times and may make changes in response to legal issues or\r\ngovernmental priorities. Any tax content downloaded for future time periods is subject to change\r\nif tax rates or tax laws change.\r\n \r\nThis rates file is intended to be used as a default for tax calculation when your software cannot\r\ncall the `CreateTransaction` API call. When using this file, your software will be unable to\r\nhandle complex tax rules such as:\r\n \r\n* Zip+4 - This tax file contains five digit zip codes only.\r\n* Different product types - This tax file contains tangible personal property tax rates only.\r\n* Mixed sourcing - This tax file cannot be used to resolve origin-based taxes.\r\n* Threshold-based taxes - This tax file does not contain information about thresholds.\r\n \r\nIf you use this file to provide default tax rates, please ensure that your software calls `CreateTransaction`\r\nto reconcile the actual transaction and determine the difference between the estimated general tax\r\nrate and the final transaction tax.\r\n \r\nThe file provided by this API is in CSV format with the following columns:\r\n \r\n* ZIP_CODE - The five digit zip code for this record.\r\n* STATE_ABBREV - A valid two character US state abbreviation for this record. Zip codes may span multiple states.\r\n* COUNTY_NAME - A valid county name for this record. Zip codes may span multiple counties.\r\n* CITY_NAME - A valid city name for this record. Zip codes may span multiple cities.\r\n* STATE_SALES_TAX - The state component of the sales tax rate.\r\n* STATE_USE_TAX - The state component of the use tax rate.\r\n* COUNTY_SALES_TAX - The county component of the sales tax rate.\r\n* COUNTY_USE_TAX - The county component of the use tax rate.\r\n* CITY_SALES_TAX - The city component of the sales tax rate.\r\n* CITY_USE_TAX - The city component of the use tax rate.\r\n* TOTAL_SALES_TAX - The total tax rate for sales tax for this postal code. This value may not equal the sum of the state/county/city due to special tax jurisdiction rules.\r\n* TOTAL_USE_TAX - The total tax rate for use tax for this postal code. This value may not equal the sum of the state/county/city due to special tax jurisdiction rules.\r\n* TAX_SHIPPING_ALONE - This column contains 'Y' if shipping is taxable.\r\n* TAX_SHIPPING_AND_HANDLING_TOGETHER - This column contains 'Y' if shipping and handling are taxable when sent together.\r\n \r\nFor more detailed tax content, please use the `BuildTaxContentFile` API which allows usage of exact items and exact locations.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/taxratesbyzipcode/download/:date?region=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "taxratesbyzipcode", "download", ":date" ], "query": [ { "description": "A two character region code which limits results to a specific region.", "key": "region", "value": "string" } ], "variable": [ { "key": "date", "value": "1998-02-12T20:23:10.405Z", "description": "The date for which point-of-sale data would be calculated (today by default). Example input: 2016-12-31" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "string" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/taxratesbyzipcode/download/:date?region=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "taxratesbyzipcode", "download", ":date" ], "query": [ { "description": "A two character region code which limits results to a specific region.", "key": "region", "value": "string" } ], "variable": [ { "key": "date", "value": "1998-02-12T20:23:10.405Z", "description": "The date for which point-of-sale data would be calculated (today by default). Example input: 2016-12-31" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/taxratesbyzipcode/download/:date?region=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "taxratesbyzipcode", "download", ":date" ], "query": [ { "description": "A two character region code which limits results to a specific region.", "key": "region", "value": "string" } ], "variable": [ { "key": "date", "value": "1998-02-12T20:23:10.405Z", "description": "The date for which point-of-sale data would be calculated (today by default). Example input: 2016-12-31" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] } ] }, { "name": "{country}", "item": [ { "name": "CountryCoefficients", "item": [ { "name": "Retrieve country coefficients for specific country", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/:country/CountryCoefficients?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", ":country", "CountryCoefficients" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* CoefficientsId, AccountId, ModifiedUserId, CreatedUserId" }, { "key": "$include", "value": "string", "description": "A comma separated list of additional data to retrieve." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "country", "value": "string", "description": "Country for which data need to be pulled for." } ] }, "description": "Retrieve all or any specific records of Country Coefficients based on the filters(optional) for specific country.\r\n \r\n Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\n Paginate your results using the `$top`, `$skip`, and `$orderby` parameters." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/:country/CountryCoefficients?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", ":country", "CountryCoefficients" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* CoefficientsId, AccountId, ModifiedUserId, CreatedUserId", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "country", "value": "string", "description": "Country for which data need to be pulled for." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 2928,\n \"value\": [\n {\n \"country\": \"string\",\n \"coefficientsId\": 7256,\n \"accountId\": 481,\n \"companyId\": 3361,\n \"coefficient\": 5593.985350577197,\n \"taxSubTypeId\": \"string\",\n \"currencyCode\": \"string\",\n \"unitOfBasisId\": 7158,\n \"isApplicable\": true,\n \"modifiedDate\": \"1964-05-10T02:04:21.864Z\",\n \"startDate\": \"1994-03-01T23:00:13.431Z\",\n \"endDate\": \"1989-11-07T10:12:28.586Z\",\n \"modifiedUserId\": 7995,\n \"createdDate\": \"2021-10-30T12:20:13.137Z\",\n \"createdUserId\": 5979\n },\n {\n \"country\": \"string\",\n \"coefficientsId\": 8067,\n \"accountId\": 1246,\n \"companyId\": 8287,\n \"coefficient\": 1263.120758100018,\n \"taxSubTypeId\": \"string\",\n \"currencyCode\": \"string\",\n \"unitOfBasisId\": 9677,\n \"isApplicable\": true,\n \"modifiedDate\": \"1978-03-14T03:03:27.239Z\",\n \"startDate\": \"1987-04-23T00:44:35.902Z\",\n \"endDate\": \"2018-04-02T21:03:26.144Z\",\n \"modifiedUserId\": 3680,\n \"createdDate\": \"2019-12-09T00:44:55.596Z\",\n \"createdUserId\": 881\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/:country/CountryCoefficients?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", ":country", "CountryCoefficients" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* CoefficientsId, AccountId, ModifiedUserId, CreatedUserId", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "country", "value": "string", "description": "Country for which data need to be pulled for." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/:country/CountryCoefficients?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", ":country", "CountryCoefficients" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* CoefficientsId, AccountId, ModifiedUserId, CreatedUserId", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "country", "value": "string", "description": "Country for which data need to be pulled for." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/:country/CountryCoefficients?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", ":country", "CountryCoefficients" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* CoefficientsId, AccountId, ModifiedUserId, CreatedUserId", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "country", "value": "string", "description": "Country for which data need to be pulled for." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] }, { "name": "countryCoefficients", "item": [ { "name": "Create new Country Coefficients. If already exist update them.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 0,\n \"coefficientDetails\": [\n {\n \"companyCode\": \"\",\n \"country\": \"\",\n \"coefficient\": 0,\n \"taxSubTypeId\": \"\",\n \"currencyCode\": \"USD\",\n \"unitOfBasisId\": 0,\n \"isApplicable\": false,\n \"startDate\": \"2026-04-02\",\n \"endDate\": \"9999-12-31\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/countryCoefficients", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "countryCoefficients" ] }, "description": "Create one or more Country Coefficients for particular country.\r\n \r\nWe would like to use country coefficients during Cross-Border calculations to slightly increase or decrease\r\na calculation for a line based on the tax-subtype and Country of destination for a transaction.\r\n \r\nThis will allow AvaTax to minimize the variance caused between actual transaction taken place on ground Vs Tax\r\nCalculated by AvaTax.\r\n \r\nMake sure to use the same API to update the country coefficients that is already present in the database.\r\nThis will make existing entry for specific country as ineffective for that date. And new entry created will get applicable\r\nto the newer transactions." }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 0,\n \"coefficientDetails\": [\n {\n \"companyCode\": \"\",\n \"country\": \"\",\n \"coefficient\": 0,\n \"taxSubTypeId\": \"\",\n \"currencyCode\": \"USD\",\n \"unitOfBasisId\": 0,\n \"isApplicable\": false,\n \"startDate\": \"2026-04-02\",\n \"endDate\": \"9999-12-31\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/countryCoefficients", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "countryCoefficients" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"count\": 0\n },\n {\n \"count\": 0\n }\n]" }, { "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 0,\n \"coefficientDetails\": [\n {\n \"companyCode\": \"\",\n \"country\": \"\",\n \"coefficient\": 0,\n \"taxSubTypeId\": \"\",\n \"currencyCode\": \"USD\",\n \"unitOfBasisId\": 0,\n \"isApplicable\": false,\n \"startDate\": \"2026-04-02\",\n \"endDate\": \"9999-12-31\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/countryCoefficients", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "countryCoefficients" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 0,\n \"coefficientDetails\": [\n {\n \"companyCode\": \"\",\n \"country\": \"\",\n \"coefficient\": 0,\n \"taxSubTypeId\": \"\",\n \"currencyCode\": \"USD\",\n \"unitOfBasisId\": 0,\n \"isApplicable\": false,\n \"startDate\": \"2026-04-02\",\n \"endDate\": \"9999-12-31\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/countryCoefficients", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "countryCoefficients" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "raw", "raw": "{\n \"accountId\": 0,\n \"coefficientDetails\": [\n {\n \"companyCode\": \"\",\n \"country\": \"\",\n \"coefficient\": 0,\n \"taxSubTypeId\": \"\",\n \"currencyCode\": \"USD\",\n \"unitOfBasisId\": 0,\n \"isApplicable\": false,\n \"startDate\": \"2026-04-02\",\n \"endDate\": \"9999-12-31\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/countryCoefficients", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "countryCoefficients" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "taxrules", "item": [ { "name": "Retrieve all tax rules", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/taxrules?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "taxrules" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxCode, taxTypeCode, taxRuleProductDetail, rateTypeCode, taxTypeGroup, taxSubType, unitOfBasis" }, { "key": "$include", "value": "string", "description": "A comma separated list of additional data to retrieve." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Get multiple taxrule objects across all companies.\r\n \r\nA tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules\r\ncan be used to change the taxability of an item, to change the tax base of an item, or to change the tax rate\r\ncharged when selling an item. Tax rules can also change tax behavior depending on the `entityUseCode` value submitted\r\nwith the transaction.\r\n \r\nYou can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your\r\nbusiness. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use\r\ncustom tax rules to redefine the behavior for your company or item.\r\n \r\nPlease use custom tax rules carefully and ensure that these tax rules match the behavior agreed upon with your\r\nauditor, legal representative, and accounting team.\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/taxrules?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "taxrules" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxCode, taxTypeCode, taxRuleProductDetail, rateTypeCode, taxTypeGroup, taxSubType, unitOfBasis", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 8811,\n \"value\": [\n {\n \"country\": \"US\",\n \"id\": 56789,\n \"jurisCode\": \"013\",\n \"taxRuleTypeId\": \"RateRule\",\n \"companyId\": 12345,\n \"taxCodeId\": 3849,\n \"taxCode\": \"FR020800\",\n \"stateFIPS\": \"04\",\n \"jurisName\": \"MARICOPA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"Country\",\n \"customerUsageType\": \"string\",\n \"entityUseCode\": \"string\",\n \"taxTypeId\": \"E\",\n \"taxTypeCode\": \"ALL\",\n \"taxRuleProductDetail\": [\n {\n \"taxRuleProductDetailId\": 1,\n \"taxRuleId\": 123,\n \"productCode\": \"220720\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"endDate\": \"2027-04-02T00:00:00+00:00\",\n \"systemId\": 28\n },\n {\n \"taxRuleProductDetailId\": 1,\n \"taxRuleId\": 123,\n \"productCode\": \"220720\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"endDate\": \"2027-04-02T00:00:00+00:00\",\n \"systemId\": 28\n }\n ],\n \"rateTypeId\": \"ReducedA\",\n \"rateTypeCode\": \"string\",\n \"isAllJuris\": false,\n \"value\": 0,\n \"cap\": 0,\n \"threshold\": 0,\n \"options\": \"string\",\n \"effectiveDate\": \"1968-03-01\",\n \"endDate\": \"2014-11-01\",\n \"description\": \"Freight\",\n \"countyFIPS\": \"013\",\n \"isSTPro\": true,\n \"region\": \"AZ\",\n \"sourcing\": \"Mixed\",\n \"taxTypeGroup\": \"SalesAndUse\",\n \"taxSubType\": \"ALL\",\n \"nonPassthroughExpression\": \"string\",\n \"currencyCode\": \"st\",\n \"preferredProgramId\": 28,\n \"uomId\": 2250,\n \"createdDate\": \"2001-05-20T00:17:39.348Z\",\n \"createdUserId\": 398,\n \"modifiedDate\": \"2010-03-11T04:49:05.648Z\",\n \"modifiedUserId\": 6527,\n \"unitOfBasis\": \"string\"\n },\n {\n \"country\": \"US\",\n \"id\": 56789,\n \"jurisCode\": \"013\",\n \"taxRuleTypeId\": \"RateRule\",\n \"companyId\": 12345,\n \"taxCodeId\": 5026,\n \"taxCode\": \"FR020800\",\n \"stateFIPS\": \"04\",\n \"jurisName\": \"MARICOPA\",\n \"jurisTypeId\": \"STA\",\n \"jurisdictionTypeId\": \"Country\",\n \"customerUsageType\": \"str\",\n \"entityUseCode\": \"string\",\n \"taxTypeId\": \"E\",\n \"taxTypeCode\": \"ALL\",\n \"taxRuleProductDetail\": [\n {\n \"taxRuleProductDetailId\": 1,\n \"taxRuleId\": 123,\n \"productCode\": \"220720\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"endDate\": \"2027-04-02T00:00:00+00:00\",\n \"systemId\": 28\n },\n {\n \"taxRuleProductDetailId\": 1,\n \"taxRuleId\": 123,\n \"productCode\": \"220720\",\n \"effectiveDate\": \"2026-04-02T00:00:00+00:00\",\n \"endDate\": \"2027-04-02T00:00:00+00:00\",\n \"systemId\": 28\n }\n ],\n \"rateTypeId\": \"ReducedA\",\n \"rateTypeCode\": \"string\",\n \"isAllJuris\": false,\n \"value\": 0,\n \"cap\": 0,\n \"threshold\": 0,\n \"options\": \"string\",\n \"effectiveDate\": \"2018-07-15\",\n \"endDate\": \"2002-04-18\",\n \"description\": \"Freight\",\n \"countyFIPS\": \"013\",\n \"isSTPro\": false,\n \"region\": \"AZ\",\n \"sourcing\": \"Mixed\",\n \"taxTypeGroup\": \"SalesAndUse\",\n \"taxSubType\": \"ALL\",\n \"nonPassthroughExpression\": \"string\",\n \"currencyCode\": \"s\",\n \"preferredProgramId\": 1959,\n \"uomId\": 9107,\n \"createdDate\": \"1968-04-14T08:55:54.408Z\",\n \"createdUserId\": 4308,\n \"modifiedDate\": \"1988-11-27T03:19:26.332Z\",\n \"modifiedUserId\": 5121,\n \"unitOfBasis\": \"string\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/taxrules?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "taxrules" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxCode, taxTypeCode, taxRuleProductDetail, rateTypeCode, taxTypeGroup, taxSubType, unitOfBasis", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/taxrules?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "taxrules" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* taxCode, taxTypeCode, taxRuleProductDetail, rateTypeCode, taxTypeGroup, taxSubType, unitOfBasis", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "upcs", "item": [ { "name": "Retrieve all UPCs", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/upcs?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "upcs" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/)." }, { "key": "$include", "value": "string", "description": "A comma separated list of additional data to retrieve." }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Get multiple UPC objects across all companies.\r\nA UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC.\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaUpc.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/upcs?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "upcs" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 5024,\n \"value\": [\n {\n \"id\": 123456789,\n \"companyId\": 1234567,\n \"upc\": \"023032550992\",\n \"legacyTaxCode\": \"PS081282\",\n \"description\": \"Yarn\"\n },\n {\n \"id\": 123456789,\n \"companyId\": 1234567,\n \"upc\": \"023032550992\",\n \"legacyTaxCode\": \"PS081282\",\n \"description\": \"Yarn\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/upcs?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "upcs" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/upcs?$filter=string&$include=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "upcs" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).", "key": "$filter", "value": "string" }, { "description": "A comma separated list of additional data to retrieve.", "key": "$include", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "users", "item": [ { "name": "Retrieve all users", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/users?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users" ], "query": [ { "key": "$include", "value": "string", "description": "Optional fetch commands." }, { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* SuppressNewUserEmail" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ] }, "description": "Get multiple user objects across all accounts.\r\n \r\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\r\nvia either username / password authentication, an OpenID / OAuth Bearer Token, or a legacy AvaTax License Key.\r\n \r\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.\r\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.\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters.\r\n \r\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:\r\n \r\n* FetchDeleted\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, ProStoresOperator, Registrar, ReturnsOnlyAccountAdmin, ReturnsOnlyAccountUser, ReturnsOnlyCompanyAdmin, ReturnsOnlyCompanyUser, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/users?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users" ], "query": [ { "description": "Optional fetch commands.", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* SuppressNewUserEmail", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 2171,\n \"value\": [\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"companyId\": 123456,\n \"userName\": \"bobExample\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Example\",\n \"email\": \"bob@example.org\",\n \"postalCode\": \"98110\",\n \"securityRoleId\": \"AccountUser\",\n \"passwordStatus\": \"UserCanChange\",\n \"isActive\": true,\n \"suppressNewUserEmail\": false,\n \"isDeleted\": false\n },\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"companyId\": 123456,\n \"userName\": \"bobExample\",\n \"firstName\": \"Bob\",\n \"lastName\": \"Example\",\n \"email\": \"bob@example.org\",\n \"postalCode\": \"98110\",\n \"securityRoleId\": \"AccountUser\",\n \"passwordStatus\": \"UserCanChange\",\n \"isActive\": true,\n \"suppressNewUserEmail\": false,\n \"isDeleted\": false\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/users?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users" ], "query": [ { "description": "Optional fetch commands.", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* SuppressNewUserEmail", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/users?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "users" ], "query": [ { "description": "Optional fetch commands.", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* SuppressNewUserEmail", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "utilities", "item": [ { "name": "ping", "item": [ { "name": "Tests connectivity and version of the service", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/utilities/ping", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "utilities", "ping" ] }, "description": "Check connectivity to AvaTax and return information about the AvaTax API server.\r\n \r\nThis API is intended to help you verify that your connection is working. This API will always succeed and will\r\nnever return a error. It provides basic information about the server you connect to:\r\n \r\n* `version` - 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.\r\n* `authenticated` - A boolean flag indicating whether or not you sent valid credentials with your API request.\r\n* `authenticationType` - If you provided valid credentials to the API, this field will tell you whether you used Bearer, Username, or LicenseKey authentication.\r\n* `authenticatedUserName` - If you provided valid credentials to the API, this field will tell you the username of the currently logged in user.\r\n* `authenticatedUserId` - If you provided valid credentials to the API, this field will tell you the user ID of the currently logged in user.\r\n* `authenticatedAccountId` - If you provided valid credentials to the API, this field will contain the account ID of the currently logged in user.\r\n \r\nThis API helps diagnose connectivity problems between your application and AvaTax; you may call this API even\r\nif you do not have verified connection credentials. If this API fails, either your computer is not connected to\r\nthe internet, or there is a routing problem between your office and Avalara, or the Avalara server is not available.\r\nFor more information on the uptime of AvaTax, please see [Avalara's AvaTax Status Page](https://status.avalara.com/).\n\n### Security Policies\n\n* This API may be called without providing authentication credentials.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/utilities/ping", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "utilities", "ping" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"version\": \"1.0.0.0\",\n \"authenticated\": true,\n \"authenticationType\": \"UsernamePassword\",\n \"authenticatedUserName\": \"TestUser\",\n \"authenticatedUserId\": 98765,\n \"authenticatedAccountId\": 123456789,\n \"authenticatedCompanyId\": 123456789,\n \"crmid\": \"1111\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/utilities/ping", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "utilities", "ping" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/utilities/ping", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "utilities", "ping" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "subscriptions", "item": [ { "name": "{serviceTypeId}", "item": [ { "name": "Checks if the current user is subscribed to a specific service", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/utilities/subscriptions/:serviceTypeId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "utilities", "subscriptions", ":serviceTypeId" ], "variable": [ { "key": "serviceTypeId", "value": "string", "description": "The service to check" } ] }, "description": "Returns a subscription object for the current account, or 404 Not Found if this subscription is not enabled for this account.\r\n \r\nThis API will return an error if it is called with invalid authentication credentials.\r\n \r\nThis API is intended to help you determine whether you have the necessary subscription to use certain API calls\r\nwithin AvaTax. You can examine the subscriptions returned from this API call to look for a particular product\r\nor subscription to provide useful information to the current user as to whether they are entitled to use\r\nspecific features of AvaTax." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/utilities/subscriptions/:serviceTypeId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "utilities", "subscriptions", ":serviceTypeId" ], "variable": [ { "key": "serviceTypeId", "value": "string", "description": "The service to check" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 12345,\n \"accountId\": 123456789,\n \"subscriptionTypeId\": 2,\n \"subscriptionDescription\": \"AvaTaxPro\",\n \"effectiveDate\": \"2015-01-01\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/utilities/subscriptions/:serviceTypeId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "utilities", "subscriptions", ":serviceTypeId" ], "variable": [ { "key": "serviceTypeId", "value": "string", "description": "The service to check" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/utilities/subscriptions/:serviceTypeId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "utilities", "subscriptions", ":serviceTypeId" ], "variable": [ { "key": "serviceTypeId", "value": "string", "description": "The service to check" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/utilities/subscriptions/:serviceTypeId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "utilities", "subscriptions", ":serviceTypeId" ], "variable": [ { "key": "serviceTypeId", "value": "string", "description": "The service to check" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] }, { "name": "List all services to which the current user is subscribed", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/utilities/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "utilities", "subscriptions" ] }, "description": "Returns the list of all subscriptions enabled for the currently logged in user.\r\n \r\nThis API will return an error if it is called with invalid authentication credentials.\r\n \r\nThis API is intended to help you determine whether you have the necessary subscription to use certain API calls\r\nwithin AvaTax. You can examine the subscriptions returned from this API call to look for a particular product\r\nor subscription to provide useful information to the current user as to whether they are entitled to use\r\nspecific features of AvaTax." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/utilities/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "utilities", "subscriptions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 5294,\n \"value\": [\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"subscriptionTypeId\": 2,\n \"subscriptionDescription\": \"AvaTaxPro\",\n \"effectiveDate\": \"2015-01-01\"\n },\n {\n \"id\": 12345,\n \"accountId\": 123456789,\n \"subscriptionTypeId\": 2,\n \"subscriptionDescription\": \"AvaTaxPro\",\n \"effectiveDate\": \"2015-01-01\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/utilities/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "utilities", "subscriptions" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/api/v2/utilities/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "utilities", "subscriptions" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"type\": \"string\",\n \"title\": \"string\",\n \"status\": 9827,\n \"detail\": \"string\",\n \"instance\": \"string\"\n}" } ] } ] } ] } ] } ] }, { "name": "companies", "item": [ { "name": "{companyId}", "item": [ { "name": "communication-certificates", "item": [ { "name": "{certificateId}", "item": [ { "name": "Retrieve a single communication certificate.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/:companyId/communication-certificates/:certificateId", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyId", "communication-certificates", ":certificateId" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company to search" }, { "key": "certificateId", "value": "451", "description": "The ID number of the certificate to search" } ] }, "description": "\n\n### Security Policies\n\n* This API depends on the following active services:*Required* (all): ECMPremiumComms, ECMProComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/companies/:companyId/communication-certificates/:certificateId", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyId", "communication-certificates", ":certificateId" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company to search" }, { "key": "certificateId", "value": "451", "description": "The ID number of the certificate to search" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": 628,\n \"effectiveDate\": \"2026-04-02T10:55:05.9083597Z\",\n \"expirationDate\": \"2026-04-02T10:55:05.90836Z\",\n \"exemptionReason\": \"INTERNET ACCESS RESELLER\",\n \"exemptionRegion\": \"Georgia\",\n \"taxNumber\": \"1234567\",\n \"certificateStatus\": \"Pending-Future\",\n \"customers\": [\n {\n \"id\": 456,\n \"customerNumber\": \"1000\",\n \"name\": \"Test 1000\"\n }\n ],\n \"exemptions\": [\n {\n \"location\": {\n \"country\": \"USA\",\n \"state\": \"GA\",\n \"county\": \"null\",\n \"city\": \"null\"\n },\n \"exemptionDesignator\": {\n \"id\": 8,\n \"type\": \"Tax type\",\n \"name\": \"License Tax\"\n },\n \"scope\": [\n \"All\"\n ],\n \"domain\": \"Local\"\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/companies/:companyId/communication-certificates/:certificateId", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyId", "communication-certificates", ":certificateId" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company to search" }, { "key": "certificateId", "value": "451", "description": "The ID number of the certificate to search" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/companies/:companyId/communication-certificates/:certificateId", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyId", "communication-certificates", ":certificateId" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company to search" }, { "key": "certificateId", "value": "451", "description": "The ID number of the certificate to search" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/companies/:companyId/communication-certificates/:certificateId", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyId", "communication-certificates", ":certificateId" ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company to search" }, { "key": "certificateId", "value": "451", "description": "The ID number of the certificate to search" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Retrieve all communication certificates.", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/:companyId/communication-certificates?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyId", "communication-certificates" ], "query": [ { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* EffectiveDate, ExpirationDate, TaxNumber, Exemptions" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company to search" } ] }, "description": "List all communication certificates that can be seen by the current user.\r\n \r\nThis API lists all communication certificates you are allowed to see.\r\n \r\nSearch for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .\r\nPaginate your results using the `$top`, `$skip`, and `$orderby` parameters. \r\nFor more information about filtering in REST, please see the documentation at http://developer.avalara.com/avatax/filtering-in-rest/ .\n\n### Security Policies\n\n* This API depends on the following active services:*Required* (all): ECMPremiumComms, ECMProComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/companies/:companyId/communication-certificates?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyId", "communication-certificates" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* EffectiveDate, ExpirationDate, TaxNumber, Exemptions", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company to search" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"count\": 9826,\n \"value\": [\n {\n \"id\": 628,\n \"effectiveDate\": \"2026-04-02T10:55:05.9083597Z\",\n \"expirationDate\": \"2026-04-02T10:55:05.90836Z\",\n \"exemptionReason\": \"INTERNET ACCESS RESELLER\",\n \"exemptionRegion\": \"Georgia\",\n \"taxNumber\": \"1234567\",\n \"certificateStatus\": \"Pending-Future\",\n \"customers\": [\n {\n \"id\": 456,\n \"customerNumber\": \"1000\",\n \"name\": \"Test 1000\"\n }\n ],\n \"exemptions\": [\n {\n \"location\": {\n \"country\": \"USA\",\n \"state\": \"GA\",\n \"county\": \"null\",\n \"city\": \"null\"\n },\n \"exemptionDesignator\": {\n \"id\": 8,\n \"type\": \"Tax type\",\n \"name\": \"License Tax\"\n },\n \"scope\": [\n \"All\"\n ],\n \"domain\": \"Local\"\n }\n ]\n },\n {\n \"id\": 628,\n \"effectiveDate\": \"2026-04-02T10:55:05.9083597Z\",\n \"expirationDate\": \"2026-04-02T10:55:05.90836Z\",\n \"exemptionReason\": \"INTERNET ACCESS RESELLER\",\n \"exemptionRegion\": \"Georgia\",\n \"taxNumber\": \"1234567\",\n \"certificateStatus\": \"Pending-Future\",\n \"customers\": [\n {\n \"id\": 456,\n \"customerNumber\": \"1000\",\n \"name\": \"Test 1000\"\n }\n ],\n \"exemptions\": [\n {\n \"location\": {\n \"country\": \"USA\",\n \"state\": \"GA\",\n \"county\": \"null\",\n \"city\": \"null\"\n },\n \"exemptionDesignator\": {\n \"id\": 8,\n \"type\": \"Tax type\",\n \"name\": \"License Tax\"\n },\n \"scope\": [\n \"All\"\n ],\n \"domain\": \"Local\"\n }\n ]\n }\n ]\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/companies/:companyId/communication-certificates?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyId", "communication-certificates" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* EffectiveDate, ExpirationDate, TaxNumber, Exemptions", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company to search" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/companies/:companyId/communication-certificates?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyId", "communication-certificates" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* EffectiveDate, ExpirationDate, TaxNumber, Exemptions", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company to search" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/companies/:companyId/communication-certificates?$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":companyId", "communication-certificates" ], "query": [ { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* EffectiveDate, ExpirationDate, TaxNumber, Exemptions", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company to search" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] } ] }, { "name": "{companyId}", "item": [ { "name": "vendor-certificates", "item": [ { "name": "List all vendor certificates for a company", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0", "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) ." }, { "key": "Accept", "value": "text/plain" } ], "url": { "raw": "{{baseUrl}}/:companyId/vendor-certificates?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ ":companyId", "vendor-certificates" ], "query": [ { "key": "$include", "value": "string", "description": "OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:\r\n \r\n * customers - Retrieves the list of vendors linked to the certificate.\r\n * po_numbers - Retrieves all PO numbers tied to the certificate.\r\n * attributes - Retrieves all attributes applied to the certificate.\r\n * histories - Retrieves the certificate update history\r\n * jobs - Retrieves the jobs for this certificate\r\n * logs - Retrieves the certificate log\r\n * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid\r\n * custom_fields - Retrieves custom fields set for this certificate" }, { "key": "$filter", "value": "string", "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* documentTypeId, documentTypeDescription, exemptionNumber, ecmsId, ecmsStatus, pdf, pages" }, { "key": "$top", "value": "451", "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records." }, { "key": "$skip", "value": "451", "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets." }, { "key": "$orderBy", "value": "string", "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`." } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company to search" } ] }, "description": "List all certificates recorded by a company\r\n \r\nA certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document\r\ncan contain information about a vendor's eligibility for exemption from sales or use taxes based on\r\ncriteria you specify when you store the certificate. To view or manage your certificates directly, please\r\nlog onto the administrative website for the product you purchased.\r\n \r\nYou can use the `$include` parameter to fetch the following additional objects for expansion:\r\n \r\n* customers - Retrieves the list of vendors linked to the certificate.\r\n* po_numbers - Retrieves all PO numbers tied to the certificate.\r\n* attributes - Retrieves all attributes applied to the certificate.\r\n* histories - Retrieves the certificate update history\r\n* jobs - Retrieves the jobs for this certificate\r\n* logs - Retrieves the certificate log\r\n* invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid\r\n* custom_fields - Retrieves custom fields set for this certificate\r\n \r\nBefore you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.\r\nCompanies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption\r\ncertificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption\r\ncertificate storage for this company, call `RequestCertificateSetup`.\r\n \r\nNote* Filtering not supported for any documentType field.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, AvaTaxOnlyAccountAdmin, AvaTaxOnlyAccountUser, AvaTaxOnlyCompanyAdmin, AvaTaxOnlyCompanyUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.\n* This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "key": "Accept", "value": "text/plain" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/:companyId/vendor-certificates?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ ":companyId", "vendor-certificates" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:\r\n \r\n * customers - Retrieves the list of vendors linked to the certificate.\r\n * po_numbers - Retrieves all PO numbers tied to the certificate.\r\n * attributes - Retrieves all attributes applied to the certificate.\r\n * histories - Retrieves the certificate update history\r\n * jobs - Retrieves the jobs for this certificate\r\n * logs - Retrieves the certificate log\r\n * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid\r\n * custom_fields - Retrieves custom fields set for this certificate", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* documentTypeId, documentTypeDescription, exemptionNumber, ecmsId, ecmsStatus, pdf, pages", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company to search" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@recordsetCount\": 4789,\n \"value\": [\n {\n \"documentTypeId\": 1,\n \"documentTypeName\": \"Vendor Purchase Certificate\",\n \"documentTypeDescription\": \"Certificate for vendor purchase exemptions\",\n \"documentTypeOutgoing\": false,\n \"id\": 0,\n \"signedDate\": \"2016-02-01\",\n \"expirationDate\": \"2020-12-31\",\n \"filename\": \"230956bc-c2ce-4c69-a624-465fcdf0bd93\",\n \"documentExists\": false,\n \"valid\": true,\n \"verified\": false,\n \"exemptPercentage\": 0,\n \"isSingleCertificate\": false,\n \"exemptionNumber\": \"VENDOR-EXEMPT-1234\",\n \"exemptionReason\": {\n \"name\": \"VENDOR_RESALE\"\n },\n \"ecmStatus\": \"None\",\n \"createdDate\": \"2026-04-02T10:55:19.570143Z\",\n \"modifiedDate\": \"2026-04-02\",\n \"taxNumberType\": \"FEIN\",\n \"businessNumberType\": \"Vendor Services\",\n \"pageCount\": 0,\n \"customers\": [\n {\n \"companyId\": 0,\n \"customerCode\": \"2ac6fde5-42a8-4c06-bfdc-12473b74cf9a\",\n \"alternateId\": \"987654321\",\n \"name\": \"Dr. Bob Example\",\n \"attnName\": \"Attn: Receiving\",\n \"line1\": \"645 Main Street\",\n \"city\": \"Irvine\",\n \"postalCode\": \"92614\",\n \"phoneNumber\": \"(949) 555-1212\",\n \"faxNumber\": \"949.555.1213\",\n \"emailAddress\": \"dr.bob.example@example.org\",\n \"contactName\": \"Alice Smith\",\n \"lastTransaction\": \"2008-10-08T00:00:00Z\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"exposureZones\": [\n {\n \"name\": \"Washington\"\n }\n ]\n }\n ],\n \"exposureZone\": {\n \"name\": \"Washington\"\n },\n \"exposureZoneName\": \"Washington\"\n }\n ],\n \"@nextLink\": \"string\",\n \"pageKey\": \"string\"\n}" }, { "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/:companyId/vendor-certificates?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ ":companyId", "vendor-certificates" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:\r\n \r\n * customers - Retrieves the list of vendors linked to the certificate.\r\n * po_numbers - Retrieves all PO numbers tied to the certificate.\r\n * attributes - Retrieves all attributes applied to the certificate.\r\n * histories - Retrieves the certificate update history\r\n * jobs - Retrieves the jobs for this certificate\r\n * logs - Retrieves the certificate log\r\n * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid\r\n * custom_fields - Retrieves custom fields set for this certificate", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* documentTypeId, documentTypeDescription, exemptionNumber, ecmsId, ecmsStatus, pdf, pages", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company to search" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/:companyId/vendor-certificates?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ ":companyId", "vendor-certificates" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:\r\n \r\n * customers - Retrieves the list of vendors linked to the certificate.\r\n * po_numbers - Retrieves all PO numbers tied to the certificate.\r\n * attributes - Retrieves all attributes applied to the certificate.\r\n * histories - Retrieves the certificate update history\r\n * jobs - Retrieves the jobs for this certificate\r\n * logs - Retrieves the certificate log\r\n * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid\r\n * custom_fields - Retrieves custom fields set for this certificate", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* documentTypeId, documentTypeDescription, exemptionNumber, ecmsId, ecmsStatus, pdf, pages", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company to search" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .", "key": "X-Avalara-Client", "value": "Swagger UI; 26.4.0; Custom; 1.0" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/:companyId/vendor-certificates?$include=string&$filter=string&$top=451&$skip=451&$orderBy=string", "host": [ "{{baseUrl}}" ], "path": [ ":companyId", "vendor-certificates" ], "query": [ { "description": "OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:\r\n \r\n * customers - Retrieves the list of vendors linked to the certificate.\r\n * po_numbers - Retrieves all PO numbers tied to the certificate.\r\n * attributes - Retrieves all attributes applied to the certificate.\r\n * histories - Retrieves the certificate update history\r\n * jobs - Retrieves the jobs for this certificate\r\n * logs - Retrieves the certificate log\r\n * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid\r\n * custom_fields - Retrieves custom fields set for this certificate", "key": "$include", "value": "string" }, { "description": "A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
*Not filterable:* documentTypeId, documentTypeDescription, exemptionNumber, ecmsId, ecmsStatus, pdf, pages", "key": "$filter", "value": "string" }, { "description": "If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.", "key": "$top", "value": "451" }, { "description": "If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.", "key": "$skip", "value": "451" }, { "description": "A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.", "key": "$orderBy", "value": "string" } ], "variable": [ { "key": "companyId", "value": "451", "description": "The ID number of the company to search" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] } ] } ] } ], "variable": [ { "key": "baseUrl", "value": "/" } ] }