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_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern:^\d+$· requiredA unique record identifier
formatstring · 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
idstring | integer · pattern:^\d+$A unique record identifier
administration_idstring | integer · pattern:^\d+$A unique record identifier of an administration
namestringaccount_typestring · enumEnum values:non_current_assetscurrent_assetsequitynon_current_liabilitiescurrent_liabilitiesrevenuedirect_costsexpensesaccount_idstring | nullparent_idstring | integer | null · pattern:^\d+$A unique record identifier
created_atstring · date-timeupdated_atstring · date-timeallowed_document_typesstring[]Enum values:sales_invoicepurchase_invoicegeneral_journal_documentfinancial_mutationpaymenttaxonomy_itemobjectfinancial_account_idstring | 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_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern:^\d+$· requiredA unique record identifier
formatstring · 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_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern:^\d+$· requiredA unique record identifier
formatstring · 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
idstring | integer · pattern:^\d+$A unique record identifier
administration_idstring | integer · pattern:^\d+$A unique record identifier of an administration
namestringaccount_typestring · enumEnum values:non_current_assetscurrent_assetsequitynon_current_liabilitiescurrent_liabilitiesrevenuedirect_costsexpensesaccount_idstring | nullparent_idstring | integer | null · pattern:^\d+$A unique record identifier
created_atstring · date-timeupdated_atstring · date-timeallowed_document_typesstring[]Enum values:sales_invoicepurchase_invoicegeneral_journal_documentfinancial_mutationpaymenttaxonomy_itemobjectfinancial_account_idstring | 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_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
formatstring · 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
idstring | integer · pattern:^\d+$A unique record identifier
administration_idstring | integer · pattern:^\d+$A unique record identifier of an administration
namestringaccount_typestring · enumEnum values:non_current_assetscurrent_assetsequitynon_current_liabilitiescurrent_liabilitiesrevenuedirect_costsexpensesaccount_idstring | nullparent_idstring | integer | null · pattern:^\d+$A unique record identifier
created_atstring · date-timeupdated_atstring · date-timeallowed_document_typesstring[]Enum values:sales_invoicepurchase_invoicegeneral_journal_documentfinancial_mutationpaymenttaxonomy_itemobjectfinancial_account_idstring | 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_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Request Body
rgs_codestring · requiredExisting RGS version 3.5 code, e.g. 'WMfoBelMfo'
ledger_accountobject
Responses
Ledger account created
idstring | integer · pattern:^\d+$A unique record identifier
administration_idstring | integer · pattern:^\d+$A unique record identifier of an administration
namestringaccount_typestring · enumEnum values:non_current_assetscurrent_assetsequitynon_current_liabilitiescurrent_liabilitiesrevenuedirect_costsexpensesaccount_idstring | nullparent_idstring | integer | null · pattern:^\d+$A unique record identifier
created_atstring · date-timeupdated_atstring · date-timeallowed_document_typesstring[]Enum values:sales_invoicepurchase_invoicegeneral_journal_documentfinancial_mutationpaymenttaxonomy_itemobjectfinancial_account_idstring | integer | null · pattern:^\d+$A unique record identifier