Skip to main content

​
Definition

A folder represents a single legal entity within an accounting system. It is the top-level container for all accounting data of a specific business: its chart of accounts, journals, book years, and transactions.

​
Purpose

  • Provides the highest level of data segregation: each folder is fully isolated.
  • Lets you manage several companies or business units through a single connection, with multi-folder support.

​
Structure

Each folder has:
  • An identifier (id) and a name (name)
  • A selected flag (selected): true if the folder was selected during activation. Requests to a folder that was not selected are rejected
  • An active flag (active): false if the folder is inactive in the accounting software. Requests to an inactive folder fail
  • The VAT number (vat) and the company number (company_number) of the entity
  • The main currency (main_currency)
  • The addresses of the entity (addresses)

​
Relationships

  • A folder contains one or more book years.
  • All accounting data belongs to a folder: ledger accounts, journals, partners, invoices, journal entries and the other objects.
  • Requests take an optional folder_id query parameter. It is required in multi-folder mode. If only one folder is selected, it is used by default. See Multi-folder support.
  • Map each folder_id to the matching legal entity in your system. When an end-user selects a company in your product, use its folder_id in your requests.
  • Each folder is fully isolated. Do not merge data between folders or assume they share a context.

​
API endpoints