{ "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