{ "opencollection": "1.0.0", "info": { "name": "Avalara Customers API", "version": "1.0" }, "items": [ { "info": { "name": "Customers", "type": "folder" }, "items": [ { "info": { "name": "Avalara List Customers for a Company", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/companies/:companyId/customers", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The numeric ID of the company" }, { "name": "$filter", "value": "", "type": "query", "description": "OData filter expression for result filtering" }, { "name": "$top", "value": "", "type": "query", "description": "Maximum number of results to return" }, { "name": "$skip", "value": "", "type": "query", "description": "Number of results to skip for pagination" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Avalara List Customers for a Company" }, { "info": { "name": "Avalara Create a New Customer", "type": "http" }, "http": { "method": "POST", "url": "https://rest.avatax.com/api/v2/companies/:companyId/customers", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "The numeric ID of the company" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Avalara Create a New Customer" }, { "info": { "name": "Avalara List Customers", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/customers", "params": [ { "name": "page", "value": "", "type": "query" }, { "name": "pageSize", "value": "", "type": "query" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Avalara List Customers" }, { "info": { "name": "Avalara Create a Customer", "type": "http" }, "http": { "method": "POST", "url": "https://rest.avatax.com/customers", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Avalara Create a Customer" }, { "info": { "name": "Avalara Get a Customer by ID", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/customers/:customerId", "params": [ { "name": "customerId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Avalara Get a Customer by ID" }, { "info": { "name": "Avalara Update a Customer", "type": "http" }, "http": { "method": "PUT", "url": "https://rest.avatax.com/customers/:customerId", "params": [ { "name": "customerId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Avalara Update a Customer" }, { "info": { "name": "Avalara List Certificates for a Customer", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/customers/:customerId/certificates", "params": [ { "name": "customerId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Avalara List Certificates for a Customer" }, { "info": { "name": "Avalara GetCustomer", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/companies/:companyId/customers/:customerCode", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "customerCode", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieve the customer identified by this URL.\n \nA customer object defines information about a person or business that purchases products from your\ncompany. When you create a tax transaction in AvaTax, you can use the `customerCode` from this\nrecord in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and\nidentify any certificates linked to this customer object. If any certificate applies to the transaction,\nAvaTax will record the appropriate elemen" }, { "info": { "name": "Avalara UpdateCustomer", "type": "http" }, "http": { "method": "PUT", "url": "https://rest.avatax.com/api/v2/companies/:companyId/customers/:customerCode", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "customerCode", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Replace the customer object at this URL with a new record.\n \nA customer object defines information about a person or business that purchases products from your\ncompany. When you create a tax transaction in AvaTax, you can use the `customerCode` from this\nrecord in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and\nidentify any certificates linked to this `customer` object. If any certificate applies to the transaction,\nAvaTax will record the app" }, { "info": { "name": "Avalara DeleteCustomer", "type": "http" }, "http": { "method": "DELETE", "url": "https://rest.avatax.com/api/v2/companies/:companyId/customers/:customerCode", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "customerCode", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Deletes the customer object referenced by this URL.\n \nA customer object defines information about a person or business that purchases products from your\ncompany. When you create a tax transaction in AvaTax, you can use the `customerCode` from this\nrecord in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and\nidentify any certificates linked to this `customer` object. If any certificate applies to the transaction,\nAvaTax will record the appropriat" }, { "info": { "name": "Avalara LinkAttributesToCustomer", "type": "http" }, "http": { "method": "PUT", "url": "https://rest.avatax.com/api/v2/companies/:companyId/customers/:customerCode/attributes/link", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "customerCode", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Link one or many attributes to a customer.\n \nA customer may have multiple attributes that control its behavior. You may link or unlink attributes to a\ncustomer at any time. The full list of defined attributes may be found using `QueryCompanyCustomerAttributes` API.\n \nA customer object defines information about a person or business that purchases products from your\ncompany. When you create a tax transaction in AvaTax, you can use the `customerCode` from this\nrecord in you" }, { "info": { "name": "Avalara LinkCertificatesToCustomer", "type": "http" }, "http": { "method": "POST", "url": "https://rest.avatax.com/api/v2/companies/:companyId/customers/:customerCode/certificates/link", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "customerCode", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Link one or more certificates to a customer.\n \nA customer object defines information about a person or business that purchases products from your\ncompany. When you create a tax transaction in AvaTax, you can use the `customerCode` from this\nrecord in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and\nidentify any certificates linked to this `customer` object. If any certificate applies to the transaction,\nAvaTax will record the appropriate eleme" }, { "info": { "name": "Avalara LinkShipToCustomersToBillCustomer", "type": "http" }, "http": { "method": "POST", "url": "https://rest.avatax.com/api/v2/companies/:companyId/customers/billto/:code/shipto/link", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "code", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Links a Ship-To customer record with a Bill-To customer record.\n \nCustomer records represent businesses or individuals who can provide exemption certificates. Some customers\nmay have certificates that are linked to their shipping address or their billing address. To group these\ncustomer records together, you may link multiple bill-to and ship-to addresses together to represent a single\nentity that has multiple different addresses of different kinds.\n \nIn general, a custom" }, { "info": { "name": "Avalara ListAttributesForCustomer", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/companies/:companyId/customers/:customerCode/attributes", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "customerCode", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieve the attributes linked to the customer identified by this URL.\n \nA customer may have multiple attributes that control its behavior. You may link or unlink attributes to a\ncustomer at any time. The full list of defined attributes may be found using `QueryCompanyCustomerAttributes` API.\n \nA customer object defines information about a person or business that purchases products from your\ncompany. When you create a tax transaction in AvaTax, you can use the `customerC" }, { "info": { "name": "Avalara ListCertificatesForCustomer", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/companies/:companyId/customers/:customerCode/certificates", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "customerCode", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "List all certificates linked to a customer.\n \nA customer object defines information about a person or business that purchases products from your\ncompany. When you create a tax transaction in AvaTax, you can use the `customerCode` from this\nrecord in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and\nidentify any certificates linked to this `customer` object. If any certificate applies to the transaction,\nAvaTax will record the appropriate elemen" }, { "info": { "name": "Avalara ListValidCertificatesForCustomer", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/companies/:companyId/customers/:customerCode/certificates/:country/:region", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "customerCode", "value": "", "type": "path" }, { "name": "country", "value": "", "type": "path" }, { "name": "region", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "List valid certificates linked to a customer in a particular country and region.\n \nThis API is intended to help identify whether a customer has already provided a certificate that\napplies to a particular country and region. This API is intended to help you remind a customer\nwhen they have or have not provided copies of their exemption certificates to you during the sales\norder process.\n \nIf a customer does not have a certificate on file and they wish to provide one, you sh" }, { "info": { "name": "Avalara UnlinkAttributesFromCustomer", "type": "http" }, "http": { "method": "PUT", "url": "https://rest.avatax.com/api/v2/companies/:companyId/customers/:customerCode/attributes/unlink", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "customerCode", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Unlink one or many attributes from a customer.\n \nA customer may have multiple attributes that control its behavior. You may link or unlink attributes to a\ncustomer at any time. The full list of defined attributes may be found using `QueryCompanyCustomerAttributes` API.\n \nA customer object defines information about a person or business that purchases products from your\ncompany. When you create a tax transaction in AvaTax, you can use the `customerCode` from this\nrecord in" }, { "info": { "name": "Avalara UnlinkCertificatesFromCustomer", "type": "http" }, "http": { "method": "POST", "url": "https://rest.avatax.com/api/v2/companies/:companyId/customers/:customerCode/certificates/unlink", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "customerCode", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Remove one or more certificates to a customer.\n \nA customer object defines information about a person or business that purchases products from your\ncompany. When you create a tax transaction in AvaTax, you can use the `customerCode` from this\nrecord in your `CreateTransaction` API call. AvaTax will search for this `customerCode` value and\nidentify any certificates linked to this `customer` object. If any certificate applies to the transaction,\nAvaTax will record the appropriate ele" } ] } ], "bundled": true }