Skip to main content

Financial Aid

Financial Aid (1.0)

Download OpenAPI specification:Download

All API calls related to Financial Aid.

StudentAward

Approve Batch Disbursement

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-approvebatchdisbursement-request-payload)
Array of objects (cmc-nexus-financialAid-services-approveDisbursementRequest)
isCommonLineImport
boolean
isAutoPost
boolean
failedDisbursements
object
agencyBranchId
number <int32>
reviewStatus
object
isEnforeBatchIntegrity
boolean
totalNumberOfDisbursements
number <int32>
isNewBatch
boolean
paidDisbursementCount
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Approve Packaged Aid

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-approvepackagedaid-request-payload)
studentAidId
number <int32>
userId
number <int32>
studentAwardPellId
number <int32>
campusId
number <int32>
studentId
number <int32>
fundSourceId
number <int32>
awardYear
string
isApproved
boolean
schoolStatusId
number <int32>
fundSourceType
string
batchId
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Auto Approve Disbursement

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-autoapprovedisbursement-request-payload)
campusId
number <int32>
studentId
number <int32>
studentEnrollmentPeriodId
number <int32>
fundSourceId
number <int32>
awardYear
string
isApproved
boolean
schoolStatusId
number <int32>
scheduleDisbursementId
number <int32>
termId
number <int32>
termCode
string
disbursementScheduledDate
string <date-time>
fundSourceType
string
amount
number <double>
disbursementBatchDetailId
number <int32>
loanEndDate
string <date-time>
isFirstTimeBorrower
boolean
certifiedDate
string <date-time>
subsequentDisbursementBatchId
number <int32>
isTermEvaluated
boolean
isHoldGroupOverridden
boolean
holdGroupList
Array of strings
batchId
number <int32>
disbursementCriteria
string
isPaid
boolean
failedReason
object

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Auto Award

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-autoaward-request-payload)
studentAcademicYearId
number <int32>
studentId
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Auto Package

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-autopackage-request-payload)
studentAcademicYearId
number <int32>
isEfc
boolean
isDelete
boolean
overrideFsaIneligibility
boolean
calculatedEfc
number <double>
applyAcademicYearSequenceFilter
boolean
campusId
number <int32>
currentPellAmount
number <double>
isMultipleDisbursement
boolean

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Award Letters

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-awardletters-request-payload)
Array of objects (cmc-nexus-financialAid-services-awardInfo)
reportName
string
fileName
string
forValidationOnly
boolean
staffDefaultCampusId
number <int32>
loggedInStaffId
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Commonline Import Upload File

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-commonlineimportuploadfile-request-payload)
fileType
number <int32>
fileName
string
isEmptyBatchId
boolean
isAllowReimport
boolean
isSuccessfullyImported
boolean
campusId
number <int32>
useDefaultCampus
boolean
fileContent
string <byte>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Commonline Process Export

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-commonlineprocessexport-request-payload)
recipientId
number <int32>
sourceSchoolId
string
sourceName
string
awardYear
string
fileType
number <int32>
fileOption
number <int32>
exportBatchId
number <int32>
batchId
string
campuses
Array of numbers <int32> [ items <int32 > ]
campusCode
string
ffelIdentifierBranch
string
forValidationOnly
boolean
canRegenerateBatchForAcceptedLoans
boolean
isSendEmail
boolean
scheduledDisbursmentIds
Array of numbers <int32> [ items <int32 > ]
staffDefaultCampusId
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Commonline Process Export Queue

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-commonlineprocessexportqueue-request-payload)
batchName
string
recipientId
number <int32>
sourceSchoolId
string
sourceName
string
awardYear
string
fileType
number <int32>
fileOption
number <int32>
exportBatchId
number <int32>
batchId
string
campuses
Array of numbers <int32> [ items <int32 > ]
campusCode
string
ffelIdentifierBranch
string
forValidationOnly
boolean
canRegenerateBatchForAcceptedLoans
boolean
isSendEmail
boolean
scheduledDisbursmentIds
Array of numbers <int32> [ items <int32 > ]
staffDefaultCampusId
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Commonline Validate Import

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-commonlinevalidateimport-request-payload)
fileType
number <int32>
fileName
string
isEmptyBatchId
boolean
isAllowReimport
boolean
isSuccessfullyImported
boolean
campusId
number <int32>
useDefaultCampus
boolean
fileContent
string <byte>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Create Student Award

Authorizations:
apikey

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Create Approve Disbursements Batch

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-createapprovedisbursementsbatch-request-payload)
campusId
number <int32>
awardYearList
Array of strings
fundSourceType
string
lenderId
number <int32>
disbursementFrom
string <date-time>
disbursementTo
string <date-time>
originationStatus
number <int32>
isPromissoryNotesAcceptedLoanIncluded
number <int32>
isReleasedCommonLineDisbursementExcluded
number <int32>
fundSourceList
Array of numbers <int32> [ items <int32 > ]
categoryList
Array of strings
lastNameCriteria
string
studentExcludedHoldGroupList
Array of strings
isBatchIntegrityEnforced
boolean
isInformedBorrowerIncluded
boolean

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Create New Award Default Values

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-createnewawarddefaultvalues-request-payload)
awardYear
string
studentId
number <int32>
fundSourceId
number <int32>
studentAcademicYearId
number <int32>
grossAmount
number <double>
awardStatus
string
fundSourceGroupId
number <int32>
isirTransactionId
string
costOfAttendance
number <double>
efc
number <double>
needBasedAmountPackaged
number <double>
nonNeedBasedAmountPackaged
number <double>
isAdditionalEligibility
boolean

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Delete Student Award

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-delete-request-payload)
updatePellOriginationStatus
boolean
updateCodGrantOriginationStatus
boolean
pellHasDisbursementGrantInRejectedStatus
boolean
codGrantHasDisbursementGrantInRejectedStatus
boolean
continuePellDisbursementGrantInRejectedStatus
boolean
continueCodGrantDisbursementGrantInRejectedStatus
boolean
Array of objects (cmc-nexus-financialAid-entities-scheduledDisbursementEntity)
Array of objects (cmc-nexus-financialAid-entities-pellSpecialDisbursementEntity)
Array of objects (cmc-nexus-financialAid-entities-studentAcademicYearPaymentPeriodEntity)
Array of objects (cmc-nexus-financialAid-entities-paidDisbursementEntity)
Array of objects (cmc-nexus-financialAid-entities-refundEntity)
object (cmc-nexus-financialAid-entities-studentAwardLoanEntity)
object (cmc-nexus-financialAid-entities-studentAwardPellEntity)
object (cmc-nexus-financialAid-entities-studentAcademicYearEntity)
costOfAttendance
number <double>
efc
number <double>
needBasedAmountPackaged
number <double>
nonNeedBasedAmountPackaged
number <double>
needBasedGrossAmount
number <double>
nonNeedBasedGrossAmount
number <double>
isLimitPackagingToCoa
boolean
isRecalculatedEfc
boolean
studentAcademicYearSequence
number <int32>
campusId
number <int32>
isScheduledAmountMisMatchWithDisbursementAmount
boolean
continueScheduledAmountMisMatchWithDisbursementAmount
boolean
preventAwardingWhenAuthorizationNotExpended
boolean
continueAwardingWhenAuthorizationNotExpended
boolean
glAuthorizationId
number <int32>
isPreventSaveForGrant
boolean
isStateAdd
boolean
recalculateCashPlan
boolean
updateAmountPackagedWithPrincipal
boolean
isAdjustPackageInEditMode
boolean
adjustPackagedAmountMessage
string
paymentAmountSplit
number <double>
isPaymentAmountSplitBasedOnNoOfPayments
boolean
allowOriginationChanged
boolean
isAllowOriginationChanged
boolean
isOriginationStatusReadyToSend
boolean
originationStatusReadyToSend
boolean
grossAmount
number <double>
originalGrossAmount
number <double>
isAddlEligibilityIndicator
boolean
resetGrossAmount
boolean
lessGrossAmount
boolean
isGrossAmountExeed
boolean
grossAmountExeed
boolean
isCampusAutoUpdatePellOriginationStatus
boolean
isAllowInformtionNotChange
boolean
isAllowInformtionChange
boolean
allowInformtionChange
boolean
isAllowAdvisor
boolean
allowAdvisor
boolean
isCommitLevelAmountChange
boolean
commitLevelAmountChange
boolean
isPreventPackaging
boolean
refundedGrossAmount
number <double>
netAmount
number <double>
isStudentLoanNetAmountNotEqualToDisbursementNetAmount
boolean
continueStudentLoanNetAmountNotEqualToDisbursementNetAmount
boolean
isStudentLoanPaidDisbursementBankFeeMoreThanLoanBankFee
boolean
continueStudentLoanPaidDisbursementBankFeeMoreThanLoanBankFee
boolean
isStudentLoanPaidDisbursementBankFeeLessThanLoanBankFee
boolean
continueStudentLoanPaidDisbursementBankFeeLessThanLoanBankFee
boolean
isAddBankFeeToCostOfAttendance
boolean
isAddBankFeeToCostOfAttendanceUserConfirmationIsYes
boolean
continueAfterConfirmationForAddBankFeeToCostOfAttendance
boolean
isStudentLoanReadyToSendValidationExists
boolean
isStudentLoanPaidDisbursementExists
boolean
disbursedAmount
number <double>
refundedAmount
number <double>
expectedAmount
number <double>
totalNetAmount
number <double>
originalAmountPackaged
number <double>
readyToSendValidationMessages
Array of strings
isUsePaymentPeriod
boolean
isSaveNonTitleIvPaymentPeriods
boolean
object (cmc-nexus-common-entities-studentRelationshipAddressEntity)
object (cmc-nexus-common-entities-studentRelationshipAddressEntity)
Array of objects (cmc-nexus-financialAid-entities-studentAwardLoanChangeEntity)
isLoanDetailsChanged
boolean
isUseBorrowerSsn
boolean
isDirectLoanReCalculate
boolean
directLoanReCalculate
boolean
isEarlyDisbursementRulesFsaHandbook
boolean
earlyDisbursementRulesFsaHandbook
boolean
isDisbursmentAmountMissMatch
boolean
disbursmentAmountMissMatch
boolean
isAllowApprove
boolean
allowApprove
boolean
isMaxLimit
boolean
maxLimit
boolean
isAdjustLoanEndDate
boolean
adjustLoanEndDate
boolean
progVerTermAssocExist
boolean
isProgVerTermAssocExist
boolean
countDisburseMentAmount
number <double>
object (cmc-nexus-financialAid-entities-codGrantOriginationEntity)
Array of objects (cmc-nexus-financialAid-entities-codGrantDisbursementEntity)
isMultipleTeachGrant
boolean
isSavingAwardInCanceledStatusCodGrant
boolean
continueSavingAwardInCanceledStatusCodGrant
boolean
isChangingOriginationStatusCodGrant
boolean
isChangingOriginationStatusCodGrantCanceledByUser
boolean
continueChangingOriginationStatusCodGrant
boolean
isCodGrantAmountPackagedGreaterThanOriginationAmountAllowed
boolean
isCodGrantAmountPackagedGreaterThanOriginationAmount
boolean
continueSaveTeacherExpertIndicator
boolean
isTeacherExpertIndicator
boolean
isNonTitleIvPaymentPeriodCreated
boolean
isCodGrantIsirOnFile
boolean
isCodGrantTotalDisbAmtNotEqualToAwardAmount
boolean
continueCodGrantTotalDisbAmtNotEqualToAwardAmount
boolean
isGrossAmontExceeded
boolean
continueGrossAmontExceeded
boolean
isCodGrantChangesToGradeLevel
boolean
continueCodGrantChangesToGradeLevel
boolean
isCampusAutoUpdateOriginationStatusCodGrant
boolean
graduateStudentsNoLongerEligible
boolean
isGraduateStudentsNoLongerEligible
boolean
isirMustFileBeforeLoan
boolean
isIsirMustFileBeforeLoan
boolean
isRequiredField
boolean
requiredField
boolean
isValidateSpecialProgramIsN
boolean
validateSpecialProgramIsN
boolean
isValidateSpecialProgramIsNotABNPT
boolean
validateSpecialProgramIsNotABNPT
boolean
isValidateSpecialProgramIsNotABN
boolean
validateSpecialProgramIsNotABN
boolean
isValidateSpecialProgramIsNotABUN
boolean
validateSpecialProgramIsNotABUN
boolean
isAllowOriginationWithEstAward
boolean
allowOriginationWithEstAward
boolean
isMaxLimitForSubDirSub
boolean
maxLimitForSubDirSub
boolean
Array of objects (cmc-nexus-financialAid-entities-studentAcademicYearPaymentPeriodEntity)
remainingNeed
number <double>
addAgencyToStudentAgency
boolean
isAdjustPackagedAmountHasNotPreventAwardWarningMessage
boolean
continueAdjustPackagedAmountHasNotPreventAwardWarningMessage
boolean
adjustPackagedAmountNotPreventAwardWarningMessage
string
isLoanBeginDateChanged
boolean
isLoanEndDateChanged
boolean
originalLoanPeriodBeginDate
string <date-time>
originalLoanPeriodEndDate
string <date-time>
isPellExists
boolean
id
number <int32>

Id

accruedInterestAmount
number <double>

Accrued Interest Amount

agencyBranchId
number <int32>

Agency Branch Id

amountCanceled
number <double>

Amount Canceled

amountDisbursed
number <double>

Amount Disbursed

amountPackaged
number <double>

Amount Packaged

amountRefunded
number <double>

Amount Refunded

applicationReceivedDate
string <date-time>

Application Received Date

applicationSentDate
string <date-time>

Application Sent Date

awardLevelAmount
number <double>

Award Level Amount

awardYear
string

Award Year

batchPackagingProcessId
number <int32>

Batch Packaging Process Id

calculationDate
string <date-time>

