Account Service

Account describe the customers and vendors accounts, that are associated with the Tenant. You can retrieve all accounts or by its id by using API.

Account Object

Attributes


AttributeTypeDescription
idlongUnique identifier for the object.
accountCodestringUnique accountCode assigned to the object.
namestringAccount name. Possible values for name.
codestringUnique code assigned to the object.
descriptionstringAccount Description.
taxCodestringAccount tax code assigned to the object.
currencystringCurrency used.
accountGroupstringAccount Group Name. Attributes for account group.
accountGroupIdstringAccount Group Id.
statusstringStatus of the account. Possible values for account status.
openingBalanceBigDecimalOpening Balance Amount.
balanceBigDecimalBalance Amount. Attributes for balance.
totalBalanceBigDecimalTotal value of Opening Balance and Balance.
totalCOABalanceBigDecimalTotal value of Opening Balance and Balance with Nature.
openingBalanceCdTypestringOpening Balance Type. Possible values for type.
accountNaturestringAccount Nature. Possible values for account nature.
customFieldjsonobjectKey-value pair for custom field name and its value.

API


Retrieve Account

Retrieves the details of an existing account. You need only supply the unique account id that was returned upon account creation.

Parameters

Code

@Autowired
private AccountsApiClient accountsApiClient;
public AccountDto getAccountById(Long accountId, String accessToken){
return this.accountsApiClient.getById(accountId, accessToken);
}

List All Accounts

Returns list of accounts.

Parameters

Code

@Autowired
private AccountsApiClient accountsApiClient;
public Accounts getAccounts(String accessToken, Integer limit, Integer page){
return this.accountsApiClient.getAccounts(accessToken, limit, page);
}

Objects


Account_Group

AttributeTypeDescription
idlongUnique identifier for the object.
namestringAccount Group Name.
parentIdlongID of AccountGroup Parent.
accountNatureIdlongID of Account Nature.
parentNamestringName of AccountGroup Parent.
isDeletedbooleanHas the value true if the accountGroup is deleted or false if the accountGroup still exist.
accountMasterlongIdentifier for accountMaster.
codestringAccount Code

Balance

AttributeTypeDescription
cdTypeenumCredit / Debit Type. Possible values for type.
openingBalanceBigDecimalOpening Balance Amount.
accountCodestringUnique accountCode assigned to the object.

Bank_Account

AttributeTypeDescription
bankNumberstringUnique identifier for the object.
bankNamestringBank Account Name.
connectStatusbooleanHas the value true if the status is active or false if the status is deactive.

Account

AttributeTypeDescription
idlongUnique identifier for the object.
accountCodestringUnique accountCode assigned to the object.
namestringAccount Name.
descriptionstringAccount Description.
accountGroupIdlongAccount Group ID
accountGroupNamestringName of Account Group.
taxCodestringAccount Tax code.
currencystringAccount Currency.
statusstringStatus of the account. Possible values for account status.
controlAccountbooleanHas the value true if the control account flag is false or false if the control account flag is true.
openingBalanceCdTypeenumCredit / Debit Type. Possible values for type.
customFieldjsonobjectKey-value pair for custom field name and its value.

Enums


ACCOUNT_NAME

  • Savings account

STATUS

  • ACTIVE
  • INACTIVE

OPENING_BALANCE_TYPE

  • CREDIT
  • DEBIT

ACCOUNT_NATURE

  • Assets

TYPE

  • CREDIT
  • DEBIT