{ "opencollection": "1.0.0", "info": { "name": "Avalara AvaTax FirmClientLinkages API", "version": "1.0.0" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "FirmClientLinkages", "type": "folder" }, "items": [ { "info": { "name": "Avalara ApproveFirmClientLinkage", "type": "http" }, "http": { "method": "POST", "url": "http://{{baseurl}}/api/v2/firmclientlinkages/:id/approve", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API enables the account admin of a client account to approve linkage request by a firm.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n" }, { "info": { "name": "Avalara CreateAndLinkNewFirmClientAccount", "type": "http" }, "http": { "method": "POST", "url": "http://{{baseurl}}/api/v2/firmclientlinkages/createandlinkclient", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API is for use by Firms only.\n \nAvalara allows firms to manage returns for clients without the clients needing to use AvaTax service.\nFirms can create accounts of FirmClient for customers they are managing using this API.\n \nCalling this API creates an account with the specified product subscriptions, but without a new user for account.\nAccount is then linked to the Firm so they can managed their returns.\nYou should call this API when a customer does not have an AvaTax " }, { "info": { "name": "Avalara ListFirmClientLinkage", "type": "http" }, "http": { "method": "GET", "url": "http://{{baseurl}}/api/v2/firmclientlinkages", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ] }, "docs": "This API enables the firm or account users to request the associated linkages to the account.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.\n" }, { "info": { "name": "Avalara CreateFirmClientLinkage", "type": "http" }, "http": { "method": "POST", "url": "http://{{baseurl}}/api/v2/firmclientlinkages", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API enables the firm admins/firm users to request the linkage of a firm account and a client account.\n\n### Security Policies\n\n* This API requires one of the following user roles: BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n" }, { "info": { "name": "Avalara GetFirmClientLinkage", "type": "http" }, "http": { "method": "GET", "url": "http://{{baseurl}}/api/v2/firmclientlinkages/:id", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "This API enables the firm admins/firm users to request the linkage of a firm account and a client account.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryU" }, { "info": { "name": "Avalara DeleteFirmClientLinkage", "type": "http" }, "http": { "method": "DELETE", "url": "http://{{baseurl}}/api/v2/firmclientlinkages/:id", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "This API marks a linkage between a firm and client as deleted.\n\n### Security Policies\n\n* This API requires one of the following user roles: BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n" }, { "info": { "name": "Avalara RejectFirmClientLinkage", "type": "http" }, "http": { "method": "POST", "url": "http://{{baseurl}}/api/v2/firmclientlinkages/:id/reject", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API enables the account admin of a client account to reject linkage request by a firm.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n" }, { "info": { "name": "Avalara ResetFirmClientLinkage", "type": "http" }, "http": { "method": "POST", "url": "http://{{baseurl}}/api/v2/firmclientlinkages/:id/reset", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API enables the firm admin of a client account to reset a previously created linkage request by a firm.\n\n### Security Policies\n\n* This API requires one of the following user roles: BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n" }, { "info": { "name": "Avalara RevokeFirmClientLinkage", "type": "http" }, "http": { "method": "POST", "url": "http://{{baseurl}}/api/v2/firmclientlinkages/:id/revoke", "headers": [ { "name": "X-Avalara-Client", "value": "AvaTax Postman Collection" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API enables the account admin of a client account to revoke a previously approved linkage request by a firm.\n\n### Security Policies\n\n* This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.\n" } ] } ], "bundled": true }