A brief overview of the Accounton data model which allows you to better navigate the REST API
The Accounton Backoffice
The Accounton backoffice serves as the exclusive environment for a specific Accountancy firm on Accounton. Your API credential key pair provides access to your particular Accounton backoffice, allowing you to perform a variety of actions such as retrieving information about users, customers, personal income tax, generated documents, and more.
Users
The user objects represent the user accounts that have login privileges to the Accounton backoffice. These accounts include both administrators and regular users who are authorized to perform various actions on resources.
Customers
The customer objects are the clients of the accountant who are present in the Accounton backoffice. These customer objects contain specific information about the customer and represent the customer file.
Financial Years
A financial year in Accounton is a specific object that denotes the beginning and end of a financial year. There is always one (and only one) financial year currently activated. The unactivated financial years are used for historic purposes. If you wish to retrieve objects such as transcripts, you may optionally specify the financial year ID that is currently active to retrieve the current transcripts along with your customer information regarding personal income tax.
Checklists
The checklist objects are the checklists that are active in the Accounton backoffice and are sent to the customers. When a specific customer answers a specific checklist, a transcript object is created. It is worth noting that the transcript object is essentially a filled-in checklist.
Transcripts
The transcript object represents a filled-in version of a checklist. When an accountant assigns a checklist to a customer, a transcript object is created. As a customer starts filling in the checklist, the information will be stored in the transcript object. The REST API provides various query parameters to filter transcript objects. This makes it easy to retrieve transcripts for a specific financialYear, customer, or checklist. Additionally, a checklist has a progressPercentage and status property which tracks the progress and state of a certain checklist.
Furthermore, once the first bit of information is provided by the customer, a document is generated containing the information related to the filled-in checklist. The API provides endpoints to (1) download this file and (2) retrieve metadata about that file. This allows you to synchronize these documents with your specific Document Management System.