Ethos Egress: Transactions

This document describes how Housing.Cloud can push Transactions to Ethos. It is expected that the Institution executed the proper due diligence to determine that the Ellucian Ethos API Models can satisfy their Institution specific Business requirements.

General:

• Endpoint: /student-charges
  • Version: application/vnd.hedtech.integration.v16+json
• Support HTTP Methods: POSTand GET

Data Model:

Field Name/Path	Description
id	A null Ethos GUID value
student.id	A person's Ethos GUID (note: this is the persons.id not the students.id from Ethos)
academicPeriod.id	Derived from the associated Cycle
fundingDestination.id	Derived from the associated Charge Code's Accounting Code
fundingSource.id	An optional configurable AR Type for Colleague only
chargeableOn	Either the date of the API call or the Cycles Effective Transaction Date
chargedAmount.amount.value	The dollar amount of the Transaction
chargedAmount.amount.value	The local currency code of the Institution
comments	This will include a unique identifier from Housing.Cloud for auditing purposes
overrideDesription	An optional description of the Transaction.Explanation of possible values is located below **

 

Configurations:

These values can be set in the Integration Configuration Data Mappings object.

• customFundingSourceCode: The override value for the AR Type in Colleague
• includeHousingAssignmentTransactions:  A flag to indicate whether or not Housing.Cloud should send Transactions related to Occupancies from Housing.Cloud to Ethos
• includeMealPlanAssignmentTransactions:  A flag to indicate whether or not Housing.Cloud should send Transactions related to Meal Plan Assignments from Housing.Cloud to Ethos
• includedAccountingCodes: An allow list of which Accounting Codes Housing.Cloud will send Transactions of
• useOverrideDescription: A flag to indicate that Housing.Cloud should pass an overrideDescription in the JSON payload. Per Ethos, the description will be a maximum of 30 characters. The description priority will be**:
  1. The description of the Transaction itself in Housing.Cloud
  2. If the Transaction description is null and it is a Housing Assignment related Transaction, then the description will be Housing-{{Building Name}}
  3. If the Transaction description is null and it is a Meal Plan Assignment related Transaction, then the description will be Dining-{{Meal Plan Name}}
  4. If the Transaction description is null and the Transaction is neither a Housing nor Meal Plan Assignment Transaction, then null is included in the payload and Colleague/Banner will default the description to the AR/Detail Code description