Scopes are used to limit a token's access to Pennylane data.
Required scopes per endpoint
Here's our mapping of API endpoints and their required scopes:
| Scopes | Endpoints |
|---|---|
| categories:readonly | List categories of a category group List categories Retrieve a category List category groups Retrieve a category group |
| companies:readonly | List companies Show companies |
| fiscal_years:readonly | List company's Fiscal Years |
| fiscal_years:all | Create a fiscal year List Company's Fiscal Years |
| trial_balance:readonly | Get the trial balance of a company |
| exports:agl | Create an analytical general ledger export Retrieve an analytical general ledger export |
| exports:fec | Create a FEC export Retrieve a FEC export |
| dms_files:readonly | List Company's DMS Files List Company's DMS Folders Get DMS files changes events |
| dms_files:all | List Company's DMS Files Upload a file to DMS List Company's DMS Folders Create a DMS folder Get DMS files changes events |
| journals:readonly | List journals Retrieve a journal |
| journals:all | Create a journal List journals Retrieve a journal |
| ledger_accounts:readonly | List ledger accounts Get a ledger account |
| ledger_accounts:all | Create a ledger account Update a ledger account List ledger accounts Get a ledger account |
| ledger_entries:readonly | List Ledger Entries Retrieve a Ledger entry List ledger entry lines Retrieve a Ledger entry line List ledger entry lines lettered to a given ledger entry line Get ledger entry line change events |
| ledger_entries:all | Create a ledger entry Update a ledger entry List Ledger Entries Retrieve a Ledger entry List ledger entry lines Retrieve a Ledger entry line List ledger entry lines lettered to a given ledger entry line Get ledger entry line change events |
| bank_accounts:readonly | List bank accounts |
| bank_accounts:all | Create a bank account List bank accounts |
| customers:readonly | List customers |
| suppliers:readonly | List suppliers |
| file_attachments:all | Upload a file |
| transactions:readonly | List transactions |
| transactions:all | Create a transaction Update a transaction List transactions |