Calculation Date

codGrantOriginationId
number <int32>

Cod Grant Origination Id

createdByUserId
number <int32>

Created By User Id

createdDateTime
string <date-time>

Created Date Time

creditCardEffectiveDate
string <date-time>

Credit Card Effective Date

downPaymentAmount
number <double>

Down Payment Amount

effectiveDate
string <date-time>

Effective Date

emailNotification
string

Email Notification

faLenderId
number <int32>

Fa Lender Id

firstPaymentDate
string <date-time>

First Payment Date

fundSourceId
number <int32>

Fund Source Id

guarantorLendingInstitutionId
number <int32>

Guarantor Lending Institution Id

interestBalance
number <double>

Interest Balance

interestOnlyUntilDate
string <date-time>

Interest Only Until Date

interestRate
number <double>

Interest Rate

interestRebateAmount
number <double>

Interest Rebate Amount

isAutoCredit
boolean

Is Auto Credit

isAutoDraft
boolean

Is Auto Draft

isAxLinkedFws
boolean

Is Ax Linked Fws

isBankFeeIncludedInCoa
boolean

Is Bank Fee Included In Coa

isCoaRecalculated
boolean

Is Coa Recalculated

isEstimatedAward
boolean

Is Estimated Award

isLocked
boolean

Is Locked

isReAllocated
boolean

Is Re Allocated

isT4BalanceEvaluated
boolean

Is T4Balance Evaluated

lastInterestDate
string <date-time>

Last Interest Date

lastModifiedDateTime
string <date-time>

Last Modified Date Time

lastModifiedUserId
number <int32>

Last Modified User Id

lastPromNotePrintDate
string <date-time>

Last Prom Note Print Date

lastStatementPrintDate
string <date-time>

Last Statement Print Date

lenderFee
number <double>

Lender Fee

loanAcademicYearEndDate
string <date-time>

Loan Academic Year End Date

loanAcademicYearStartDate
string <date-time>

Loan Academic Year Start Date

loanIdentificationNumber
number <int32>

Loan Identification Number

loanPeriodBeginDate
string <date-time>

Loan Period Begin Date

loanPeriodEndDate
string <date-time>

Loan Period End Date

lockedByUserId
number <int32>

Locked By User Id

nextPaymentDate
string <date-time>

Next Payment Date

note
string

Note

numberPayments
object

Number Payments

paymentAmount
number <double>

Payment Amount

paymentDay
object

Payment Day

paymentFrequency
object

Payment Frequency

paymentPlanId
number <int32>

Payment Plan Id

paymentPlanTermId
number <int32>

Payment Plan Term Id

principalBalance
number <double>

Principal Balance

promNoteDocumentId
number <int32>

Prom Note Document Id

rep9010CollectionRate
number <double>

Rep9010Collection Rate

rep9010DiscountRate
number <double>

Rep9010Discount Rate

rep9010NumberOfYears
number <double>

Rep9010Number Of Years

rowVersion
string
secondaryInterestRate
number <double>

Secondary Interest Rate

secondaryInterestRateEffectiveDate
string <date-time>

Secondary Interest Rate Effective Date

servicerLendingInstitutionId
number <int32>

Servicer Lending Institution Id

servicerRecordIdentifier
string

Servicer Record Identifier

source
string

Source

status
string

Status

studentAcademicYearId
number <int32>

Student Academic Year Id

studentAwardNonTitleIvRuleId
number <int32>

Student Award Non Title Iv Rule Id

studentAwardPellId
number <int32>

Student Award Pell Id

studentBankAccountId
number <int32>

Student Bank Account Id

studentCreditCardId
number <int32>

Student Credit Card Id

studentEnrollmentPeriodId
number <int32>

Student Enrollment Period Id

studentId
number <int32>

Student Id

studentLoanPeriodId
number <int32>

Student Loan Period Id

studentRelationshipAddressId
number <int32>

Student Relationship Address Id

totalAmountPaid
number <double>

Total Amount Paid

webAlertNotification
string

Web Alert Notification

Array of objects (cmc-nexus-financialAid-entities-studentAwardLoanEntity)
originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Delete Approve Disbursements Batch

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-deleteapprovedisbursementsbatch-request-payload)
approveDisbursementBatchId
number <int32>
isCommonLineBatch
boolean

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Delete Student Award Student Payment

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-deletestudentawardstudentpayment-request-payload)
studentAwardId
number <int32>
preventString
string

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Student Award

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-get-request-payload)
id
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Direct Loan Coa

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-getdirectloancoa-request-payload)
studentId
number <int32>
studentAcademicYearId
number <int32>
startDate
string <date-time>
endDate
string <date-time>
loanAwardYear
string

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Eligibility Review Disbursement

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-geteligibilityreviewdisbursement-request-payload)
isFilterOnPaidDisbursement
boolean
campusList
Array of numbers <int32> [ items <int32 > ]
awardYearList
Array of strings
schoolStatusList
Array of numbers <int32> [ items <int32 > ]
termList
Array of numbers <int32> [ items <int32 > ]
fundSourceList
Array of numbers <int32> [ items <int32 > ]
disbursementFromDate
string <date-time>
disbursementToDate
string <date-time>
batchNumberList
Array of numbers <int32> [ items <int32 > ]
batchFromDate
string <date-time>
batchToDate
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Gross Amount

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-getgrossamount-request-payload)
studentAcademicYearId
number <int32>
awardYear
string
studentEnrollmentPeriodId
number <int32>
studentId
number <int32>
fundSourceId
number <int32>
isDdVeteran
boolean
isAdditionalEligibilityValidation
boolean
studentAwardId
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Loan Period Details

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-getloanperioddetails-request-payload)
academicYearId
number <int32>
awardYear
string
enrollmentPeriodId
number <int32>
isDoNotUsePaymentPeriods
boolean
studentEnrollmentPeriodId
number <int32>
studentId
number <int32>
fundSourceType
string
isCreateLoanPeriod
boolean

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Print Statements Selection

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-getprintstatementsselection-request-payload)
studentId
number <int32>
campusId
string
note
string
closeDate
string
beginStartDate
string
endStartDate
string
balanceSource
string
accountBalance
string
principalBalance
string
interestBalance
string
paymentCoupon
string
printIdentifier
number <int32>
campusGroupId
number <int32>
schoolStatusIdList
Array of numbers <int32> [ items <int32 > ]
shiftIdList
Array of numbers <int32> [ items <int32 > ]
programVersionIdList
Array of numbers <int32> [ items <int32 > ]
programVersionExists
string
statusExists
string
shiftExists
string
isExcludeAutoDraftStudents
boolean
truthInLending
string
workStationIdentifier
string

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Student Award List

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-getstudentawardlist-request-payload)
campusesIds
string
fundSourcesIds
string
schoolStatusIds
string
packagingStatusIds
string
lowLoanPeriodStart
string
highLoanPeriodStart
string
lowLoanPeriodEnd
string
highLoanPeriodEnd
string
lowAwardNoticeDate
string
highAwardNoticeDate
string
lowPackagingDate
string
highPackagingDate
string
lowDisbdate
string
highDisbDate
string
advisorStaffID
number <int32>
userID
number <int32>
includeEstimatedAward
boolean

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Title IVCredit Balance Calculation

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-gettitleivcreditbalancecalculation-request-payload)
isToolAction
boolean
isCreditBalance
boolean
isNoWaiver
boolean
isStudentCrWaiver
boolean
isParCrWaiver
boolean
isStudentT4Waiver
boolean
isParT4Waiver
boolean
schoolStatusIdList
Array of numbers <int32> [ items <int32 > ]
campusGroupIdList
Array of numbers <int32> [ items <int32 > ]
systemSchoolStatusCategoryIdList
Array of numbers <int32> [ items <int32 > ]
programVersionIdList
Array of numbers <int32> [ items <int32 > ]
studentAcademicYearDate1
string
studentAcademicYearDate2
string
studentAcademicYearDate3
string
studentAcademicYearDate4
string
awardYear
string

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Move Student Award Servicer Id

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-movestudentawardservicerid-request-payload)
oldStudentAwardId
number <int32>
newStudentAwardId
number <int32>
servicerRecordId
string

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Override Cod Origination

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-overridecodorigination-request-payload)
recordId
number <int32>
fundSource
string
awardYear
string
isOriginationChangeUpdated
boolean
originationDate
string <date-time>
amount
number <double>
status
string
atsStatus
string
atsLinkIndicator
string
atsElectronicIndicator
string
promNoteStatus
string
mpnType
string
mpnLinkIndicator
string
creditDecisionStatus
string
Array of objects (cmc-nexus-financialAid-services-originationChangeDetail)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Post Work Study Disbursements

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-postworkstudydisbursements-request-payload)
campusId
number <int32>
fundSourceId
number <int32>
transactionDate
string <date-time>
Array of objects (cmc-nexus-financialAid-entities-paidDisbursementEntity)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Proceed Award

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-proceedaward-request-payload)
studentAwardId
number <int32>
studentId
number <int32>
awardYear
string
studentEnrollmentPeriodId
number <int32>
academicYearId
number <int32>
fundSourceId
number <int32>
campusId
number <int32>
grossAmount
number <double>
costOfAttendence
number <double>
packagedEfc
number <double>
efcOffset
number <double>
status
string
fundSourceCode
string
disbursementScheduleId
number <int32>
roundDisbs
boolean
allowCrossOverPell
boolean
isEligibleForDirLoan
boolean
needBasedGrossAmount
number <double>
currentNeedBaseAmount
number <double>
nonNeedBasedGrossAmount
number <double>
currentNonNeedBaseAmount
number <double>
typeOfAid
string
isFsaIneligibilityCode
boolean
isLoanExist
boolean
isNeedBased
boolean
isUpdateDependencyStatus
boolean
isEnrollStatus
boolean
isAdJustAmount
boolean
isAlternativePell
boolean
pellPaidEfc
number <double>
isAdditionalEligibility
boolean

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Reassign Student Award

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-reassignstudentaward-request-payload)
studentAcademicYearId
number <int32>
studentAwardIds
object
fundSourceIds
object
isAdmin
boolean

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Remove Disbursements

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-removedisbursements-request-payload)
batchId
number <int32>
isRemoveAllUnApprovedDisbursements
boolean
Array of objects (cmc-nexus-financialAid-entities-disbursementBatchDetailEntity)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save Student Award

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-save-request-payload)
updatePellOriginationStatus
boolean
updateCodGrantOriginationStatus
boolean
pellHasDisbursementGrantInRejectedStatus
boolean
codGrantHasDisbursementGrantInRejectedStatus
boolean
continuePellDisbursementGrantInRejectedStatus
boolean
continueCodGrantDisbursementGrantInRejectedStatus
boolean
Array of objects (cmc-nexus-financialAid-entities-scheduledDisbursementEntity)
Array of objects (cmc-nexus-financialAid-entities-pellSpecialDisbursementEntity)
Array of objects (cmc-nexus-financialAid-entities-studentAcademicYearPaymentPeriodEntity)
Array of objects (cmc-nexus-financialAid-entities-paidDisbursementEntity)
Array of objects (cmc-nexus-financialAid-entities-refundEntity)
object (cmc-nexus-financialAid-entities-studentAwardLoanEntity)
object (cmc-nexus-financialAid-entities-studentAwardPellEntity)
object (cmc-nexus-financialAid-entities-studentAcademicYearEntity)
costOfAttendance
number <double>
efc
number <double>
needBasedAmountPackaged
number <double>
nonNeedBasedAmountPackaged
number <double>
needBasedGrossAmount
number <double>
nonNeedBasedGrossAmount
number <double>
isLimitPackagingToCoa
boolean
isRecalculatedEfc
boolean
studentAcademicYearSequence
number <int32>
campusId
number <int32>
isScheduledAmountMisMatchWithDisbursementAmount
boolean
continueScheduledAmountMisMatchWithDisbursementAmount
boolean
preventAwardingWhenAuthorizationNotExpended
boolean
continueAwardingWhenAuthorizationNotExpended
boolean
glAuthorizationId
number <int32>
isPreventSaveForGrant
boolean
isStateAdd
boolean
recalculateCashPlan
boolean
updateAmountPackagedWithPrincipal
boolean
isAdjustPackageInEditMode
boolean
adjustPackagedAmountMessage
string
paymentAmountSplit
number <double>
isPaymentAmountSplitBasedOnNoOfPayments
boolean
allowOriginationChanged
boolean
isAllowOriginationChanged
boolean
isOriginationStatusReadyToSend
boolean
originationStatusReadyToSend
boolean
grossAmount
number <double>
originalGrossAmount
number <double>
isAddlEligibilityIndicator
boolean
resetGrossAmount
boolean
lessGrossAmount
boolean
isGrossAmountExeed
boolean
grossAmountExeed
boolean
isCampusAutoUpdatePellOriginationStatus
boolean
isAllowInformtionNotChange
boolean
isAllowInformtionChange
boolean
allowInformtionChange
boolean
isAllowAdvisor
boolean
allowAdvisor
boolean
isCommitLevelAmountChange
boolean
commitLevelAmountChange
boolean
isPreventPackaging
boolean
refundedGrossAmount
number <double>
netAmount
number <double>
isStudentLoanNetAmountNotEqualToDisbursementNetAmount
boolean
continueStudentLoanNetAmountNotEqualToDisbursementNetAmount
boolean
isStudentLoanPaidDisbursementBankFeeMoreThanLoanBankFee
boolean
continueStudentLoanPaidDisbursementBankFeeMoreThanLoanBankFee
boolean
isStudentLoanPaidDisbursementBankFeeLessThanLoanBankFee
boolean
continueStudentLoanPaidDisbursementBankFeeLessThanLoanBankFee
boolean
isAddBankFeeToCostOfAttendance
boolean
isAddBankFeeToCostOfAttendanceUserConfirmationIsYes
boolean
continueAfterConfirmationForAddBankFeeToCostOfAttendance
boolean
isStudentLoanReadyToSendValidationExists
boolean
isStudentLoanPaidDisbursementExists
boolean
disbursedAmount
number <double>
refundedAmount
number <double>
expectedAmount
number <double>
totalNetAmount
number <double>
originalAmountPackaged
number <double>
readyToSendValidationMessages
Array of strings
isUsePaymentPeriod
boolean
isSaveNonTitleIvPaymentPeriods
boolean
object (cmc-nexus-common-entities-studentRelationshipAddressEntity)
object (cmc-nexus-common-entities-studentRelationshipAddressEntity)
Array of objects (cmc-nexus-financialAid-entities-studentAwardLoanChangeEntity)
isLoanDetailsChanged
boolean
isUseBorrowerSsn
boolean
isDirectLoanReCalculate
boolean
directLoanReCalculate
boolean
isEarlyDisbursementRulesFsaHandbook
boolean
earlyDisbursementRulesFsaHandbook
boolean
isDisbursmentAmountMissMatch
boolean
disbursmentAmountMissMatch
boolean
isAllowApprove
boolean
allowApprove
boolean
isMaxLimit
boolean
maxLimit
boolean
isAdjustLoanEndDate
boolean
adjustLoanEndDate
boolean
progVerTermAssocExist
boolean
isProgVerTermAssocExist
boolean
countDisburseMentAmount
number <double>
object (cmc-nexus-financialAid-entities-codGrantOriginationEntity)
Array of objects (cmc-nexus-financialAid-entities-codGrantDisbursementEntity)
isMultipleTeachGrant
boolean
isSavingAwardInCanceledStatusCodGrant
boolean
continueSavingAwardInCanceledStatusCodGrant
boolean
isChangingOriginationStatusCodGrant
boolean
isChangingOriginationStatusCodGrantCanceledByUser
boolean
continueChangingOriginationStatusCodGrant
boolean
isCodGrantAmountPackagedGreaterThanOriginationAmountAllowed
boolean
isCodGrantAmountPackagedGreaterThanOriginationAmount
boolean
continueSaveTeacherExpertIndicator
boolean
isTeacherExpertIndicator
boolean
isNonTitleIvPaymentPeriodCreated
boolean
isCodGrantIsirOnFile
boolean
isCodGrantTotalDisbAmtNotEqualToAwardAmount
boolean
continueCodGrantTotalDisbAmtNotEqualToAwardAmount
boolean
isGrossAmontExceeded
boolean
continueGrossAmontExceeded
boolean
isCodGrantChangesToGradeLevel
boolean
continueCodGrantChangesToGradeLevel
boolean
isCampusAutoUpdateOriginationStatusCodGrant
boolean
graduateStudentsNoLongerEligible
boolean
isGraduateStudentsNoLongerEligible
boolean
isirMustFileBeforeLoan
boolean
isIsirMustFileBeforeLoan
boolean
isRequiredField
boolean
requiredField
boolean
isValidateSpecialProgramIsN
boolean
validateSpecialProgramIsN
boolean
isValidateSpecialProgramIsNotABNPT
boolean
validateSpecialProgramIsNotABNPT
boolean
isValidateSpecialProgramIsNotABN
boolean
validateSpecialProgramIsNotABN
boolean
isValidateSpecialProgramIsNotABUN
boolean
validateSpecialProgramIsNotABUN
boolean
isAllowOriginationWithEstAward
boolean
allowOriginationWithEstAward
boolean
isMaxLimitForSubDirSub
boolean
maxLimitForSubDirSub
boolean
Array of objects (cmc-nexus-financialAid-entities-studentAcademicYearPaymentPeriodEntity)
remainingNeed
number <double>
addAgencyToStudentAgency
boolean
isAdjustPackagedAmountHasNotPreventAwardWarningMessage
boolean
continueAdjustPackagedAmountHasNotPreventAwardWarningMessage
boolean
adjustPackagedAmountNotPreventAwardWarningMessage
string
isLoanBeginDateChanged
boolean
isLoanEndDateChanged
boolean
originalLoanPeriodBeginDate
string <date-time>
originalLoanPeriodEndDate
string <date-time>
isPellExists
boolean
id
number <int32>

