Dartmouth API Developer Portal

General Ledger Transactions API

Returns individual transaction information from the General Ledger.

Rating

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

Required Scopes

Scope Description
"urn:dartmouth:general_ledger:read.transaction" This scope is required in order to view GL transaction information. Authorization of this scope is granted by Financial Accounting

Request

GET /api/general_ledger/transactions/{id}

Required Headers

Authorization: Bearer {jwt}

Reqired Parameters

Parameter Name Type Description Valid values Required

(none)

Notes on usage

The scope associated with this resource allows the calling individual/application access to "confidential" transaction information when requested. The calling individual/application must adhere to Dartmouth's policies on data privacy when using this data.

The Transactions API is designed to return information about Posted GL transactions beginning on 7/1/2019. Data prior to this date can be loaded if a use case arises.

The Transactions API is availble for filtering and paged result sets consistent with the syntax specified in the introduction section covering filtering and paging. A typical use case will require filtering to a small set of records. Then entire transaction database contains millions of records.

The API also supports finding individual transactions through a transaction_id field that is a concatenation of the batch_id, header_id and line number separated by underscores (_).

The activity and natural class fields are broken out as separate fields in the payload. Descriptions for both of these values are also available in the payload. Then entire GL string is attributes concatenated_segments. Segment values and descriptions for other segments can be added in the future as use cases arise (e.g. for additional querying functionality).

Filtering example

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

/api/general_ledger/transactions?activity=728500&effective_date=>2019-08-01T04:00:00Z&effective_date=<2019-08-30T04:00:00Z

NOTE: that dates must conform to the iso8601 standard documented in the "JSON Formats and Data Types" section of this guide. Also know that the date data in the cache are stored as "string" data. Effective dates in the Oracle GL are all stored as local 00:00:00 time and converted to iso8601 UTC time in the cache.

Because of this, queries might more safely get all transactions for a "day" by using a 00 to 99 time component which will guarantee getting any date on that day. For example:

/api/general_ledger/transactions?activity=728500&effective_date=>2019-08-01T00:00:00Z&effective_date=<2019-08-30T99:99:99Z

Returns

Status Code Description
200 The URI parameter {netid} passed in is a valid employee
404 The URI parameter {netid} passed in is NOT a valid employee

Top Level Payload Attribute Descriptions

Field Type Description Known Issues
natural_class string the natural class value
accounted_cr string credits
cache_date array the last update of the cache for this record in iso8601 format
je_batch_name array an array of faculty appointments by organization (see attributes in next table)
je_header_id string journal entry header id
reference_1 array free form reference information from the source of the transaction
activity_name string the description of the activity
effective_date string the effective date of the transaction
reference_4 string free form reference information from the source of the transaction
line_description string description of the transaction line
last_update_date string last modification to the transaction in the GL
accounted_dr string debits
creation_date string creation date of the transaction in the GL
je_line_num string journal entry line number
concatenated_segments string the full chart string
transaction_id string batch_id, header_id and line number separated by underscores (_)
activity string the activity segment from the chart string

Sample Request

https://api.dartmouth.edu/api/general_ledger/transactions/7947963_8552863_67

Sample Return

[
    {
        "natural_class": "8151",
        "accounted_cr": null,
        "cache_date": "2019-12-06T19:50:09Z",
        "je_batch_name": "PAYT P-Card 08/06/19, Exp Pay 16-AUG-08 AUG-08 PCARD_DC A 406845 24638536",
        "je_header_id": 8552863,
        "reference_1": "TST*SKINNY PANCAKE HANOVE",
        "activity_name": "Student Organizations Board Example",
        "effective_date": "2019-08-05T04:00:00Z",
        "reference_4": "Board Meeting on 8/1",
        "line_description": "29197 - Some Organization - TST*SKINNY PANCAKE HANOVE",
        "natclass_name": "NONTRAVEL Meals Local",
        "last_update_date": "2019-08-06T22:23:37Z",
        "accounted_dr": 63.22,
        "creation_date": "2019-08-06T22:16:56Z",
        "je_line_num": 67,
        "concatenated_segments": "20.610.368000.888800.0000.8151",
        "transaction_id": "7947963_8552863_67",
        "activity": "888800"
    }
]