AccountingPlanMaster

HTTP	Operation	Type	Object
POST	Read	⚙️ ActionThe action resource represents a type of object that differs from standard queries or mutations. For a query, it returns a result already prepared by Sage Active, with no possibility to add filters, sorts, or explore the data further, or it executes an action (e.g., sending an email). For a mutation, it executes a specific business action, also carried out by Sage Active, which will impact the data (e.g., generating a credit note from an invoice). (Query)	`accountingPlansMasterById`
POST	Create	⚙️ ActionThe action resource represents a type of object that differs from standard queries or mutations. For a query, it returns a result already prepared by Sage Active, with no possibility to add filters, sorts, or explore the data further, or it executes an action (e.g., sending an email). For a mutation, it executes a specific business action, also carried out by Sage Active, which will impact the data (e.g., generating a credit note from an invoice). (Mutation)	`ImportAccountingPlanMaster`

Description

The accountingPlanMaster resource represents the standard templates of accounting plans delivered within the system. These templates are specific to the legislations of FR (France), ES (Spain), or DE (Germany), reflecting the reference accounting plan models for each jurisdiction.

These models are distinct from the accountingaccount resource, and if a model is not imported, its associated accounts will not be available within the organization.

The primary purpose of this resource is to retrieve the template of an accounting plan to identify the standard accounting plans used in Sage Active and also to allow the importation of a template into an empty accounting plan.
It facilitates aligning the accounting practices with the legal standards of the respective country, ensuring accuracy and compliance but does not have any other utility within the system.

Key	Value
`Authorization`	Bearer Current access Token How to find?
`X-TenantId`	Current tenant id How to find?
`X-OrganizationId`	Current organization Id How to find?
`x-api-key`	Primary or secondary subscription key of your app How to find?

Tips and Tricks

Pagination is typically required for queries that return multiple records.
However, for the accountingPlansMasterById query, pagination is not necessary as this query returns all accounts from the template without the need to manage pagination.

accountingPlansMasterById

Fields	Type	Description
idSSystem field that cannot be assigned RThis field is read-only, its value cannot be assigned	UUID	Predefined template ID See InfoAdditional information is available in the Info block below

description RThis field is read-only, its value cannot be assigned	String	Template Name
accountingPlanMasterLines[] RThis field is read-only, its value cannot be assigned	Array	List of accounting accounts from the template

Info

Id General chart of accounts

Id General chart of accounts for SMEs

accountingPlansMasterById/accountingPlanMasterLines

Fields	Type	Description
idSSystem field that cannot be assigned RThis field is read-only, its value cannot be assigned	UUID	Id

code RThis field is read-only, its value cannot be assigned	String	Code
name RThis field is read-only, its value cannot be assigned	String	Name
accountLevel RThis field is read-only, its value cannot be assigned	UNDEFINED GROUP SUB_GROUP ACCOUNT BREAKDOWN SUB_ACCOUNT TOTAL	Level See InfoAdditional information is available in the Info block below
subAccountType RThis field is read-only, its value cannot be assigned	UNDEFINED CUSTOMER PROVIDER BANK CASH CHARGE REVENUE CAPITAL FIXED_ASSET MANAGEMENT_RESULT DEPRECIATION_PROVISION STOCK RESULT_BALANCE_ SHEET EMPLOYEE TITLE CURRENT_ASSETS BORROWED_CAPITAL COST REDUCTION_IN_EXPENSES NEUTRAL_REVENUE NEUTRAL_EXPENSES SALES_DEDUCTION EXCHANGE_RATE_INCOME EXCHANGE_RATE_EXPENSE BALANCE_CARRIED_FORWARD AGGREGATE_CARRIED_FORWARD OTHER_BALANCE_SHEET_ACCOUNT STATISTICAL_BALANCE STATISTICAL_CONSUMPTION SUPPLIER_RETURNABLE_PACKAGING CUSTOMER_RETURNABLE_PACKAGING CUSTOMER_PREPAYMENT_TAX_INCLUDED SUPPLIER_PREPAYMENT_TAX_INCLUDED INPUT_TAX OUTPUT_TAX	Nature of account
accountType RThis field is read-only, its value cannot be assigned	UNDEFINED BALANCE_SHEET INCOME_STATEMENT SPECIAL ECPN STATISTICAL	Category See InfoAdditional information is available in the Info block below

Info

accountLevel:
- Group: Unused (For Spain only).
- Subgroup: Unused (For Spain only).
- Account: Unused (For Spain only).
- Breakdown: Unused (For Spain only).
- Subaccount: Accounting account of Detail. Is composed for minimum 6 or more digits. Subaccount can be used only to generate accounting entries.
- Total: Used for the balance guides.
- Group: Unused (For Spain only).
- Subgroup: Unused (For Spain only).
- Account: Unused (For Spain only).
- Breakdown: Unused (For Spain only).
- Subaccount: Accounting account of Detail. Is composed for minimum 6 or more digits. Subaccount can be used only to generate accounting entries.
- Total: Unused (For France only).
- Group: Accounting account of Total. Only 1 digit is allowed. Represents an element of the organization’s financial statement
- Subgroup: Accounting account of Total. Is composed of 2 digits. It’s a division of the financial statement element.
- Account: Accounting account of Total. Is composed of 3 digits. These are the accounts defined according to each country’s chart of accounts.
- Breakdown: Accounting account of Total. Is composed of 4 digits. It’s a division of the Account.
- Subaccount: Accounting account of Detail. Is composed for minimum 5 or more digits. Subaccount can be used only to generate accounting entries.
- Total: Unused (For France only).
subAccountType : only used for 5-Subaccount level.
accountType:
- Balance sheet: account classes 1 to 5
- Income statement : account classes 6 and 7
- Special : account classes 8 and 9
- ECPN : Unused (For Spain only).
- Balance sheet: account classes 1 to 5
- Income statement : account classes 6 and 7
- Special :Unused (For France only).
- ECPN : Unused (For Spain only).
- Balance sheet: account classes 1 to 5
- Income statement : account classes 6 and 7
- Special :Unused (For France only).
- ECPN : Financial statements in net worth

ImportAccountingPlanMaster

Fields	Type	Description
accountingPlanMasterId SSystem field that cannot be assigned	UUID	Id

subAccountLength *The value of the field or object is mandatory	Int	Code

Description

Header

Tips and Tricks

accountingPlansMasterById

Info

accountingPlansMasterById/accountingPlanMasterLines

Info

ImportAccountingPlanMaster

Informations