FOformancehq
Accounts

Analyze accounts and suggest a Chart of Accounts

Changed on

Scans all accounts in a ledger, discovers address patterns, and returns a suggested Chart of Accounts. Useful after a mirror import to understand account structure. Requires ledger:read scope.

get/v3/{ledgerName}/analyze-accounts

Request

  • Base URL
    http://localhost:9000
  • URL
    http://localhost:9000/v3/{ledgerName}/analyze-accounts
  • Auth
    • HTTP bearer
    • or none

Path parameters

ledgerNamestring required

Name of the ledger

Query parameters

variableThresholdinteger

Max distinct children before classifying as variable (0 = default 10)

Headers

X-Consistency'linearizable' | 'stale'

Read consistency. linearizable (the default) runs a Raft ReadIndex barrier and waits for the receiving node to apply up to it. stale serves the read from the receiving node's own store, with no barrier and no forwarding to the leader, so the answer may lag the leader. Matching ignores case and surrounding whitespace. An unknown value, or a repeated or comma-joined header, returns 400 INVALID_REQUEST on every /v3 route, writes included; a valid value has no effect on writes. The gRPC equivalent is the x-consistency request metadata.

Response

Analysis completed successfully

Changes

  • f5e817eca038Revision changes
    • info

      api operation id analyzeAccounts removed and replaced with v3AnalyzeAccounts

  • 3da23d327316Revision changes
    • info

      added the media type text/plain for the response with the status

    • info

      added the media type text/plain for the response with the status