{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"d6eb89b7-b41a-4051-a9e0-4b8197eeec0d","name":"Active API - Documentation","description":"Here, you'll find a list of all our APIs, their necessary parameters, and example requests and responses, as well as authentication / integration information + more.\n\nKey API Features:\n\n- **Core Functions**: Interact with clients, users, and offices.\n    \n- **Workflow Management**: Handle jobs, deliverables and tasks efficiently.\n    \n- **Workpapers**: Interact with binders, binder sources and other associated data.\n    \n- **Ledger:** Manage Ledger files, datasets and standard financial charts.\n    \n\n### Integration\n\nIf you wish to integrate with our external API, please contact our support team and provide the following information.\n\n1. **Integration Name**: Identify the name of your integration.\n    \n2. **Scopes**: Specify the allowed scopes for this integration, as detailed in the section below.\n    \n3. **Logo URL**: Provide a URL linking to the logo you wish to associate with this integration.\n    \n4. **User Access and Permissions**:\n    \n    - Email of the user to whom access will be granted. This user will act as a “service account”, only service accounts can access and use this API. All other users will return an Unauthorized response. This is required for testing purposes.\n        \n    - Level of permissions for this user (e.g., read-only or read and write).\n        \n5. **Firm Specification**: If the user above is affiliated with multiple firms, please specify the relevant firm name.\n    \n6. **Redirect URLS**: A URL or set of URLS where users will be redirected after successful authentication.\n    \n7. **Post Logout URL**: A URL where users will be redirected to after logging out.\n    \n\n### Service Account\n\nAll users accessing the external API must be designated as service accounts; otherwise, all actions will result in a forbidden response. Service accounts can have either READ or WRITE permissions. These permissions adhere to scope level restrictions. For example, if a user has WRITE permissions at the service account level but only READ permissions at the scope level, they will not be able to perform write operations. Service accounts are subject to firm level security.\n\nOnly users within Business Fitness who have an Owner security role can modify and view service account role permissions. These permissions can be viewed and modified within the admin center of the Active platform when editing a user. Additionally, only users with security roles of Admin or Owner can act as a service account. If a user's security role changes from Admin or Owner to User, their service account permissions will be revoked.\n\nA service account user does not need to be licensed for any product to use the API. However, if your firm does not have an active subscription for the product you are trying to access (e.g., attempting to access Workflow endpoints without an active Workflow subscription), you will receive an HTTP 402 \"Payment Required\" response.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"31711831","team":5840243,"collectionId":"d6eb89b7-b41a-4051-a9e0-4b8197eeec0d","publishedId":"2s9Yynm4V5","public":true,"publicUrl":"https://development.businessfitness.com","privateUrl":"https://go.postman.co/documentation/31711831-d6eb89b7-b41a-4051-a9e0-4b8197eeec0d","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Active by Business Fitness documentation for integration with our APIs. This guide covers detailed instructions to help you use and test our APIs."},{"name":"title","value":"Business Fitness Active API - Documentation"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2024-08-30T04:50:09.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Business Fitness Active API - Documentation","description":"Active by Business Fitness documentation for integration with our APIs. This guide covers detailed instructions to help you use and test our APIs."},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Production - Active API Environment Template","id":"c848bc5c-ad07-494e-8dfa-ba75849e45ea","owner":"31904214","values":[{"key":"client_id","value":"","enabled":true,"type":"secret"},{"key":"scopes","value":"x-api core.read workflow.read workpapers.read","enabled":true,"type":"default"},{"key":"callback_url","value":"https://your-callback-url.com","enabled":true,"type":"default"},{"key":"auth_url","value":"https://identity.businessfitness.com.au/connect/authorize","enabled":true,"type":"default"},{"key":"access_token_url","value":"https://identity.businessfitness.com.au/connect/token","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/b33433e813aa0b9f2816bfd118a6ebd10242766c7620a6d5f81736b10d3f71eb","favicon":"https://res.cloudinary.com/postman/image/upload/v1703027835/team/fivg1by4mkdla00cuuz7.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Production - Active API Environment Template","value":"31904214-c848bc5c-ad07-494e-8dfa-ba75849e45ea"}],"canonicalUrl":"https://development.businessfitness.com/view/metadata/2s9Yynm4V5"}