Accounting | Account Info

The Account Info end point allows you to get the summary information from an account, such as the last posting date, total balance or period balance.

Overview

URL	api/{tenantKey}/{orgKey}/accounting/accountInfos
Methods Supported	GET

All Operations

This service includes the following operations:

• GET:
  • GET Get Account Summary

All Resources

This service uses the following resources:

• AccountSummary

GET Operations

GET Get Account Summary

This operation allows you to get a summary information from an specific account.

The following elements are required:

companyKey	(string) The company code "abbreviation" as defined on the company setup.
accountKey	(string) The GLAccount to get the information from.
ledgerKey	(string) The ledger.
financialYear	(int) The financial year.
financialPeriod	(int) The period number to get the summary as specified in the financial calendars entity.

Response:

When successful, the response body contains a resource of type 'AccountSummary'. See AccountSummary.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

Resources

AccountSummary

The following elements are optional:

accountDescription	(string) The GL Account description as specified in the GLAccout entity.
accountClassType	(string) The GLAccount class type.
accountTaxonomy	(string) The GLAccount Taxonomy.
lastPostingDate	(string) The last record movement on the account.
lastPostingDateTitle	(string) A label in the user language to the last posting date.
totalBalanceValue	(string) The current account balance since the beginning of the financial year.
totalBalanceTitle	(string) A label in the user language to the total balance.
totalBalanceEstimate	(string) The estimated balance value for the account.
periodBalanceValue	(string) The balance value for the account in the specified period.
periodBalanceTitle	(string) A label in the user language to the period balance.
periodBalanceEstimate	(string) The estimated balance value for the account in the specified period.
forecastBalanceValue	(string) A forecast balance value based on the previous periods.
forecastBalanceTitle	(string) A label in the user language to the forcast balance.
totalPostingsValue	(string) The total number of postings in the specified account.
totalPostingsTitle	(string) A label in the user language to the total posting number.