Id

accruedInterestAmount
number <double>

Accrued Interest Amount

agencyBranchId
number <int32>

Agency Branch Id

amountCanceled
number <double>

Amount Canceled

amountDisbursed
number <double>

Amount Disbursed

amountPackaged
number <double>

Amount Packaged

amountRefunded
number <double>

Amount Refunded

applicationReceivedDate
string <date-time>

Application Received Date

applicationSentDate
string <date-time>

Application Sent Date

awardLevelAmount
number <double>

Award Level Amount

awardYear
string

Award Year

batchPackagingProcessId
number <int32>

Batch Packaging Process Id

calculationDate
string <date-time>

Calculation Date

codGrantOriginationId
number <int32>

Cod Grant Origination Id

createdByUserId
number <int32>

Created By User Id

createdDateTime
string <date-time>

Created Date Time

creditCardEffectiveDate
string <date-time>

Credit Card Effective Date

downPaymentAmount
number <double>

Down Payment Amount

effectiveDate
string <date-time>

Effective Date

emailNotification
string

Email Notification

faLenderId
number <int32>

Fa Lender Id

firstPaymentDate
string <date-time>

First Payment Date

fundSourceId
number <int32>

Fund Source Id

guarantorLendingInstitutionId
number <int32>

Guarantor Lending Institution Id

interestBalance
number <double>

Interest Balance

interestOnlyUntilDate
string <date-time>

Interest Only Until Date

interestRate
number <double>

Interest Rate

interestRebateAmount
number <double>

Interest Rebate Amount

isAutoCredit
boolean

Is Auto Credit

isAutoDraft
boolean

Is Auto Draft

isAxLinkedFws
boolean

Is Ax Linked Fws

isBankFeeIncludedInCoa
boolean

Is Bank Fee Included In Coa

isCoaRecalculated
boolean

Is Coa Recalculated

isEstimatedAward
boolean

Is Estimated Award

isLocked
boolean

Is Locked

isReAllocated
boolean

Is Re Allocated

isT4BalanceEvaluated
boolean

Is T4Balance Evaluated

lastInterestDate
string <date-time>

Last Interest Date

lastModifiedDateTime
string <date-time>

Last Modified Date Time

lastModifiedUserId
number <int32>

Last Modified User Id

lastPromNotePrintDate
string <date-time>

Last Prom Note Print Date

lastStatementPrintDate
string <date-time>

Last Statement Print Date

lenderFee
number <double>

Lender Fee

loanAcademicYearEndDate
string <date-time>

Loan Academic Year End Date

loanAcademicYearStartDate
string <date-time>

Loan Academic Year Start Date

loanIdentificationNumber
number <int32>

Loan Identification Number

loanPeriodBeginDate
string <date-time>

Loan Period Begin Date

loanPeriodEndDate
string <date-time>

Loan Period End Date

lockedByUserId
number <int32>

Locked By User Id

nextPaymentDate
string <date-time>

Next Payment Date

note
string

Note

numberPayments
object

Number Payments

paymentAmount
number <double>

Payment Amount

paymentDay
object

Payment Day

paymentFrequency
object

Payment Frequency

paymentPlanId
number <int32>

Payment Plan Id

paymentPlanTermId
number <int32>

Payment Plan Term Id

principalBalance
number <double>

Principal Balance

promNoteDocumentId
number <int32>

Prom Note Document Id

rep9010CollectionRate
number <double>

Rep9010Collection Rate

rep9010DiscountRate
number <double>

Rep9010Discount Rate

rep9010NumberOfYears
number <double>

Rep9010Number Of Years

rowVersion
string
secondaryInterestRate
number <double>

Secondary Interest Rate

secondaryInterestRateEffectiveDate
string <date-time>

Secondary Interest Rate Effective Date

servicerLendingInstitutionId
number <int32>

Servicer Lending Institution Id

servicerRecordIdentifier
string

Servicer Record Identifier

source
string

Source

status
string

Status

studentAcademicYearId
number <int32>

Student Academic Year Id

studentAwardNonTitleIvRuleId
number <int32>

Student Award Non Title Iv Rule Id

studentAwardPellId
number <int32>

Student Award Pell Id

studentBankAccountId
number <int32>

Student Bank Account Id

studentCreditCardId
number <int32>

Student Credit Card Id

studentEnrollmentPeriodId
number <int32>

Student Enrollment Period Id

studentId
number <int32>

Student Id

studentLoanPeriodId
number <int32>

Student Loan Period Id

studentRelationshipAddressId
number <int32>

Student Relationship Address Id

totalAmountPaid
number <double>

Total Amount Paid

webAlertNotification
string

Web Alert Notification

Array of objects (cmc-nexus-financialAid-entities-studentAwardLoanEntity)
originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save Disclosure Print History

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-savedisclosureprinthistory-request-payload)
faStudentAidID
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save New Student Award

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-savenew-request-payload)
updatePellOriginationStatus
boolean
updateCodGrantOriginationStatus
boolean
pellHasDisbursementGrantInRejectedStatus
boolean
codGrantHasDisbursementGrantInRejectedStatus
boolean
continuePellDisbursementGrantInRejectedStatus
boolean
continueCodGrantDisbursementGrantInRejectedStatus
boolean
Array of objects (cmc-nexus-financialAid-entities-scheduledDisbursementEntity)
Array of objects (cmc-nexus-financialAid-entities-pellSpecialDisbursementEntity)
Array of objects (cmc-nexus-financialAid-entities-studentAcademicYearPaymentPeriodEntity)
Array of objects (cmc-nexus-financialAid-entities-paidDisbursementEntity)
Array of objects (cmc-nexus-financialAid-entities-refundEntity)
object (cmc-nexus-financialAid-entities-studentAwardLoanEntity)
object (cmc-nexus-financialAid-entities-studentAwardPellEntity)
object (cmc-nexus-financialAid-entities-studentAcademicYearEntity)
costOfAttendance
number <double>
efc
number <double>
needBasedAmountPackaged
number <double>
nonNeedBasedAmountPackaged
number <double>
needBasedGrossAmount
number <double>
nonNeedBasedGrossAmount
number <double>
isLimitPackagingToCoa
boolean
isRecalculatedEfc
boolean
studentAcademicYearSequence
number <int32>
campusId
number <int32>
isScheduledAmountMisMatchWithDisbursementAmount
boolean
continueScheduledAmountMisMatchWithDisbursementAmount
boolean
preventAwardingWhenAuthorizationNotExpended
boolean
continueAwardingWhenAuthorizationNotExpended
boolean
glAuthorizationId
number <int32>
isPreventSaveForGrant
boolean
isStateAdd
boolean
recalculateCashPlan
boolean
updateAmountPackagedWithPrincipal
boolean
isAdjustPackageInEditMode
boolean
adjustPackagedAmountMessage
string
paymentAmountSplit
number <double>
isPaymentAmountSplitBasedOnNoOfPayments
boolean
allowOriginationChanged
boolean
isAllowOriginationChanged
boolean
isOriginationStatusReadyToSend
boolean
originationStatusReadyToSend
boolean
grossAmount
number <double>
originalGrossAmount
number <double>
isAddlEligibilityIndicator
boolean
resetGrossAmount
boolean
lessGrossAmount
boolean
isGrossAmountExeed
boolean
grossAmountExeed
boolean
isCampusAutoUpdatePellOriginationStatus
boolean
isAllowInformtionNotChange
boolean
isAllowInformtionChange
boolean
allowInformtionChange
boolean
isAllowAdvisor
boolean
allowAdvisor
boolean
isCommitLevelAmountChange
boolean
commitLevelAmountChange
boolean
isPreventPackaging
boolean
refundedGrossAmount
number <double>
netAmount
number <double>
isStudentLoanNetAmountNotEqualToDisbursementNetAmount
boolean
continueStudentLoanNetAmountNotEqualToDisbursementNetAmount
boolean
isStudentLoanPaidDisbursementBankFeeMoreThanLoanBankFee
boolean
continueStudentLoanPaidDisbursementBankFeeMoreThanLoanBankFee
boolean
isStudentLoanPaidDisbursementBankFeeLessThanLoanBankFee
boolean
continueStudentLoanPaidDisbursementBankFeeLessThanLoanBankFee
boolean
isAddBankFeeToCostOfAttendance
boolean
isAddBankFeeToCostOfAttendanceUserConfirmationIsYes
boolean
continueAfterConfirmationForAddBankFeeToCostOfAttendance
boolean
isStudentLoanReadyToSendValidationExists
boolean
isStudentLoanPaidDisbursementExists
boolean
disbursedAmount
number <double>
refundedAmount
number <double>
expectedAmount
number <double>
totalNetAmount
number <double>
originalAmountPackaged
number <double>
readyToSendValidationMessages
Array of strings
isUsePaymentPeriod
boolean
isSaveNonTitleIvPaymentPeriods
boolean
object (cmc-nexus-common-entities-studentRelationshipAddressEntity)
object (cmc-nexus-common-entities-studentRelationshipAddressEntity)
Array of objects (cmc-nexus-financialAid-entities-studentAwardLoanChangeEntity)
isLoanDetailsChanged
boolean
isUseBorrowerSsn
boolean
isDirectLoanReCalculate
boolean
directLoanReCalculate
boolean
isEarlyDisbursementRulesFsaHandbook
boolean
earlyDisbursementRulesFsaHandbook
boolean
isDisbursmentAmountMissMatch
boolean
disbursmentAmountMissMatch
boolean
isAllowApprove
boolean
allowApprove
boolean
isMaxLimit
boolean
maxLimit
boolean
isAdjustLoanEndDate
boolean
adjustLoanEndDate
boolean
progVerTermAssocExist
boolean
isProgVerTermAssocExist
boolean
countDisburseMentAmount
number <double>
object (cmc-nexus-financialAid-entities-codGrantOriginationEntity)
Array of objects (cmc-nexus-financialAid-entities-codGrantDisbursementEntity)
isMultipleTeachGrant
boolean
isSavingAwardInCanceledStatusCodGrant
boolean
continueSavingAwardInCanceledStatusCodGrant
boolean
isChangingOriginationStatusCodGrant
boolean
isChangingOriginationStatusCodGrantCanceledByUser
boolean
continueChangingOriginationStatusCodGrant
boolean
isCodGrantAmountPackagedGreaterThanOriginationAmountAllowed
boolean
isCodGrantAmountPackagedGreaterThanOriginationAmount
boolean
continueSaveTeacherExpertIndicator
boolean
isTeacherExpertIndicator
boolean
isNonTitleIvPaymentPeriodCreated
boolean
isCodGrantIsirOnFile
boolean
isCodGrantTotalDisbAmtNotEqualToAwardAmount
boolean
continueCodGrantTotalDisbAmtNotEqualToAwardAmount
boolean
isGrossAmontExceeded
boolean
continueGrossAmontExceeded
boolean
isCodGrantChangesToGradeLevel
boolean
continueCodGrantChangesToGradeLevel
boolean
isCampusAutoUpdateOriginationStatusCodGrant
boolean
graduateStudentsNoLongerEligible
boolean
isGraduateStudentsNoLongerEligible
boolean
isirMustFileBeforeLoan
boolean
isIsirMustFileBeforeLoan
boolean
isRequiredField
boolean
requiredField
boolean
isValidateSpecialProgramIsN
boolean
validateSpecialProgramIsN
boolean
isValidateSpecialProgramIsNotABNPT
boolean
validateSpecialProgramIsNotABNPT
boolean
isValidateSpecialProgramIsNotABN
boolean
validateSpecialProgramIsNotABN
boolean
isValidateSpecialProgramIsNotABUN
boolean
validateSpecialProgramIsNotABUN
boolean
isAllowOriginationWithEstAward
boolean
allowOriginationWithEstAward
boolean
isMaxLimitForSubDirSub
boolean
maxLimitForSubDirSub
boolean
Array of objects (cmc-nexus-financialAid-entities-studentAcademicYearPaymentPeriodEntity)
remainingNeed
number <double>
addAgencyToStudentAgency
boolean
isAdjustPackagedAmountHasNotPreventAwardWarningMessage
boolean
continueAdjustPackagedAmountHasNotPreventAwardWarningMessage
boolean
adjustPackagedAmountNotPreventAwardWarningMessage
string
isLoanBeginDateChanged
boolean
isLoanEndDateChanged
boolean
originalLoanPeriodBeginDate
string <date-time>
originalLoanPeriodEndDate
string <date-time>
isPellExists
boolean
id
number <int32>

