Dartmouth API Developer Portal

Accounts Recievables_

Request

GET /api/accountes_recievables/accounts/{ar_number}

Required Headers

Authorization: Bearer {jwt}

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 {ar_number} as possible. You must look at the result flags of is_well_formed, is_legal, is_ar_exists and cc_enabled in order to determine that status of the {ar_number}. Checking the is_legal flag should be examined for determining if the {ar_number} is legal to use in a transaction.

Returns

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

Field	Type	Description
ar_account	string	ar account number
ar_description	string	description of ar account
is_well_formed	boolean	equals true if {ar_number} is syntactcally correct
is_legal	number	equals true if the AR account is legal for use in transactions, false otherwise
is_ar_exists	boolean	returns true if the account exists regardless of whether it is active or inactive, false otherwise
ar_coa_string	string	returns the chart of account string associated with the account for billing purposes

Sample Request

https://api-preprod.dartmouth.edu/api/accounts_receivable/accounts/22970n

Sample Return

{
    "ar_account": "33970N",
    "ar_description": "ACME INC.",
    "is_well_formed": true,
    "parse_error_desc": null,
    "is_legal": true,
    "is_ar_exists": true,
    "ar_coa_string": "20.550.909000.343618.AFX8.1368"
}