Dartmouth API Developer Portal

Accounts Receivables Detail Codes_

Request

GET /api/accountes_receivables/accounts/detail_codes/{detail_code}

Required Headers

Authorization: Bearer {jwt}

Parameters

none

Notes on usage

The detail codes lookup is a lookup in the Banner AR system for the existence of the {detail_code} URI parameter. If the detail code exists a 200 status code is returned and a payload of information about the detail code. If the detail code does not exist a 404 is returned.

COMPATIBILITY NOTE that this api call is directly tied to the implementation of Banner AR and will definitely change in a future AR system.

Returns

Status Code Description
200 The Account Lookup completed
404 The detail code does not exist
500 The database is unavailable
Field Type Description
detail_code string
desc string
type_ind string
priority string
is_like_term boolean
dcat_code string
amount string
term_code string
effective_date date string
is_refundable boolean
is_receipt boolean
is_refund boolean
activity_date date string
payt_code string
is_prebill_print boolean
gl_nos_enterable string
taxt_code string
is_tbdc boolean
is_detail_code boolean
is_detc_active boolean
is_dird boolean
is_tiv boolean
is_inst_chg boolean
is_like_aidy boolean
is_payhist boolean
is_abdc boolean
is_like_period boolean
surrogate_id number
version number
user_id string
data_origin string
vpdi_code string

Sample Request

https://api.dartmouth.edu/api/accounts_receivable/detail_codes/S355

Sample Return

{
    "detail_code": "S355",
    "desc": "Sch McLane Fam",
    "type_ind": "P",
    "priority": "000",
    "is_like_term": false,
    "dcat_code": "FA",
    "amount": null,
    "term_code": null,
    "effective_date": null,
    "is_refundable": true,
    "is_receipt": false,
    "is_refund": false,
    "activity_date": "2003-04-30T04:00:00Z",
    "payt_code": "N",
    "is_prebill_print": false,
    "gl_nos_enterable": "N",
    "taxt_code": null,
    "is_tbdc": false,
    "is_detail_code": false,
    "is_detc_active": true,
    "is_dird": false,
    "is_tiv": false,
    "is_inst_chg": false,
    "is_like_aidy": false,
    "is_payhist": false,
    "is_abdc": false,
    "is_like_period": false,
    "surrogate_id": 854,
    "version": 0,
    "user_id": null,
    "data_origin": null,
    "vpdi_code": null
}