Id

accruedInterestAmount
number <double>

Accrued Interest Amount

agencyBranchId
number <int32>

Agency Branch Id

amountCanceled
number <double>

Amount Canceled

amountDisbursed
number <double>

Amount Disbursed

amountPackaged
number <double>

Amount Packaged

amountRefunded
number <double>

Amount Refunded

applicationReceivedDate
string <date-time>

Application Received Date

applicationSentDate
string <date-time>

Application Sent Date

awardLevelAmount
number <double>

Award Level Amount

awardYear
string

Award Year

batchPackagingProcessId
number <int32>

Batch Packaging Process Id

calculationDate
string <date-time>

Calculation Date

codGrantOriginationId
number <int32>

Cod Grant Origination Id

createdByUserId
number <int32>

Created By User Id

createdDateTime
string <date-time>

Created Date Time

creditCardEffectiveDate
string <date-time>

Credit Card Effective Date

downPaymentAmount
number <double>

Down Payment Amount

effectiveDate
string <date-time>

Effective Date

emailNotification
string

Email Notification

faLenderId
number <int32>

Fa Lender Id

firstPaymentDate
string <date-time>

First Payment Date

fundSourceId
number <int32>

Fund Source Id

guarantorLendingInstitutionId
number <int32>

Guarantor Lending Institution Id

interestBalance
number <double>

Interest Balance

interestOnlyUntilDate
string <date-time>

Interest Only Until Date

interestRate
number <double>

Interest Rate

interestRebateAmount
number <double>

Interest Rebate Amount

isAutoCredit
boolean

Is Auto Credit

isAutoDraft
boolean

Is Auto Draft

isAxLinkedFws
boolean

Is Ax Linked Fws

isBankFeeIncludedInCoa
boolean

Is Bank Fee Included In Coa

isCoaRecalculated
boolean

Is Coa Recalculated

isEstimatedAward
boolean

Is Estimated Award

isLocked
boolean

Is Locked

isReAllocated
boolean

Is Re Allocated

isT4BalanceEvaluated
boolean

Is T4Balance Evaluated

lastInterestDate
string <date-time>

Last Interest Date

lastModifiedDateTime
string <date-time>

Last Modified Date Time

lastModifiedUserId
number <int32>

Last Modified User Id

lastPromNotePrintDate
string <date-time>

Last Prom Note Print Date

lastStatementPrintDate
string <date-time>

Last Statement Print Date

lenderFee
number <double>

Lender Fee

loanAcademicYearEndDate
string <date-time>

Loan Academic Year End Date

loanAcademicYearStartDate
string <date-time>

Loan Academic Year Start Date

loanIdentificationNumber
number <int32>

Loan Identification Number

loanPeriodBeginDate
string <date-time>

Loan Period Begin Date

loanPeriodEndDate
string <date-time>

Loan Period End Date

lockedByUserId
number <int32>

Locked By User Id

nextPaymentDate
string <date-time>

Next Payment Date

note
string

Note

numberPayments
object

Number Payments

paymentAmount
number <double>

Payment Amount

paymentDay
object

Payment Day

paymentFrequency
object

Payment Frequency

paymentPlanId
number <int32>

Payment Plan Id

paymentPlanTermId
number <int32>

Payment Plan Term Id

principalBalance
number <double>

Principal Balance

promNoteDocumentId
number <int32>

Prom Note Document Id

rep9010CollectionRate
number <double>

Rep9010Collection Rate

rep9010DiscountRate
number <double>

Rep9010Discount Rate

rep9010NumberOfYears
number <double>

Rep9010Number Of Years

rowVersion
string
secondaryInterestRate
number <double>

Secondary Interest Rate

secondaryInterestRateEffectiveDate
string <date-time>

Secondary Interest Rate Effective Date

servicerLendingInstitutionId
number <int32>

Servicer Lending Institution Id

servicerRecordIdentifier
string

Servicer Record Identifier

source
string

Source

status
string

Status

studentAcademicYearId
number <int32>

Student Academic Year Id

studentAwardNonTitleIvRuleId
number <int32>

Student Award Non Title Iv Rule Id

studentAwardPellId
number <int32>

Student Award Pell Id

studentBankAccountId
number <int32>

Student Bank Account Id

studentCreditCardId
number <int32>

Student Credit Card Id

studentEnrollmentPeriodId
number <int32>

Student Enrollment Period Id

studentId
number <int32>

Student Id

studentLoanPeriodId
number <int32>

Student Loan Period Id

studentRelationshipAddressId
number <int32>

Student Relationship Address Id

totalAmountPaid
number <double>

Total Amount Paid

webAlertNotification
string

Web Alert Notification

Array of objects (cmc-nexus-financialAid-entities-studentAwardLoanEntity)
originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save Print Disclosure Date

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-saveprintdisclosuredate-request-payload)
studentAwardId
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save Tsm Review

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-savetsmreview-request-payload)
Array of objects (cmc-nexus-financialAid-services-tsmReviewAlertRecord)
Array of objects (cmc-nexus-financialAid-services-tsmReviewErrorAckRecord)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Servicer Auto Approve Disbursement Batch Schedule Refunds

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-servicerautoapprovedisbursementbatchschedulerefunds-request-payload)
Array of objects (cmc-nexus-financialAid-services-servicerDisbursementScheduleRefunds)
campusId
number <int32>
batchId
number <int32>
faExportImportFileid
number <int32>
isRequiredToCloseBatch
boolean

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Servicer Export Add Drop

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-servicerexportadddrop-request-payload)
campusGroupId
number <int32>
extractDate
string <date-time>
globalSchoolId
string
termId
Array of numbers <int32> [ items <int32 > ]
campusId
number <int32>
Array of objects (cmc-nexus-financialAid-services-servicerExportAddDropList)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Servicer Export Pre Pull

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-servicerexportprepull-request-payload)
campusGroupId
number <int32>
extractDate
string <date-time>
globalSchoolId
string
termId
Array of numbers <int32> [ items <int32 > ]
futureDate
string <date-time>
fileType
string
campusId
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Servicer Export Weekly Extract

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-servicerexportweeklyextract-request-payload)
campusGroupId
number <int32>
extractDate
string <date-time>
globalSchoolId
string
termId
Array of numbers <int32> [ items <int32 > ]
campusId
number <int32>
includeFuturesUpTo
string <date-time>
includeNotificationOfPaymentRecalculation
boolean
Array of objects (cmc-nexus-financialAid-services-servicerExportWeeklyList)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Update Award Information

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-updateawardinformation-request-payload)
selectedAcademicYearId
number <int32>
selectedEnrollmentPeriodId
number <int32>
selectedAwardYear
string
selectedLoanPeriodId
number <int32>
selectedActionId
number <int32>
continueForOriginatedLoan
boolean
studentId
number <int32>
studentAwardDetails
Array of objects

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Validate Servicer Global

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentaward-validateservicerglobal-request-payload)
campusGroupId
number <int32>
extractDate
string <date-time>
globalSchoolId
string
termId
Array of numbers <int32> [ items <int32 > ]
exportBatchId
number <int32>
batchId
string
campusId
number <int32>
includeFuturesUpTo
string <date-time>
includeNotificationOfPaymentRecalculation
boolean
fileType
string

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

DirectLoanConfigurationSetting

Get Direct Loan Configuration Setting

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-directloanconfigurationsetting-getdirectloanconfigurationsetting-request-payload)
directLoanIdentifier
string

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save Direct Loan Configuration Setting

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-directloanconfigurationsetting-save-request-payload)
object (cmc-nexus-financialAid-entities-directLoanConfigurationSettingEntity)
id
required
number <int32>

Id

createdDateTime
string <date-time>

Created Date Time

directLoanIdentifier
required
string

Direct Loan Identifier

disbursementDateDaysAdded
object

Disbursement Date Days Added

faaName
string

Faa Name

interestRebatePct02
required
number <double>

Interest Rebate Pct02

interestRebatePct03
required
number <double>

Interest Rebate Pct03

interestRebatePct04
required
number <double>

Interest Rebate Pct04

interestRebatePct05
required
number <double>

Interest Rebate Pct05

interestRebatePct06
required
number <double>

Interest Rebate Pct06

interestRebatePct07
required
number <double>

Interest Rebate Pct07

interestRebatePct08
required
number <double>

Interest Rebate Pct08

isDirecrLoanUsed05
boolean

Is Direcr Loan Used05

isDirectLoanUsed
boolean

Is Direct Loan Used

isDirectLoanUsed00
boolean

Is Direct Loan Used00

isDirectLoanUsed01
boolean

Is Direct Loan Used01

isDirectLoanUsed02
boolean

Is Direct Loan Used02

isDirectLoanUsed03
boolean

Is Direct Loan Used03

isDirectLoanUsed04
boolean

Is Direct Loan Used04

isDirectLoanUsed06
boolean

Is Direct Loan Used06

isDirectLoanUsed07
boolean

Is Direct Loan Used07

isDirectLoanUsed08
boolean

Is Direct Loan Used08

isDirectLoanUsed09
boolean

Is Direct Loan Used09

isDirectLoanUsed10
boolean

Is Direct Loan Used10

isDirectLoanUsed11
boolean

Is Direct Loan Used11

isDirectLoanUsed12
boolean

Is Direct Loan Used12

isDirectLoanUsed13
boolean

Is Direct Loan Used13

isDirectLoanUsed14
boolean

Is Direct Loan Used14

isDirectLoanUsed15
boolean

Is Direct Loan Used15

isDirectLoanUsed16
boolean

Is Direct Loan Used16

isDirectLoanUsed17
boolean

Is Direct Loan Used17

isDirectLoanUsed18
boolean

Is Direct Loan Used18

isDirectLoanUsed19
boolean

Is Direct Loan Used19

isDirectLoanUsed20
boolean

Is Direct Loan Used20

isDirectLoanUsed21
boolean

Is Direct Loan Used21

isDirectLoanUsed22
boolean

Is Direct Loan Used22

isDirectLoanUsed23
boolean

Is Direct Loan Used23

isDisbDateAdustmentAutoCreated
boolean

Is Disb Date Adustment Auto Created

isDisclosurePrintedAtLoc
boolean

Is Disclosure Printed At Loc

isDrawDownRequestAllowed
boolean

Is Draw Down Request Allowed

isLpAutoOrigOnStuStatusOrT4Ref
boolean

Is Lp Auto Orig On Stu Status Or T4Ref

isMasterPromNoteEnabled
boolean

Is Master Prom Note Enabled

isOriginationChangesAutoCreatedCancelledDisbRefund
boolean

Is Origination Changes Auto Created Cancelled Disb Refund

isOriginationStatusAutoUpdated
boolean

Is Origination Status Auto Updated

isReadyToPayDisbursementsIncluded
boolean

Is Ready To Pay Disbursements Included

isScheduledDisbursementsIncluded
boolean

Is Scheduled Disbursements Included

isSpeOriginationBbayInvalidDate
boolean

Is Spe Origination Bbay Invalid Date

isSpeOriginationChange
boolean

Is Spe Origination Change

