The ChartOfAccounts resource allows accounts to be listed and viewed. Here are some examples URIs:

· /ChartOfAccounts - returns accounts from chart;

· /ChartOfAccounts?acceptpayments=true - returns accounts from chart which are accepting payments;

· /ChartOfAccounts?class=REVENUE - returns accounts from chart with REVENUE account class

· /ChartOfAccounts?status=ACTIVE - returns accounts from chart having ACTIVE status

 

The full range of URIs and HTTP Verbs supported are:

Operation

HTTP Action

List of accounts from chart

GET /ChartOfAccounts

Get account from chart

GET /ChartOfAccounts/{code}

These filters can be used with the GET ChartOfAccounts endpoint:

Filter

Description

name

Only return accounts from chart with which name starts with the specific name

class

Only return accounts from chart with specific class

status

Only return accounts from chart having same status

acceptpayments

Only return accounts from chart having same AcceptPayments flag value

systemaccount

Only return system accounts from chart if flag value is true, or only not system account if flag value is false

Filters are used by adding the filter and value to the URI: /ChartOfAccounts?name=ABC

Available Fields for Account:

Property

Type

Length

Required

Notes

Code

String

50

Yes

Account code is unique code number for Account

Name

String

50

Yes

Account name – short title for Account

Description

String

1024

 

Optional description of how this account should be used

Class

String

50

Yes

Account class, that define for what account is used.

Type

String

50

Yes

Account type inside class

Status

String

50

Yes

Account status. See possible values below

SystemAccount

String

50

No

System Account

AcceptPayments

Boolean

 

 

Flag indicates if account can be selected to accept payment from customers and to suppliers

 

Valid Account Class values:

Value

Description

ASSET

Account is used for assets accounting

EQUITY

Account is used for equity accounting

LIABILITY

Account is used for liability accounting

EXPENSE

Account is used for expense accounting

REVENUE

Account is used for revenue accounting

 

Valid Account Status values:

Value

Description

ACTIVE

Account is active, you can use them

ARCHIVED

Account is archived