Dartmouth API Developer Portal

General Ledger Segments API

Returns individual General Ledger segment values. Typical use case would be pick lists in applications.

Rating

Attribute Value
Highly Available Yes
Cache Refresh Interval Once Daily
Filtering Yes

Required Scopes

None required

Request

GET /api/general_ledger/entities
GET /api/general_ledger/orgs
GET /api/general_ledger/fundings
GET /api/general_ledger/activities
GET /api/general_ledger/subactivities
GET /api/general_ledger/natural_classes

Required Headers

Authorization: Bearer {jwt}

Reqired Parameters

Parameter Name Type Description Valid values Required

(none)

Notes on usage

The Segments API consists of six individual endpoints returning information about each individual segment from General Ledger Chart of Accounts.

The Segments API is availble for filtering and paged result sets consistent with the syntax specified in the introduction section covering filtering and paging.

All segments may require filtering in the typical use case of supporting a UI that allows a user to construct chart strings. This table summarizes filtering requirements:

Segment Typical Filter Description
entities ?parent_child_flag=C filters to allowable child values in a typical use case of constructing chart strings
orgs ?parent_child_flag=C filters to allowable child values in a typical use case of constructing chart strings
fundings ?parent_child_flag=C filters to allowable child values in a typical use case of constructing chart strings
activities ?parent_child_flag=C filters to allowable child values in a typical use case of constructing chart strings
subactivities ?activity={activity} subactivities are connected to particular activity values, once an activity value is chosen the allowable list of subactivities will be returned with a similar filter
natural_classes ?parent_child_flag=C filters to allowable child values in a typical use case of constructing chart strings

Filtering example

The following example filters for a particular activity segment within a date range:

/api/general_ledger/subactivities?activity=728500

Returns

Status Code Description
200 values returned via query or by resource id
404 returned when a resource id (such as entity code) is requested and the resource is not found

Top Level Payload Attribute Descriptions

Field Type Description Known Issues
{segment id} string the segments resource identifier such as 20 for entity or 350 for org
{segment_description} string describes the segments use
parent_child_flag string a flag showing either P or C for Parent or Child values. Typical use case is filter to child values. N/A on subactivities.
internal_expense_revenue_code string (natural_classes only) shows whether the NC is either Revenue and Expense
cache_date ISO8601 date string the last refresh date of this cache entry

Sample Return

Entities

[
    {
        "entity": "93",
        "entity_description": "NNEACC",
        "parent_child_flag": "C",
        "cache_date": "2022-05-31T15:34:17Z"
    }
]

Orgs

[
    {
        "org": "361",
        "org_description": "Medical Services",
        "parent_child_flag": "C",
        "cache_date": "2022-05-31T15:34:22Z"
    }
]

Fundings

[
    {
        "funding": "110001",
        "funding_description": "Rubin Addition",
        "parent_child_flag": "C",
        "cache_date": "2022-05-31T15:34:27Z"
    }
]

Activities

[
    {
        "activity": "110901",
        "activity_description": "Accessible Dartmouth Initiative",
        "parent_child_flag": "C",
        "cache_date": "2022-05-31T15:34:33Z"
    }
]

Subactivities

[
    {
        "subactivity_id": "0000.100000",
        "subactivity": "0000",
        "subactivity_description": "Default",
        "activity": "100000",
        "cache_date": "2022-05-31T15:34:44Z"
    }
]

Natural Classes

[
    {
        "natural_class": "2791",
        "natural_class_description": "LIAB Condtnl Asset Retirement Oblig",
        "internal_expense_revenue_code": "NA",
        "parent_child_flag": "C",
        "cache_date": "2022-05-31T15:35:17Z"
    }
]