lastModifiedDateTime
string <date-time>

Last Modified Date Time

lastModifiedUserId
number <int32>

Last Modified User Id

minimumNumberDisbursements
number <int32>

Minimum Number Disbursements

numberPromNotes
number <int32>

Number Prom Notes

plusFeePct00
required
number <double>

Plus Fee Pct00

plusFeePct01
required
number <double>

Plus Fee Pct01

plusFeePct02
required
number <double>

Plus Fee Pct02

plusFeePct03
required
number <double>

Plus Fee Pct03

plusFeePct04
required
number <double>

Plus Fee Pct04

plusFeePct05
required
number <double>

Plus Fee Pct05

plusFeePct06
required
number <double>

Plus Fee Pct06

plusFeePct07
required
number <double>

Plus Fee Pct07

plusFeePct08
required
number <double>

Plus Fee Pct08

promNotePrintOption
string

Prom Note Print Option

rowVersion
string
speOriginationChangeState
number <int32>

Spe Origination Change State

subFeePct00
required
number <double>

Sub Fee Pct00

subFeePct01
required
number <double>

Sub Fee Pct01

subFeePct02
required
number <double>

Sub Fee Pct02

subFeePct03
required
number <double>

Sub Fee Pct03

subFeePct04
required
number <double>

Sub Fee Pct04

subFeePct05
required
number <double>

Sub Fee Pct05

subFeePct06
required
number <double>

Sub Fee Pct06

subFeePct07
required
number <double>

Sub Fee Pct07

subFeePct08
required
number <double>

Sub Fee Pct08

unsubFeePct00
required
number <double>

Unsub Fee Pct00

unsubFeePct01
required
number <double>

Unsub Fee Pct01

unsubFeePct02
required
number <double>

Unsub Fee Pct02

unsubFeePct03
required
number <double>

Unsub Fee Pct03

unsubFeePct04
required
number <double>

Unsub Fee Pct04

unsubFeePct05
required
number <double>

Unsub Fee Pct05

unsubFeePct06
required
number <double>

Unsub Fee Pct06

unsubFeePct07
required
number <double>

Unsub Fee Pct07

unsubFeePct08
required
number <double>

Unsub Fee Pct08

originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save New Direct Loan Configuration Setting

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-directloanconfigurationsetting-savenew-request-payload)
object (cmc-nexus-financialAid-entities-directLoanConfigurationSettingEntity)
id
required
number <int32>

Id

createdDateTime
string <date-time>

Created Date Time

directLoanIdentifier
required
string

Direct Loan Identifier

disbursementDateDaysAdded
object

Disbursement Date Days Added

faaName
string

Faa Name

interestRebatePct02
required
number <double>

Interest Rebate Pct02

interestRebatePct03
required
number <double>

Interest Rebate Pct03

interestRebatePct04
required
number <double>

Interest Rebate Pct04

interestRebatePct05
required
number <double>

Interest Rebate Pct05

interestRebatePct06
required
number <double>

Interest Rebate Pct06

interestRebatePct07
required
number <double>

Interest Rebate Pct07

interestRebatePct08
required
number <double>

Interest Rebate Pct08

isDirecrLoanUsed05
boolean

Is Direcr Loan Used05

isDirectLoanUsed
boolean

Is Direct Loan Used

isDirectLoanUsed00
boolean

Is Direct Loan Used00

isDirectLoanUsed01
boolean

Is Direct Loan Used01

isDirectLoanUsed02
boolean

Is Direct Loan Used02

isDirectLoanUsed03
boolean

Is Direct Loan Used03

isDirectLoanUsed04
boolean

Is Direct Loan Used04

isDirectLoanUsed06
boolean

Is Direct Loan Used06

isDirectLoanUsed07
boolean

Is Direct Loan Used07

isDirectLoanUsed08
boolean

Is Direct Loan Used08

isDirectLoanUsed09
boolean

Is Direct Loan Used09

isDirectLoanUsed10
boolean

Is Direct Loan Used10

isDirectLoanUsed11
boolean

Is Direct Loan Used11

isDirectLoanUsed12
boolean

Is Direct Loan Used12

isDirectLoanUsed13
boolean

Is Direct Loan Used13

isDirectLoanUsed14
boolean

Is Direct Loan Used14

isDirectLoanUsed15
boolean

Is Direct Loan Used15

isDirectLoanUsed16
boolean

Is Direct Loan Used16

isDirectLoanUsed17
boolean

Is Direct Loan Used17

isDirectLoanUsed18
boolean

Is Direct Loan Used18

isDirectLoanUsed19
boolean

Is Direct Loan Used19

isDirectLoanUsed20
boolean

Is Direct Loan Used20

isDirectLoanUsed21
boolean

Is Direct Loan Used21

isDirectLoanUsed22
boolean

Is Direct Loan Used22

isDirectLoanUsed23
boolean

Is Direct Loan Used23

isDisbDateAdustmentAutoCreated
boolean

Is Disb Date Adustment Auto Created

isDisclosurePrintedAtLoc
boolean

Is Disclosure Printed At Loc

isDrawDownRequestAllowed
boolean

Is Draw Down Request Allowed

isLpAutoOrigOnStuStatusOrT4Ref
boolean

Is Lp Auto Orig On Stu Status Or T4Ref

isMasterPromNoteEnabled
boolean

Is Master Prom Note Enabled

isOriginationChangesAutoCreatedCancelledDisbRefund
boolean

Is Origination Changes Auto Created Cancelled Disb Refund

isOriginationStatusAutoUpdated
boolean

Is Origination Status Auto Updated

isReadyToPayDisbursementsIncluded
boolean

Is Ready To Pay Disbursements Included

isScheduledDisbursementsIncluded
boolean

Is Scheduled Disbursements Included

isSpeOriginationBbayInvalidDate
boolean

Is Spe Origination Bbay Invalid Date

isSpeOriginationChange
boolean

Is Spe Origination Change

lastModifiedDateTime
string <date-time>

Last Modified Date Time

lastModifiedUserId
number <int32>

Last Modified User Id

minimumNumberDisbursements
number <int32>

Minimum Number Disbursements

numberPromNotes
number <int32>

Number Prom Notes

plusFeePct00
required
number <double>

Plus Fee Pct00

plusFeePct01
required
number <double>

Plus Fee Pct01

plusFeePct02
required
number <double>

Plus Fee Pct02

plusFeePct03
required
number <double>

Plus Fee Pct03

plusFeePct04
required
number <double>

Plus Fee Pct04

plusFeePct05
required
number <double>

Plus Fee Pct05

plusFeePct06
required
number <double>

Plus Fee Pct06

plusFeePct07
required
number <double>

Plus Fee Pct07

plusFeePct08
required
number <double>

Plus Fee Pct08

promNotePrintOption
string

Prom Note Print Option

rowVersion
string
speOriginationChangeState
number <int32>

Spe Origination Change State

subFeePct00
required
number <double>

Sub Fee Pct00

subFeePct01
required
number <double>

Sub Fee Pct01

subFeePct02
required
number <double>

Sub Fee Pct02

subFeePct03
required
number <double>

Sub Fee Pct03

subFeePct04
required
number <double>

Sub Fee Pct04

subFeePct05
required
number <double>

Sub Fee Pct05

subFeePct06
required
number <double>

Sub Fee Pct06

subFeePct07
required
number <double>

Sub Fee Pct07

subFeePct08
required
number <double>

Sub Fee Pct08

unsubFeePct00
required
number <double>

Unsub Fee Pct00

unsubFeePct01
required
number <double>

Unsub Fee Pct01

unsubFeePct02
required
number <double>

Unsub Fee Pct02

unsubFeePct03
required
number <double>

Unsub Fee Pct03

unsubFeePct04
required
number <double>

Unsub Fee Pct04

unsubFeePct05
required
number <double>

Unsub Fee Pct05

unsubFeePct06
required
number <double>

Unsub Fee Pct06

unsubFeePct07
required
number <double>

Unsub Fee Pct07

unsubFeePct08
required
number <double>

Unsub Fee Pct08

originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

FaSapStatus

Create Fa Sap Status

Authorizations:
apikey

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Delete Fa Sap Status

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-fasapstatus-delete-request-payload)
Array of objects (cmc-nexus-financialAid-entities-faSapStatusStudentGroupEntity)
id
number <int32>

Id

code
string

Code

createdDateTime
string <date-time>

Created Date Time

excludeFromCalc
boolean

Exclude From Calc

isActive
boolean

Is Active

isSapMet
boolean

Is Sap Met

isSystemCode
boolean

Is System Code

lastModifiedDateTime
string <date-time>

Last Modified Date Time

lastModifiedUserId
number <int32>

Last Modified User Id

name
string

Name

rowVersion
string
originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Fa Sap Status

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-fasapstatus-get-request-payload)
id
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save Fa Sap Status

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-fasapstatus-save-request-payload)
Array of objects (cmc-nexus-financialAid-entities-faSapStatusStudentGroupEntity)
id
number <int32>

Id

code
string

Code

createdDateTime
string <date-time>

Created Date Time

excludeFromCalc
boolean

Exclude From Calc

isActive
boolean

Is Active

isSapMet
boolean

Is Sap Met

isSystemCode
boolean

Is System Code

lastModifiedDateTime
string <date-time>

Last Modified Date Time

lastModifiedUserId
number <int32>

Last Modified User Id

name
string

Name

rowVersion
string
originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save New Fa Sap Status

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-fasapstatus-savenew-request-payload)
Array of objects (cmc-nexus-financialAid-entities-faSapStatusStudentGroupEntity)
id
number <int32>

Id

code
string

Code

createdDateTime
string <date-time>

Created Date Time

excludeFromCalc
boolean

Exclude From Calc

isActive
boolean

Is Active

isSapMet
boolean

Is Sap Met

isSystemCode
boolean

Is System Code

lastModifiedDateTime
string <date-time>

Last Modified Date Time

lastModifiedUserId
number <int32>

Last Modified User Id

name
string

Name

rowVersion
string
originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

PellGrantConfigSetting

Get Pell Grant Config Setting

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-pellgrantconfigsetting-getpellgrantconfigsetting-request-payload)
attRfmsPellIdCode
string

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save Pell Grant Config Setting

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-pellgrantconfigsetting-save-request-payload)
object (cmc-nexus-financialAid-entities-pellGrantConfigSettingEntity)
id
required
number <int32>

Id

attRfmsPellIdCode
required
string

Att Rfms Pell Id Code

createdDateTime
string <date-time>

Created Date Time

defaultAcademicCalendar
string

Default Academic Calendar

defaultCreditHoursInAcademicYr
number <int32>

Default Credit Hours In Academic Yr

defaultPaymentMethodology
string

Default Payment Methodology

defaultWeeksInAcademicYr
number <int32>

Default Weeks In Academic Yr

disbursementDateDaysAdded
object

Disbursement Date Days Added

disbursementOption
string

Disbursement Option

dunsNumber
string

Duns Number

faaEmailAddress
string

Faa Email Address

faaFaxNumber
string

Faa Fax Number

faaName
string

Faa Name

faaPhoneNumber
string

Faa Phone Number

faaPhoneNumberExt
string

Faa Phone Number Ext

financialControl
string

Financial Control

institutionType
string

Institution Type

isDisbursementDateAdjustmentAutoCreated
boolean

Is Disbursement Date Adjustment Auto Created

isOriginationStatusAutoUpdated
boolean

Is Origination Status Auto Updated

isPellReoriginatedInSpe
boolean

Is Pell Reoriginated In Spe

isRfmsUsed00
boolean

Is Rfms Used00

isRfmsUsed01
boolean

Is Rfms Used01

isRfmsUsed02
boolean

Is Rfms Used02

isRfmsUsed03
boolean

Is Rfms Used03

isRfmsUsed04
boolean

Is Rfms Used04

isRfmsUsed05
boolean

Is Rfms Used05

isRfmsUsed06
boolean

Is Rfms Used06

isRfmsUsed07
boolean

Is Rfms Used07

isRfmsUsed08
boolean

Is Rfms Used08

isRfmsUsed09
boolean

Is Rfms Used09

isRfmsUsed10
boolean

Is Rfms Used10

isRfmsUsed11
boolean

Is Rfms Used11

isRfmsUsed12
boolean

Is Rfms Used12

isRfmsUsed13
boolean

Is Rfms Used13

isRfmsUsed14
boolean

Is Rfms Used14

isRfmsUsed15
boolean

Is Rfms Used15

isRfmsUsed16
boolean

Is Rfms Used16

isRfmsUsed17
boolean

Is Rfms Used17

isRfmsUsed18
boolean

Is Rfms Used18

isRfmsUsed19
boolean

Is Rfms Used19

isRfmsUsed20
boolean

Is Rfms Used20

isRfmsUsed21
boolean

Is Rfms Used21

isRfmsUsed22
boolean

Is Rfms Used22

isRfmsUsed23
boolean

Is Rfms Used23

isScheduledDisbursementReported
boolean

Is Scheduled Disbursement Reported

isSpecialDisbursement
boolean

Is Special Disbursement

lastModifiedDateTime
string <date-time>

Last Modified Date Time

lastModifiedUserId
number <int32>

Last Modified User Id

offsetScheduledDisbursementDays
number <int32>

Offset Scheduled Disbursement Days

rowVersion
string
originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save New Pell Grant Config Setting

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-pellgrantconfigsetting-savenew-request-payload)
object (cmc-nexus-financialAid-entities-pellGrantConfigSettingEntity)
id
required
number <int32>

Id

attRfmsPellIdCode
required
string

Att Rfms Pell Id Code

createdDateTime
string <date-time>

Created Date Time

defaultAcademicCalendar
string

Default Academic Calendar

defaultCreditHoursInAcademicYr
number <int32>

Default Credit Hours In Academic Yr

defaultPaymentMethodology
string

Default Payment Methodology

