Deprecated

Deprecation of ledger scope replaced by granular scope

The ledger OAuth scope has been deprecated across all ledger-related API endpoints. We have introduced more granular scopes that provide better control over API access permissions.

New Scopes

Three new scope families have been introduced to replace the deprecated ledger scope:

  • For journal operations: journals:readonly / journals:all
  • For ledger account operations: ledger_accounts:readonly / ledger_accounts:all
  • For ledger entries and ledger entry lines operations: ledger_entries:readonly / ledger_entries:all

Affected Endpoints

Journals

  • GET /api/external/v2/journals
    • Deprecated scope: ledger
    • New scopes: journals:readonlyjournals:all
  • POST /api/external/v2/journals
    • Deprecated scope: ledger
    • New scope: journals:all
  • GET /api/external/v2/journals/{id}
    • Deprecated scope: ledger
    • New scopes: journals:readonlyjournals:all

Ledger Accounts

  • GET /api/external/v2/ledger_accounts
    • Deprecated scope: ledger
    • New scopes: ledger_accounts:readonlyledger_accounts:all
  • POST /api/external/v2/ledger_accounts
    • Deprecated scope: ledger
    • New scope: ledger_accounts:all
  • GET /api/external/v2/ledger_accounts/{id}
    • Deprecated scope: ledger
    • New scopes: ledger_accounts:readonlyledger_accounts:all

Ledger Entries

  • GET /api/external/v2/ledger_entries
    • Deprecated scope: ledger
    • New scopes: ledger_entries:readonlyledger_entries:all
  • POST /api/external/v2/ledger_entries
    • Deprecated scope: ledger
    • New scope: ledger_entries:all
  • GET /api/external/v2/ledger_entries/{id}
    • Deprecated scope: ledger
    • New scopes: ledger_entries:readonlyledger_entries:all
  • PUT /api/external/v2/ledger_entries/{id}
    • Deprecated scope: ledger
    • New scope: ledger_entries:all
  • GET /api/external/v2/ledger_entries/{ledger_entry_id}/ledger_entry_lines
    • Deprecated scope: ledger
    • New scopes: ledger_entries:readonlyledger_entries:all

Ledger Entry Lines

  • GET /api/external/v2/ledger_entry_lines
    • Deprecated scope: ledger
    • New scopes: ledger_entries:readonlyledger_entries:all
  • GET /api/external/v2/ledger_entry_lines/{id}
    • Deprecated scope: ledger
    • New scopes: ledger_entries:readonlyledger_entries:all
  • POST /api/external/v2/ledger_entry_lines/letter
    • Deprecated scope: ledger
    • New scope: ledger_entries:all
  • DELETE /api/external/v2/ledger_entry_lines/unletter
    • Deprecated scope: ledger
    • New scope: ledger_entries:all
  • GET /api/external/v2/ledger_entry_lines/{id}/lettered_ledger_entry_lines
    • Deprecated scope: ledger
    • New scopes: ledger_entries:readonlyledger_entries:all
  • GET /api/external/v2/ledger_entry_lines/{ledger_entry_line_id}/categories
    • Deprecated scope: ledger
    • New scopes: ledger_entries:readonlyledger_entries:all
  • PUT /api/external/v2/ledger_entry_lines/{ledger_entry_line_id}/categories
    • Deprecated scope: ledger
    • New scope: ledger_entries:all