API Reference

Scopes

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

companies:readonly

List companies
Show companies

fiscal_years:readonly

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 DMS files
List DMS files changelog events

journals:readonly

List journals
Retrieve a journal

ledger_accounts:readonly

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