defaultWeeksInAcademicYr
number <int32>

Default Weeks In Academic Yr

disbursementDateDaysAdded
object

Disbursement Date Days Added

disbursementOption
string

Disbursement Option

dunsNumber
string

Duns Number

faaEmailAddress
string

Faa Email Address

faaFaxNumber
string

Faa Fax Number

faaName
string

Faa Name

faaPhoneNumber
string

Faa Phone Number

faaPhoneNumberExt
string

Faa Phone Number Ext

financialControl
string

Financial Control

institutionType
string

Institution Type

isDisbursementDateAdjustmentAutoCreated
boolean

Is Disbursement Date Adjustment Auto Created

isOriginationStatusAutoUpdated
boolean

Is Origination Status Auto Updated

isPellReoriginatedInSpe
boolean

Is Pell Reoriginated In Spe

isRfmsUsed00
boolean

Is Rfms Used00

isRfmsUsed01
boolean

Is Rfms Used01

isRfmsUsed02
boolean

Is Rfms Used02

isRfmsUsed03
boolean

Is Rfms Used03

isRfmsUsed04
boolean

Is Rfms Used04

isRfmsUsed05
boolean

Is Rfms Used05

isRfmsUsed06
boolean

Is Rfms Used06

isRfmsUsed07
boolean

Is Rfms Used07

isRfmsUsed08
boolean

Is Rfms Used08

isRfmsUsed09
boolean

Is Rfms Used09

isRfmsUsed10
boolean

Is Rfms Used10

isRfmsUsed11
boolean

Is Rfms Used11

isRfmsUsed12
boolean

Is Rfms Used12

isRfmsUsed13
boolean

Is Rfms Used13

isRfmsUsed14
boolean

Is Rfms Used14

isRfmsUsed15
boolean

Is Rfms Used15

isRfmsUsed16
boolean

Is Rfms Used16

isRfmsUsed17
boolean

Is Rfms Used17

isRfmsUsed18
boolean

Is Rfms Used18

isRfmsUsed19
boolean

Is Rfms Used19

isRfmsUsed20
boolean

Is Rfms Used20

isRfmsUsed21
boolean

Is Rfms Used21

isRfmsUsed22
boolean

Is Rfms Used22

isRfmsUsed23
boolean

Is Rfms Used23

isScheduledDisbursementReported
boolean

Is Scheduled Disbursement Reported

isSpecialDisbursement
boolean

Is Special Disbursement

lastModifiedDateTime
string <date-time>

Last Modified Date Time

lastModifiedUserId
number <int32>

Last Modified User Id

offsetScheduledDisbursementDays
number <int32>

Offset Scheduled Disbursement Days

rowVersion
string
originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

StudentAcademicYear

Calculate Budget Cost Of Attendance

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentacademicyear-calculatebudgetcostofattendance-request-payload)
object (cmc-nexus-financialAid-entities-studentAcademicYearEntity)
studentId
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Calculate Student Academic Year Budget Info

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentacademicyear-calculatestudentacademicyearbudgetinfo-request-payload)
object (cmc-nexus-financialAid-entities-studentAcademicYearEntity)
studentAwardPellId
number <int32>
originationStatus
string
financialAidAdvisorId
number <int32>
financialAidStaffGroupId
number <int32>
isAcademicYearDateReview
boolean
dependencyStatus
string
sendChangesToCod
boolean
isUserAllowedToApproveDirectLoan
boolean
proceedAfterDatesModifiedValidation
boolean
isProceedAfterDatesModifiedValidation
boolean
proceedAfterCalculateCreditValidation
boolean
isProceedAfterCalculateCreditValidation
boolean
remainingCredits
number <double>
remainingWeeks
number <double>
proceedAfterCalculateHoursValidation
boolean
isProceedAfterCalculateHoursValidation
boolean
proceedAfterCreditDefinitiontValidation
boolean
isProceedAfterCreditDefinitiontValidation
boolean
proceedAfterHoursDefinitiontValidation
boolean
isProceedAfterHoursDefinitiontValidation
boolean
proceedAfterMoreCreditsValidation
boolean
isProceedAfterMoreCreditsValidation
boolean
proceedAfterMoreHoursValidation
boolean
isProceedAfterMoreHoursValidation
boolean
canProceedToSave
boolean
isDdVeteran
boolean
rightsResponsibilitiesAck
boolean
faGradPlusCounselingDate
string <date-time>
faEntranceInterviewDate
string <date-time>
savePackageMethodOrTermToPackage
boolean
id
required
number <int32>

Id

academicYearId
number <int32>

Academic Year Id

acYrNote
string

Ac Yr Note

autoAwardConfigurationId
number <int32>

Auto Award Configuration Id

autoAwardEnrollmentStatusId
number <int32>

Auto Award Enrollment Status Id

autoAwardEvaluationType
string

Auto Award Evaluation Type

autoAwardInitialCalculationDate
string <date-time>

Auto Award Initial Calculation Date

autoAwardRepackageCalculationDate
string <date-time>

Auto Award Repackage Calculation Date

autoAwardRequestProcess
string

Auto Award Request Process

awardNoticePrintedDate
string <date-time>

Award Notice Printed Date

awardNoticeSigned
string <date-time>

Award Notice Signed

billedDate
string <date-time>

Billed Date

booksSupplies
number <double>

Books Supplies

budgetId
number <int32>

Budget Id

budgetRecordIdentifier
string

Budget Record Identifier

costOfAttendance
number <double>

Cost Of Attendance

counselingCompleteDate
string <date-time>

Counseling Complete Date

counselingType
string

Counseling Type

createdDateTime
string <date-time>

Created Date Time

creditHoursExpectedToComplete
number <double>

Credit Hours Expected To Complete

creditHoursInAcademicYear
number <double>

Credit Hours In Academic Year

endDate
string <date-time>

End Date

faAdvisorId
number <int32>

Fa Advisor Id

firstAwardYear
string

First Award Year

gradeLevelId
number <int32>

Grade Level Id

housingStatusCode
string

Housing Status Code

hppaLevel
string

Hppa Level

institutionalCharges
number <double>

Institutional Charges

isAutoAwardBudgetLock
boolean

Is Auto Award Budget Lock

isAutoAwardPackageLock
boolean

Is Auto Award Package Lock

isBankFeesLocked
boolean

Is Bank Fees Locked

isBooksSuppliesInstitutional
boolean

Is Books Supplies Institutional

isBooksSuppliesLocked
boolean

Is Books Supplies Locked

isEndDateExcluded
boolean

Is End Date Excluded

isExcludedFromMtf
boolean

Is Excluded From Mtf

isFirstTimeBorrower
boolean

Is First Time Borrower

isHybridDates
boolean

Is Hybrid Dates

isOther10Locked
boolean

Is Other10Locked

isOther11Locked
boolean

Is Other11Locked

isOther1Locked
boolean

Is Other1Locked

isOther2Locked
boolean

Is Other2Locked

isOther3Locked
boolean

Is Other3Locked

isOther4Locked
boolean

Is Other4Locked

isOther5Locked
boolean

Is Other5Locked

isOther6Locked
boolean

Is Other6Locked

isOther7Locked
boolean

Is Other7Locked

isOther8Locked
boolean

Is Other8Locked

isOther9Locked
boolean

Is Other9Locked

isOtherCostInstitutional10
boolean

Is Other Cost Institutional10

isOtherCostInstitutional11
boolean

Is Other Cost Institutional11

isOtherCostInstitutional9
boolean

Is Other Cost Institutional9

isOtherCostInstitutionalCharge1
boolean

Is Other Cost Institutional Charge1

isOtherCostInstitutionalCharge2
boolean

Is Other Cost Institutional Charge2

isOtherCostInstitutionalCharge3
boolean

Is Other Cost Institutional Charge3

isOtherCostInstitutionalCharge4
boolean

Is Other Cost Institutional Charge4

isOtherCostInstitutionalCharge5
boolean

Is Other Cost Institutional Charge5

isOtherCostInstitutionalCharge6
boolean

Is Other Cost Institutional Charge6

isOtherCostInstitutionalCharge7
boolean

Is Other Cost Institutional Charge7

isOtherCostInstitutionalCharge8
boolean

Is Other Cost Institutional Charge8

isPackageRevised
boolean

Is Package Revised

isProrateDlAllowed
boolean

Is Prorate Dl Allowed

isReentryAcademicYear
boolean

Is Reentry Academic Year

isRoomBoardInstitutional
boolean

Is Room Board Institutional

isRoomBoardLocked
boolean

Is Room Board Locked

isStartDateExcluded
boolean

Is Start Date Excluded

isSummerPackagingExcluded
boolean

Is Summer Packaging Excluded

isTravelInstitutional
boolean

Is Travel Institutional

isTravelLocked
boolean

Is Travel Locked

isTuitionLocked
boolean

Is Tuition Locked

isUnsubEligibilityUpToHeal
boolean

Is Unsub Eligibility Up To Heal

isUnsupportedDependent
boolean

Is Unsupported Dependent

iwinAy
number <double>

Iwin Ay

iwMonths
number <double>

Iw Months

lastModifiedDateTime
string <date-time>

Last Modified Date Time

lastModifiedUserId
number <int32>

Last Modified User Id

lenderFees
number <double>

Lender Fees

monthsIncademicYear
number <double>

Months Incademic Year

note
string

Note

otherCostAmount1
number <double>

Other Cost Amount1

otherCostAmount10
number <double>

Other Cost Amount10

otherCostAmount11
number <double>

Other Cost Amount11

otherCostAmount2
number <double>

Other Cost Amount2

otherCostAmount3
number <double>

Other Cost Amount3

otherCostAmount4
number <double>

Other Cost Amount4

otherCostAmount5
number <double>

Other Cost Amount5

otherCostAmount6
number <double>

Other Cost Amount6

otherCostAmount7
number <double>

Other Cost Amount7

otherCostAmount8
number <double>

Other Cost Amount8

otherCostAmount9
number <double>

Other Cost Amount9

otherCostDescription1
string

Other Cost Description1

otherCostDescription10
string

Other Cost Description10

otherCostDescription11
string

Other Cost Description11

otherCostDescription2
string

Other Cost Description2

otherCostDescription3
string

Other Cost Description3

otherCostDescription4
string

Other Cost Description4

otherCostDescription5
string

Other Cost Description5

otherCostDescription6
string

Other Cost Description6

otherCostDescription7
string

Other Cost Description7

otherCostDescription8
string

Other Cost Description8

otherCostDescription9
string

Other Cost Description9

packageDate
string <date-time>

Package Date

packagedToEnrollmentStatusId
number <int32>

Packaged To Enrollment Status Id

packagingMethodId
number <int32>

Packaging Method Id

packagingStatusId
number <int32>

Packaging Status Id

pellCostOfAttendance
number <double>

Pell Cost Of Attendance

plusCreditDecisionStatus
string

Plus Credit Decision Status

programVersionAcademicYearId
number <int32>

Program Version Academic Year Id

programVersionPellCoaDetailId
number <int32>

Program Version Pell Coa Detail Id

refCreditHoursInAcademicYear
number <double>

Ref Credit Hours In Academic Year

refWeeksInAcademicYear
number <double>

Ref Weeks In Academic Year

revisedAwardNoticePrinted
string <date-time>

Revised Award Notice Printed

revisedAwardNoticeSigned
string <date-time>

Revised Award Notice Signed

roomBoard
number <double>

Room Board

rowVersion
string
secondAwardYear
string

Second Award Year

secondAwardYearPackagingStatusId
number <int32>

Second Award Year Packaging Status Id

sequence
object

Sequence

startDate
string <date-time>

Start Date

studentEnrollmentPeriodId
number <int32>

Student Enrollment Period Id

teachCounselingDate
string <date-time>

Teach Counseling Date

termsToPackageDirectLoan
string

Terms To Package Direct Loan

travel
number <double>

Travel

tuition
number <double>

Tuition

weeksEnrolledInAcademicYear
number <int32>

Weeks Enrolled In Academic Year

weeksInAcademicYear
number <double>

Weeks In Academic Year

weeksNonEnrollment
number <double>

Weeks Non Enrollment

Array of objects (cmc-nexus-financialAid-entities-studentAcademicYearCommentEntity)
originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Create Student Academic Year

Authorizations:
apikey

Responses

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Delete Student Academic Year

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentacademicyear-delete-request-payload)
studentAwardPellId
number <int32>
originationStatus
string
financialAidAdvisorId
number <int32>
financialAidStaffGroupId
number <int32>
isAcademicYearDateReview
boolean
dependencyStatus
string
sendChangesToCod
boolean
isUserAllowedToApproveDirectLoan
boolean
proceedAfterDatesModifiedValidation
boolean
isProceedAfterDatesModifiedValidation
boolean
proceedAfterCalculateCreditValidation
boolean
isProceedAfterCalculateCreditValidation
boolean
remainingCredits
number <double>
remainingWeeks
number <double>
proceedAfterCalculateHoursValidation
boolean
isProceedAfterCalculateHoursValidation
boolean
proceedAfterCreditDefinitiontValidation
boolean
isProceedAfterCreditDefinitiontValidation
boolean
proceedAfterHoursDefinitiontValidation
boolean
isProceedAfterHoursDefinitiontValidation
boolean
proceedAfterMoreCreditsValidation
boolean
isProceedAfterMoreCreditsValidation
boolean
proceedAfterMoreHoursValidation
boolean
isProceedAfterMoreHoursValidation
boolean
canProceedToSave
boolean
isDdVeteran
boolean
rightsResponsibilitiesAck
boolean
faGradPlusCounselingDate
string <date-time>
faEntranceInterviewDate
string <date-time>
savePackageMethodOrTermToPackage
boolean
id
number <int32>

Id

academicYearId
number <int32>

Academic Year Id

acYrNote
string

Ac Yr Note

autoAwardConfigurationId
number <int32>

