Pledger.io documentation
GitHub
4.3.1
2025-04-20

Profile import

This process is responsible for importing user profiles exported from other installations into the running Pledger.io.

Required variables

The import process requires the following variables to be set when starting:

  • storageToken, the file token that was returned after a file upload to Pledger.io. The uploaded file must adhere to the user profile JSON schema.

The profile JSON file

The import is JSON based and adheres to the user profile JSON schema. This schema can contain any of the following:

  • Accounts, as described in the linked JSON schema.

  • Categories, as described in the linked JSON schema.

  • Contacts, as described in the linked JSON schema.

  • Transaction rules, as described in the linked JSON schema.

  • Budgets, as described in the linked JSON schema.

  • Transaction tags, as described a list of strings.

  • Transactions, as described in the linked JSON schema.

The business process model

The process for importing a profile is split in:

  • The main process that imports accounts, budgets, categories, tags and transactions.

  • A dedicated sub-process to import the transaction rules.

Note

The process will first import the core entities (accounts, categories, budgets and tags) followed by the contracts and any transaction rules. This is due to the fact that both contracts and transaction rules can reference the core entities.

Main import process

profile import
Figure 1. Main import process

Transaction rule sub-process

transaction rule import
Figure 2. Sub-process for transaction rules
2025-04-24