{ "opencollection": "1.0.0", "info": { "name": "Avalara Certificates API", "version": "1.0" }, "items": [ { "info": { "name": "Certificates", "type": "folder" }, "items": [ { "info": { "name": "Avalara List Certificates for a Company", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/companies/:companyId/certificates", "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": "Retrieves exemption certificates associated with the specified company." }, { "info": { "name": "Avalara Create a New Certificate", "type": "http" }, "http": { "method": "POST", "url": "https://rest.avatax.com/api/v2/companies/:companyId/certificates", "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 Certificate" }, { "info": { "name": "Avalara List Certificates", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/certificates", "params": [ { "name": "status", "value": "", "type": "query" }, { "name": "customerId", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "pageSize", "value": "", "type": "query" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieves a filtered list of exemption certificates." }, { "info": { "name": "Avalara Create a Certificate", "type": "http" }, "http": { "method": "POST", "url": "https://rest.avatax.com/certificates", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Creates a new exemption certificate record." }, { "info": { "name": "Avalara Get a Certificate", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/certificates/:certificateId", "params": [ { "name": "certificateId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieves a single certificate by its ID." }, { "info": { "name": "Avalara Update a Certificate", "type": "http" }, "http": { "method": "PUT", "url": "https://rest.avatax.com/certificates/:certificateId", "params": [ { "name": "certificateId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Avalara Update a Certificate" }, { "info": { "name": "Avalara Delete a Certificate", "type": "http" }, "http": { "method": "DELETE", "url": "https://rest.avatax.com/certificates/:certificateId", "params": [ { "name": "certificateId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Avalara Delete a Certificate" }, { "info": { "name": "Avalara Download Certificate Attachment", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/certificates/:certificateId/attachment", "params": [ { "name": "certificateId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Downloads the PDF or image attachment for a certificate." }, { "info": { "name": "Avalara Upload Certificate Attachment", "type": "http" }, "http": { "method": "POST", "url": "https://rest.avatax.com/certificates/:certificateId/attachment", "params": [ { "name": "certificateId", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Avalara Upload Certificate Attachment" }, { "info": { "name": "Avalara GetCertificate", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/companies/:companyId/certificates/:id", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get the current certificate identified by this URL.\n \nA certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document\ncan contain information about a customer's eligibility for exemption from sales or use taxes based on\ncriteria you specify when you store the certificate. To view or manage your certificates directly, please\nlog onto the administrative website for the product you purchased.\n \nYou can use the `$include` parameter to f" }, { "info": { "name": "Avalara UpdateCertificate", "type": "http" }, "http": { "method": "PUT", "url": "https://rest.avatax.com/api/v2/companies/:companyId/certificates/:id", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Replace the certificate identified by this URL with a new one.\n \nA certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document\ncan contain information about a customer's eligibility for exemption from sales or use taxes based on\ncriteria you specify when you store the certificate. To view or manage your certificates directly, please\nlog onto the administrative website for the product you purchased.\n \nBefore you can use any exempti" }, { "info": { "name": "Avalara DeleteCertificate", "type": "http" }, "http": { "method": "DELETE", "url": "https://rest.avatax.com/api/v2/companies/:companyId/certificates/:id", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Revoke the certificate identified by this URL, then delete it.\n \nA certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document\ncan contain information about a customer's eligibility for exemption from sales or use taxes based on\ncriteria you specify when you store the certificate. To view or manage your certificates directly, please\nlog onto the administrative website for the product you purchased.\n \nRevoked certificates can no lo" }, { "info": { "name": "Avalara DownloadCertificateImage", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/companies/:companyId/certificates/:id/attachment", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Download an image or PDF file for this certificate.\n \nThis API can be used to download either a single-page preview of the certificate or a full PDF document.\nTo retrieve a preview image, set the `$type` parameter to `Jpeg` and the `$page` parameter to `1`.\n \nA certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document\ncan contain information about a customer's eligibility for exemption from sales or use taxes based on\ncriteria yo" }, { "info": { "name": "Avalara UploadCertificateImage", "type": "http" }, "http": { "method": "POST", "url": "https://rest.avatax.com/api/v2/companies/:companyId/certificates/:id/attachment", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Upload an image or PDF attachment for this certificate.\n \nImage attachments can be of the format `PDF`, `JPEG`, `TIFF`, or `PNG`. To upload a multi-page image, please\nuse the `PDF` data type.\n \nA certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document\ncan contain information about a customer's eligibility for exemption from sales or use taxes based on\ncriteria you specify when you store the certificate. To view or manage your" }, { "info": { "name": "Avalara GetCertificateSetup", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/companies/:companyId/certificates/setup", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Checks whether this company is configured to use exemption certificates in AvaTax.\n \nExemption certificates are tracked through a different auditable data store than the one that\nholds AvaTax transactions. To use the AvaTax exemption certificate document store, please call\n`GetCertificateSetup` to see if your company is configured to use the exemption certificate\ndocument store. To request setup, please call `RequestCertificateSetup` and your company will\nbe configured with data sto" }, { "info": { "name": "Avalara RequestCertificateSetup", "type": "http" }, "http": { "method": "POST", "url": "https://rest.avatax.com/api/v2/companies/:companyId/certificates/setup", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Requests the setup of exemption certificates for this company.\n \nExemption certificates are tracked through a different auditable data store than the one that\nholds AvaTax transactions. To use the AvaTax exemption certificate document store, please call\n`GetCertificateSetup` to see if your company is configured to use the exemption certificate\ndocument store. To request setup, please call `RequestCertificateSetup` and your company will\nbe configured with data storage in the auditabl" }, { "info": { "name": "Avalara LinkAttributesToCertificate", "type": "http" }, "http": { "method": "POST", "url": "https://rest.avatax.com/api/v2/companies/:companyId/certificates/:id/attributes/link", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Link one or many attributes to a certificate.\n \nA certificate may have multiple attributes that control its behavior. You may link or unlink attributes to a\ncertificate at any time. The full list of defined attributes may be found using `ListCertificateAttributes`.\n \nA certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document\ncan contain information about a customer's eligibility for exemption from sales or use taxes based on\nc" }, { "info": { "name": "Avalara LinkCustomersToCertificate", "type": "http" }, "http": { "method": "POST", "url": "https://rest.avatax.com/api/v2/companies/:companyId/certificates/:id/customers/link", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Link one or more customers to an existing certificate.\n \nCustomers and certificates must be linked before a customer can make use of a certificate to obtain\na tax exemption in AvaTax. Since some certificates may cover more than one business entity, a certificate\ncan be connected to multiple customer records using the `LinkCustomersToCertificate` API.\n \nA certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document\ncan contain infor" }, { "info": { "name": "Avalara ListAttributesForCertificate", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/companies/:companyId/certificates/:id/attributes", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieve the list of attributes that are linked to this certificate.\n \nA certificate may have multiple attributes that control its behavior. You may link or unlink attributes to a\ncertificate at any time. The full list of defined attributes may be found using [ListCertificateAttributes](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListCertificateAttributes/) API.\n \nA certificate is a document stored in either AvaTax Exemptions or CertCapt" }, { "info": { "name": "Avalara ListCustomersForCertificate", "type": "http" }, "http": { "method": "GET", "url": "https://rest.avatax.com/api/v2/companies/:companyId/certificates/:id/customers", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "List all customers linked to this certificate.\n \nCustomers must be linked to a certificate in order to make use of its tax exemption features. You\ncan link or unlink customers to a certificate at any time.\n \nA certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document\ncan contain information about a customer's eligibility for exemption from sales or use taxes based on\ncriteria you specify when you store the certificate. To view " }, { "info": { "name": "Avalara UnlinkAttributesFromCertificate", "type": "http" }, "http": { "method": "POST", "url": "https://rest.avatax.com/api/v2/companies/:companyId/certificates/:id/attributes/unlink", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Unlink one or many attributes from a certificate.\n \nA certificate may have multiple attributes that control its behavior. You may link or unlink attributes to a\ncertificate at any time. The full list of defined attributes may be found using `ListCertificateAttributes`.\n \nA certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document\ncan contain information about a customer's eligibility for exemption from sales or use taxes based " }, { "info": { "name": "Avalara UnlinkCustomersFromCertificate", "type": "http" }, "http": { "method": "POST", "url": "https://rest.avatax.com/api/v2/companies/:companyId/certificates/:id/customers/unlink", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "companyId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Unlinks one or more customers from a certificate.\n \nUnlinking a certificate from a customer will prevent the certificate from being used to generate\ntax exemptions for the customer in the future. If any previous transactions for this customer had\nused this linked certificate, those transactions will be unchanged and will still have a link to the\nexemption certificate in question.\n \nA certificate is a document stored in either AvaTax Exemptions or CertCapture. The certific" } ] } ], "bundled": true }