Auto Award Configuration Id

autoAwardEnrollmentStatusId
number <int32>

Auto Award Enrollment Status Id

autoAwardEvaluationType
string

Auto Award Evaluation Type

autoAwardInitialCalculationDate
string <date-time>

Auto Award Initial Calculation Date

autoAwardRepackageCalculationDate
string <date-time>

Auto Award Repackage Calculation Date

autoAwardRequestProcess
string

Auto Award Request Process

awardNoticePrintedDate
string <date-time>

Award Notice Printed Date

awardNoticeSigned
string <date-time>

Award Notice Signed

billedDate
string <date-time>

Billed Date

booksSupplies
number <double>

Books Supplies

budgetId
number <int32>

Budget Id

budgetRecordIdentifier
string

Budget Record Identifier

costOfAttendance
number <double>

Cost Of Attendance

counselingCompleteDate
string <date-time>

Counseling Complete Date

counselingType
string

Counseling Type

createdDateTime
string <date-time>

Created Date Time

creditHoursExpectedToComplete
number <double>

Credit Hours Expected To Complete

creditHoursInAcademicYear
number <double>

Credit Hours In Academic Year

endDate
string <date-time>

End Date

faAdvisorId
number <int32>

Fa Advisor Id

firstAwardYear
string

First Award Year

gradeLevelId
number <int32>

Grade Level Id

housingStatusCode
string

Housing Status Code

hppaLevel
string

Hppa Level

institutionalCharges
number <double>

Institutional Charges

isAutoAwardBudgetLock
boolean

Is Auto Award Budget Lock

isAutoAwardPackageLock
boolean

Is Auto Award Package Lock

isBankFeesLocked
boolean

Is Bank Fees Locked

isBooksSuppliesInstitutional
boolean

Is Books Supplies Institutional

isBooksSuppliesLocked
boolean

Is Books Supplies Locked

isEndDateExcluded
boolean

Is End Date Excluded

isExcludedFromMtf
boolean

Is Excluded From Mtf

isFirstTimeBorrower
boolean

Is First Time Borrower

isHybridDates
boolean

Is Hybrid Dates

isOther10Locked
boolean

Is Other10Locked

isOther11Locked
boolean

Is Other11Locked

isOther1Locked
boolean

Is Other1Locked

isOther2Locked
boolean

Is Other2Locked

isOther3Locked
boolean

Is Other3Locked

isOther4Locked
boolean

Is Other4Locked

isOther5Locked
boolean

Is Other5Locked

isOther6Locked
boolean

Is Other6Locked

isOther7Locked
boolean

Is Other7Locked

isOther8Locked
boolean

Is Other8Locked

isOther9Locked
boolean

Is Other9Locked

isOtherCostInstitutional10
boolean

Is Other Cost Institutional10

isOtherCostInstitutional11
boolean

Is Other Cost Institutional11

isOtherCostInstitutional9
boolean

Is Other Cost Institutional9

isOtherCostInstitutionalCharge1
boolean

Is Other Cost Institutional Charge1

isOtherCostInstitutionalCharge2
boolean

Is Other Cost Institutional Charge2

isOtherCostInstitutionalCharge3
boolean

Is Other Cost Institutional Charge3

isOtherCostInstitutionalCharge4
boolean

Is Other Cost Institutional Charge4

isOtherCostInstitutionalCharge5
boolean

Is Other Cost Institutional Charge5

isOtherCostInstitutionalCharge6
boolean

Is Other Cost Institutional Charge6

isOtherCostInstitutionalCharge7
boolean

Is Other Cost Institutional Charge7

isOtherCostInstitutionalCharge8
boolean

Is Other Cost Institutional Charge8

isPackageRevised
boolean

Is Package Revised

isProrateDlAllowed
boolean

Is Prorate Dl Allowed

isReentryAcademicYear
boolean

Is Reentry Academic Year

isRoomBoardInstitutional
boolean

Is Room Board Institutional

isRoomBoardLocked
boolean

Is Room Board Locked

isStartDateExcluded
boolean

Is Start Date Excluded

isSummerPackagingExcluded
boolean

Is Summer Packaging Excluded

isTravelInstitutional
boolean

Is Travel Institutional

isTravelLocked
boolean

Is Travel Locked

isTuitionLocked
boolean

Is Tuition Locked

isUnsubEligibilityUpToHeal
boolean

Is Unsub Eligibility Up To Heal

isUnsupportedDependent
boolean

Is Unsupported Dependent

iwinAy
number <double>

Iwin Ay

iwMonths
number <double>

Iw Months

lastModifiedDateTime
string <date-time>

Last Modified Date Time

lastModifiedUserId
number <int32>

Last Modified User Id

lenderFees
number <double>

Lender Fees

monthsIncademicYear
number <double>

Months Incademic Year

note
string

Note

otherCostAmount1
number <double>

Other Cost Amount1

otherCostAmount10
number <double>

Other Cost Amount10

otherCostAmount11
number <double>

Other Cost Amount11

otherCostAmount2
number <double>

Other Cost Amount2

otherCostAmount3
number <double>

Other Cost Amount3

otherCostAmount4
number <double>

Other Cost Amount4

otherCostAmount5
number <double>

Other Cost Amount5

otherCostAmount6
number <double>

Other Cost Amount6

otherCostAmount7
number <double>

Other Cost Amount7

otherCostAmount8
number <double>

Other Cost Amount8

otherCostAmount9
number <double>

Other Cost Amount9

otherCostDescription1
string

Other Cost Description1

otherCostDescription10
string

Other Cost Description10

otherCostDescription11
string

Other Cost Description11

otherCostDescription2
string

Other Cost Description2

otherCostDescription3
string

Other Cost Description3

otherCostDescription4
string

Other Cost Description4

otherCostDescription5
string

Other Cost Description5

otherCostDescription6
string

Other Cost Description6

otherCostDescription7
string

Other Cost Description7

otherCostDescription8
string

Other Cost Description8

otherCostDescription9
string

Other Cost Description9

packageDate
string <date-time>

Package Date

packagedToEnrollmentStatusId
number <int32>

Packaged To Enrollment Status Id

packagingMethodId
number <int32>

Packaging Method Id

packagingStatusId
number <int32>

Packaging Status Id

pellCostOfAttendance
number <double>

Pell Cost Of Attendance

plusCreditDecisionStatus
string

Plus Credit Decision Status

programVersionAcademicYearId
number <int32>

Program Version Academic Year Id

programVersionPellCoaDetailId
number <int32>

Program Version Pell Coa Detail Id

refCreditHoursInAcademicYear
number <double>

Ref Credit Hours In Academic Year

refWeeksInAcademicYear
number <double>

Ref Weeks In Academic Year

revisedAwardNoticePrinted
string <date-time>

Revised Award Notice Printed

revisedAwardNoticeSigned
string <date-time>

Revised Award Notice Signed

roomBoard
number <double>

Room Board

rowVersion
string
secondAwardYear
string

Second Award Year

secondAwardYearPackagingStatusId
number <int32>

Second Award Year Packaging Status Id

sequence
object

Sequence

startDate
string <date-time>

Start Date

studentEnrollmentPeriodId
number <int32>

Student Enrollment Period Id

teachCounselingDate
string <date-time>

Teach Counseling Date

termsToPackageDirectLoan
string

Terms To Package Direct Loan

travel
number <double>

Travel

tuition
number <double>

Tuition

weeksEnrolledInAcademicYear
number <int32>

Weeks Enrolled In Academic Year

weeksInAcademicYear
number <double>

Weeks In Academic Year

weeksNonEnrollment
number <double>

Weeks Non Enrollment

Array of objects (cmc-nexus-financialAid-entities-studentAcademicYearCommentEntity)
originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Generate Academic Years For Enrollment

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentacademicyear-generateacademicyearsforenrollment-request-payload)
adEnrollId
number <int32>
transferCreditHours
number <double>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Get Student Academic Year

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentacademicyear-get-request-payload)
id
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save Student Academic Year

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentacademicyear-save-request-payload)
studentAwardPellId
number <int32>
originationStatus
string
financialAidAdvisorId
number <int32>
financialAidStaffGroupId
number <int32>
isAcademicYearDateReview
boolean
dependencyStatus
string
sendChangesToCod
boolean
isUserAllowedToApproveDirectLoan
boolean
proceedAfterDatesModifiedValidation
boolean
isProceedAfterDatesModifiedValidation
boolean
proceedAfterCalculateCreditValidation
boolean
isProceedAfterCalculateCreditValidation
boolean
remainingCredits
number <double>
remainingWeeks
number <double>
proceedAfterCalculateHoursValidation
boolean
isProceedAfterCalculateHoursValidation
boolean
proceedAfterCreditDefinitiontValidation
boolean
isProceedAfterCreditDefinitiontValidation
boolean
proceedAfterHoursDefinitiontValidation
boolean
isProceedAfterHoursDefinitiontValidation
boolean
proceedAfterMoreCreditsValidation
boolean
isProceedAfterMoreCreditsValidation
boolean
proceedAfterMoreHoursValidation
boolean
isProceedAfterMoreHoursValidation
boolean
canProceedToSave
boolean
isDdVeteran
boolean
rightsResponsibilitiesAck
boolean
faGradPlusCounselingDate
string <date-time>
faEntranceInterviewDate
string <date-time>
savePackageMethodOrTermToPackage
boolean
id
number <int32>

Id

academicYearId
number <int32>

Academic Year Id

acYrNote
string

Ac Yr Note

autoAwardConfigurationId
number <int32>

Auto Award Configuration Id

autoAwardEnrollmentStatusId
number <int32>

Auto Award Enrollment Status Id

autoAwardEvaluationType
string

Auto Award Evaluation Type

autoAwardInitialCalculationDate
string <date-time>

Auto Award Initial Calculation Date

autoAwardRepackageCalculationDate
string <date-time>

Auto Award Repackage Calculation Date

autoAwardRequestProcess
string

Auto Award Request Process

awardNoticePrintedDate
string <date-time>

Award Notice Printed Date

awardNoticeSigned
string <date-time>

Award Notice Signed

billedDate
string <date-time>

Billed Date

booksSupplies
number <double>

Books Supplies

budgetId
number <int32>

Budget Id

budgetRecordIdentifier
string

Budget Record Identifier

costOfAttendance
number <double>

Cost Of Attendance

counselingCompleteDate
string <date-time>

Counseling Complete Date

counselingType
string

Counseling Type

createdDateTime
string <date-time>

Created Date Time

creditHoursExpectedToComplete
number <double>

Credit Hours Expected To Complete

creditHoursInAcademicYear
number <double>

Credit Hours In Academic Year

endDate
string <date-time>

End Date

faAdvisorId
number <int32>

Fa Advisor Id

firstAwardYear
string

First Award Year

gradeLevelId
number <int32>

Grade Level Id

housingStatusCode
string

Housing Status Code

hppaLevel
string

Hppa Level

institutionalCharges
number <double>

Institutional Charges

isAutoAwardBudgetLock
boolean

Is Auto Award Budget Lock

isAutoAwardPackageLock
boolean

Is Auto Award Package Lock

isBankFeesLocked
boolean

Is Bank Fees Locked

isBooksSuppliesInstitutional
boolean

Is Books Supplies Institutional

isBooksSuppliesLocked
boolean

Is Books Supplies Locked

isEndDateExcluded
boolean

Is End Date Excluded

isExcludedFromMtf
boolean

Is Excluded From Mtf

isFirstTimeBorrower
boolean

Is First Time Borrower

isHybridDates
boolean

Is Hybrid Dates

isOther10Locked
boolean

Is Other10Locked

isOther11Locked
boolean

Is Other11Locked

isOther1Locked
boolean

Is Other1Locked

isOther2Locked
boolean

Is Other2Locked

isOther3Locked
boolean

Is Other3Locked

isOther4Locked
boolean

Is Other4Locked

isOther5Locked
boolean

Is Other5Locked

isOther6Locked
boolean

Is Other6Locked

isOther7Locked
boolean

Is Other7Locked

isOther8Locked
boolean

Is Other8Locked

isOther9Locked
boolean

Is Other9Locked

isOtherCostInstitutional10
boolean

Is Other Cost Institutional10

isOtherCostInstitutional11
boolean

Is Other Cost Institutional11

isOtherCostInstitutional9
boolean

Is Other Cost Institutional9

isOtherCostInstitutionalCharge1
boolean

Is Other Cost Institutional Charge1

isOtherCostInstitutionalCharge2
boolean

Is Other Cost Institutional Charge2

isOtherCostInstitutionalCharge3
boolean

Is Other Cost Institutional Charge3

isOtherCostInstitutionalCharge4
boolean

Is Other Cost Institutional Charge4

isOtherCostInstitutionalCharge5
boolean

Is Other Cost Institutional Charge5

isOtherCostInstitutionalCharge6
boolean

Is Other Cost Institutional Charge6

isOtherCostInstitutionalCharge7
boolean

Is Other Cost Institutional Charge7

isOtherCostInstitutionalCharge8
boolean

Is Other Cost Institutional Charge8

isPackageRevised
boolean

Is Package Revised

isProrateDlAllowed
boolean

Is Prorate Dl Allowed

isReentryAcademicYear
boolean

Is Reentry Academic Year

isRoomBoardInstitutional
boolean

Is Room Board Institutional

isRoomBoardLocked
boolean

Is Room Board Locked

isStartDateExcluded
boolean

Is Start Date Excluded

isSummerPackagingExcluded
boolean

Is Summer Packaging Excluded

isTravelInstitutional
boolean

Is Travel Institutional

isTravelLocked
boolean

Is Travel Locked

isTuitionLocked
boolean

Is Tuition Locked

isUnsubEligibilityUpToHeal
boolean

Is Unsub Eligibility Up To Heal

isUnsupportedDependent
boolean

Is Unsupported Dependent

