Dartmouth API Developer Portal

#Accounts

Account String Lookup/Validation API

Returns information about various account strings used in accounting systems. Currently support for General Ledger, Grants Accounting, Accounts Receivable.

Required Scopes

Access to the account lookup API is open to public (Dartmouth affiliation required).

Required Headers

Authorization: Bearer {jwt}

General Ledger

Request

GET /api/general_ledger/accounts/{chart_string}

Parameters

none

Notes on usage

The api should always return a status code of 200 as long as the backend database service is available (NOTE that periodic maintenance may make the database unavailable). The backend service always tries to match and validate as much of the URI parameter {chart_string} as possible. You must look at the result flags of well_formed, legal, cc_exists and cc_enabled in order to determine that status of the {chart_string}. Chart accounts that are perfectly valid are not created until used in a transaction. Therefore checking the legal flag should be examined for determining if the {chart_string} is legal to use in a transaction.

The GL account validation allows for testing of either 5 or 6 segment strings. If a 5 segment string is passed to the API a default natural class that is guaranteed to be legal with any combination is appended to the string to form a full string, and the resulting full string is checked for legality. The default natural class segment and natural class description is removed from the payload prior to being returned to the caller.

1.10.3.1.7. Returns

Status Code	Description
200	The Account Lookup completed
500	The database is unavailable

Field	Type	Description
ccid	number	internal numeric identifier for the 6 segment combination, null if not active combo
is_fully_formed	boolean	if all six segments present, then this equals true, otherwise false
is_well_formed	boolean	equals true if well formed, otherwise false
is_legal	boolean	equals true if a legal segment combination, otherwise false
is_cc_exists	boolean	equals true if an active code combination is defined, otherwise false
is_cc_enabled	boolean	equals true if the CC is defined, and the enabled flag is true, otherwise false
concatenated_str	string	the segment values separated by util.separator
consolidated_str	string	the segment values concatenated as a single value without separators
account_desc	string	description of 5 of 6 segments separated by util.separator
short_description	string	short description using only org and activity
parse_error_desc	string	if any errors parsing, contains details of errors found
validation_error_desc	string	errors checking cross segment validation,they go here
is_grant_related	boolean	is account grant_related
is_capital_project	boolean	is account capital_project
is_internal_revenue	boolean	is account internal_revenue
is_internal_expense	boolean	is account internal_expense
account_str	string	the 5of6 account
account_natural class	string	the natural class
concatenated_desc	string	description of all segments separated by util.separator

1.10.3.1.8. Sample Request

https://api.dartmouth.edu/api/general_ledger/accounts/30.108.200159.594000.0000.7266

1.10.3.1.9. Sample Return

{
    "ccid": 538971,
    "is_fully_formed": true,
    "is_well_formed": true,
    "is_legal": true,
    "is_cc_exists": true,
    "is_cc_enabled": true,
    "concatenated_str": "30.108.200159.594000.0000.7266",
    "consolidated_str": "3010820015959400000007266",
    "account_desc": "Geisel School of Medicine:Micro Immuno:Sentman Reserve:Lab Based Faculty Research:Default",
    "short_description": "Micro Immuno:Lab Based Faculty Research",
    "parse_error_desc": null,
    "validation_error_desc": null,
    "is_grant_related": false,
    "is_capital_project": false,
    "is_internal_revenue": false,
    "is_internal_expense": false,
    "account_str": "30.108.200159.594000.0000",
    "account_natural_class": "7266",
    "concatenated_desc": "Geisel School of Medicine:Micro Immuno:Sentman Reserve:Lab Based Faculty Research:Default:MAINT EQUIP Laboratory"
}