Ledger accounts are the categories in your bookkeeping, like revenue, costs, assets, and liabilities.
Returns information about a ledger account
Returns information about a ledger account.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
id
string | integer · pattern:^\d+$
· requiredA unique record identifier
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
A ledger account
id
string | integer · pattern:^\d+$
A unique record identifier
administration_id
string | integer · pattern:^\d+$
A unique record identifier of an administration
name
stringaccount_type
string · enumEnum values:non_current_assetscurrent_assetsequitynon_current_liabilitiescurrent_liabilitiesrevenuedirect_costsexpensesaccount_id
string | nullparent_id
string | integer | null · pattern:^\d+$
A unique record identifier
created_at
string · date-timeupdated_at
string · date-timeallowed_document_types
string[]Enum values:sales_invoicepurchase_invoicegeneral_journal_documentfinancial_mutationpaymenttaxonomy_item
objectfinancial_account_id
string | integer | null · pattern:^\d+$
A unique record identifier
Deletes a ledger account
Deletes or deactivates a ledger account. First, an attempt is made to deactivate the ledger account. If that fails, an attempt is made to delete the ledger account. Always returns a 204 status code even if the ledger account could not be deleted or deactivated.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
id
string | integer · pattern:^\d+$
· requiredA unique record identifier
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
Ledger account deleted
Updates a ledger account
Updates a ledger account.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
id
string | integer · pattern:^\d+$
· requiredA unique record identifier
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
Ledger account updated
id
string | integer · pattern:^\d+$
A unique record identifier
administration_id
string | integer · pattern:^\d+$
A unique record identifier of an administration
name
stringaccount_type
string · enumEnum values:non_current_assetscurrent_assetsequitynon_current_liabilitiescurrent_liabilitiesrevenuedirect_costsexpensesaccount_id
string | nullparent_id
string | integer | null · pattern:^\d+$
A unique record identifier
created_at
string · date-timeupdated_at
string · date-timeallowed_document_types
string[]Enum values:sales_invoicepurchase_invoicegeneral_journal_documentfinancial_mutationpaymenttaxonomy_item
objectfinancial_account_id
string | integer | null · pattern:^\d+$
A unique record identifier
List all ledger accounts of an administration
Returns a list of all the ledger accounts in the administration.
Pagination is not supported for this endpoint.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
A list of ledger accounts
id
string | integer · pattern:^\d+$
A unique record identifier
administration_id
string | integer · pattern:^\d+$
A unique record identifier of an administration
name
stringaccount_type
string · enumEnum values:non_current_assetscurrent_assetsequitynon_current_liabilitiescurrent_liabilitiesrevenuedirect_costsexpensesaccount_id
string | nullparent_id
string | integer | null · pattern:^\d+$
A unique record identifier
created_at
string · date-timeupdated_at
string · date-timeallowed_document_types
string[]Enum values:sales_invoicepurchase_invoicegeneral_journal_documentfinancial_mutationpaymenttaxonomy_item
objectfinancial_account_id
string | integer | null · pattern:^\d+$
A unique record identifier
Creates a new ledger account
The account_type
determines the kind of ledger account, this can be any of the following values:
non_current_assets
, current_assets
, equity
, provisions
, non_current_liabilities
, current_liabilities
, revenue
, direct_costs
, expenses
, other_income_expenses
By providing the parent_id
, it is possible to create a tree of ledger accounts. Make sure the account_types
of the parent and child equal.
path Parameters
administration_id
string | integer · pattern:^\d+$
· requiredThe unique identifier of the administration
A unique record identifier of an administration
format
string · pattern:^(.(json|xml))?$
· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Request Body
rgs_code
string · requiredExisting RGS version 3.5 code, e.g. 'WMfoBelMfo'
ledger_account
object
Responses
Ledger account created
id
string | integer · pattern:^\d+$
A unique record identifier
administration_id
string | integer · pattern:^\d+$
A unique record identifier of an administration
name
stringaccount_type
string · enumEnum values:non_current_assetscurrent_assetsequitynon_current_liabilitiescurrent_liabilitiesrevenuedirect_costsexpensesaccount_id
string | nullparent_id
string | integer | null · pattern:^\d+$
A unique record identifier
created_at
string · date-timeupdated_at
string · date-timeallowed_document_types
string[]Enum values:sales_invoicepurchase_invoicegeneral_journal_documentfinancial_mutationpaymenttaxonomy_item
objectfinancial_account_id
string | integer | null · pattern:^\d+$
A unique record identifier