iwinAy
number <double>

Iwin Ay

iwMonths
number <double>

Iw Months

lastModifiedDateTime
string <date-time>

Last Modified Date Time

lastModifiedUserId
number <int32>

Last Modified User Id

lenderFees
number <double>

Lender Fees

monthsIncademicYear
number <double>

Months Incademic Year

note
string

Note

otherCostAmount1
number <double>

Other Cost Amount1

otherCostAmount10
number <double>

Other Cost Amount10

otherCostAmount11
number <double>

Other Cost Amount11

otherCostAmount2
number <double>

Other Cost Amount2

otherCostAmount3
number <double>

Other Cost Amount3

otherCostAmount4
number <double>

Other Cost Amount4

otherCostAmount5
number <double>

Other Cost Amount5

otherCostAmount6
number <double>

Other Cost Amount6

otherCostAmount7
number <double>

Other Cost Amount7

otherCostAmount8
number <double>

Other Cost Amount8

otherCostAmount9
number <double>

Other Cost Amount9

otherCostDescription1
string

Other Cost Description1

otherCostDescription10
string

Other Cost Description10

otherCostDescription11
string

Other Cost Description11

otherCostDescription2
string

Other Cost Description2

otherCostDescription3
string

Other Cost Description3

otherCostDescription4
string

Other Cost Description4

otherCostDescription5
string

Other Cost Description5

otherCostDescription6
string

Other Cost Description6

otherCostDescription7
string

Other Cost Description7

otherCostDescription8
string

Other Cost Description8

otherCostDescription9
string

Other Cost Description9

packageDate
string <date-time>

Package Date

packagedToEnrollmentStatusId
number <int32>

Packaged To Enrollment Status Id

packagingMethodId
number <int32>

Packaging Method Id

packagingStatusId
number <int32>

Packaging Status Id

pellCostOfAttendance
number <double>

Pell Cost Of Attendance

plusCreditDecisionStatus
string

Plus Credit Decision Status

programVersionAcademicYearId
number <int32>

Program Version Academic Year Id

programVersionPellCoaDetailId
number <int32>

Program Version Pell Coa Detail Id

refCreditHoursInAcademicYear
number <double>

Ref Credit Hours In Academic Year

refWeeksInAcademicYear
number <double>

Ref Weeks In Academic Year

revisedAwardNoticePrinted
string <date-time>

Revised Award Notice Printed

revisedAwardNoticeSigned
string <date-time>

Revised Award Notice Signed

roomBoard
number <double>

Room Board

rowVersion
string
secondAwardYear
string

Second Award Year

secondAwardYearPackagingStatusId
number <int32>

Second Award Year Packaging Status Id

sequence
object

Sequence

startDate
string <date-time>

Start Date

studentEnrollmentPeriodId
number <int32>

Student Enrollment Period Id

teachCounselingDate
string <date-time>

Teach Counseling Date

termsToPackageDirectLoan
string

Terms To Package Direct Loan

travel
number <double>

Travel

tuition
number <double>

Tuition

weeksEnrolledInAcademicYear
number <int32>

Weeks Enrolled In Academic Year

weeksInAcademicYear
number <double>

Weeks In Academic Year

weeksNonEnrollment
number <double>

Weeks Non Enrollment

Array of objects (cmc-nexus-financialAid-entities-studentAcademicYearCommentEntity)
originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Save New Student Academic Year

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentacademicyear-savenew-request-payload)
studentAwardPellId
number <int32>
originationStatus
string
financialAidAdvisorId
number <int32>
financialAidStaffGroupId
number <int32>
isAcademicYearDateReview
boolean
dependencyStatus
string
sendChangesToCod
boolean
isUserAllowedToApproveDirectLoan
boolean
proceedAfterDatesModifiedValidation
boolean
isProceedAfterDatesModifiedValidation
boolean
proceedAfterCalculateCreditValidation
boolean
isProceedAfterCalculateCreditValidation
boolean
remainingCredits
number <double>
remainingWeeks
number <double>
proceedAfterCalculateHoursValidation
boolean
isProceedAfterCalculateHoursValidation
boolean
proceedAfterCreditDefinitiontValidation
boolean
isProceedAfterCreditDefinitiontValidation
boolean
proceedAfterHoursDefinitiontValidation
boolean
isProceedAfterHoursDefinitiontValidation
boolean
proceedAfterMoreCreditsValidation
boolean
isProceedAfterMoreCreditsValidation
boolean
proceedAfterMoreHoursValidation
boolean
isProceedAfterMoreHoursValidation
boolean
canProceedToSave
boolean
isDdVeteran
boolean
rightsResponsibilitiesAck
boolean
faGradPlusCounselingDate
string <date-time>
faEntranceInterviewDate
string <date-time>
savePackageMethodOrTermToPackage
boolean
id
number <int32>

Id

academicYearId
number <int32>

Academic Year Id

acYrNote
string

Ac Yr Note

autoAwardConfigurationId
number <int32>

Auto Award Configuration Id

autoAwardEnrollmentStatusId
number <int32>

Auto Award Enrollment Status Id

autoAwardEvaluationType
string

Auto Award Evaluation Type

autoAwardInitialCalculationDate
string <date-time>

Auto Award Initial Calculation Date

autoAwardRepackageCalculationDate
string <date-time>

Auto Award Repackage Calculation Date

autoAwardRequestProcess
string

Auto Award Request Process

awardNoticePrintedDate
string <date-time>

Award Notice Printed Date

awardNoticeSigned
string <date-time>

Award Notice Signed

billedDate
string <date-time>

Billed Date

booksSupplies
number <double>

Books Supplies

budgetId
number <int32>

Budget Id

budgetRecordIdentifier
string

Budget Record Identifier

costOfAttendance
number <double>

Cost Of Attendance

counselingCompleteDate
string <date-time>

Counseling Complete Date

counselingType
string

Counseling Type

createdDateTime
string <date-time>

Created Date Time

creditHoursExpectedToComplete
number <double>

Credit Hours Expected To Complete

creditHoursInAcademicYear
number <double>

Credit Hours In Academic Year

endDate
string <date-time>

End Date

faAdvisorId
number <int32>

Fa Advisor Id

firstAwardYear
string

First Award Year

gradeLevelId
number <int32>

Grade Level Id

housingStatusCode
string

Housing Status Code

hppaLevel
string

Hppa Level

institutionalCharges
number <double>

Institutional Charges

isAutoAwardBudgetLock
boolean

Is Auto Award Budget Lock

isAutoAwardPackageLock
boolean

Is Auto Award Package Lock

isBankFeesLocked
boolean

Is Bank Fees Locked

isBooksSuppliesInstitutional
boolean

Is Books Supplies Institutional

isBooksSuppliesLocked
boolean

Is Books Supplies Locked

isEndDateExcluded
boolean

Is End Date Excluded

isExcludedFromMtf
boolean

Is Excluded From Mtf

isFirstTimeBorrower
boolean

Is First Time Borrower

isHybridDates
boolean

Is Hybrid Dates

isOther10Locked
boolean

Is Other10Locked

isOther11Locked
boolean

Is Other11Locked

isOther1Locked
boolean

Is Other1Locked

isOther2Locked
boolean

Is Other2Locked

isOther3Locked
boolean

Is Other3Locked

isOther4Locked
boolean

Is Other4Locked

isOther5Locked
boolean

Is Other5Locked

isOther6Locked
boolean

Is Other6Locked

isOther7Locked
boolean

Is Other7Locked

isOther8Locked
boolean

Is Other8Locked

isOther9Locked
boolean

Is Other9Locked

isOtherCostInstitutional10
boolean

Is Other Cost Institutional10

isOtherCostInstitutional11
boolean

Is Other Cost Institutional11

isOtherCostInstitutional9
boolean

Is Other Cost Institutional9

isOtherCostInstitutionalCharge1
boolean

Is Other Cost Institutional Charge1

isOtherCostInstitutionalCharge2
boolean

Is Other Cost Institutional Charge2

isOtherCostInstitutionalCharge3
boolean

Is Other Cost Institutional Charge3

isOtherCostInstitutionalCharge4
boolean

Is Other Cost Institutional Charge4

isOtherCostInstitutionalCharge5
boolean

Is Other Cost Institutional Charge5

isOtherCostInstitutionalCharge6
boolean

Is Other Cost Institutional Charge6

isOtherCostInstitutionalCharge7
boolean

Is Other Cost Institutional Charge7

isOtherCostInstitutionalCharge8
boolean

Is Other Cost Institutional Charge8

isPackageRevised
boolean

Is Package Revised

isProrateDlAllowed
boolean

Is Prorate Dl Allowed

isReentryAcademicYear
boolean

Is Reentry Academic Year

isRoomBoardInstitutional
boolean

Is Room Board Institutional

isRoomBoardLocked
boolean

Is Room Board Locked

isStartDateExcluded
boolean

Is Start Date Excluded

isSummerPackagingExcluded
boolean

Is Summer Packaging Excluded

isTravelInstitutional
boolean

Is Travel Institutional

isTravelLocked
boolean

Is Travel Locked

isTuitionLocked
boolean

Is Tuition Locked

isUnsubEligibilityUpToHeal
boolean

Is Unsub Eligibility Up To Heal

isUnsupportedDependent
boolean

Is Unsupported Dependent

iwinAy
number <double>

Iwin Ay

iwMonths
number <double>

Iw Months

lastModifiedDateTime
string <date-time>

Last Modified Date Time

lastModifiedUserId
number <int32>

Last Modified User Id

lenderFees
number <double>

Lender Fees

monthsIncademicYear
number <double>

Months Incademic Year

note
string

Note

otherCostAmount1
number <double>

Other Cost Amount1

otherCostAmount10
number <double>

Other Cost Amount10

otherCostAmount11
number <double>

Other Cost Amount11

otherCostAmount2
number <double>

Other Cost Amount2

otherCostAmount3
number <double>

Other Cost Amount3

otherCostAmount4
number <double>

Other Cost Amount4

otherCostAmount5
number <double>

Other Cost Amount5

otherCostAmount6
number <double>

Other Cost Amount6

otherCostAmount7
number <double>

Other Cost Amount7

otherCostAmount8
number <double>

Other Cost Amount8

otherCostAmount9
number <double>

Other Cost Amount9

otherCostDescription1
string

Other Cost Description1

otherCostDescription10
string

Other Cost Description10

otherCostDescription11
string

Other Cost Description11

otherCostDescription2
string

Other Cost Description2

otherCostDescription3
string

Other Cost Description3

otherCostDescription4
string

Other Cost Description4

otherCostDescription5
string

Other Cost Description5

otherCostDescription6
string

Other Cost Description6

otherCostDescription7
string

Other Cost Description7

otherCostDescription8
string

Other Cost Description8

otherCostDescription9
string

Other Cost Description9

packageDate
string <date-time>

Package Date

packagedToEnrollmentStatusId
number <int32>

Packaged To Enrollment Status Id

packagingMethodId
number <int32>

Packaging Method Id

packagingStatusId
number <int32>

Packaging Status Id

pellCostOfAttendance
number <double>

Pell Cost Of Attendance

plusCreditDecisionStatus
string

Plus Credit Decision Status

programVersionAcademicYearId
number <int32>

Program Version Academic Year Id

programVersionPellCoaDetailId
number <int32>

Program Version Pell Coa Detail Id

refCreditHoursInAcademicYear
number <double>

Ref Credit Hours In Academic Year

refWeeksInAcademicYear
number <double>

Ref Weeks In Academic Year

revisedAwardNoticePrinted
string <date-time>

Revised Award Notice Printed

revisedAwardNoticeSigned
string <date-time>

Revised Award Notice Signed

roomBoard
number <double>

Room Board

rowVersion
string
secondAwardYear
string

Second Award Year

secondAwardYearPackagingStatusId
number <int32>

Second Award Year Packaging Status Id

sequence
object

Sequence

startDate
string <date-time>

Start Date

studentEnrollmentPeriodId
number <int32>

Student Enrollment Period Id

teachCounselingDate
string <date-time>

Teach Counseling Date

termsToPackageDirectLoan
string

Terms To Package Direct Loan

travel
number <double>

Travel

tuition
number <double>

Tuition

weeksEnrolledInAcademicYear
number <int32>

Weeks Enrolled In Academic Year

weeksInAcademicYear
number <double>

Weeks In Academic Year

weeksNonEnrollment
number <double>

Weeks Non Enrollment

Array of objects (cmc-nexus-financialAid-entities-studentAcademicYearCommentEntity)
originalState
string
secureState
string
extendedProperties
Array of any
entityState
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Update Student Academic Year Packaging Method

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentacademicyear-updatestudentacademicyearpackagingmethod-request-payload)
studentAcademicYearId
number <int32>
packagingMethodId
number <int32>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Update Student Academic Year Print Award Notice Dates

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentacademicyear-updatestudentacademicyearprintawardnoticedates-request-payload)
studentAcademicYearId
number <int32>
awardNoticePrinted
string <date-time>
awardNoticeSigned
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Update Student Academic Year Terms To Package Direct Loan

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentacademicyear-updatestudentacademicyeartermstopackagedirectloan-request-payload)
studentAcademicYearId
number <int32>
termsToPackageDirectLoan
string
isProrateDlAllowed
boolean

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}

Update Student Academic Year Unsupported Dependent

Authorizations:
apikey
Request Body schema: application/json

Payload for the command

object (financialaid-studentacademicyear-updatestudentacademicyearunsupporteddependent-request-payload)
studentAcademicYearId
number <int32>
isUnsupportedDependent
boolean

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "payload": {
    },
  • "notifications": [
    ],
  • "hasError": false,
  • "hasFault": false,
  • "hasWarning": false,
  • "hasValidationError": false,
  • "hasValidationWarning": false,
  • "hasValidationInformation": false,
  • "hasSecurityError": false
}