Student Accounts

API docs by Redocly

Student Accounts (1.0)

Download OpenAPI specification:Download

Anthology, Inc.: support@anthology.com URL: https://www.anthology.com

All API calls related to Student Accounts.

BillingTransactionCode

Create Billing Transaction Code

Authorizations:

apikey

Responses

Response samples

Content type

application/json

{"payload": {"data": {"campusIds": [0
],
"id": 0,
"allowRequiredTermOverride": true,
"billingTransactionCodeCategoryId": 0,
"campusGroupId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financeAccountCodeId": 0,
"financeDepartmentCodeId": 0,
"financeProjectCodeId": 0,
"includeInRevenueRecognition": true,
"isActive": true,
"isDeposit": true,
"isDepositsAccepted": true,
"isDiscount": true,
"isEditMiscCashGlAccountNumberAllowed": true,
"isExamFee": true,
"isForfeit": true,
"isIncludedIn1098T": true,
"isIncludedInRt4Calculation": true,
"isIncludedSchoolActivitiesRevenue1098T": true,
"isInterestCharge": true,
"isLateFee": true,
"isNegativeRevenueAmortized": true,
"isPenalty": true,
"isRefund": true,
"isRetakeFee": true,
"isRevenueDeferred": true,
"isStudentBilledOneTimeOnly": true,
"isSystemCode": true,
"isTitleIvCharge": true,
"isTitleIvChargeNoWaiver": true,
"isTuition": true,
"isWriteOff": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"revenuePeriod": "string",
"rowVersion": "string",
"usage": "string",
"billingTransactionCodeTaxRateAssociations": [{"id": 0,
"billingTransactionCodeId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"rowVersion": "string",
"taxRateId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Delete Billing Transaction Code

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-billingtransactioncode-delete-request-payload)

campusIds	Array of numbers <int32> [ items <int32 > ]
id	number <int32> Id
allowRequiredTermOverride	boolean Allow Required Term Override
billingTransactionCodeCategoryId	number <int32> Billing Transaction Code Category Id
campusGroupId	number <int32> Campus Group Id
code	string Code
createdDateTime	string <date-time> Created Date Time
financeAccountCodeId	number <int32> Finance Account Code Id
financeDepartmentCodeId	number <int32> Finance Department Code Id
financeProjectCodeId	number <int32> Finance Project Code Id
includeInRevenueRecognition	boolean Include In Revenue Recognition
isActive	boolean Is Active
isDeposit	boolean Is Deposit
isDepositsAccepted	boolean Is Deposits Accepted
isDiscount	boolean Is Discount
isEditMiscCashGlAccountNumberAllowed	boolean Is Edit Misc Cash Gl Account Number Allowed
isExamFee	boolean Is Exam Fee
isForfeit	boolean Is Forfeit
isIncludedIn1098T	boolean Is Included In1098T
isIncludedInRt4Calculation	boolean Is Included In Rt4Calculation
isIncludedSchoolActivitiesRevenue1098T	boolean Is Included School Activities Revenue1098T
isInterestCharge	boolean Is Interest Charge
isLateFee	boolean Is Late Fee
isNegativeRevenueAmortized	boolean Is Negative Revenue Amortized
isPenalty	boolean Is Penalty
isRefund	boolean Is Refund
isRetakeFee	boolean Is Retake Fee
isRevenueDeferred	boolean Is Revenue Deferred
isStudentBilledOneTimeOnly	boolean Is Student Billed One Time Only
isSystemCode	boolean Is System Code
isTitleIvCharge	boolean Is Title Iv Charge
isTitleIvChargeNoWaiver	boolean Is Title Iv Charge No Waiver
isTuition	boolean Is Tuition
isWriteOff	boolean Is Write Off
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
name	string Name
revenuePeriod	string Revenue Period
rowVersion	string
usage	string Usage
	Array of objects (cmc-nexus-studentAccounts-entities-billingTransactionCodeTaxRateAssociationEntity)
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"campusIds": [0
],
"id": 0,
"allowRequiredTermOverride": true,
"billingTransactionCodeCategoryId": 0,
"campusGroupId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financeAccountCodeId": 0,
"financeDepartmentCodeId": 0,
"financeProjectCodeId": 0,
"includeInRevenueRecognition": true,
"isActive": true,
"isDeposit": true,
"isDepositsAccepted": true,
"isDiscount": true,
"isEditMiscCashGlAccountNumberAllowed": true,
"isExamFee": true,
"isForfeit": true,
"isIncludedIn1098T": true,
"isIncludedInRt4Calculation": true,
"isIncludedSchoolActivitiesRevenue1098T": true,
"isInterestCharge": true,
"isLateFee": true,
"isNegativeRevenueAmortized": true,
"isPenalty": true,
"isRefund": true,
"isRetakeFee": true,
"isRevenueDeferred": true,
"isStudentBilledOneTimeOnly": true,
"isSystemCode": true,
"isTitleIvCharge": true,
"isTitleIvChargeNoWaiver": true,
"isTuition": true,
"isWriteOff": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"revenuePeriod": "string",
"rowVersion": "string",
"usage": "string",
"billingTransactionCodeTaxRateAssociations": [{"id": 0,
"billingTransactionCodeId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"rowVersion": "string",
"taxRateId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"deleted": true
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Billing Transaction Code

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-billingtransactioncode-get-request-payload)

id	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"id": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"campusIds": [0
],
"id": 0,
"allowRequiredTermOverride": true,
"billingTransactionCodeCategoryId": 0,
"campusGroupId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financeAccountCodeId": 0,
"financeDepartmentCodeId": 0,
"financeProjectCodeId": 0,
"includeInRevenueRecognition": true,
"isActive": true,
"isDeposit": true,
"isDepositsAccepted": true,
"isDiscount": true,
"isEditMiscCashGlAccountNumberAllowed": true,
"isExamFee": true,
"isForfeit": true,
"isIncludedIn1098T": true,
"isIncludedInRt4Calculation": true,
"isIncludedSchoolActivitiesRevenue1098T": true,
"isInterestCharge": true,
"isLateFee": true,
"isNegativeRevenueAmortized": true,
"isPenalty": true,
"isRefund": true,
"isRetakeFee": true,
"isRevenueDeferred": true,
"isStudentBilledOneTimeOnly": true,
"isSystemCode": true,
"isTitleIvCharge": true,
"isTitleIvChargeNoWaiver": true,
"isTuition": true,
"isWriteOff": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"revenuePeriod": "string",
"rowVersion": "string",
"usage": "string",
"billingTransactionCodeTaxRateAssociations": [{"id": 0,
"billingTransactionCodeId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"rowVersion": "string",
"taxRateId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Available Billing Transaction Code List

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-billingtransactioncode-getavailablebillingtransactioncodelist-request-payload)

campusIdList	Array of numbers <int32> [ items <int32 > ]
transactionPaymentDueDateRuleId	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"campusIdList": [0
],
"transactionPaymentDueDateRuleId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"billingTransactionCodeEntityList": [{"campusIds": [0
],
"id": 0,
"allowRequiredTermOverride": true,
"billingTransactionCodeCategoryId": 0,
"campusGroupId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financeAccountCodeId": 0,
"financeDepartmentCodeId": 0,
"financeProjectCodeId": 0,
"includeInRevenueRecognition": true,
"isActive": true,
"isDeposit": true,
"isDepositsAccepted": true,
"isDiscount": true,
"isEditMiscCashGlAccountNumberAllowed": true,
"isExamFee": true,
"isForfeit": true,
"isIncludedIn1098T": true,
"isIncludedInRt4Calculation": true,
"isIncludedSchoolActivitiesRevenue1098T": true,
"isInterestCharge": true,
"isLateFee": true,
"isNegativeRevenueAmortized": true,
"isPenalty": true,
"isRefund": true,
"isRetakeFee": true,
"isRevenueDeferred": true,
"isStudentBilledOneTimeOnly": true,
"isSystemCode": true,
"isTitleIvCharge": true,
"isTitleIvChargeNoWaiver": true,
"isTuition": true,
"isWriteOff": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"revenuePeriod": "string",
"rowVersion": "string",
"usage": "string",
"billingTransactionCodeTaxRateAssociations": [{"id": 0,
"billingTransactionCodeId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"rowVersion": "string",
"taxRateId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Billing Transaction Code List

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-billingtransactioncode-getbillingtransactioncodelist-request-payload)

subsidiaryAccountTypeId	number <int32>
campusIdList	Array of numbers <int32> [ items <int32 > ]

Responses

Request samples

Payload

Content type

application/json

{"payload": {"subsidiaryAccountTypeId": 0,
"campusIdList": [0
]
}
}

Response samples

Content type

application/json

{"payload": {"data": {"billingTransactionCodeList": [{"billingTransactionCodeId": 0,
"code": "string",
"name": "string",
"isSelected": true,
"usage": "string",
"allowRequiredTermOverride": true,
"isIncludedIn1098T": true,
"subsidiaryAccountTypeId": 0
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get California Strf Students

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-billingtransactioncode-getcaliforniastrfstudents-request-payload)

studentId	number <int32>
campusId	number <int32>
termId	number <int32>
amount	number <double>
billingTransactionCodeId	number <int32>
fromEnrollmentDate	string <date-time>
toEnrollmentDate	string <date-time>
evaluationPeriod	string
feeSelection	string
effectiveDate	string <date-time>
programVersionIdList	Array of numbers <int32> [ items <int32 > ]
studentGroupIdList	Array of numbers <int32> [ items <int32 > ]

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentId": 0,
"campusId": 0,
"termId": 0,
"amount": 0,
"billingTransactionCodeId": 0,
"fromEnrollmentDate": "2019-08-24T14:15:22Z",
"toEnrollmentDate": "2019-08-24T14:15:22Z",
"evaluationPeriod": "string",
"feeSelection": "string",
"effectiveDate": "2019-08-24T14:15:22Z",
"programVersionIdList": [0
],
"studentGroupIdList": [0
]
}
}

Response samples

Content type

application/json

{"payload": {"data": {"californiaStrfStudentList": [{"studentId": 0,
"studentName": "string",
"studentNumber": "string",
"campusId": 0,
"studentEnrollmentPeriodId": 0,
"studentStatus": "string",
"programVersionName": "string",
"programVersionCode": "string",
"enrollmentDate": "2019-08-24T14:15:22Z",
"tuitionAmount": 0,
"tuitionAmountToPay": 0,
"amountToCharge": 0,
"netAmountToCharge": 0,
"previousAmount": 0
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Subsidiary Account Type Campus Detail List

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-billingtransactioncode-getsubsidiaryaccounttypecampusdetaillist-request-payload)

subsidiaryAccountTypeId	number <int32>
campusIdList	Array of numbers <int32> [ items <int32 > ]
fiscalYear	string

Responses

Request samples

Payload

Content type

application/json

{"payload": {"subsidiaryAccountTypeId": 0,
"campusIdList": [0
],
"fiscalYear": "string"
}
}

Response samples

Content type

application/json

{"payload": {"data": {"subsidiaryAccountTypeCampusDetailList": [{"subsidiaryAccountTypeCampusDetailId": 0,
"campusId": 0,
"journalEntryId": 0,
"campusName": "string",
"debitAccount": "string",
"creditAccount": "string",
"debitCostAccount": "string",
"creditCostAccount": "string",
"creditAccountIndex": 0,
"debitAccountIndex": 0,
"transactionType": "string",
"journalEntryName": "string",
"ledgerDefinition": "string",
"fiscalYear": "string"
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Billing Transaction Code

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-billingtransactioncode-save-request-payload)

campusIds	Array of numbers <int32> [ items <int32 > ]
id	number <int32> Id
allowRequiredTermOverride	boolean Allow Required Term Override
billingTransactionCodeCategoryId	number <int32> Billing Transaction Code Category Id
campusGroupId	number <int32> Campus Group Id
code	string Code
createdDateTime	string <date-time> Created Date Time
financeAccountCodeId	number <int32> Finance Account Code Id
financeDepartmentCodeId	number <int32> Finance Department Code Id
financeProjectCodeId	number <int32> Finance Project Code Id
includeInRevenueRecognition	boolean Include In Revenue Recognition
isActive	boolean Is Active
isDeposit	boolean Is Deposit
isDepositsAccepted	boolean Is Deposits Accepted
isDiscount	boolean Is Discount
isEditMiscCashGlAccountNumberAllowed	boolean Is Edit Misc Cash Gl Account Number Allowed
isExamFee	boolean Is Exam Fee
isForfeit	boolean Is Forfeit
isIncludedIn1098T	boolean Is Included In1098T
isIncludedInRt4Calculation	boolean Is Included In Rt4Calculation
isIncludedSchoolActivitiesRevenue1098T	boolean Is Included School Activities Revenue1098T
isInterestCharge	boolean Is Interest Charge
isLateFee	boolean Is Late Fee
isNegativeRevenueAmortized	boolean Is Negative Revenue Amortized
isPenalty	boolean Is Penalty
isRefund	boolean Is Refund
isRetakeFee	boolean Is Retake Fee
isRevenueDeferred	boolean Is Revenue Deferred
isStudentBilledOneTimeOnly	boolean Is Student Billed One Time Only
isSystemCode	boolean Is System Code
isTitleIvCharge	boolean Is Title Iv Charge
isTitleIvChargeNoWaiver	boolean Is Title Iv Charge No Waiver
isTuition	boolean Is Tuition
isWriteOff	boolean Is Write Off
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
name	string Name
revenuePeriod	string Revenue Period
rowVersion	string
usage	string Usage
	Array of objects (cmc-nexus-studentAccounts-entities-billingTransactionCodeTaxRateAssociationEntity)
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"campusIds": [0
],
"id": 0,
"allowRequiredTermOverride": true,
"billingTransactionCodeCategoryId": 0,
"campusGroupId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financeAccountCodeId": 0,
"financeDepartmentCodeId": 0,
"financeProjectCodeId": 0,
"includeInRevenueRecognition": true,
"isActive": true,
"isDeposit": true,
"isDepositsAccepted": true,
"isDiscount": true,
"isEditMiscCashGlAccountNumberAllowed": true,
"isExamFee": true,
"isForfeit": true,
"isIncludedIn1098T": true,
"isIncludedInRt4Calculation": true,
"isIncludedSchoolActivitiesRevenue1098T": true,
"isInterestCharge": true,
"isLateFee": true,
"isNegativeRevenueAmortized": true,
"isPenalty": true,
"isRefund": true,
"isRetakeFee": true,
"isRevenueDeferred": true,
"isStudentBilledOneTimeOnly": true,
"isSystemCode": true,
"isTitleIvCharge": true,
"isTitleIvChargeNoWaiver": true,
"isTuition": true,
"isWriteOff": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"revenuePeriod": "string",
"rowVersion": "string",
"usage": "string",
"billingTransactionCodeTaxRateAssociations": [{"id": 0,
"billingTransactionCodeId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"rowVersion": "string",
"taxRateId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"campusIds": [0
],
"id": 0,
"allowRequiredTermOverride": true,
"billingTransactionCodeCategoryId": 0,
"campusGroupId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financeAccountCodeId": 0,
"financeDepartmentCodeId": 0,
"financeProjectCodeId": 0,
"includeInRevenueRecognition": true,
"isActive": true,
"isDeposit": true,
"isDepositsAccepted": true,
"isDiscount": true,
"isEditMiscCashGlAccountNumberAllowed": true,
"isExamFee": true,
"isForfeit": true,
"isIncludedIn1098T": true,
"isIncludedInRt4Calculation": true,
"isIncludedSchoolActivitiesRevenue1098T": true,
"isInterestCharge": true,
"isLateFee": true,
"isNegativeRevenueAmortized": true,
"isPenalty": true,
"isRefund": true,
"isRetakeFee": true,
"isRevenueDeferred": true,
"isStudentBilledOneTimeOnly": true,
"isSystemCode": true,
"isTitleIvCharge": true,
"isTitleIvChargeNoWaiver": true,
"isTuition": true,
"isWriteOff": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"revenuePeriod": "string",
"rowVersion": "string",
"usage": "string",
"billingTransactionCodeTaxRateAssociations": [{"id": 0,
"billingTransactionCodeId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"rowVersion": "string",
"taxRateId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save New Billing Transaction Code

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-billingtransactioncode-savenew-request-payload)

campusIds	Array of numbers <int32> [ items <int32 > ]
id	number <int32> Id
allowRequiredTermOverride	boolean Allow Required Term Override
billingTransactionCodeCategoryId	number <int32> Billing Transaction Code Category Id
campusGroupId	number <int32> Campus Group Id
code	string Code
createdDateTime	string <date-time> Created Date Time
financeAccountCodeId	number <int32> Finance Account Code Id
financeDepartmentCodeId	number <int32> Finance Department Code Id
financeProjectCodeId	number <int32> Finance Project Code Id
includeInRevenueRecognition	boolean Include In Revenue Recognition
isActive	boolean Is Active
isDeposit	boolean Is Deposit
isDepositsAccepted	boolean Is Deposits Accepted
isDiscount	boolean Is Discount
isEditMiscCashGlAccountNumberAllowed	boolean Is Edit Misc Cash Gl Account Number Allowed
isExamFee	boolean Is Exam Fee
isForfeit	boolean Is Forfeit
isIncludedIn1098T	boolean Is Included In1098T
isIncludedInRt4Calculation	boolean Is Included In Rt4Calculation
isIncludedSchoolActivitiesRevenue1098T	boolean Is Included School Activities Revenue1098T
isInterestCharge	boolean Is Interest Charge
isLateFee	boolean Is Late Fee
isNegativeRevenueAmortized	boolean Is Negative Revenue Amortized
isPenalty	boolean Is Penalty
isRefund	boolean Is Refund
isRetakeFee	boolean Is Retake Fee
isRevenueDeferred	boolean Is Revenue Deferred
isStudentBilledOneTimeOnly	boolean Is Student Billed One Time Only
isSystemCode	boolean Is System Code
isTitleIvCharge	boolean Is Title Iv Charge
isTitleIvChargeNoWaiver	boolean Is Title Iv Charge No Waiver
isTuition	boolean Is Tuition
isWriteOff	boolean Is Write Off
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
name	string Name
revenuePeriod	string Revenue Period
rowVersion	string
usage	string Usage
	Array of objects (cmc-nexus-studentAccounts-entities-billingTransactionCodeTaxRateAssociationEntity)
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"campusIds": [0
],
"id": 0,
"allowRequiredTermOverride": true,
"billingTransactionCodeCategoryId": 0,
"campusGroupId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financeAccountCodeId": 0,
"financeDepartmentCodeId": 0,
"financeProjectCodeId": 0,
"includeInRevenueRecognition": true,
"isActive": true,
"isDeposit": true,
"isDepositsAccepted": true,
"isDiscount": true,
"isEditMiscCashGlAccountNumberAllowed": true,
"isExamFee": true,
"isForfeit": true,
"isIncludedIn1098T": true,
"isIncludedInRt4Calculation": true,
"isIncludedSchoolActivitiesRevenue1098T": true,
"isInterestCharge": true,
"isLateFee": true,
"isNegativeRevenueAmortized": true,
"isPenalty": true,
"isRefund": true,
"isRetakeFee": true,
"isRevenueDeferred": true,
"isStudentBilledOneTimeOnly": true,
"isSystemCode": true,
"isTitleIvCharge": true,
"isTitleIvChargeNoWaiver": true,
"isTuition": true,
"isWriteOff": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"revenuePeriod": "string",
"rowVersion": "string",
"usage": "string",
"billingTransactionCodeTaxRateAssociations": [{"id": 0,
"billingTransactionCodeId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"rowVersion": "string",
"taxRateId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"campusIds": [0
],
"id": 0,
"allowRequiredTermOverride": true,
"billingTransactionCodeCategoryId": 0,
"campusGroupId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financeAccountCodeId": 0,
"financeDepartmentCodeId": 0,
"financeProjectCodeId": 0,
"includeInRevenueRecognition": true,
"isActive": true,
"isDeposit": true,
"isDepositsAccepted": true,
"isDiscount": true,
"isEditMiscCashGlAccountNumberAllowed": true,
"isExamFee": true,
"isForfeit": true,
"isIncludedIn1098T": true,
"isIncludedInRt4Calculation": true,
"isIncludedSchoolActivitiesRevenue1098T": true,
"isInterestCharge": true,
"isLateFee": true,
"isNegativeRevenueAmortized": true,
"isPenalty": true,
"isRefund": true,
"isRetakeFee": true,
"isRevenueDeferred": true,
"isStudentBilledOneTimeOnly": true,
"isSystemCode": true,
"isTitleIvCharge": true,
"isTitleIvChargeNoWaiver": true,
"isTuition": true,
"isWriteOff": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"revenuePeriod": "string",
"rowVersion": "string",
"usage": "string",
"billingTransactionCodeTaxRateAssociations": [{"id": 0,
"billingTransactionCodeId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"rowVersion": "string",
"taxRateId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

CashDrawer

Create Cash Drawer

Authorizations:

apikey

Responses

Response samples

Content type

application/json

{"payload": {"data": {"campusIdList": [0
],
"isProcessContinuedWithoutBankDeposit": true,
"warningAmountDecimal": 0,
"restrictAmountDecimal": 0,
"id": 0,
"campusGroupId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"restrictAmount": 0,
"rowVersion": "string",
"usedByUserId": 0,
"warningAmount": 0,
"campusGroup": {"id": 0,
"approverStaffId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financialCampusGroup": true,
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"saStmtComments": "string",
"saStmtLastCloseDate": "2019-08-24T14:15:22Z",
"type": "string",
"campusList": [{"id": 0,
"campusGroupId": 0,
"campusId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isCampusActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Delete Cash Drawer

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-cashdrawer-delete-request-payload)

campusIdList	Array of numbers <int32> [ items <int32 > ]
isProcessContinuedWithoutBankDeposit	boolean
warningAmountDecimal	number <double>
restrictAmountDecimal	number <double>
id	number <int32> Id
campusGroupId	number <int32> Campus Group Id
code	string Code
createdDateTime	string <date-time> Created Date Time
isActive	boolean Is Active
isSystemCode	boolean Is System Code
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
name	string Name
restrictAmount	number <int32> Restrict Amount
rowVersion	string
usedByUserId	number <int32> Used By User Id
warningAmount	number <int32> Warning Amount
	object (cmc-nexus-common-entities-campusGroupEntity)
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"campusIdList": [0
],
"isProcessContinuedWithoutBankDeposit": true,
"warningAmountDecimal": 0,
"restrictAmountDecimal": 0,
"id": 0,
"campusGroupId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"restrictAmount": 0,
"rowVersion": "string",
"usedByUserId": 0,
"warningAmount": 0,
"campusGroup": {"id": 0,
"approverStaffId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financialCampusGroup": true,
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"saStmtComments": "string",
"saStmtLastCloseDate": "2019-08-24T14:15:22Z",
"type": "string",
"campusList": [{"id": 0,
"campusGroupId": 0,
"campusId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isCampusActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"deleted": true
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Cash Drawer

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-cashdrawer-get-request-payload)

id	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"id": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"campusIdList": [0
],
"isProcessContinuedWithoutBankDeposit": true,
"warningAmountDecimal": 0,
"restrictAmountDecimal": 0,
"id": 0,
"campusGroupId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"restrictAmount": 0,
"rowVersion": "string",
"usedByUserId": 0,
"warningAmount": 0,
"campusGroup": {"id": 0,
"approverStaffId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financialCampusGroup": true,
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"saStmtComments": "string",
"saStmtLastCloseDate": "2019-08-24T14:15:22Z",
"type": "string",
"campusList": [{"id": 0,
"campusGroupId": 0,
"campusId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isCampusActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Cash Drawer

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-cashdrawer-save-request-payload)

campusIdList	Array of numbers <int32> [ items <int32 > ]
isProcessContinuedWithoutBankDeposit	boolean
warningAmountDecimal	number <double>
restrictAmountDecimal	number <double>
id	number <int32> Id
campusGroupId	number <int32> Campus Group Id
code	string Code
createdDateTime	string <date-time> Created Date Time
isActive	boolean Is Active
isSystemCode	boolean Is System Code
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
name	string Name
restrictAmount	number <int32> Restrict Amount
rowVersion	string
usedByUserId	number <int32> Used By User Id
warningAmount	number <int32> Warning Amount
	object (cmc-nexus-common-entities-campusGroupEntity)
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"campusIdList": [0
],
"isProcessContinuedWithoutBankDeposit": true,
"warningAmountDecimal": 0,
"restrictAmountDecimal": 0,
"id": 0,
"campusGroupId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"restrictAmount": 0,
"rowVersion": "string",
"usedByUserId": 0,
"warningAmount": 0,
"campusGroup": {"id": 0,
"approverStaffId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financialCampusGroup": true,
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"saStmtComments": "string",
"saStmtLastCloseDate": "2019-08-24T14:15:22Z",
"type": "string",
"campusList": [{"id": 0,
"campusGroupId": 0,
"campusId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isCampusActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"campusIdList": [0
],
"isProcessContinuedWithoutBankDeposit": true,
"warningAmountDecimal": 0,
"restrictAmountDecimal": 0,
"id": 0,
"campusGroupId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"restrictAmount": 0,
"rowVersion": "string",
"usedByUserId": 0,
"warningAmount": 0,
"campusGroup": {"id": 0,
"approverStaffId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financialCampusGroup": true,
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"saStmtComments": "string",
"saStmtLastCloseDate": "2019-08-24T14:15:22Z",
"type": "string",
"campusList": [{"id": 0,
"campusGroupId": 0,
"campusId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isCampusActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save New Cash Drawer

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-cashdrawer-savenew-request-payload)

campusIdList	Array of numbers <int32> [ items <int32 > ]
isProcessContinuedWithoutBankDeposit	boolean
warningAmountDecimal	number <double>
restrictAmountDecimal	number <double>
id	number <int32> Id
campusGroupId	number <int32> Campus Group Id
code	string Code
createdDateTime	string <date-time> Created Date Time
isActive	boolean Is Active
isSystemCode	boolean Is System Code
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
name	string Name
restrictAmount	number <int32> Restrict Amount
rowVersion	string
usedByUserId	number <int32> Used By User Id
warningAmount	number <int32> Warning Amount
	object (cmc-nexus-common-entities-campusGroupEntity)
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"campusIdList": [0
],
"isProcessContinuedWithoutBankDeposit": true,
"warningAmountDecimal": 0,
"restrictAmountDecimal": 0,
"id": 0,
"campusGroupId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"restrictAmount": 0,
"rowVersion": "string",
"usedByUserId": 0,
"warningAmount": 0,
"campusGroup": {"id": 0,
"approverStaffId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financialCampusGroup": true,
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"saStmtComments": "string",
"saStmtLastCloseDate": "2019-08-24T14:15:22Z",
"type": "string",
"campusList": [{"id": 0,
"campusGroupId": 0,
"campusId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isCampusActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"campusIdList": [0
],
"isProcessContinuedWithoutBankDeposit": true,
"warningAmountDecimal": 0,
"restrictAmountDecimal": 0,
"id": 0,
"campusGroupId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"restrictAmount": 0,
"rowVersion": "string",
"usedByUserId": 0,
"warningAmount": 0,
"campusGroup": {"id": 0,
"approverStaffId": 0,
"code": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"financialCampusGroup": true,
"isActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"name": "string",
"rowVersion": "string",
"saStmtComments": "string",
"saStmtLastCloseDate": "2019-08-24T14:15:22Z",
"type": "string",
"campusList": [{"id": 0,
"campusGroupId": 0,
"campusId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"isCampusActive": true,
"isSystemCode": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"rowVersion": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

StipendSchedule

Create Stipend Schedule

Authorizations:

apikey

Responses

Response samples

Content type

application/json

{"payload": {"data": {"fundSourceId": 0,
"id": 0,
"createdByUserId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditBalanceType": "string",
"disbursementNumber": { },
"isAchScheduled": true,
"isAutomated": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"payeeName": "string",
"previousStatus": "string",
"returnMethod": "string",
"rowVersion": "string",
"scheduledAmount": 0,
"scheduledDate": "2019-08-24T14:15:22Z",
"status": "string",
"stipendAddressType": "string",
"stipendSummaryId": 0,
"studentAcademicYearPaymentPeriodId": 0,
"studentAccountTransactionId": 0,
"studentAwardId": 0,
"studentBankAccountId": 0,
"studentRefundCalculationId": 0,
"studentRelationshipAddressId": 0,
"termId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Delete Stipend Schedule

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-stipendschedule-delete-request-payload)

fundSourceId	number <int32>
id	number <int32> Id
createdByUserId	number <int32> Created By User Id
createdDateTime	string <date-time> Created Date Time
creditBalanceType	string Credit Balance Type
disbursementNumber	object Disbursement Number
isAchScheduled	boolean Is Ach Scheduled
isAutomated	boolean Is Automated
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
payeeName	string Payee Name
previousStatus	string Previous Status
returnMethod	string Return Method
rowVersion	string
scheduledAmount	number <double> Scheduled Amount
scheduledDate	string <date-time> Scheduled Date
status	string Status
stipendAddressType	string Stipend Address Type
stipendSummaryId	number <int32> Stipend Summary Id
studentAcademicYearPaymentPeriodId	number <int32> Student Academic Year Payment Period Id
studentAccountTransactionId	number <int32> Student Account Transaction Id
studentAwardId	number <int32> Student Award Id
studentBankAccountId	number <int32> Student Bank Account Id
studentRefundCalculationId	number <int32> Student Refund Calculation Id
studentRelationshipAddressId	number <int32> Student Relationship Address Id
termId	number <int32> Term Id
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"fundSourceId": 0,
"id": 0,
"createdByUserId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditBalanceType": "string",
"disbursementNumber": { },
"isAchScheduled": true,
"isAutomated": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"payeeName": "string",
"previousStatus": "string",
"returnMethod": "string",
"rowVersion": "string",
"scheduledAmount": 0,
"scheduledDate": "2019-08-24T14:15:22Z",
"status": "string",
"stipendAddressType": "string",
"stipendSummaryId": 0,
"studentAcademicYearPaymentPeriodId": 0,
"studentAccountTransactionId": 0,
"studentAwardId": 0,
"studentBankAccountId": 0,
"studentRefundCalculationId": 0,
"studentRelationshipAddressId": 0,
"termId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"deleted": true
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Delete Multiple Stipends

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-stipendschedule-deletemultiplestipends-request-payload)

stipendIdList

Array of numbers <int32> [ items <int32 > ]

Responses

Request samples

Payload

Content type

application/json

{"payload": {"stipendIdList": [0
]
}
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Stipend Schedule

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-stipendschedule-get-request-payload)

id	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"id": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"fundSourceId": 0,
"id": 0,
"createdByUserId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditBalanceType": "string",
"disbursementNumber": { },
"isAchScheduled": true,
"isAutomated": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"payeeName": "string",
"previousStatus": "string",
"returnMethod": "string",
"rowVersion": "string",
"scheduledAmount": 0,
"scheduledDate": "2019-08-24T14:15:22Z",
"status": "string",
"stipendAddressType": "string",
"stipendSummaryId": 0,
"studentAcademicYearPaymentPeriodId": 0,
"studentAccountTransactionId": 0,
"studentAwardId": 0,
"studentBankAccountId": 0,
"studentRefundCalculationId": 0,
"studentRelationshipAddressId": 0,
"termId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Post Stipend

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-stipendschedule-poststipend-request-payload)

stipendScheduleId	number <int32>
studentId	number <int32>
studentEnrollmentPeriodCampusId	number <int32>
dueDate	string <date-time>
sentDate	string <date-time>
bankAccountId	number <int32>
academicYear	number <double>
termId	number <int32>
studentAcademicYearPaymentPeriodId	number <int32>
isPaymentPeriodUsed	boolean
reference	string
checkNumber	string
rowVersion	string
stipendAddrType	string
stipendAddrID	number <int32>
isPreviousYear1098t	boolean
payeeName	string

Responses

Request samples

Payload

Content type

application/json

{"payload": {"stipendScheduleId": 0,
"studentId": 0,
"studentEnrollmentPeriodCampusId": 0,
"dueDate": "2019-08-24T14:15:22Z",
"sentDate": "2019-08-24T14:15:22Z",
"bankAccountId": 0,
"academicYear": 0,
"termId": 0,
"studentAcademicYearPaymentPeriodId": 0,
"isPaymentPeriodUsed": true,
"reference": "string",
"checkNumber": "string",
"rowVersion": "string",
"stipendAddrType": "string",
"stipendAddrID": 0,
"isPreviousYear1098t": true,
"payeeName": "string"
}
}

Response samples

Content type

application/json

{"payload": {"data": {"studentAccountTransactionId": 0,
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Reassign Stipend

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-stipendschedule-reassignstipend-request-payload)

stipendScheduleId	number <int32>
studentAwardId	number <int32>
note	string

Responses

Request samples

Payload

Content type

application/json

{"payload": {"stipendScheduleId": 0,
"studentAwardId": 0,
"note": "string"
}
}

Response samples

Content type

application/json

{"payload": {"data": {"stipendSchedule": {"fundSourceId": 0,
"id": 0,
"createdByUserId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditBalanceType": "string",
"disbursementNumber": { },
"isAchScheduled": true,
"isAutomated": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"payeeName": "string",
"previousStatus": "string",
"returnMethod": "string",
"rowVersion": "string",
"scheduledAmount": 0,
"scheduledDate": "2019-08-24T14:15:22Z",
"status": "string",
"stipendAddressType": "string",
"stipendSummaryId": 0,
"studentAcademicYearPaymentPeriodId": 0,
"studentAccountTransactionId": 0,
"studentAwardId": 0,
"studentBankAccountId": 0,
"studentRefundCalculationId": 0,
"studentRelationshipAddressId": 0,
"termId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"stipendSummary": {"isEftDefaultForStipends": true,
"isDefaultPayee": true,
"id": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"disbursedAmount": 0,
"firstPaymentDate": "2019-08-24T14:15:22Z",
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"lockedByStaffId": 0,
"numberDisbursements": { },
"paymentFrequency": 0,
"rowVersion": "string",
"status": "string",
"studentAcademicYearId": 0,
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"totalAmount": 0,
"stipendSchedule": [{"fundSourceId": 0,
"id": 0,
"createdByUserId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditBalanceType": "string",
"disbursementNumber": { },
"isAchScheduled": true,
"isAutomated": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"payeeName": "string",
"previousStatus": "string",
"returnMethod": "string",
"rowVersion": "string",
"scheduledAmount": 0,
"scheduledDate": "2019-08-24T14:15:22Z",
"status": "string",
"stipendAddressType": "string",
"stipendSummaryId": 0,
"studentAcademicYearPaymentPeriodId": 0,
"studentAccountTransactionId": 0,
"studentAwardId": 0,
"studentBankAccountId": 0,
"studentRefundCalculationId": 0,
"studentRelationshipAddressId": 0,
"termId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Stipend Schedule

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-stipendschedule-save-request-payload)

fundSourceId	number <int32>
id	number <int32> Id
createdByUserId	number <int32> Created By User Id
createdDateTime	string <date-time> Created Date Time
creditBalanceType	string Credit Balance Type
disbursementNumber	object Disbursement Number
isAchScheduled	boolean Is Ach Scheduled
isAutomated	boolean Is Automated
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
payeeName	string Payee Name
previousStatus	string Previous Status
returnMethod	string Return Method
rowVersion	string
scheduledAmount	number <double> Scheduled Amount
scheduledDate	string <date-time> Scheduled Date
status	string Status
stipendAddressType	string Stipend Address Type
stipendSummaryId	number <int32> Stipend Summary Id
studentAcademicYearPaymentPeriodId	number <int32> Student Academic Year Payment Period Id
studentAccountTransactionId	number <int32> Student Account Transaction Id
studentAwardId	number <int32> Student Award Id
studentBankAccountId	number <int32> Student Bank Account Id
studentRefundCalculationId	number <int32> Student Refund Calculation Id
studentRelationshipAddressId	number <int32> Student Relationship Address Id
termId	number <int32> Term Id
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"fundSourceId": 0,
"id": 0,
"createdByUserId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditBalanceType": "string",
"disbursementNumber": { },
"isAchScheduled": true,
"isAutomated": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"payeeName": "string",
"previousStatus": "string",
"returnMethod": "string",
"rowVersion": "string",
"scheduledAmount": 0,
"scheduledDate": "2019-08-24T14:15:22Z",
"status": "string",
"stipendAddressType": "string",
"stipendSummaryId": 0,
"studentAcademicYearPaymentPeriodId": 0,
"studentAccountTransactionId": 0,
"studentAwardId": 0,
"studentBankAccountId": 0,
"studentRefundCalculationId": 0,
"studentRelationshipAddressId": 0,
"termId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"fundSourceId": 0,
"id": 0,
"createdByUserId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditBalanceType": "string",
"disbursementNumber": { },
"isAchScheduled": true,
"isAutomated": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"payeeName": "string",
"previousStatus": "string",
"returnMethod": "string",
"rowVersion": "string",
"scheduledAmount": 0,
"scheduledDate": "2019-08-24T14:15:22Z",
"status": "string",
"stipendAddressType": "string",
"stipendSummaryId": 0,
"studentAcademicYearPaymentPeriodId": 0,
"studentAccountTransactionId": 0,
"studentAwardId": 0,
"studentBankAccountId": 0,
"studentRefundCalculationId": 0,
"studentRelationshipAddressId": 0,
"termId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save New Stipend Schedule

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-stipendschedule-savenew-request-payload)

fundSourceId	number <int32>
id	number <int32> Id
createdByUserId	number <int32> Created By User Id
createdDateTime	string <date-time> Created Date Time
creditBalanceType	string Credit Balance Type
disbursementNumber	object Disbursement Number
isAchScheduled	boolean Is Ach Scheduled
isAutomated	boolean Is Automated
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
payeeName	string Payee Name
previousStatus	string Previous Status
returnMethod	string Return Method
rowVersion	string
scheduledAmount	number <double> Scheduled Amount
scheduledDate	string <date-time> Scheduled Date
status	string Status
stipendAddressType	string Stipend Address Type
stipendSummaryId	number <int32> Stipend Summary Id
studentAcademicYearPaymentPeriodId	number <int32> Student Academic Year Payment Period Id
studentAccountTransactionId	number <int32> Student Account Transaction Id
studentAwardId	number <int32> Student Award Id
studentBankAccountId	number <int32> Student Bank Account Id
studentRefundCalculationId	number <int32> Student Refund Calculation Id
studentRelationshipAddressId	number <int32> Student Relationship Address Id
termId	number <int32> Term Id
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"fundSourceId": 0,
"id": 0,
"createdByUserId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditBalanceType": "string",
"disbursementNumber": { },
"isAchScheduled": true,
"isAutomated": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"payeeName": "string",
"previousStatus": "string",
"returnMethod": "string",
"rowVersion": "string",
"scheduledAmount": 0,
"scheduledDate": "2019-08-24T14:15:22Z",
"status": "string",
"stipendAddressType": "string",
"stipendSummaryId": 0,
"studentAcademicYearPaymentPeriodId": 0,
"studentAccountTransactionId": 0,
"studentAwardId": 0,
"studentBankAccountId": 0,
"studentRefundCalculationId": 0,
"studentRelationshipAddressId": 0,
"termId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"fundSourceId": 0,
"id": 0,
"createdByUserId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditBalanceType": "string",
"disbursementNumber": { },
"isAchScheduled": true,
"isAutomated": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"payeeName": "string",
"previousStatus": "string",
"returnMethod": "string",
"rowVersion": "string",
"scheduledAmount": 0,
"scheduledDate": "2019-08-24T14:15:22Z",
"status": "string",
"stipendAddressType": "string",
"stipendSummaryId": 0,
"studentAcademicYearPaymentPeriodId": 0,
"studentAccountTransactionId": 0,
"studentAwardId": 0,
"studentBankAccountId": 0,
"studentRefundCalculationId": 0,
"studentRelationshipAddressId": 0,
"termId": 0,
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Unlock Refund Or Stipend

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-stipendschedule-unlockrefundorstipend-request-payload)

stipendId	number <int32>
processType	string
recordId	Array of numbers <int32> [ items <int32 > ]

Responses

Request samples

Payload

Content type

application/json

{"payload": {"stipendId": 0,
"processType": "string",
"recordId": [0
]
}
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Update Refund Or Stipend

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-stipendschedule-updaterefundorstipend-request-payload)

refundId	number <int32>
returnMethod	string
dueDate	string <date-time>
amount	number <double>
campusId	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"refundId": 0,
"returnMethod": "string",
"dueDate": "2019-08-24T14:15:22Z",
"amount": 0,
"campusId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

StudentAccountTransaction

Adjust Account Transaction Charge

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-adjustaccounttransactioncharge-request-payload)

id	number <int32>
studentId	number <int32>
billingTransactionCodeId	number <int32>
billingTransactionCode	string
transactionAmount	number <double>
studentEnrollmentPeriodId	number <int32>
studentAcademicYearId	number <int32>
academicYearSequence	number <int32>
termId	number <int32>
transactionDate	string <date-time>
reference	string
allowProcessByAutomation	boolean
transactionNumber	number <int32>
description	string
classSectionId	number <int32>
studentAcademicYearPaymentPeriodId	number <int32>
note	string
studentSubsidiaryAccountTransactionId	number <int32>
studentEnrollmentPeriodFeeId	number <int32>
isTransactionAmountChanged	boolean
paymentDueDate	string <date-time>
isCalculateTransactionDueDate	boolean
isTaxIncluded	boolean
	Array of objects (cmc-nexus-studentAccounts-services-postAccountTransactionChargeTax)
isIncludeIn1098T	boolean

Responses

Request samples

Payload

Content type

application/json

{"payload": {"id": 0,
"studentId": 0,
"billingTransactionCodeId": 0,
"billingTransactionCode": "string",
"transactionAmount": 0,
"studentEnrollmentPeriodId": 0,
"studentAcademicYearId": 0,
"academicYearSequence": 0,
"termId": 0,
"transactionDate": "2019-08-24T14:15:22Z",
"reference": "string",
"allowProcessByAutomation": true,
"transactionNumber": 0,
"description": "string",
"classSectionId": 0,
"studentAcademicYearPaymentPeriodId": 0,
"note": "string",
"studentSubsidiaryAccountTransactionId": 0,
"studentEnrollmentPeriodFeeId": 0,
"isTransactionAmountChanged": true,
"paymentDueDate": "2019-08-24T14:15:22Z",
"isCalculateTransactionDueDate": true,
"isTaxIncluded": true,
"chargeTaxList": [{"taxRateId": 0,
"rate": 0,
"taxAmount": 0,
"billingTransactionCodeId": 0,
"isIncludeIn1098T": true
}
],
"isIncludeIn1098T": true
}
}

Response samples

Content type

application/json

{"payload": {"data": {"studentAccountTransaction": {"id": 0,
"academicYearSequence": 0,
"achBatchFileId": 0,
"admissionsRepId": 0,
"afterTaxAmount": 0,
"agencyBranchCreditCardId": 0,
"amountPaid": 0,
"appliedDate": "2019-08-24T14:15:22Z",
"awardBursaryConfigDetailId": 0,
"bankAccountId": 0,
"bankDepositId": 0,
"batchNumber": "string",
"billingTransactionCode": "string",
"campusId": 0,
"cashDrawerSessionId": 0,
"checkClearedDate": "2019-08-24T14:15:22Z",
"checkNumber": "string",
"checkStatus": "string",
"classSectionId": 0,
"courseAmountToRetain": 0,
"courseId": 0,
"courseRefundPolicyId": 0,
"createdByUserId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditCardAuthorizationNumber": "string",
"creditCardBatchTransactionId": 0,
"creditCardDeclineCode": "string",
"depositId": 0,
"description": "string",
"discountAmount": 0,
"drn": "string",
"eftClearedDate": "2019-08-24T14:15:22Z",
"eftNumber": "string",
"eftStatus": "string",
"exchangeRate": 0,
"foreignExchangeGainLoss": 0,
"invoiceAddedDate": "2019-08-24T14:15:22Z",
"invoiceNumber": "string",
"isAutomatedProcess": true,
"isGeneralLedgerStatusFlag": true,
"isInPendingQueue": true,
"isManualCheckExtract": true,
"isPenaltyProcessed": true,
"isPostedToGeneralLedger": true,
"isPreviousYear1098t": true,
"isReconciledInCnf": true,
"isReissued": true,
"isSentBack": true,
"isTaxIncluded": true,
"isVoidedTransaction": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"merchantProcessingCode": "string",
"originalStudentAccountTransactionId": 0,
"paidDisbursementId": 0,
"paymentDueDate": "2019-08-24T14:15:22Z",
"paymentPeriodId": 0,
"paymentType": "string",
"postDate": "2019-08-24T14:15:22Z",
"preferredCurrencyAmount": 0,
"primaryCurrencyCodeId": 0,
"receiptNumber": "string",
"receiptPrintedDate": "2019-08-24T14:15:22Z",
"reference": "string",
"refundCalculationId": 0,
"refundId": 0,
"registrationTermId": 0,
"rowVersion": "string",
"sa1098T": "string",
"source": "string",
"status": "string",
"studentAcademicYearPaymentPeriodId": 0,
"studentAccountBatchBillingId": 0,
"studentAccountPendingTransactionIdReference": 0,
"studentAwardId": 0,
"studentBankAccountId": 0,
"studentCreditCardId": 0,
"studentEnrollmentPeriodFeeId": 0,
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"studentRevenueDetailId": 0,
"syAddressId": 0,
"termId": 0,
"transactionAmount": 0,
"transactionCurrencyCodeId": 0,
"transactionDate": "2019-08-24T14:15:22Z",
"transactionNumber": 0,
"tuitionDiscountPolicyId": 0,
"type": "string",
"vendorReferenceNumber": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"studentSubsidiaryAccountTransaction": {"id": 0,
"academicYearSequence": { },
"afterTaxAmount": 0,
"amount": 0,
"bankAccountId": 0,
"bankDepositId": 0,
"billingTransactionCodeId": 0,
"campusId": 0,
"cashDrawerSessionId": 0,
"checkDate": "2019-08-24T14:15:22Z",
"checkNumber": "string",
"checkStatus": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"creditCardAuthorizationNumber": "string",
"creditCardDeclineCode": "string",
"description": "string",
"drn": "string",
"eftClearedDate": "2019-08-24T14:15:22Z",
"eftNumber": "string",
"eftStatus": "string",
"exchangeRate": 0,
"foreignExchangeGainLoss": 0,
"isGeneralLedgerStatusFlag": true,
"isIncludedIn1098T": true,
"isInPendingQueue": true,
"isPostedToGeneralLedger": true,
"isPreviousYear": true,
"isReconciledInCnf": true,
"isReissued": true,
"isScholarshipOrGrant": true,
"isSentBack": true,
"isTaxIncluded": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"paymentDueDate": "2019-08-24T14:15:22Z",
"paymentType": "string",
"preferredCurrencyAmount": 0,
"primaryCurrencyCodeId": 0,
"receiptNumber": "string",
"reference": "string",
"rowVersion": "string",
"source": "string",
"studentCreditCardId": 0,
"studentRelationshipAddressId": 0,
"studentSubsidiaryAccountId": 0,
"studentSubsidiaryAccountRefundId": 0,
"termId": 0,
"transactionCurrencyCodeId": 0,
"transactionDate": "2019-08-24T14:15:22Z",
"transactionNumber": { },
"type": "string",
"vendorReferenceNumber": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"returnValidationCode": "string",
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Adjust Account Transaction Payment

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-adjustaccounttransactionpayment-request-payload)

id	number <int32>
studentId	number <int32>
studentCreditCardId	number <int32>
description	string
paymentType	string
reference	string
checkNumber	string
transactionAmount	number <double>
bankAccountId	number <int32>
creditCardAuthorizationNumber	string
creditCardDeclineCode	string
studentEnrollmentPeriodId	number <int32>
academicYearSequence	number <int32>
termId	number <int32>
transactionDate	string <date-time>
transactionNumber	number <int32>
studentAcademicYearPaymentPeriodId	number <int32>
syAddressId	number <int32>
note	string
rowVersion	string
studentSubsidiaryAccountTransactionId	number <int32>
classSectionId	number <int32>
isIncludeIn1098T	boolean
isScholarshipOrGrant	boolean
studentBankAccountId	number <int32>
extendedProperties	Array of any
drn	string
appliedInvoices	object

Responses

Request samples

Payload

Content type

application/json

{"payload": {"id": 0,
"studentId": 0,
"studentCreditCardId": 0,
"description": "string",
"paymentType": "string",
"reference": "string",
"checkNumber": "string",
"transactionAmount": 0,
"bankAccountId": 0,
"creditCardAuthorizationNumber": "string",
"creditCardDeclineCode": "string",
"studentEnrollmentPeriodId": 0,
"academicYearSequence": 0,
"termId": 0,
"transactionDate": "2019-08-24T14:15:22Z",
"transactionNumber": 0,
"studentAcademicYearPaymentPeriodId": 0,
"syAddressId": 0,
"note": "string",
"rowVersion": "string",
"studentSubsidiaryAccountTransactionId": 0,
"classSectionId": 0,
"isIncludeIn1098T": true,
"isScholarshipOrGrant": true,
"studentBankAccountId": 0,
"extendedProperties": [null
],
"drn": "string",
"appliedInvoices": { }
}
}

Response samples

Content type

application/json

{"payload": {"data": {"studentAccountTransaction": {"id": 0,
"academicYearSequence": 0,
"achBatchFileId": 0,
"admissionsRepId": 0,
"afterTaxAmount": 0,
"agencyBranchCreditCardId": 0,
"amountPaid": 0,
"appliedDate": "2019-08-24T14:15:22Z",
"awardBursaryConfigDetailId": 0,
"bankAccountId": 0,
"bankDepositId": 0,
"batchNumber": "string",
"billingTransactionCode": "string",
"campusId": 0,
"cashDrawerSessionId": 0,
"checkClearedDate": "2019-08-24T14:15:22Z",
"checkNumber": "string",
"checkStatus": "string",
"classSectionId": 0,
"courseAmountToRetain": 0,
"courseId": 0,
"courseRefundPolicyId": 0,
"createdByUserId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditCardAuthorizationNumber": "string",
"creditCardBatchTransactionId": 0,
"creditCardDeclineCode": "string",
"depositId": 0,
"description": "string",
"discountAmount": 0,
"drn": "string",
"eftClearedDate": "2019-08-24T14:15:22Z",
"eftNumber": "string",
"eftStatus": "string",
"exchangeRate": 0,
"foreignExchangeGainLoss": 0,
"invoiceAddedDate": "2019-08-24T14:15:22Z",
"invoiceNumber": "string",
"isAutomatedProcess": true,
"isGeneralLedgerStatusFlag": true,
"isInPendingQueue": true,
"isManualCheckExtract": true,
"isPenaltyProcessed": true,
"isPostedToGeneralLedger": true,
"isPreviousYear1098t": true,
"isReconciledInCnf": true,
"isReissued": true,
"isSentBack": true,
"isTaxIncluded": true,
"isVoidedTransaction": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"merchantProcessingCode": "string",
"originalStudentAccountTransactionId": 0,
"paidDisbursementId": 0,
"paymentDueDate": "2019-08-24T14:15:22Z",
"paymentPeriodId": 0,
"paymentType": "string",
"postDate": "2019-08-24T14:15:22Z",
"preferredCurrencyAmount": 0,
"primaryCurrencyCodeId": 0,
"receiptNumber": "string",
"receiptPrintedDate": "2019-08-24T14:15:22Z",
"reference": "string",
"refundCalculationId": 0,
"refundId": 0,
"registrationTermId": 0,
"rowVersion": "string",
"sa1098T": "string",
"source": "string",
"status": "string",
"studentAcademicYearPaymentPeriodId": 0,
"studentAccountBatchBillingId": 0,
"studentAccountPendingTransactionIdReference": 0,
"studentAwardId": 0,
"studentBankAccountId": 0,
"studentCreditCardId": 0,
"studentEnrollmentPeriodFeeId": 0,
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"studentRevenueDetailId": 0,
"syAddressId": 0,
"termId": 0,
"transactionAmount": 0,
"transactionCurrencyCodeId": 0,
"transactionDate": "2019-08-24T14:15:22Z",
"transactionNumber": 0,
"tuitionDiscountPolicyId": 0,
"type": "string",
"vendorReferenceNumber": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"studentSubsidiaryAccountTransaction": {"id": 0,
"academicYearSequence": { },
"afterTaxAmount": 0,
"amount": 0,
"bankAccountId": 0,
"bankDepositId": 0,
"billingTransactionCodeId": 0,
"campusId": 0,
"cashDrawerSessionId": 0,
"checkDate": "2019-08-24T14:15:22Z",
"checkNumber": "string",
"checkStatus": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"creditCardAuthorizationNumber": "string",
"creditCardDeclineCode": "string",
"description": "string",
"drn": "string",
"eftClearedDate": "2019-08-24T14:15:22Z",
"eftNumber": "string",
"eftStatus": "string",
"exchangeRate": 0,
"foreignExchangeGainLoss": 0,
"isGeneralLedgerStatusFlag": true,
"isIncludedIn1098T": true,
"isInPendingQueue": true,
"isPostedToGeneralLedger": true,
"isPreviousYear": true,
"isReconciledInCnf": true,
"isReissued": true,
"isScholarshipOrGrant": true,
"isSentBack": true,
"isTaxIncluded": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"paymentDueDate": "2019-08-24T14:15:22Z",
"paymentType": "string",
"preferredCurrencyAmount": 0,
"primaryCurrencyCodeId": 0,
"receiptNumber": "string",
"reference": "string",
"rowVersion": "string",
"source": "string",
"studentCreditCardId": 0,
"studentRelationshipAddressId": 0,
"studentSubsidiaryAccountId": 0,
"studentSubsidiaryAccountRefundId": 0,
"termId": 0,
"transactionCurrencyCodeId": 0,
"transactionDate": "2019-08-24T14:15:22Z",
"transactionNumber": { },
"type": "string",
"vendorReferenceNumber": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Adjust Account Transaction Refund

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-adjustaccounttransactionrefund-request-payload)

id	number <int32>
studentEnrollmentPeriodId	number <int32>
studentId	number <int32>
termId	number <int32>
academicYearSequence	number <int32>
transactionDate	string <date-time>
transactionAmount	number <double>
studentAcademicYearPaymentPeriodId	number <int32>
checkNumber	string
checkStatus	string
checkClearedDate	string <date-time>
bankAccountId	number <int32>
description	string
reference	string
ignoreTermRequired	boolean
allowMultipleRefundsVoid	boolean
note	string
isVoidRefund	boolean
isReScheduleCheckPrint	boolean
isIncludeIn1098T	boolean
isScholarshipOrGrant	boolean
isPreviousYear	boolean

Responses

Request samples

Payload

Content type

application/json

{"payload": {"id": 0,
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"termId": 0,
"academicYearSequence": 0,
"transactionDate": "2019-08-24T14:15:22Z",
"transactionAmount": 0,
"studentAcademicYearPaymentPeriodId": 0,
"checkNumber": "string",
"checkStatus": "string",
"checkClearedDate": "2019-08-24T14:15:22Z",
"bankAccountId": 0,
"description": "string",
"reference": "string",
"ignoreTermRequired": true,
"allowMultipleRefundsVoid": true,
"note": "string",
"isVoidRefund": true,
"isReScheduleCheckPrint": true,
"isIncludeIn1098T": true,
"isScholarshipOrGrant": true,
"isPreviousYear": true
}
}

Response samples

Content type

application/json

{"payload": {"data": {"returnCode": "string",
"associatedStudentAccountTransactionList": [{"id": 0,
"academicYearSequence": 0,
"achBatchFileId": 0,
"admissionsRepId": 0,
"afterTaxAmount": 0,
"agencyBranchCreditCardId": 0,
"amountPaid": 0,
"appliedDate": "2019-08-24T14:15:22Z",
"awardBursaryConfigDetailId": 0,
"bankAccountId": 0,
"bankDepositId": 0,
"batchNumber": "string",
"billingTransactionCode": "string",
"campusId": 0,
"cashDrawerSessionId": 0,
"checkClearedDate": "2019-08-24T14:15:22Z",
"checkNumber": "string",
"checkStatus": "string",
"classSectionId": 0,
"courseAmountToRetain": 0,
"courseId": 0,
"courseRefundPolicyId": 0,
"createdByUserId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditCardAuthorizationNumber": "string",
"creditCardBatchTransactionId": 0,
"creditCardDeclineCode": "string",
"depositId": 0,
"description": "string",
"discountAmount": 0,
"drn": "string",
"eftClearedDate": "2019-08-24T14:15:22Z",
"eftNumber": "string",
"eftStatus": "string",
"exchangeRate": 0,
"foreignExchangeGainLoss": 0,
"invoiceAddedDate": "2019-08-24T14:15:22Z",
"invoiceNumber": "string",
"isAutomatedProcess": true,
"isGeneralLedgerStatusFlag": true,
"isInPendingQueue": true,
"isManualCheckExtract": true,
"isPenaltyProcessed": true,
"isPostedToGeneralLedger": true,
"isPreviousYear1098t": true,
"isReconciledInCnf": true,
"isReissued": true,
"isSentBack": true,
"isTaxIncluded": true,
"isVoidedTransaction": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"merchantProcessingCode": "string",
"originalStudentAccountTransactionId": 0,
"paidDisbursementId": 0,
"paymentDueDate": "2019-08-24T14:15:22Z",
"paymentPeriodId": 0,
"paymentType": "string",
"postDate": "2019-08-24T14:15:22Z",
"preferredCurrencyAmount": 0,
"primaryCurrencyCodeId": 0,
"receiptNumber": "string",
"receiptPrintedDate": "2019-08-24T14:15:22Z",
"reference": "string",
"refundCalculationId": 0,
"refundId": 0,
"registrationTermId": 0,
"rowVersion": "string",
"sa1098T": "string",
"source": "string",
"status": "string",
"studentAcademicYearPaymentPeriodId": 0,
"studentAccountBatchBillingId": 0,
"studentAccountPendingTransactionIdReference": 0,
"studentAwardId": 0,
"studentBankAccountId": 0,
"studentCreditCardId": 0,
"studentEnrollmentPeriodFeeId": 0,
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"studentRevenueDetailId": 0,
"syAddressId": 0,
"termId": 0,
"transactionAmount": 0,
"transactionCurrencyCodeId": 0,
"transactionDate": "2019-08-24T14:15:22Z",
"transactionNumber": 0,
"tuitionDiscountPolicyId": 0,
"type": "string",
"vendorReferenceNumber": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
],
"studentSubsidiaryAccountTransaction": {"id": 0,
"academicYearSequence": { },
"afterTaxAmount": 0,
"amount": 0,
"bankAccountId": 0,
"bankDepositId": 0,
"billingTransactionCodeId": 0,
"campusId": 0,
"cashDrawerSessionId": 0,
"checkDate": "2019-08-24T14:15:22Z",
"checkNumber": "string",
"checkStatus": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"creditCardAuthorizationNumber": "string",
"creditCardDeclineCode": "string",
"description": "string",
"drn": "string",
"eftClearedDate": "2019-08-24T14:15:22Z",
"eftNumber": "string",
"eftStatus": "string",
"exchangeRate": 0,
"foreignExchangeGainLoss": 0,
"isGeneralLedgerStatusFlag": true,
"isIncludedIn1098T": true,
"isInPendingQueue": true,
"isPostedToGeneralLedger": true,
"isPreviousYear": true,
"isReconciledInCnf": true,
"isReissued": true,
"isScholarshipOrGrant": true,
"isSentBack": true,
"isTaxIncluded": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"paymentDueDate": "2019-08-24T14:15:22Z",
"paymentType": "string",
"preferredCurrencyAmount": 0,
"primaryCurrencyCodeId": 0,
"receiptNumber": "string",
"reference": "string",
"rowVersion": "string",
"source": "string",
"studentCreditCardId": 0,
"studentRelationshipAddressId": 0,
"studentSubsidiaryAccountId": 0,
"studentSubsidiaryAccountRefundId": 0,
"termId": 0,
"transactionCurrencyCodeId": 0,
"transactionDate": "2019-08-24T14:15:22Z",
"transactionNumber": { },
"type": "string",
"vendorReferenceNumber": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Apply Account Transaction Credit

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-applyaccounttransactioncredit-request-payload)

studentAccountTransactionId	number <int32>
studentId	number <int32>
isChildSelected	boolean
	Array of objects (cmc-nexus-studentAccounts-services-applyAccountTransactionCredit)

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentAccountTransactionId": 0,
"studentId": 0,
"isChildSelected": true,
"applyAccountTransactionCreditList": [{"appliedToStudentAccountTransactionId": 0,
"transactionAmount": 0,
"amountPaid": 0,
"differenceAmountPaid": 0,
"transactionBalance": 0,
"transactionNumber": 0
}
]
}
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Authenticate Cashier Login

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-authenticatecashierlogin-request-payload)

username	string
password	string

Responses

Request samples

Payload

Content type

application/json

{"payload": {"username": "string",
"password": "string"
}
}

Response samples

Content type

application/json

{"payload": {"data": {"authenticationResult": 0,
"userId": 0,
"username": "string",
"upn": "string",
"authenticationType": "string",
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Auto Apply Account Transaction Credit

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-autoapplyaccounttransactioncredit-request-payload)

studentId

number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Create Student Account Transaction

Authorizations:

apikey

Responses

Response samples

Content type

application/json

{"payload": {"data": {"id": 0,
"academicYearSequence": 0,
"achBatchFileId": 0,
"admissionsRepId": 0,
"afterTaxAmount": 0,
"agencyBranchCreditCardId": 0,
"amountPaid": 0,
"appliedDate": "2019-08-24T14:15:22Z",
"awardBursaryConfigDetailId": 0,
"bankAccountId": 0,
"bankDepositId": 0,
"batchNumber": "string",
"billingTransactionCode": "string",
"campusId": 0,
"cashDrawerSessionId": 0,
"checkClearedDate": "2019-08-24T14:15:22Z",
"checkNumber": "string",
"checkStatus": "string",
"classSectionId": 0,
"courseAmountToRetain": 0,
"courseId": 0,
"courseRefundPolicyId": 0,
"createdByUserId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditCardAuthorizationNumber": "string",
"creditCardBatchTransactionId": 0,
"creditCardDeclineCode": "string",
"depositId": 0,
"description": "string",
"discountAmount": 0,
"drn": "string",
"eftClearedDate": "2019-08-24T14:15:22Z",
"eftNumber": "string",
"eftStatus": "string",
"exchangeRate": 0,
"foreignExchangeGainLoss": 0,
"invoiceAddedDate": "2019-08-24T14:15:22Z",
"invoiceNumber": "string",
"isAutomatedProcess": true,
"isGeneralLedgerStatusFlag": true,
"isInPendingQueue": true,
"isManualCheckExtract": true,
"isPenaltyProcessed": true,
"isPostedToGeneralLedger": true,
"isPreviousYear1098t": true,
"isReconciledInCnf": true,
"isReissued": true,
"isSentBack": true,
"isTaxIncluded": true,
"isVoidedTransaction": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"merchantProcessingCode": "string",
"originalStudentAccountTransactionId": 0,
"paidDisbursementId": 0,
"paymentDueDate": "2019-08-24T14:15:22Z",
"paymentPeriodId": 0,
"paymentType": "string",
"postDate": "2019-08-24T14:15:22Z",
"preferredCurrencyAmount": 0,
"primaryCurrencyCodeId": 0,
"receiptNumber": "string",
"receiptPrintedDate": "2019-08-24T14:15:22Z",
"reference": "string",
"refundCalculationId": 0,
"refundId": 0,
"registrationTermId": 0,
"rowVersion": "string",
"sa1098T": "string",
"source": "string",
"status": "string",
"studentAcademicYearPaymentPeriodId": 0,
"studentAccountBatchBillingId": 0,
"studentAccountPendingTransactionIdReference": 0,
"studentAwardId": 0,
"studentBankAccountId": 0,
"studentCreditCardId": 0,
"studentEnrollmentPeriodFeeId": 0,
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"studentRevenueDetailId": 0,
"syAddressId": 0,
"termId": 0,
"transactionAmount": 0,
"transactionCurrencyCodeId": 0,
"transactionDate": "2019-08-24T14:15:22Z",
"transactionNumber": 0,
"tuitionDiscountPolicyId": 0,
"type": "string",
"vendorReferenceNumber": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Create Disbursements For Agency Data

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-createdisbursementsforagencydata-request-payload)

invoiceOption	string
campusIdList	object
agencyBranchIdList	object
closingDate	string <date-time>
invoiceType	string
comment	string
isEnrollmentInformation	boolean
isStudentAddress	boolean
isCourseSchedule	boolean
isPaymentOption	boolean
isGrade	boolean
termId	number <int32>
isEnforceBatchIntegrity	boolean
userId	number <int32>
reprint	number <int32>
	Array of objects (cmc-nexus-studentAccounts-services-thirdPartyAgencyBatchData)

Responses

Request samples

Payload

Content type

application/json

{"payload": {"invoiceOption": "string",
"campusIdList": { },
"agencyBranchIdList": { },
"closingDate": "2019-08-24T14:15:22Z",
"invoiceType": "string",
"comment": "string",
"isEnrollmentInformation": true,
"isStudentAddress": true,
"isCourseSchedule": true,
"isPaymentOption": true,
"isGrade": true,
"termId": 0,
"isEnforceBatchIntegrity": true,
"userId": 0,
"reprint": 0,
"thirdPartyAgencyBatchDataList": [{"invoiceType": "string",
"studentId": 0,
"printId": "string",
"accountBalance": 0,
"studentAwardId": 0,
"agencyBranchId": 0,
"invoiceNumber": "string",
"invoiceDate": "2019-08-24T14:15:22Z"
}
]
}
}

Response samples

Content type

application/json

{"payload": {"data": {"studentRecordList": [{"syStudentID": 0,
"amAgencyBranchID": 0,
"thirdPartyInvoiceNumber": "string",
"thirdPartyInvoiceLine": "string",
"faFundSourceID": 0,
"awardYear": "string",
"faStudentAidID": 0,
"faSchedID": 0,
"netAmount": 0
}
],
"isSuccess": true,
"totalStudent": 0,
"fileNames": ["string"
],
"invoiceOption": "string",
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Delete Student Account Transaction

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-delete-request-payload)

id	number <int32> Id
academicYearSequence	number <double> Academic Year Sequence
achBatchFileId	number <int32> Ach Batch File Id
admissionsRepId	number <int32> Admissions Rep Id
afterTaxAmount	number <double> After Tax Amount
agencyBranchCreditCardId	number <int32> Agency Branch Credit Card Id
amountPaid	number <double> Amount Paid
appliedDate	string <date-time> Applied Date
awardBursaryConfigDetailId	number <int32> Award Bursary Config Detail Id
bankAccountId	number <int32> Bank Account Id
bankDepositId	number <int32> Bank Deposit Id
batchNumber	string Batch Number
billingTransactionCode	string Billing Transaction Code
campusId	number <int32> Campus Id
cashDrawerSessionId	number <int32> Cash Drawer Session Id
checkClearedDate	string <date-time> Check Cleared Date
checkNumber	string Check Number
checkStatus	string Check Status
classSectionId	number <int32> Class Section Id
courseAmountToRetain	number <double> Course Amount To Retain
courseId	number <int32> Course Id
courseRefundPolicyId	number <int32> Course Refund Policy Id
createdByUserId	number <int32> Created By User Id
createdDateTime	string <date-time> Created Date Time
creditCardAuthorizationNumber	string Credit Card Authorization Number
creditCardBatchTransactionId	number <int32> Credit Card Batch Transaction Id
creditCardDeclineCode	string Credit Card Decline Code
depositId	number <int32> Deposit Id
description	string Description
discountAmount	number <double> Discount Amount
drn	string Drn
eftClearedDate	string <date-time> Eft Cleared Date
eftNumber	string Eft Number
eftStatus	string Eft Status
exchangeRate	number <double> Exchange Rate
foreignExchangeGainLoss	number <double> Foreign Exchange Gain Loss
invoiceAddedDate	string <date-time> Invoice Added Date
invoiceNumber	string Invoice Number
isAutomatedProcess	boolean Is Automated Process
isGeneralLedgerStatusFlag	boolean Is General Ledger Status Flag
isInPendingQueue	boolean Is In Pending Queue
isManualCheckExtract	boolean Is Manual Check Extract
isPenaltyProcessed	boolean Is Penalty Processed
isPostedToGeneralLedger	boolean Is Posted To General Ledger
isPreviousYear1098t	boolean Is Previous Year1098t
isReconciledInCnf	boolean Is Reconciled In Cnf
isReissued	boolean Is Reissued
isSentBack	boolean Is Sent Back
isTaxIncluded	boolean Is Tax Included
isVoidedTransaction	boolean Is Voided Transaction
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
merchantProcessingCode	string Merchant Processing Code
originalStudentAccountTransactionId	number <int32> Original Student Account Transaction Id
paidDisbursementId	number <int32> Paid Disbursement Id
paymentDueDate	string <date-time> Transaction Due Date
paymentPeriodId	number <int32> Payment Period Id
paymentType	string Payment Type
postDate	string <date-time> Post Date
preferredCurrencyAmount	number <double> Preferred Currency Amount
primaryCurrencyCodeId	number <int32> Primary Currency Code Id
receiptNumber	string Receipt Number
receiptPrintedDate	string <date-time> Receipt Printed Date
reference	string Reference
refundCalculationId	number <int32> Refund Calculation Id
refundId	number <int32> Refund Id
registrationTermId	number <int32> Registration Term Id
rowVersion	string
sa1098T	string Sa1098T
source	string Source
status	string Status
studentAcademicYearPaymentPeriodId	number <int32> Student Academic Year Payment Period Id
studentAccountBatchBillingId	number <int32> Student Account Batch Billing Id
studentAccountPendingTransactionIdReference	number <int32> Student Account Pending Transaction Id Reference
studentAwardId	number <int32> Student Award Id
studentBankAccountId	number <int32> Student Bank Account Id
studentCreditCardId	number <int32> Student Credit Card Id
studentEnrollmentPeriodFeeId	number <int32> Student Enrollment Period Fee Id
studentEnrollmentPeriodId	number <int32> Student Enrollment Period Id
studentId	number <int32> Student Id
studentRevenueDetailId	number <int32> Student Revenue Detail Id
syAddressId	number <int32> Sy Address Id
termId	number <int32> Term Id
transactionAmount	number <double> Transaction Amount
transactionCurrencyCodeId	number <int32> Transaction Currency Code Id
transactionDate	string <date-time> Transaction Date
transactionNumber	number <double> Transaction Number
tuitionDiscountPolicyId	number <int32> Tuition Discount Policy Id
type	string Type
vendorReferenceNumber	string Vendor Reference Number
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"id": 0,
"academicYearSequence": 0,
"achBatchFileId": 0,
"admissionsRepId": 0,
"afterTaxAmount": 0,
"agencyBranchCreditCardId": 0,
"amountPaid": 0,
"appliedDate": "2019-08-24T14:15:22Z",
"awardBursaryConfigDetailId": 0,
"bankAccountId": 0,
"bankDepositId": 0,
"batchNumber": "string",
"billingTransactionCode": "string",
"campusId": 0,
"cashDrawerSessionId": 0,
"checkClearedDate": "2019-08-24T14:15:22Z",
"checkNumber": "string",
"checkStatus": "string",
"classSectionId": 0,
"courseAmountToRetain": 0,
"courseId": 0,
"courseRefundPolicyId": 0,
"createdByUserId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditCardAuthorizationNumber": "string",
"creditCardBatchTransactionId": 0,
"creditCardDeclineCode": "string",
"depositId": 0,
"description": "string",
"discountAmount": 0,
"drn": "string",
"eftClearedDate": "2019-08-24T14:15:22Z",
"eftNumber": "string",
"eftStatus": "string",
"exchangeRate": 0,
"foreignExchangeGainLoss": 0,
"invoiceAddedDate": "2019-08-24T14:15:22Z",
"invoiceNumber": "string",
"isAutomatedProcess": true,
"isGeneralLedgerStatusFlag": true,
"isInPendingQueue": true,
"isManualCheckExtract": true,
"isPenaltyProcessed": true,
"isPostedToGeneralLedger": true,
"isPreviousYear1098t": true,
"isReconciledInCnf": true,
"isReissued": true,
"isSentBack": true,
"isTaxIncluded": true,
"isVoidedTransaction": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"merchantProcessingCode": "string",
"originalStudentAccountTransactionId": 0,
"paidDisbursementId": 0,
"paymentDueDate": "2019-08-24T14:15:22Z",
"paymentPeriodId": 0,
"paymentType": "string",
"postDate": "2019-08-24T14:15:22Z",
"preferredCurrencyAmount": 0,
"primaryCurrencyCodeId": 0,
"receiptNumber": "string",
"receiptPrintedDate": "2019-08-24T14:15:22Z",
"reference": "string",
"refundCalculationId": 0,
"refundId": 0,
"registrationTermId": 0,
"rowVersion": "string",
"sa1098T": "string",
"source": "string",
"status": "string",
"studentAcademicYearPaymentPeriodId": 0,
"studentAccountBatchBillingId": 0,
"studentAccountPendingTransactionIdReference": 0,
"studentAwardId": 0,
"studentBankAccountId": 0,
"studentCreditCardId": 0,
"studentEnrollmentPeriodFeeId": 0,
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"studentRevenueDetailId": 0,
"syAddressId": 0,
"termId": 0,
"transactionAmount": 0,
"transactionCurrencyCodeId": 0,
"transactionDate": "2019-08-24T14:15:22Z",
"transactionNumber": 0,
"tuitionDiscountPolicyId": 0,
"type": "string",
"vendorReferenceNumber": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"deleted": true
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Delete Account Transaction Charge

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-deleteaccounttransactioncharge-request-payload)

id	number <int32>
note	string
studentAccountTransactionId	number <int32>
studentSubsidiaryAccountTransactionId	number <int32>
studentId	number <int32>
studentEnrollmentPeriodId	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"id": 0,
"note": "string",
"studentAccountTransactionId": 0,
"studentSubsidiaryAccountTransactionId": 0,
"studentId": 0,
"studentEnrollmentPeriodId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Delete Account Transaction Payment

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-deleteaccounttransactionpayment-request-payload)

studentAccountTransactionId	number <int32>
studentSubsidiaryAccountTransactionId	number <int32>
studentId	number <int32>
studentEnrollmentPeriodId	number <int32>
note	string

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentAccountTransactionId": 0,
"studentSubsidiaryAccountTransactionId": 0,
"studentId": 0,
"studentEnrollmentPeriodId": 0,
"note": "string"
}
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Delete Disbursement Batch

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-deletedisbursementbatch-request-payload)

batchId	number <int32>
userId	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"batchId": 0,
"userId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"isSuccess": true,
"message": "string",
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

General Ledger Release Undo

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-generalledgerreleaseundo-request-payload)

campusId	number <int32>
batchNumber	string

Responses

Request samples

Payload

Content type

application/json

{"payload": {"campusId": 0,
"batchNumber": "string"
}
}

Response samples

Content type

application/json

{"payload": {"data": {"gLReleaseUndoSuccess": true,
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Generate Interest By Account Balance

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-generateinterestbyaccountbalance-request-payload)

campuses	object
studentGroupId	number <int32>
systemSchoolStatuses	object
transactionDate	string <date-time>
lastInterestDate	string <date-time>
reference	string
interestRate	string
termId	number <int32>
billCodeId	number <int32>
hasIncurredCharges	boolean
isIncurredChargeByTerm	boolean
incurredChargeByFromDate	string <date-time>
incurredChargeByEndDate	string <date-time>
incurredChargeByTerms	object
hasExpectedFundings	boolean
excludeFundSource	boolean
fundSources	object
fundSourceType	string
fundFromDate	string <date-time>
fundToDate	string <date-time>
fundByTerms	object

Responses

Request samples

Payload

Content type

application/json

{"payload": {"campuses": { },
"studentGroupId": 0,
"systemSchoolStatuses": { },
"transactionDate": "2019-08-24T14:15:22Z",
"lastInterestDate": "2019-08-24T14:15:22Z",
"reference": "string",
"interestRate": "string",
"termId": 0,
"billCodeId": 0,
"hasIncurredCharges": true,
"isIncurredChargeByTerm": true,
"incurredChargeByFromDate": "2019-08-24T14:15:22Z",
"incurredChargeByEndDate": "2019-08-24T14:15:22Z",
"incurredChargeByTerms": { },
"hasExpectedFundings": true,
"excludeFundSource": true,
"fundSources": { },
"fundSourceType": "string",
"fundFromDate": "2019-08-24T14:15:22Z",
"fundToDate": "2019-08-24T14:15:22Z",
"fundByTerms": { }
}
}

Response samples

Content type

application/json

{"payload": {"data": {"accountBalanceList": [{"studentName": "string",
"sSN": "string",
"stunum": "string",
"enrollNum": 0,
"syStudentID": 0,
"syCampusID": 0,
"syCampusDescrip": "string",
"faStudentAidID": 0,
"interestAmount": 0,
"code": "string",
"faFundSourceID": 0,
"principalBalance": 0,
"interestRate": 0,
"firstPayDate": "2019-08-24T14:15:22Z",
"nextPayDate": "2019-08-24T14:15:22Z",
"lastInterestDate": "2019-08-24T14:15:22Z",
"userID": 0,
"adTermID": 0,
"adEnrollID": 0,
"amRepID": 0,
"syGroupsID": 0,
"sySchoolStatusID": 0,
"originalStartDate": "2019-08-24T14:15:22Z",
"studentStatus": "string"
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Generate Interest By Principal Balance

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-generateinterestbyprincipalbalance-request-payload)

campusId	object
fundSourceId	object
schoolStatusID	object
termId	number <int32>
transactionDate	string <date-time>
referenceText	string
userId	number <int32>
lastInterestDate	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"campusId": { },
"fundSourceId": { },
"schoolStatusID": { },
"termId": 0,
"transactionDate": "2019-08-24T14:15:22Z",
"referenceText": "string",
"userId": 0,
"lastInterestDate": "2019-08-24T14:15:22Z"
}
}

Response samples

Content type

application/json

{"payload": {"data": {"principalBalanceList": [{"studentName": "string",
"sSN": "string",
"stunum": "string",
"enrollNum": "string",
"syStudentID": 0,
"syCampusID": 0,
"faStudentAidID": 0,
"interestAmount": 0,
"code": "string",
"faFundSourceID": 0,
"principalBalance": 0,
"interestRate": 0,
"firstPayDate": "2019-08-24T14:15:22Z",
"nextPayDate": "2019-08-24T14:15:22Z",
"lastInterestDate": "2019-08-24T14:15:22Z",
"userID": 0,
"adTermID": 0,
"adEnrollID": 0,
"amRepID": 0,
"syGroupsID": 0,
"sySchoolStatusID": 0,
"originalStartDate": "2019-08-24T14:15:22Z",
"campusDescrip": "string",
"studentStatus": "string"
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Generate Interest Charges Update

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-generateinterestchargesupdate-request-payload)

billCode	string
interestChargeBasis	string
	Array of objects (cmc-nexus-studentAccounts-services-generateInterestCharges)

Responses

Request samples

Payload

Content type

application/json

{"payload": {"billCode": "string",
"interestChargeBasis": "string",
"generateInterestCharges": [{"studentId": 0,
"campusId": 0,
"enrollId": 0,
"termId": 0,
"admissionRepId": 0,
"studentAidId": 0,
"transactionDate": "2019-08-24T14:15:22Z",
"originalStartDate": "2019-08-24T14:15:22Z",
"amount": 0,
"referenceNumbmer": "string",
"balance": 0,
"paymentDate": "2019-08-24T14:15:22Z",
"lastInterestDate": "2019-08-24T14:15:22Z",
"fundSource": "string",
"interestRate": 0,
"studentStatus": "string",
"userId": "string"
}
]
}
}

Response samples

Content type

application/json

{"payload": {"data": {"totalInterestCharge": 0,
"totalStudentCount": 0,
"saveInterstChargeResponse": [{"studentId": 0,
"isProcessSuccess": true,
"speNotifications": "string",
"interestChargeBasis": "string"
}
],
"speNotifications": "string",
"isProcessSuccess": true,
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Student Account Transaction

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-get-request-payload)

id	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"id": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"id": 0,
"academicYearSequence": 0,
"achBatchFileId": 0,
"admissionsRepId": 0,
"afterTaxAmount": 0,
"agencyBranchCreditCardId": 0,
"amountPaid": 0,
"appliedDate": "2019-08-24T14:15:22Z",
"awardBursaryConfigDetailId": 0,
"bankAccountId": 0,
"bankDepositId": 0,
"batchNumber": "string",
"billingTransactionCode": "string",
"campusId": 0,
"cashDrawerSessionId": 0,
"checkClearedDate": "2019-08-24T14:15:22Z",
"checkNumber": "string",
"checkStatus": "string",
"classSectionId": 0,
"courseAmountToRetain": 0,
"courseId": 0,
"courseRefundPolicyId": 0,
"createdByUserId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditCardAuthorizationNumber": "string",
"creditCardBatchTransactionId": 0,
"creditCardDeclineCode": "string",
"depositId": 0,
"description": "string",
"discountAmount": 0,
"drn": "string",
"eftClearedDate": "2019-08-24T14:15:22Z",
"eftNumber": "string",
"eftStatus": "string",
"exchangeRate": 0,
"foreignExchangeGainLoss": 0,
"invoiceAddedDate": "2019-08-24T14:15:22Z",
"invoiceNumber": "string",
"isAutomatedProcess": true,
"isGeneralLedgerStatusFlag": true,
"isInPendingQueue": true,
"isManualCheckExtract": true,
"isPenaltyProcessed": true,
"isPostedToGeneralLedger": true,
"isPreviousYear1098t": true,
"isReconciledInCnf": true,
"isReissued": true,
"isSentBack": true,
"isTaxIncluded": true,
"isVoidedTransaction": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"merchantProcessingCode": "string",
"originalStudentAccountTransactionId": 0,
"paidDisbursementId": 0,
"paymentDueDate": "2019-08-24T14:15:22Z",
"paymentPeriodId": 0,
"paymentType": "string",
"postDate": "2019-08-24T14:15:22Z",
"preferredCurrencyAmount": 0,
"primaryCurrencyCodeId": 0,
"receiptNumber": "string",
"receiptPrintedDate": "2019-08-24T14:15:22Z",
"reference": "string",
"refundCalculationId": 0,
"refundId": 0,
"registrationTermId": 0,
"rowVersion": "string",
"sa1098T": "string",
"source": "string",
"status": "string",
"studentAcademicYearPaymentPeriodId": 0,
"studentAccountBatchBillingId": 0,
"studentAccountPendingTransactionIdReference": 0,
"studentAwardId": 0,
"studentBankAccountId": 0,
"studentCreditCardId": 0,
"studentEnrollmentPeriodFeeId": 0,
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"studentRevenueDetailId": 0,
"syAddressId": 0,
"termId": 0,
"transactionAmount": 0,
"transactionCurrencyCodeId": 0,
"transactionDate": "2019-08-24T14:15:22Z",
"transactionNumber": 0,
"tuitionDiscountPolicyId": 0,
"type": "string",
"vendorReferenceNumber": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Agency Branches By Agency

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-getagencybranchesbyagency-request-payload)

agencyIdList	Array of numbers <int32> [ items <int32 > ]
invoiceType	string

Responses

Request samples

Payload

Content type

application/json

{"payload": {"agencyIdList": [0
],
"invoiceType": "string"
}
}

Response samples

Content type

application/json

{"payload": {"data": {"agencyBranchList": [{"id": 0,
"city": "string",
"name": "string"
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Agency Records For Batch

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-getagencyrecordsforbatch-request-payload)

actualStartDate	string <date-time>
actualEndDate	string <date-time>
invoiceType	string
isNegativeBalance	boolean
isZeroBalance	boolean
isPositiveBalance	boolean
studentId	number <int32>
columnToPrint	string
closingDate	string <date-time>
agencyBranchIdList	object
fundSourceIdList	object
schoolStatusIdList	object
shiftIdList	object
programVersionIdList	object
campusIdList	object
currencyCodeId	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"actualStartDate": "2019-08-24T14:15:22Z",
"actualEndDate": "2019-08-24T14:15:22Z",
"invoiceType": "string",
"isNegativeBalance": true,
"isZeroBalance": true,
"isPositiveBalance": true,
"studentId": 0,
"columnToPrint": "string",
"closingDate": "2019-08-24T14:15:22Z",
"agencyBranchIdList": { },
"fundSourceIdList": { },
"schoolStatusIdList": { },
"shiftIdList": { },
"programVersionIdList": { },
"campusIdList": { },
"currencyCodeId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"agencyRecordsForBatch": [{"studentName": "string",
"printIdentifier": "string",
"agencyBranchNameFundSourceCode": "string",
"invoiceType": "string",
"startDate": "2019-08-24T14:15:22Z",
"accountBalance": 0,
"studentID": 0,
"agencyBranchID": 0,
"studentAwardId": 0
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Agency Records For Student

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-getagencyrecordsforstudent-request-payload)

studentId	number <int32>
invoiceType	string
isNegativeBalance	boolean
isZeroBalance	boolean
isPositiveBalance	boolean
columnToPrint	string
closingDate	string <date-time>
agencyBranchIdList	object
currencyCodeId	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentId": 0,
"invoiceType": "string",
"isNegativeBalance": true,
"isZeroBalance": true,
"isPositiveBalance": true,
"columnToPrint": "string",
"closingDate": "2019-08-24T14:15:22Z",
"agencyBranchIdList": { },
"currencyCodeId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"agencyRecordsForStudent": [{"studentName": "string",
"printIdentifier": "string",
"agencyBranchNameFundSourceCode": "string",
"invoiceType": "string",
"startDate": "2019-08-24T14:15:22Z",
"accountBalance": 0,
"studentId": 0,
"agencyBranchId": 0,
"studentAwardId": 0
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Batch Charge

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-getbatchcharge-request-payload)

campusIdList	Array of numbers <int32> [ items <int32 > ]
shiftIdList	Array of numbers <int32> [ items <int32 > ]
programVersionIdList	Array of numbers <int32> [ items <int32 > ]
studentGroupIdList	Array of numbers <int32> [ items <int32 > ]
studentStatusIdList	Array of numbers <int32> [ items <int32 > ]
academicYearSequence	string
paymentPeriod	string
transactionType	string
transactionDate	string <date-time>
transactionAmount	number <double>
description	string
reference	string
programVersionStartDate	string <date-time>
programVersionEndDate	string <date-time>
paymentPeriodStartDate	string <date-time>
paymentPeriodEndDate	string <date-time>
reenrollStartDate	string <date-time>
reenrollEndDate	string <date-time>
graduationStartDate	string <date-time>
graduationEndDate	string <date-time>
billingCodeTransactionId	number <int32>
termId	number <int32>
serviceTypeId	number <int32>
transactionCurrencyCodeId	number <int32>
isIncludeIn1098T	boolean
subsidiaryAccountTypeId	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"campusIdList": [0
],
"shiftIdList": [0
],
"programVersionIdList": [0
],
"studentGroupIdList": [0
],
"studentStatusIdList": [0
],
"academicYearSequence": "string",
"paymentPeriod": "string",
"transactionType": "string",
"transactionDate": "2019-08-24T14:15:22Z",
"transactionAmount": 0,
"description": "string",
"reference": "string",
"programVersionStartDate": "2019-08-24T14:15:22Z",
"programVersionEndDate": "2019-08-24T14:15:22Z",
"paymentPeriodStartDate": "2019-08-24T14:15:22Z",
"paymentPeriodEndDate": "2019-08-24T14:15:22Z",
"reenrollStartDate": "2019-08-24T14:15:22Z",
"reenrollEndDate": "2019-08-24T14:15:22Z",
"graduationStartDate": "2019-08-24T14:15:22Z",
"graduationEndDate": "2019-08-24T14:15:22Z",
"billingCodeTransactionId": 0,
"termId": 0,
"serviceTypeId": 0,
"transactionCurrencyCodeId": 0,
"isIncludeIn1098T": true,
"subsidiaryAccountTypeId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"studentBatchChargeList": [{"id": 0,
"rowIdentifier": { },
"studentName": "string",
"startDate": "2019-08-24T14:15:22Z",
"programVersionId": 0,
"programVersionCode": "string",
"programVersionName": "string",
"schoolStatusName": "string",
"studentEnrollmentPeriodId": 0,
"enrollmentNumber": "string",
"studentNumber": "string",
"shiftName": "string",
"graduationDate": "2019-08-24T14:15:22Z",
"reenrollDate": "2019-08-24T14:15:22Z",
"transactionType": "string",
"billingTransactionCodeId": 0,
"billingTransactionCode": "string",
"termId": 0,
"termName": "string",
"academicYearSequence": "string",
"description": "string",
"flagOutOfSchool": 0,
"flagMultipleEnrollments": 0,
"feeAmount": 0,
"studentAcademicYearPaymentPeriodId": 0,
"enrollmentCount": 0,
"campusId": 0,
"studentAccountPendingTransactionId": 0
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Disbursement Batches By Campus

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-getdisbursementbatchesbycampus-request-payload)

campusIdList	object
fundSourceIdList	object
disbursementBatchCreatedFromDate	string <date-time>
disbursementBatchCreatedToDate	string <date-time>
thirdPartyInvoiceNumber	string
currencyCodeId	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"campusIdList": { },
"fundSourceIdList": { },
"disbursementBatchCreatedFromDate": "2019-08-24T14:15:22Z",
"disbursementBatchCreatedToDate": "2019-08-24T14:15:22Z",
"thirdPartyInvoiceNumber": "string",
"currencyCodeId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"disbursementBatchesByCampusList": [{"disbursementBatchId": 0,
"isOkToPost": true,
"createdDateTime": "2019-08-24T14:15:22Z",
"isStudentsDropped": true,
"importFileCode": "string",
"fundSourceName": "string",
"fundSourceTypeName": "string",
"lendingInstitutionName": "string",
"staffName": "string",
"fundSourceId": 0,
"fundSourceType": "string",
"numberOfApproved": 0,
"exportImportFileId": 0,
"numberOfDisbursements": 0,
"batchAmount": 0,
"amountApproved": 0,
"reviewed": { },
"agencyBranchId": 0,
"thirdPartyInvoiceNumber": "string",
"paymentsAssociatedToCourses": true
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Student Account Transaction Search List

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-getstudentaccounttransactionsearchlist-request-payload)

searchType	number <int32>
billingTransactionCodeId	number <int32>
description	string
transactionAmountFrom	number <double>
transactionAmountTo	number <double>
referenceNumber	string
checkNumber	string
termId	number <int32>
transactionDateFrom	string <date-time>
transactionDateTo	string <date-time>
expectedStartDateFrom	string <date-time>
expectedStartDateTo	string <date-time>
enrollmentDateFrom	string <date-time>
enrollmentDateTo	string <date-time>
paymentPeriodStartDateFrom	string <date-time>
paymentPeriodStartDateTo	string <date-time>
checkClearedDateFrom	string <date-time>
checkClearedDateTo	string <date-time>
cashDrawerSession	string
campusId	number <int32>
schoolStatusIdList	Array of numbers <int32> [ items <int32 > ]
programIdList	Array of numbers <int32> [ items <int32 > ]
checkStatusIdList	Array of numbers <int32> [ items <int32 > ]
bankAccountIdList	Array of numbers <int32> [ items <int32 > ]
transactionsTypeList	Array of strings
isNonDepositedItemsIncluded	boolean
academicYear	number <int32>
paymentPeriod	number <int32>
fundSourceId	number <int32>
isCashDrawerVisible	boolean
chargesIncluded	object
drn	string

Responses

Request samples

Payload

Content type

application/json

{"payload": {"searchType": 0,
"billingTransactionCodeId": 0,
"description": "string",
"transactionAmountFrom": 0,
"transactionAmountTo": 0,
"referenceNumber": "string",
"checkNumber": "string",
"termId": 0,
"transactionDateFrom": "2019-08-24T14:15:22Z",
"transactionDateTo": "2019-08-24T14:15:22Z",
"expectedStartDateFrom": "2019-08-24T14:15:22Z",
"expectedStartDateTo": "2019-08-24T14:15:22Z",
"enrollmentDateFrom": "2019-08-24T14:15:22Z",
"enrollmentDateTo": "2019-08-24T14:15:22Z",
"paymentPeriodStartDateFrom": "2019-08-24T14:15:22Z",
"paymentPeriodStartDateTo": "2019-08-24T14:15:22Z",
"checkClearedDateFrom": "2019-08-24T14:15:22Z",
"checkClearedDateTo": "2019-08-24T14:15:22Z",
"cashDrawerSession": "string",
"campusId": 0,
"schoolStatusIdList": [0
],
"programIdList": [0
],
"checkStatusIdList": [0
],
"bankAccountIdList": [0
],
"transactionsTypeList": ["string"
],
"isNonDepositedItemsIncluded": true,
"academicYear": 0,
"paymentPeriod": 0,
"fundSourceId": 0,
"isCashDrawerVisible": true,
"chargesIncluded": { },
"drn": "string"
}
}

Response samples

Content type

application/json

{"payload": {"data": {"transactionSearchList": [{"studentName": "string",
"studentNumber": "string",
"ssn": "string",
"transactionDescription": "string",
"transactionType": "string",
"transactionTypeName": "string",
"transactionDate": "2019-08-24T14:15:22Z",
"reference": "string",
"checkNumber": "string",
"transactionAmount": 0,
"billingTransationCode": "string",
"billingTransationName": "string",
"campusName": "string",
"campusId": 0,
"programName": "string",
"bankDepositId": 0,
"studentSubsidiaryTransactionId": 0,
"termId": 0,
"isDeposited": true,
"isVoided": true,
"accountNumber": "string",
"bankAccountName": "string",
"checkStatus": "string",
"checkDate": "2019-08-24T14:15:22Z",
"cashDrawerSession": "string",
"billingTransactionCodeId": 0,
"termCode": "string",
"studentAccountTransactionId": 0,
"transactionNumber": { },
"studentId": 0,
"programVersionName": "string",
"studentEnrollmentPeriodId": 0,
"isPostedToGeneralLedger": true,
"academicYear": "string",
"fundSource": "string",
"source": "string",
"sourceName": "string",
"paymentType": "string",
"subsidiaryAccountTypeId": 0,
"drn": "string"
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Third Party Agency Existing Invoice

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-getthirdpartyagencyexistinginvoice-request-payload)

campusIdList	object
studentId	number <int32>
columnToPrint	string
enrollmentFromDate	string <date-time>
enrollmentToDate	string <date-time>
invoiceNumber	string
invoiceType	string
fundSourceIdList	object
agencyIdList	object
agencyBranchIdList	object
currencyCodeId	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"campusIdList": { },
"studentId": 0,
"columnToPrint": "string",
"enrollmentFromDate": "2019-08-24T14:15:22Z",
"enrollmentToDate": "2019-08-24T14:15:22Z",
"invoiceNumber": "string",
"invoiceType": "string",
"fundSourceIdList": { },
"agencyIdList": { },
"agencyBranchIdList": { },
"currencyCodeId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"thirdPartyAgencyExistingInvoiceList": [{"studentName": "string",
"printIdentifier": "string",
"agencyBranchName": "string",
"invoiceType": "string",
"invoiceDate": "2019-08-24T14:15:22Z",
"invoiceNumber": "string",
"amount": 0,
"studentId": 0,
"agencyBranchId": 0
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Third Party Agency Invoice Number

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-getthirdpartyagencyinvoicenumber-request-payload)

campusIdList	object
studentId	number <int32>
fundSourceIdList	object
agenciyIdList	object
agencyBranchIdList	object
fromActualStartDate	string <date-time>
toActualStartDate	string <date-time>
studentSelectionType	string

Responses

Request samples

Payload

Content type

application/json

{"payload": {"campusIdList": { },
"studentId": 0,
"fundSourceIdList": { },
"agenciyIdList": { },
"agencyBranchIdList": { },
"fromActualStartDate": "2019-08-24T14:15:22Z",
"toActualStartDate": "2019-08-24T14:15:22Z",
"studentSelectionType": "string"
}
}

Response samples

Content type

application/json

{"payload": {"data": {"thirdPartyAgencyInvoiceNumbers": [{"agencyBranch": "string",
"thirdPartyInvoiceNumber": "string"
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Get Un Applied Credit

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-getunappliedcredit-request-payload)

campusId	number <int32>
fundSourceId	number <int32>
fundSourceIdList	Array of numbers <int32> [ items <int32 > ]
billingTransactionCodeIdList	Array of numbers <int32> [ items <int32 > ]
schoolStatusId	number <int32>
termId	number <int32>
lowDate	string <date-time>
highDate	string <date-time>
creditWaiverIdList	Array of numbers <int32> [ items <int32 > ]
isReapplyCredit	boolean

Responses

Request samples

Payload

Content type

application/json

{"payload": {"campusId": 0,
"fundSourceId": 0,
"fundSourceIdList": [0
],
"billingTransactionCodeIdList": [0
],
"schoolStatusId": 0,
"termId": 0,
"lowDate": "2019-08-24T14:15:22Z",
"highDate": "2019-08-24T14:15:22Z",
"creditWaiverIdList": [0
],
"isReapplyCredit": true
}
}

Response samples

Content type

application/json

{"payload": {"data": {"campusId": 0,
"unappliedCreditList": [{"studentName": "string",
"transactionName": "string",
"transactionDate": "2019-08-24T14:15:22Z",
"billingTransactionCodeCode": "string",
"transactionType": "string",
"fundSourceType": "string",
"transactionAmount": 0,
"transactionAmountApplied": 0,
"newTransactionAmountApplied": 0,
"transactionBalance": 0,
"checkNumber": "string",
"reference": "string",
"receiptNumber": "string",
"termCode": "string",
"termName": "string",
"fundSourceCode": "string",
"fundSourceName": "string",
"awardYear": "string",
"paymentPeriod": "string",
"studentAccountTransactionId": 0,
"studentId": 0,
"type": "string",
"studentNumber": "string"
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Manage Apply Credit

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-manageapplycredit-request-payload)

studentAccountTransactionId	number <int32>
studentId	number <int32>
isChildSelected	boolean
	Array of objects (cmc-nexus-studentAccounts-services-applyAccountTransactionCredit)

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentAccountTransactionId": 0,
"studentId": 0,
"isChildSelected": true,
"applyAccountTransactionCreditList": [{"appliedToStudentAccountTransactionId": 0,
"transactionAmount": 0,
"amountPaid": 0,
"differenceAmountPaid": 0,
"transactionBalance": 0,
"transactionNumber": 0
}
]
}
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Manage Auto Apply Credit

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-manageautoapplycredit-request-payload)

campusId	number <int32>
fundSourceId	number <int32>
fundSourceIdList	Array of numbers <int32> [ items <int32 > ]
billingTransactionCodeIdList	Array of numbers <int32> [ items <int32 > ]
schoolStatusId	number <int32>
termId	number <int32>
lowDate	string <date-time>
highDate	string <date-time>
creditWaiverIdList	Array of numbers <int32> [ items <int32 > ]
isReapplyCredit	boolean

Responses

Request samples

Payload

Content type

application/json

{"payload": {"campusId": 0,
"fundSourceId": 0,
"fundSourceIdList": [0
],
"billingTransactionCodeIdList": [0
],
"schoolStatusId": 0,
"termId": 0,
"lowDate": "2019-08-24T14:15:22Z",
"highDate": "2019-08-24T14:15:22Z",
"creditWaiverIdList": [0
],
"isReapplyCredit": true
}
}

Response samples

Content type

application/json

{"payload": {"data": {"campusId": 0,
"unappliedCreditList": [{"studentName": "string",
"transactionName": "string",
"transactionDate": "2019-08-24T14:15:22Z",
"billingTransactionCodeCode": "string",
"transactionType": "string",
"fundSourceType": "string",
"transactionAmount": 0,
"transactionAmountApplied": 0,
"newTransactionAmountApplied": 0,
"transactionBalance": 0,
"checkNumber": "string",
"reference": "string",
"receiptNumber": "string",
"termCode": "string",
"termName": "string",
"fundSourceCode": "string",
"fundSourceName": "string",
"awardYear": "string",
"paymentPeriod": "string",
"studentAccountTransactionId": 0,
"studentId": 0,
"type": "string",
"studentNumber": "string"
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Payment Due Date Update

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-paymentduedateupdate-request-payload)

transactionIdList	Array of numbers <int32> [ items <int32 > ]
campusIdList	Array of numbers <int32> [ items <int32 > ]
searchType	number <int32>
billingTransactionCodeIdList	Array of numbers <int32> [ items <int32 > ]
description	string
termIdList	Array of numbers <int32> [ items <int32 > ]
paymentPeriodStartDateFrom	string <date-time>
paymentPeriodStartDateTo	string <date-time>
transactionDateFrom	string <date-time>
transactionDateTo	string <date-time>
postDateFrom	string <date-time>
postDateTo	string <date-time>
paymentDueDateFrom	string <date-time>
paymentDueDateTo	string <date-time>
paymentDueDate	string <date-time>
isOverwriteExistingDueDate	boolean
isAutoCalculatePaymentDueDate	boolean

Responses

Request samples

Payload

Content type

application/json

{"payload": {"transactionIdList": [0
],
"campusIdList": [0
],
"searchType": 0,
"billingTransactionCodeIdList": [0
],
"description": "string",
"termIdList": [0
],
"paymentPeriodStartDateFrom": "2019-08-24T14:15:22Z",
"paymentPeriodStartDateTo": "2019-08-24T14:15:22Z",
"transactionDateFrom": "2019-08-24T14:15:22Z",
"transactionDateTo": "2019-08-24T14:15:22Z",
"postDateFrom": "2019-08-24T14:15:22Z",
"postDateTo": "2019-08-24T14:15:22Z",
"paymentDueDateFrom": "2019-08-24T14:15:22Z",
"paymentDueDateTo": "2019-08-24T14:15:22Z",
"paymentDueDate": "2019-08-24T14:15:22Z",
"isOverwriteExistingDueDate": true,
"isAutoCalculatePaymentDueDate": true
}
}

Response samples

Content type

application/json

{"payload": {"data": {"campusIdList": [0
],
"transactionSource": "string",
"updateTransactionSearchList": [{"transactionId": 0,
"studentId": 0,
"academicYear": "string",
"studentName": "string",
"studentNumber": "string",
"transactionNumber": 0,
"transactionDate": "2019-08-24T14:15:22Z",
"paymentDueDate": "2019-08-24T14:15:22Z",
"transactionType": "string",
"transactionBillCode": "string",
"transactionName": "string",
"transactionAmount": 0,
"termName": "string",
"campusName": "string",
"updatedPaymentDueDate": "2019-08-24T14:15:22Z"
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Post Account Transaction Charge

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-postaccounttransactioncharge-request-payload)

studentId	number <int32>
billingTransactionCodeId	number <int32>
transactionAmount	number <double>
studentEnrollmentPeriodId	number <int32>
studentAcademicYearId	number <int32>
termId	number <int32>
studentAccountClassSectionId	number <int32>
studentAcademicYearPaymentPeriodId	number <int32>
transactionDate	string <date-time>
description	string
reference	string
isChargeAdjustment	boolean
ignoreTermRequired	boolean
overrideBilledDate	boolean
allowProcessByAutomation	boolean
subsidiaryAccountTypeId	number <int32>
studentEnrollmentPeriodFeeId	number <int32>
paymentDueDate	string <date-time>
isTaxIncluded	boolean
	Array of objects (cmc-nexus-studentAccounts-services-postAccountTransactionChargeTax)
isIncludeIn1098T	boolean
extendedProperties	Array of any

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentId": 0,
"billingTransactionCodeId": 0,
"transactionAmount": 0,
"studentEnrollmentPeriodId": 0,
"studentAcademicYearId": 0,
"termId": 0,
"studentAccountClassSectionId": 0,
"studentAcademicYearPaymentPeriodId": 0,
"transactionDate": "2019-08-24T14:15:22Z",
"description": "string",
"reference": "string",
"isChargeAdjustment": true,
"ignoreTermRequired": true,
"overrideBilledDate": true,
"allowProcessByAutomation": true,
"subsidiaryAccountTypeId": 0,
"studentEnrollmentPeriodFeeId": 0,
"paymentDueDate": "2019-08-24T14:15:22Z",
"isTaxIncluded": true,
"chargeTaxList": [{"taxRateId": 0,
"rate": 0,
"taxAmount": 0,
"billingTransactionCodeId": 0,
"isIncludeIn1098T": true
}
],
"isIncludeIn1098T": true,
"extendedProperties": [null
]
}
}

Response samples

Content type

application/json

{"payload": {"data": {"studentAccountTransaction": {"id": 0,
"academicYearSequence": 0,
"achBatchFileId": 0,
"admissionsRepId": 0,
"afterTaxAmount": 0,
"agencyBranchCreditCardId": 0,
"amountPaid": 0,
"appliedDate": "2019-08-24T14:15:22Z",
"awardBursaryConfigDetailId": 0,
"bankAccountId": 0,
"bankDepositId": 0,
"batchNumber": "string",
"billingTransactionCode": "string",
"campusId": 0,
"cashDrawerSessionId": 0,
"checkClearedDate": "2019-08-24T14:15:22Z",
"checkNumber": "string",
"checkStatus": "string",
"classSectionId": 0,
"courseAmountToRetain": 0,
"courseId": 0,
"courseRefundPolicyId": 0,
"createdByUserId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditCardAuthorizationNumber": "string",
"creditCardBatchTransactionId": 0,
"creditCardDeclineCode": "string",
"depositId": 0,
"description": "string",
"discountAmount": 0,
"drn": "string",
"eftClearedDate": "2019-08-24T14:15:22Z",
"eftNumber": "string",
"eftStatus": "string",
"exchangeRate": 0,
"foreignExchangeGainLoss": 0,
"invoiceAddedDate": "2019-08-24T14:15:22Z",
"invoiceNumber": "string",
"isAutomatedProcess": true,
"isGeneralLedgerStatusFlag": true,
"isInPendingQueue": true,
"isManualCheckExtract": true,
"isPenaltyProcessed": true,
"isPostedToGeneralLedger": true,
"isPreviousYear1098t": true,
"isReconciledInCnf": true,
"isReissued": true,
"isSentBack": true,
"isTaxIncluded": true,
"isVoidedTransaction": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"merchantProcessingCode": "string",
"originalStudentAccountTransactionId": 0,
"paidDisbursementId": 0,
"paymentDueDate": "2019-08-24T14:15:22Z",
"paymentPeriodId": 0,
"paymentType": "string",
"postDate": "2019-08-24T14:15:22Z",
"preferredCurrencyAmount": 0,
"primaryCurrencyCodeId": 0,
"receiptNumber": "string",
"receiptPrintedDate": "2019-08-24T14:15:22Z",
"reference": "string",
"refundCalculationId": 0,
"refundId": 0,
"registrationTermId": 0,
"rowVersion": "string",
"sa1098T": "string",
"source": "string",
"status": "string",
"studentAcademicYearPaymentPeriodId": 0,
"studentAccountBatchBillingId": 0,
"studentAccountPendingTransactionIdReference": 0,
"studentAwardId": 0,
"studentBankAccountId": 0,
"studentCreditCardId": 0,
"studentEnrollmentPeriodFeeId": 0,
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"studentRevenueDetailId": 0,
"syAddressId": 0,
"termId": 0,
"transactionAmount": 0,
"transactionCurrencyCodeId": 0,
"transactionDate": "2019-08-24T14:15:22Z",
"transactionNumber": 0,
"tuitionDiscountPolicyId": 0,
"type": "string",
"vendorReferenceNumber": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"studentSubsidiaryAccountTransaction": {"id": 0,
"academicYearSequence": { },
"afterTaxAmount": 0,
"amount": 0,
"bankAccountId": 0,
"bankDepositId": 0,
"billingTransactionCodeId": 0,
"campusId": 0,
"cashDrawerSessionId": 0,
"checkDate": "2019-08-24T14:15:22Z",
"checkNumber": "string",
"checkStatus": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"creditCardAuthorizationNumber": "string",
"creditCardDeclineCode": "string",
"description": "string",
"drn": "string",
"eftClearedDate": "2019-08-24T14:15:22Z",
"eftNumber": "string",
"eftStatus": "string",
"exchangeRate": 0,
"foreignExchangeGainLoss": 0,
"isGeneralLedgerStatusFlag": true,
"isIncludedIn1098T": true,
"isInPendingQueue": true,
"isPostedToGeneralLedger": true,
"isPreviousYear": true,
"isReconciledInCnf": true,
"isReissued": true,
"isScholarshipOrGrant": true,
"isSentBack": true,
"isTaxIncluded": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"paymentDueDate": "2019-08-24T14:15:22Z",
"paymentType": "string",
"preferredCurrencyAmount": 0,
"primaryCurrencyCodeId": 0,
"receiptNumber": "string",
"reference": "string",
"rowVersion": "string",
"source": "string",
"studentCreditCardId": 0,
"studentRelationshipAddressId": 0,
"studentSubsidiaryAccountId": 0,
"studentSubsidiaryAccountRefundId": 0,
"termId": 0,
"transactionCurrencyCodeId": 0,
"transactionDate": "2019-08-24T14:15:22Z",
"transactionNumber": { },
"type": "string",
"vendorReferenceNumber": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"returnValidationCode": "string",
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Post Account Transaction Payment

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-postaccounttransactionpayment-request-payload)

studentId	number <int32>
studentEnrollmentPeriodId	number <int32>
academicYearSequence	number <int32>
paymentMode	number <int32>
fundSourceId	number <int32>
scheduledPaymentId	number <int32>
paymentType	string
bankAccountId	number <int32>
studentAcademicYearPaymentPeriodId	number <int32>
description	string
transactionDate	string <date-time>
transactionAmount	number <double>
reference	string
termId	number <int32>
paidByUserId	number <int32>
studentCreditCardId	number <int32>
authorizationNumber	string
verificationNumber	string
checkNumber	string
cashDrawerId	number <int32>
cashDrawerSessionId	number <int32>
cashierUserId	number <int32>
isStudentCreditCardAuthorizeRequired	boolean
ignoreTermRequired	boolean
studentAwardYearId	number <int32>
awardYear	string
overrideDisbursementAssociation	boolean
openingBalance	number <double>
isStudentPayment	boolean
agencyBranchId	number <int32>
subsidiaryAccountTypeId	number <int32>
payWithExistingCreditCard	boolean
isNewPaymentSuccessful	boolean
baseURI	string
isCardSavedForFuture	boolean
isSaveAndNew	boolean
agencyCreditCardId	number <int32>
studentAccountTransactionId	number <int32>
isApplyPayment	boolean
isPrint	boolean
isFromProcess	boolean
preferredCurrencyAmount	number <double>
classSectionId	number <int32>
isIncludeIn1098T	boolean
isScholarshipOrGrant	boolean
merchantProcessingCode	string
studentPaymentPlanScheduleId	number <int32>
studentBankAccountId	number <int32>
extendedProperties	Array of any
drn	string
appliedInvoices	object
vendorReferenceNumber	string

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentId": 0,
"studentEnrollmentPeriodId": 0,
"academicYearSequence": 0,
"paymentMode": 0,
"fundSourceId": 0,
"scheduledPaymentId": 0,
"paymentType": "string",
"bankAccountId": 0,
"studentAcademicYearPaymentPeriodId": 0,
"description": "string",
"transactionDate": "2019-08-24T14:15:22Z",
"transactionAmount": 0,
"reference": "string",
"termId": 0,
"paidByUserId": 0,
"studentCreditCardId": 0,
"authorizationNumber": "string",
"verificationNumber": "string",
"checkNumber": "string",
"cashDrawerId": 0,
"cashDrawerSessionId": 0,
"cashierUserId": 0,
"isStudentCreditCardAuthorizeRequired": true,
"ignoreTermRequired": true,
"studentAwardYearId": 0,
"awardYear": "string",
"overrideDisbursementAssociation": true,
"openingBalance": 0,
"isStudentPayment": true,
"agencyBranchId": 0,
"subsidiaryAccountTypeId": 0,
"payWithExistingCreditCard": true,
"isNewPaymentSuccessful": true,
"baseURI": "string",
"isCardSavedForFuture": true,
"isSaveAndNew": true,
"agencyCreditCardId": 0,
"studentAccountTransactionId": 0,
"isApplyPayment": true,
"isPrint": true,
"isFromProcess": true,
"preferredCurrencyAmount": 0,
"classSectionId": 0,
"isIncludeIn1098T": true,
"isScholarshipOrGrant": true,
"merchantProcessingCode": "string",
"studentPaymentPlanScheduleId": 0,
"studentBankAccountId": 0,
"extendedProperties": [null
],
"drn": "string",
"appliedInvoices": { },
"vendorReferenceNumber": "string"
}
}

Response samples

Content type

application/json

{"payload": {"data": {"studentAccountTransaction": {"id": 0,
"academicYearSequence": 0,
"achBatchFileId": 0,
"admissionsRepId": 0,
"afterTaxAmount": 0,
"agencyBranchCreditCardId": 0,
"amountPaid": 0,
"appliedDate": "2019-08-24T14:15:22Z",
"awardBursaryConfigDetailId": 0,
"bankAccountId": 0,
"bankDepositId": 0,
"batchNumber": "string",
"billingTransactionCode": "string",
"campusId": 0,
"cashDrawerSessionId": 0,
"checkClearedDate": "2019-08-24T14:15:22Z",
"checkNumber": "string",
"checkStatus": "string",
"classSectionId": 0,
"courseAmountToRetain": 0,
"courseId": 0,
"courseRefundPolicyId": 0,
"createdByUserId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditCardAuthorizationNumber": "string",
"creditCardBatchTransactionId": 0,
"creditCardDeclineCode": "string",
"depositId": 0,
"description": "string",
"discountAmount": 0,
"drn": "string",
"eftClearedDate": "2019-08-24T14:15:22Z",
"eftNumber": "string",
"eftStatus": "string",
"exchangeRate": 0,
"foreignExchangeGainLoss": 0,
"invoiceAddedDate": "2019-08-24T14:15:22Z",
"invoiceNumber": "string",
"isAutomatedProcess": true,
"isGeneralLedgerStatusFlag": true,
"isInPendingQueue": true,
"isManualCheckExtract": true,
"isPenaltyProcessed": true,
"isPostedToGeneralLedger": true,
"isPreviousYear1098t": true,
"isReconciledInCnf": true,
"isReissued": true,
"isSentBack": true,
"isTaxIncluded": true,
"isVoidedTransaction": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"merchantProcessingCode": "string",
"originalStudentAccountTransactionId": 0,
"paidDisbursementId": 0,
"paymentDueDate": "2019-08-24T14:15:22Z",
"paymentPeriodId": 0,
"paymentType": "string",
"postDate": "2019-08-24T14:15:22Z",
"preferredCurrencyAmount": 0,
"primaryCurrencyCodeId": 0,
"receiptNumber": "string",
"receiptPrintedDate": "2019-08-24T14:15:22Z",
"reference": "string",
"refundCalculationId": 0,
"refundId": 0,
"registrationTermId": 0,
"rowVersion": "string",
"sa1098T": "string",
"source": "string",
"status": "string",
"studentAcademicYearPaymentPeriodId": 0,
"studentAccountBatchBillingId": 0,
"studentAccountPendingTransactionIdReference": 0,
"studentAwardId": 0,
"studentBankAccountId": 0,
"studentCreditCardId": 0,
"studentEnrollmentPeriodFeeId": 0,
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"studentRevenueDetailId": 0,
"syAddressId": 0,
"termId": 0,
"transactionAmount": 0,
"transactionCurrencyCodeId": 0,
"transactionDate": "2019-08-24T14:15:22Z",
"transactionNumber": 0,
"tuitionDiscountPolicyId": 0,
"type": "string",
"vendorReferenceNumber": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"studentSubsidiaryAccountTransaction": {"id": 0,
"academicYearSequence": { },
"afterTaxAmount": 0,
"amount": 0,
"bankAccountId": 0,
"bankDepositId": 0,
"billingTransactionCodeId": 0,
"campusId": 0,
"cashDrawerSessionId": 0,
"checkDate": "2019-08-24T14:15:22Z",
"checkNumber": "string",
"checkStatus": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"creditCardAuthorizationNumber": "string",
"creditCardDeclineCode": "string",
"description": "string",
"drn": "string",
"eftClearedDate": "2019-08-24T14:15:22Z",
"eftNumber": "string",
"eftStatus": "string",
"exchangeRate": 0,
"foreignExchangeGainLoss": 0,
"isGeneralLedgerStatusFlag": true,
"isIncludedIn1098T": true,
"isInPendingQueue": true,
"isPostedToGeneralLedger": true,
"isPreviousYear": true,
"isReconciledInCnf": true,
"isReissued": true,
"isScholarshipOrGrant": true,
"isSentBack": true,
"isTaxIncluded": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"paymentDueDate": "2019-08-24T14:15:22Z",
"paymentType": "string",
"preferredCurrencyAmount": 0,
"primaryCurrencyCodeId": 0,
"receiptNumber": "string",
"reference": "string",
"rowVersion": "string",
"source": "string",
"studentCreditCardId": 0,
"studentRelationshipAddressId": 0,
"studentSubsidiaryAccountId": 0,
"studentSubsidiaryAccountRefundId": 0,
"termId": 0,
"transactionCurrencyCodeId": 0,
"transactionDate": "2019-08-24T14:15:22Z",
"transactionNumber": { },
"type": "string",
"vendorReferenceNumber": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"returnCode": "string",
"paymentUrl": "string",
"vendor": "string",
"ticket": "string",
"ticketName": "string",
"isTouchnetPaymentProvider": true,
"htmlResponse": "string",
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Post Account Transaction Refund

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-postaccounttransactionrefund-request-payload)

id	number <int32>
studentId	number <int32>
studentEnrollmentPeriodId	number <int32>
paidDisbursementId	number <int32>
studentAwardId	number <int32>
academicYearSequence	number <int32>
studentAcademicYearId	number <int32>
fundSourceId	number <int32>
isPostedToLedger	boolean
returnMethod	string
bankAccountId	number <int32>
studentAcademicYearPaymentPeriodId	number <int32>
description	string
note	string
transactionDate	string <date-time>
sentDate	string <date-time>
transactionAmount	number <double>
reference	string
termId	number <int32>
studentCreditCardId	number <int32>
checkNumber	string
isAwardAmountPostedAndScheduledOverride	boolean
isAwardAmountOverride	boolean
isReadytoSendFlagOverride	boolean
isReadytoSend	boolean
isPaidDisbursementAmountOverride	boolean
ignoreTermRequired	boolean
isReleasedToGreatPlain	boolean
campusId	number <int32>
isSubsidiary	boolean
applyRefund	boolean
editPayeeAfterSave	boolean
	Array of objects (cmc-nexus-studentAccounts-services-distributionDisbursementList)
subsidiaryAccountTypeId	number <int32>
addressType	string
syAddressId	number <int32>
studentAccountTransactionId	number <int32>
isIncludeIn1098T	boolean
isScholarshipOrGrant	boolean
isPreviousYear	boolean
studentBankAccountId	number <int32>
actualAcademicYearId	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"id": 0,
"studentId": 0,
"studentEnrollmentPeriodId": 0,
"paidDisbursementId": 0,
"studentAwardId": 0,
"academicYearSequence": 0,
"studentAcademicYearId": 0,
"fundSourceId": 0,
"isPostedToLedger": true,
"returnMethod": "string",
"bankAccountId": 0,
"studentAcademicYearPaymentPeriodId": 0,
"description": "string",
"note": "string",
"transactionDate": "2019-08-24T14:15:22Z",
"sentDate": "2019-08-24T14:15:22Z",
"transactionAmount": 0,
"reference": "string",
"termId": 0,
"studentCreditCardId": 0,
"checkNumber": "string",
"isAwardAmountPostedAndScheduledOverride": true,
"isAwardAmountOverride": true,
"isReadytoSendFlagOverride": true,
"isReadytoSend": true,
"isPaidDisbursementAmountOverride": true,
"ignoreTermRequired": true,
"isReleasedToGreatPlain": true,
"campusId": 0,
"isSubsidiary": true,
"applyRefund": true,
"editPayeeAfterSave": true,
"disbursementAmountDistributionList": [{"disbursementId": 0,
"refundAmount": 0,
"studentAwardId": 0,
"disbursementNumber": 0,
"isIncludeIn1098T": true,
"isScholarshipOrGrant": true,
"isPreviousYear": true
}
],
"subsidiaryAccountTypeId": 0,
"addressType": "string",
"syAddressId": 0,
"studentAccountTransactionId": 0,
"isIncludeIn1098T": true,
"isScholarshipOrGrant": true,
"isPreviousYear": true,
"studentBankAccountId": 0,
"actualAcademicYearId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"studentAccountTransaction": {"id": 0,
"academicYearSequence": 0,
"achBatchFileId": 0,
"admissionsRepId": 0,
"afterTaxAmount": 0,
"agencyBranchCreditCardId": 0,
"amountPaid": 0,
"appliedDate": "2019-08-24T14:15:22Z",
"awardBursaryConfigDetailId": 0,
"bankAccountId": 0,
"bankDepositId": 0,
"batchNumber": "string",
"billingTransactionCode": "string",
"campusId": 0,
"cashDrawerSessionId": 0,
"checkClearedDate": "2019-08-24T14:15:22Z",
"checkNumber": "string",
"checkStatus": "string",
"classSectionId": 0,
"courseAmountToRetain": 0,
"courseId": 0,
"courseRefundPolicyId": 0,
"createdByUserId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditCardAuthorizationNumber": "string",
"creditCardBatchTransactionId": 0,
"creditCardDeclineCode": "string",
"depositId": 0,
"description": "string",
"discountAmount": 0,
"drn": "string",
"eftClearedDate": "2019-08-24T14:15:22Z",
"eftNumber": "string",
"eftStatus": "string",
"exchangeRate": 0,
"foreignExchangeGainLoss": 0,
"invoiceAddedDate": "2019-08-24T14:15:22Z",
"invoiceNumber": "string",
"isAutomatedProcess": true,
"isGeneralLedgerStatusFlag": true,
"isInPendingQueue": true,
"isManualCheckExtract": true,
"isPenaltyProcessed": true,
"isPostedToGeneralLedger": true,
"isPreviousYear1098t": true,
"isReconciledInCnf": true,
"isReissued": true,
"isSentBack": true,
"isTaxIncluded": true,
"isVoidedTransaction": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"merchantProcessingCode": "string",
"originalStudentAccountTransactionId": 0,
"paidDisbursementId": 0,
"paymentDueDate": "2019-08-24T14:15:22Z",
"paymentPeriodId": 0,
"paymentType": "string",
"postDate": "2019-08-24T14:15:22Z",
"preferredCurrencyAmount": 0,
"primaryCurrencyCodeId": 0,
"receiptNumber": "string",
"receiptPrintedDate": "2019-08-24T14:15:22Z",
"reference": "string",
"refundCalculationId": 0,
"refundId": 0,
"registrationTermId": 0,
"rowVersion": "string",
"sa1098T": "string",
"source": "string",
"status": "string",
"studentAcademicYearPaymentPeriodId": 0,
"studentAccountBatchBillingId": 0,
"studentAccountPendingTransactionIdReference": 0,
"studentAwardId": 0,
"studentBankAccountId": 0,
"studentCreditCardId": 0,
"studentEnrollmentPeriodFeeId": 0,
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"studentRevenueDetailId": 0,
"syAddressId": 0,
"termId": 0,
"transactionAmount": 0,
"transactionCurrencyCodeId": 0,
"transactionDate": "2019-08-24T14:15:22Z",
"transactionNumber": 0,
"tuitionDiscountPolicyId": 0,
"type": "string",
"vendorReferenceNumber": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"studentAccountTransactionId": 0,
"studentSubsidiaryAccountTransaction": {"id": 0,
"academicYearSequence": { },
"afterTaxAmount": 0,
"amount": 0,
"bankAccountId": 0,
"bankDepositId": 0,
"billingTransactionCodeId": 0,
"campusId": 0,
"cashDrawerSessionId": 0,
"checkDate": "2019-08-24T14:15:22Z",
"checkNumber": "string",
"checkStatus": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"creditCardAuthorizationNumber": "string",
"creditCardDeclineCode": "string",
"description": "string",
"drn": "string",
"eftClearedDate": "2019-08-24T14:15:22Z",
"eftNumber": "string",
"eftStatus": "string",
"exchangeRate": 0,
"foreignExchangeGainLoss": 0,
"isGeneralLedgerStatusFlag": true,
"isIncludedIn1098T": true,
"isInPendingQueue": true,
"isPostedToGeneralLedger": true,
"isPreviousYear": true,
"isReconciledInCnf": true,
"isReissued": true,
"isScholarshipOrGrant": true,
"isSentBack": true,
"isTaxIncluded": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"paymentDueDate": "2019-08-24T14:15:22Z",
"paymentType": "string",
"preferredCurrencyAmount": 0,
"primaryCurrencyCodeId": 0,
"receiptNumber": "string",
"reference": "string",
"rowVersion": "string",
"source": "string",
"studentCreditCardId": 0,
"studentRelationshipAddressId": 0,
"studentSubsidiaryAccountId": 0,
"studentSubsidiaryAccountRefundId": 0,
"termId": 0,
"transactionCurrencyCodeId": 0,
"transactionDate": "2019-08-24T14:15:22Z",
"transactionNumber": { },
"type": "string",
"vendorReferenceNumber": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"returnCode": "string",
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Post Return Check

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-postreturncheck-request-payload)

studentAccountTransactionId	number <int32>
note	string
studentSubsidiaryAccountTransactionId	number <int32>
studentId	number <int32>
studentEnrollmentPeriodId	number <int32>
isPreviousYear	boolean

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentAccountTransactionId": 0,
"note": "string",
"studentSubsidiaryAccountTransactionId": 0,
"studentId": 0,
"studentEnrollmentPeriodId": 0,
"isPreviousYear": true
}
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Print Registration Bill

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-printregistrationbill-request-payload)

campusId	number <int32>
studentId	number <int32>
termIdList	Array of numbers <int32> [ items <int32 > ]
termGroupId	number <int32>
paymentPeriodId	number <int32>
lowBillingDate	string <date-time>
highBillingDate	string <date-time>
addDropDate	string <date-time>
isReportStatus	boolean
reportType	string
studentEnrollmentPeriodId	number <int32>
isAddDropDate	boolean
userId	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"campusId": 0,
"studentId": 0,
"termIdList": [0
],
"termGroupId": 0,
"paymentPeriodId": 0,
"lowBillingDate": "2019-08-24T14:15:22Z",
"highBillingDate": "2019-08-24T14:15:22Z",
"addDropDate": "2019-08-24T14:15:22Z",
"isReportStatus": true,
"reportType": "string",
"studentEnrollmentPeriodId": 0,
"isAddDropDate": true,
"userId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"batchId": "string",
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Student Account Transaction

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-save-request-payload)

id	number <int32> Id
academicYearSequence	number <double> Academic Year Sequence
achBatchFileId	number <int32> Ach Batch File Id
admissionsRepId	number <int32> Admissions Rep Id
afterTaxAmount	number <double> After Tax Amount
agencyBranchCreditCardId	number <int32> Agency Branch Credit Card Id
amountPaid	number <double> Amount Paid
appliedDate	string <date-time> Applied Date
awardBursaryConfigDetailId	number <int32> Award Bursary Config Detail Id
bankAccountId	number <int32> Bank Account Id
bankDepositId	number <int32> Bank Deposit Id
batchNumber	string Batch Number
billingTransactionCode	string Billing Transaction Code
campusId	number <int32> Campus Id
cashDrawerSessionId	number <int32> Cash Drawer Session Id
checkClearedDate	string <date-time> Check Cleared Date
checkNumber	string Check Number
checkStatus	string Check Status
classSectionId	number <int32> Class Section Id
courseAmountToRetain	number <double> Course Amount To Retain
courseId	number <int32> Course Id
courseRefundPolicyId	number <int32> Course Refund Policy Id
createdByUserId	number <int32> Created By User Id
createdDateTime	string <date-time> Created Date Time
creditCardAuthorizationNumber	string Credit Card Authorization Number
creditCardBatchTransactionId	number <int32> Credit Card Batch Transaction Id
creditCardDeclineCode	string Credit Card Decline Code
depositId	number <int32> Deposit Id
description	string Description
discountAmount	number <double> Discount Amount
drn	string Drn
eftClearedDate	string <date-time> Eft Cleared Date
eftNumber	string Eft Number
eftStatus	string Eft Status
exchangeRate	number <double> Exchange Rate
foreignExchangeGainLoss	number <double> Foreign Exchange Gain Loss
invoiceAddedDate	string <date-time> Invoice Added Date
invoiceNumber	string Invoice Number
isAutomatedProcess	boolean Is Automated Process
isGeneralLedgerStatusFlag	boolean Is General Ledger Status Flag
isInPendingQueue	boolean Is In Pending Queue
isManualCheckExtract	boolean Is Manual Check Extract
isPenaltyProcessed	boolean Is Penalty Processed
isPostedToGeneralLedger	boolean Is Posted To General Ledger
isPreviousYear1098t	boolean Is Previous Year1098t
isReconciledInCnf	boolean Is Reconciled In Cnf
isReissued	boolean Is Reissued
isSentBack	boolean Is Sent Back
isTaxIncluded	boolean Is Tax Included
isVoidedTransaction	boolean Is Voided Transaction
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
merchantProcessingCode	string Merchant Processing Code
originalStudentAccountTransactionId	number <int32> Original Student Account Transaction Id
paidDisbursementId	number <int32> Paid Disbursement Id
paymentDueDate	string <date-time> Transaction Due Date
paymentPeriodId	number <int32> Payment Period Id
paymentType	string Payment Type
postDate	string <date-time> Post Date
preferredCurrencyAmount	number <double> Preferred Currency Amount
primaryCurrencyCodeId	number <int32> Primary Currency Code Id
receiptNumber	string Receipt Number
receiptPrintedDate	string <date-time> Receipt Printed Date
reference	string Reference
refundCalculationId	number <int32> Refund Calculation Id
refundId	number <int32> Refund Id
registrationTermId	number <int32> Registration Term Id
rowVersion	string
sa1098T	string Sa1098T
source	string Source
status	string Status
studentAcademicYearPaymentPeriodId	number <int32> Student Academic Year Payment Period Id
studentAccountBatchBillingId	number <int32> Student Account Batch Billing Id
studentAccountPendingTransactionIdReference	number <int32> Student Account Pending Transaction Id Reference
studentAwardId	number <int32> Student Award Id
studentBankAccountId	number <int32> Student Bank Account Id
studentCreditCardId	number <int32> Student Credit Card Id
studentEnrollmentPeriodFeeId	number <int32> Student Enrollment Period Fee Id
studentEnrollmentPeriodId	number <int32> Student Enrollment Period Id
studentId	number <int32> Student Id
studentRevenueDetailId	number <int32> Student Revenue Detail Id
syAddressId	number <int32> Sy Address Id
termId	number <int32> Term Id
transactionAmount	number <double> Transaction Amount
transactionCurrencyCodeId	number <int32> Transaction Currency Code Id
transactionDate	string <date-time> Transaction Date
transactionNumber	number <double> Transaction Number
tuitionDiscountPolicyId	number <int32> Tuition Discount Policy Id
type	string Type
vendorReferenceNumber	string Vendor Reference Number
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"id": 0,
"academicYearSequence": 0,
"achBatchFileId": 0,
"admissionsRepId": 0,
"afterTaxAmount": 0,
"agencyBranchCreditCardId": 0,
"amountPaid": 0,
"appliedDate": "2019-08-24T14:15:22Z",
"awardBursaryConfigDetailId": 0,
"bankAccountId": 0,
"bankDepositId": 0,
"batchNumber": "string",
"billingTransactionCode": "string",
"campusId": 0,
"cashDrawerSessionId": 0,
"checkClearedDate": "2019-08-24T14:15:22Z",
"checkNumber": "string",
"checkStatus": "string",
"classSectionId": 0,
"courseAmountToRetain": 0,
"courseId": 0,
"courseRefundPolicyId": 0,
"createdByUserId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditCardAuthorizationNumber": "string",
"creditCardBatchTransactionId": 0,
"creditCardDeclineCode": "string",
"depositId": 0,
"description": "string",
"discountAmount": 0,
"drn": "string",
"eftClearedDate": "2019-08-24T14:15:22Z",
"eftNumber": "string",
"eftStatus": "string",
"exchangeRate": 0,
"foreignExchangeGainLoss": 0,
"invoiceAddedDate": "2019-08-24T14:15:22Z",
"invoiceNumber": "string",
"isAutomatedProcess": true,
"isGeneralLedgerStatusFlag": true,
"isInPendingQueue": true,
"isManualCheckExtract": true,
"isPenaltyProcessed": true,
"isPostedToGeneralLedger": true,
"isPreviousYear1098t": true,
"isReconciledInCnf": true,
"isReissued": true,
"isSentBack": true,
"isTaxIncluded": true,
"isVoidedTransaction": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"merchantProcessingCode": "string",
"originalStudentAccountTransactionId": 0,
"paidDisbursementId": 0,
"paymentDueDate": "2019-08-24T14:15:22Z",
"paymentPeriodId": 0,
"paymentType": "string",
"postDate": "2019-08-24T14:15:22Z",
"preferredCurrencyAmount": 0,
"primaryCurrencyCodeId": 0,
"receiptNumber": "string",
"receiptPrintedDate": "2019-08-24T14:15:22Z",
"reference": "string",
"refundCalculationId": 0,
"refundId": 0,
"registrationTermId": 0,
"rowVersion": "string",
"sa1098T": "string",
"source": "string",
"status": "string",
"studentAcademicYearPaymentPeriodId": 0,
"studentAccountBatchBillingId": 0,
"studentAccountPendingTransactionIdReference": 0,
"studentAwardId": 0,
"studentBankAccountId": 0,
"studentCreditCardId": 0,
"studentEnrollmentPeriodFeeId": 0,
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"studentRevenueDetailId": 0,
"syAddressId": 0,
"termId": 0,
"transactionAmount": 0,
"transactionCurrencyCodeId": 0,
"transactionDate": "2019-08-24T14:15:22Z",
"transactionNumber": 0,
"tuitionDiscountPolicyId": 0,
"type": "string",
"vendorReferenceNumber": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"id": 0,
"academicYearSequence": 0,
"achBatchFileId": 0,
"admissionsRepId": 0,
"afterTaxAmount": 0,
"agencyBranchCreditCardId": 0,
"amountPaid": 0,
"appliedDate": "2019-08-24T14:15:22Z",
"awardBursaryConfigDetailId": 0,
"bankAccountId": 0,
"bankDepositId": 0,
"batchNumber": "string",
"billingTransactionCode": "string",
"campusId": 0,
"cashDrawerSessionId": 0,
"checkClearedDate": "2019-08-24T14:15:22Z",
"checkNumber": "string",
"checkStatus": "string",
"classSectionId": 0,
"courseAmountToRetain": 0,
"courseId": 0,
"courseRefundPolicyId": 0,
"createdByUserId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditCardAuthorizationNumber": "string",
"creditCardBatchTransactionId": 0,
"creditCardDeclineCode": "string",
"depositId": 0,
"description": "string",
"discountAmount": 0,
"drn": "string",
"eftClearedDate": "2019-08-24T14:15:22Z",
"eftNumber": "string",
"eftStatus": "string",
"exchangeRate": 0,
"foreignExchangeGainLoss": 0,
"invoiceAddedDate": "2019-08-24T14:15:22Z",
"invoiceNumber": "string",
"isAutomatedProcess": true,
"isGeneralLedgerStatusFlag": true,
"isInPendingQueue": true,
"isManualCheckExtract": true,
"isPenaltyProcessed": true,
"isPostedToGeneralLedger": true,
"isPreviousYear1098t": true,
"isReconciledInCnf": true,
"isReissued": true,
"isSentBack": true,
"isTaxIncluded": true,
"isVoidedTransaction": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"merchantProcessingCode": "string",
"originalStudentAccountTransactionId": 0,
"paidDisbursementId": 0,
"paymentDueDate": "2019-08-24T14:15:22Z",
"paymentPeriodId": 0,
"paymentType": "string",
"postDate": "2019-08-24T14:15:22Z",
"preferredCurrencyAmount": 0,
"primaryCurrencyCodeId": 0,
"receiptNumber": "string",
"receiptPrintedDate": "2019-08-24T14:15:22Z",
"reference": "string",
"refundCalculationId": 0,
"refundId": 0,
"registrationTermId": 0,
"rowVersion": "string",
"sa1098T": "string",
"source": "string",
"status": "string",
"studentAcademicYearPaymentPeriodId": 0,
"studentAccountBatchBillingId": 0,
"studentAccountPendingTransactionIdReference": 0,
"studentAwardId": 0,
"studentBankAccountId": 0,
"studentCreditCardId": 0,
"studentEnrollmentPeriodFeeId": 0,
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"studentRevenueDetailId": 0,
"syAddressId": 0,
"termId": 0,
"transactionAmount": 0,
"transactionCurrencyCodeId": 0,
"transactionDate": "2019-08-24T14:15:22Z",
"transactionNumber": 0,
"tuitionDiscountPolicyId": 0,
"type": "string",
"vendorReferenceNumber": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save California Student Tuition Recovery Fund

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-savecaliforniastudenttuitionrecoveryfund-request-payload)

campusId	number <int32>
termId	number <int32>
billingTransactionCodeId	number <int32>
billingTransactionCode	string
amountPerThousand	number <double>
reference	string
transactionDate	string <date-time>
	Array of objects (cmc-nexus-studentAccounts-services-studentRecordForCaliforniaStrf)
evaluationPeriod	string
feeSelection	string

Responses

Request samples

Payload

Content type

application/json

{"payload": {"campusId": 0,
"termId": 0,
"billingTransactionCodeId": 0,
"billingTransactionCode": "string",
"amountPerThousand": 0,
"reference": "string",
"transactionDate": "2019-08-24T14:15:22Z",
"studentRecordForCaliforniaStrfList": [{"studentEnrollmentPeriodId": 0,
"tuitionAmount": 0,
"amountToCharge": 0,
"previousAmount": 0,
"netAmountToCharge": 0
}
],
"evaluationPeriod": "string",
"feeSelection": "string"
}
}

Response samples

Content type

application/json

{"payload": {"data": {"transactionCount": 0,
"transactionAmount": 0,
"message": "string",
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Campus Tuition Discount

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-savecampustuitiondiscount-request-payload)

termId	number <int32>
transactionDate	string <date-time>
tuitionDiscountPolicyId	number <int32>
campusId	number <int32>
	Array of objects (cmc-nexus-studentAccounts-services-tuitionDiscountList)

Responses

Request samples

Payload

Content type

application/json

{"payload": {"termId": 0,
"transactionDate": "2019-08-24T14:15:22Z",
"tuitionDiscountPolicyId": 0,
"campusId": 0,
"tuitionDiscountList": [{"studentId": 0,
"studentEnrollmentPeriodId": 0,
"courseId": 0,
"type": "string",
"amount": 0,
"classSectionId": 0,
"academicYearPaymentPeriodId": 0,
"frequency": "string",
"isBillingDetailPosted": true,
"groupClassSchedID": "string",
"date": "2019-08-24T14:15:22Z"
}
]
}
}

Response samples

Content type

application/json

{"payload": {"data": {"saveTuitionDiscountCampusResponse": [{"studentId": 0,
"isProcessSuccess": true,
"speNotifications": "string",
"interestChargeBasis": "string"
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Disbursement Batch

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-savedisbursementbatch-request-payload)

disbursementBatchId	number <int32>
userId	number <int32>
reviewStatus	number <int32>
isBatchLocked	boolean
isApproved	boolean
	Array of objects (cmc-nexus-studentAccounts-services-disbursementBatchData)
actionCommand	string
campusIdList	Array of numbers <int32> [ items <int32 > ]

Responses

Request samples

Payload

Content type

application/json

{"payload": {"disbursementBatchId": 0,
"userId": 0,
"reviewStatus": 0,
"isBatchLocked": true,
"isApproved": true,
"disbursementBatchList": [{"disbursementBatchDetailId": 0,
"isApproved": true,
"amount": 0,
"scheduledDisbursementId": 0,
"isPellGrant": true,
"reason": "string"
}
],
"actionCommand": "string",
"campusIdList": [0
]
}
}

Response samples

Content type

application/json

{"payload": {"data": {"newBatchId": 0,
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Fund Source Stipend Return Order

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-savefundsourcestipendreturnorder-request-payload)

	Array of objects (cmc-nexus-studentAccounts-services-fundSourcePriorityOrder)
campusId	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"fundSourcePriorityOrderList": [{"fundSourceId": 0,
"priorityOrder": 0,
"fundSourceOrderId": 0
}
],
"campusId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save New Student Account Transaction

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-savenew-request-payload)

id	number <int32> Id
academicYearSequence	number <double> Academic Year Sequence
achBatchFileId	number <int32> Ach Batch File Id
admissionsRepId	number <int32> Admissions Rep Id
afterTaxAmount	number <double> After Tax Amount
agencyBranchCreditCardId	number <int32> Agency Branch Credit Card Id
amountPaid	number <double> Amount Paid
appliedDate	string <date-time> Applied Date
awardBursaryConfigDetailId	number <int32> Award Bursary Config Detail Id
bankAccountId	number <int32> Bank Account Id
bankDepositId	number <int32> Bank Deposit Id
batchNumber	string Batch Number
billingTransactionCode	string Billing Transaction Code
campusId	number <int32> Campus Id
cashDrawerSessionId	number <int32> Cash Drawer Session Id
checkClearedDate	string <date-time> Check Cleared Date
checkNumber	string Check Number
checkStatus	string Check Status
classSectionId	number <int32> Class Section Id
courseAmountToRetain	number <double> Course Amount To Retain
courseId	number <int32> Course Id
courseRefundPolicyId	number <int32> Course Refund Policy Id
createdByUserId	number <int32> Created By User Id
createdDateTime	string <date-time> Created Date Time
creditCardAuthorizationNumber	string Credit Card Authorization Number
creditCardBatchTransactionId	number <int32> Credit Card Batch Transaction Id
creditCardDeclineCode	string Credit Card Decline Code
depositId	number <int32> Deposit Id
description	string Description
discountAmount	number <double> Discount Amount
drn	string Drn
eftClearedDate	string <date-time> Eft Cleared Date
eftNumber	string Eft Number
eftStatus	string Eft Status
exchangeRate	number <double> Exchange Rate
foreignExchangeGainLoss	number <double> Foreign Exchange Gain Loss
invoiceAddedDate	string <date-time> Invoice Added Date
invoiceNumber	string Invoice Number
isAutomatedProcess	boolean Is Automated Process
isGeneralLedgerStatusFlag	boolean Is General Ledger Status Flag
isInPendingQueue	boolean Is In Pending Queue
isManualCheckExtract	boolean Is Manual Check Extract
isPenaltyProcessed	boolean Is Penalty Processed
isPostedToGeneralLedger	boolean Is Posted To General Ledger
isPreviousYear1098t	boolean Is Previous Year1098t
isReconciledInCnf	boolean Is Reconciled In Cnf
isReissued	boolean Is Reissued
isSentBack	boolean Is Sent Back
isTaxIncluded	boolean Is Tax Included
isVoidedTransaction	boolean Is Voided Transaction
lastModifiedDateTime	string <date-time> Last Modified Date Time
lastModifiedUserId	number <int32> Last Modified User Id
merchantProcessingCode	string Merchant Processing Code
originalStudentAccountTransactionId	number <int32> Original Student Account Transaction Id
paidDisbursementId	number <int32> Paid Disbursement Id
paymentDueDate	string <date-time> Transaction Due Date
paymentPeriodId	number <int32> Payment Period Id
paymentType	string Payment Type
postDate	string <date-time> Post Date
preferredCurrencyAmount	number <double> Preferred Currency Amount
primaryCurrencyCodeId	number <int32> Primary Currency Code Id
receiptNumber	string Receipt Number
receiptPrintedDate	string <date-time> Receipt Printed Date
reference	string Reference
refundCalculationId	number <int32> Refund Calculation Id
refundId	number <int32> Refund Id
registrationTermId	number <int32> Registration Term Id
rowVersion	string
sa1098T	string Sa1098T
source	string Source
status	string Status
studentAcademicYearPaymentPeriodId	number <int32> Student Academic Year Payment Period Id
studentAccountBatchBillingId	number <int32> Student Account Batch Billing Id
studentAccountPendingTransactionIdReference	number <int32> Student Account Pending Transaction Id Reference
studentAwardId	number <int32> Student Award Id
studentBankAccountId	number <int32> Student Bank Account Id
studentCreditCardId	number <int32> Student Credit Card Id
studentEnrollmentPeriodFeeId	number <int32> Student Enrollment Period Fee Id
studentEnrollmentPeriodId	number <int32> Student Enrollment Period Id
studentId	number <int32> Student Id
studentRevenueDetailId	number <int32> Student Revenue Detail Id
syAddressId	number <int32> Sy Address Id
termId	number <int32> Term Id
transactionAmount	number <double> Transaction Amount
transactionCurrencyCodeId	number <int32> Transaction Currency Code Id
transactionDate	string <date-time> Transaction Date
transactionNumber	number <double> Transaction Number
tuitionDiscountPolicyId	number <int32> Tuition Discount Policy Id
type	string Type
vendorReferenceNumber	string Vendor Reference Number
originalState	string
secureState	string
extendedProperties	Array of any
entityState	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"id": 0,
"academicYearSequence": 0,
"achBatchFileId": 0,
"admissionsRepId": 0,
"afterTaxAmount": 0,
"agencyBranchCreditCardId": 0,
"amountPaid": 0,
"appliedDate": "2019-08-24T14:15:22Z",
"awardBursaryConfigDetailId": 0,
"bankAccountId": 0,
"bankDepositId": 0,
"batchNumber": "string",
"billingTransactionCode": "string",
"campusId": 0,
"cashDrawerSessionId": 0,
"checkClearedDate": "2019-08-24T14:15:22Z",
"checkNumber": "string",
"checkStatus": "string",
"classSectionId": 0,
"courseAmountToRetain": 0,
"courseId": 0,
"courseRefundPolicyId": 0,
"createdByUserId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditCardAuthorizationNumber": "string",
"creditCardBatchTransactionId": 0,
"creditCardDeclineCode": "string",
"depositId": 0,
"description": "string",
"discountAmount": 0,
"drn": "string",
"eftClearedDate": "2019-08-24T14:15:22Z",
"eftNumber": "string",
"eftStatus": "string",
"exchangeRate": 0,
"foreignExchangeGainLoss": 0,
"invoiceAddedDate": "2019-08-24T14:15:22Z",
"invoiceNumber": "string",
"isAutomatedProcess": true,
"isGeneralLedgerStatusFlag": true,
"isInPendingQueue": true,
"isManualCheckExtract": true,
"isPenaltyProcessed": true,
"isPostedToGeneralLedger": true,
"isPreviousYear1098t": true,
"isReconciledInCnf": true,
"isReissued": true,
"isSentBack": true,
"isTaxIncluded": true,
"isVoidedTransaction": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"merchantProcessingCode": "string",
"originalStudentAccountTransactionId": 0,
"paidDisbursementId": 0,
"paymentDueDate": "2019-08-24T14:15:22Z",
"paymentPeriodId": 0,
"paymentType": "string",
"postDate": "2019-08-24T14:15:22Z",
"preferredCurrencyAmount": 0,
"primaryCurrencyCodeId": 0,
"receiptNumber": "string",
"receiptPrintedDate": "2019-08-24T14:15:22Z",
"reference": "string",
"refundCalculationId": 0,
"refundId": 0,
"registrationTermId": 0,
"rowVersion": "string",
"sa1098T": "string",
"source": "string",
"status": "string",
"studentAcademicYearPaymentPeriodId": 0,
"studentAccountBatchBillingId": 0,
"studentAccountPendingTransactionIdReference": 0,
"studentAwardId": 0,
"studentBankAccountId": 0,
"studentCreditCardId": 0,
"studentEnrollmentPeriodFeeId": 0,
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"studentRevenueDetailId": 0,
"syAddressId": 0,
"termId": 0,
"transactionAmount": 0,
"transactionCurrencyCodeId": 0,
"transactionDate": "2019-08-24T14:15:22Z",
"transactionNumber": 0,
"tuitionDiscountPolicyId": 0,
"type": "string",
"vendorReferenceNumber": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"id": 0,
"academicYearSequence": 0,
"achBatchFileId": 0,
"admissionsRepId": 0,
"afterTaxAmount": 0,
"agencyBranchCreditCardId": 0,
"amountPaid": 0,
"appliedDate": "2019-08-24T14:15:22Z",
"awardBursaryConfigDetailId": 0,
"bankAccountId": 0,
"bankDepositId": 0,
"batchNumber": "string",
"billingTransactionCode": "string",
"campusId": 0,
"cashDrawerSessionId": 0,
"checkClearedDate": "2019-08-24T14:15:22Z",
"checkNumber": "string",
"checkStatus": "string",
"classSectionId": 0,
"courseAmountToRetain": 0,
"courseId": 0,
"courseRefundPolicyId": 0,
"createdByUserId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditCardAuthorizationNumber": "string",
"creditCardBatchTransactionId": 0,
"creditCardDeclineCode": "string",
"depositId": 0,
"description": "string",
"discountAmount": 0,
"drn": "string",
"eftClearedDate": "2019-08-24T14:15:22Z",
"eftNumber": "string",
"eftStatus": "string",
"exchangeRate": 0,
"foreignExchangeGainLoss": 0,
"invoiceAddedDate": "2019-08-24T14:15:22Z",
"invoiceNumber": "string",
"isAutomatedProcess": true,
"isGeneralLedgerStatusFlag": true,
"isInPendingQueue": true,
"isManualCheckExtract": true,
"isPenaltyProcessed": true,
"isPostedToGeneralLedger": true,
"isPreviousYear1098t": true,
"isReconciledInCnf": true,
"isReissued": true,
"isSentBack": true,
"isTaxIncluded": true,
"isVoidedTransaction": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"merchantProcessingCode": "string",
"originalStudentAccountTransactionId": 0,
"paidDisbursementId": 0,
"paymentDueDate": "2019-08-24T14:15:22Z",
"paymentPeriodId": 0,
"paymentType": "string",
"postDate": "2019-08-24T14:15:22Z",
"preferredCurrencyAmount": 0,
"primaryCurrencyCodeId": 0,
"receiptNumber": "string",
"receiptPrintedDate": "2019-08-24T14:15:22Z",
"reference": "string",
"refundCalculationId": 0,
"refundId": 0,
"registrationTermId": 0,
"rowVersion": "string",
"sa1098T": "string",
"source": "string",
"status": "string",
"studentAcademicYearPaymentPeriodId": 0,
"studentAccountBatchBillingId": 0,
"studentAccountPendingTransactionIdReference": 0,
"studentAwardId": 0,
"studentBankAccountId": 0,
"studentCreditCardId": 0,
"studentEnrollmentPeriodFeeId": 0,
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"studentRevenueDetailId": 0,
"syAddressId": 0,
"termId": 0,
"transactionAmount": 0,
"transactionCurrencyCodeId": 0,
"transactionDate": "2019-08-24T14:15:22Z",
"transactionNumber": 0,
"tuitionDiscountPolicyId": 0,
"type": "string",
"vendorReferenceNumber": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Student Registration Bill

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-savestudentregistrationbill-request-payload)

id	number <int32>
	Array of objects (cmc-nexus-studentAccounts-services-studentRegistrationBillRequest_StudentList)
printOverallBalance	boolean
printClassSchedule	boolean
printPaymentDueDate	boolean
paymentDueDate	string <date-time>
printAddDropDate	boolean
addDropDate	string <date-time>
printExpFunding	number <int32>
statementComment	string
registrationComment	string
printStudentAddress	boolean
printEnrollmentInfo	boolean
printLedgerCard	boolean
printSubsidiary	boolean
lowBillingDate	string <date-time>
maxBillingDate	string <date-time>
connectedEnrollment	boolean
defaultCampusID	number <int32>
termIdList	Array of numbers <int32> [ items <int32 > ]
scheduleTermId	number <int32>
includeEstimatedAid	boolean
includePendingAid	boolean
includeApprovedAid	boolean

Responses

Request samples

Payload

Content type

application/json

{"payload": {"id": 0,
"studentLists": [{"syStudentID": 0,
"adEnrollID": 0,
"studentName": "string",
"nameStudent": "string",
"adTermID": 0,
"printIdentifier": "string",
"programVersion": "string",
"expStartDate": "2019-08-24T14:15:22Z",
"arBalance": 0,
"gradDate": "2019-08-24T14:15:22Z",
"estimatedFunding": 0,
"charges": 0,
"pendingCharges": 0,
"syCampusID": 0,
"adTermList": "string",
"studentAcademicYearPaymentPeriodId": 0,
"adEnrollIDConnect": 0,
"programVersionConnect": "string",
"expStartDateConnect": "2019-08-24T14:15:22Z",
"gradDateConnect": "2019-08-24T14:15:22Z",
"studentAcademicYearPaymentPeriodIdConnect": 0,
"paymentPeriodCode": "string",
"termCode": "string",
"termGroupCode": "string",
"termStudentGroupId": 0,
"expectedFundingTermIdList": "string"
}
],
"printOverallBalance": true,
"printClassSchedule": true,
"printPaymentDueDate": true,
"paymentDueDate": "2019-08-24T14:15:22Z",
"printAddDropDate": true,
"addDropDate": "2019-08-24T14:15:22Z",
"printExpFunding": 0,
"statementComment": "string",
"registrationComment": "string",
"printStudentAddress": true,
"printEnrollmentInfo": true,
"printLedgerCard": true,
"printSubsidiary": true,
"lowBillingDate": "2019-08-24T14:15:22Z",
"maxBillingDate": "2019-08-24T14:15:22Z",
"connectedEnrollment": true,
"defaultCampusID": 0,
"termIdList": [0
],
"scheduleTermId": 0,
"includeEstimatedAid": true,
"includePendingAid": true,
"includeApprovedAid": true
}
}

Response samples

Content type

application/json

{"payload": {"data": {"message": "string",
"fileNames": ["string"
],
"studentList": [{"studentId": 0,
"studentEnrollmentPeriodId": 0,
"studentName": "string",
"paymentPeriodCode": "string",
"termCode": "string",
"programVersionName": "string",
"actualCharge": 0,
"campusId": 0,
"termGroupId": 0,
"billingPeriod": "string"
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Save Tuition Discount

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-savetuitiondiscount-request-payload)

studentEnrollmentPeriodId	number <int32>
termId	number <int32>
transactionDate	string <date-time>
studentId	number <int32>
campusId	number <int32>
	Array of objects (cmc-nexus-studentAccounts-services-tuitionDiscount)

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentEnrollmentPeriodId": 0,
"termId": 0,
"transactionDate": "2019-08-24T14:15:22Z",
"studentId": 0,
"campusId": 0,
"tuitionDiscountList": [{"courseId": 0,
"tuitionDiscountPolicyId": 0,
"type": "string",
"amount": 0,
"classSectionId": 0,
"academicYearPaymentPeriodId": 0,
"frequency": "string",
"isBillingDetailPosted": true,
"groupClassSchedID": "string",
"date": "2019-08-24T14:15:22Z"
}
]
}
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Un Apply Account Transaction Credit

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-unapplyaccounttransactioncredit-request-payload)

studentAccountTransactionId	number <int32>
studentId	number <int32>
isChildSelected	boolean
	Array of objects (cmc-nexus-studentAccounts-services-applyAccountTransactionCredit)

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentAccountTransactionId": 0,
"studentId": 0,
"isChildSelected": true,
"applyAccountTransactionCreditList": [{"appliedToStudentAccountTransactionId": 0,
"transactionAmount": 0,
"amountPaid": 0,
"differenceAmountPaid": 0,
"transactionBalance": 0,
"transactionNumber": 0
}
]
}
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Update Payment Due Date

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-updatepaymentduedate-request-payload)

campusIdList	Array of numbers <int32> [ items <int32 > ]
searchType	number <int32>
billingTransactionCodeIdList	Array of numbers <int32> [ items <int32 > ]
description	string
termIdList	Array of numbers <int32> [ items <int32 > ]
paymentPeriodStartDateFrom	string <date-time>
paymentPeriodStartDateTo	string <date-time>
transactionDateFrom	string <date-time>
transactionDateTo	string <date-time>
postDateFrom	string <date-time>
postDateTo	string <date-time>
paymentDueDateFrom	string <date-time>
paymentDueDateTo	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"campusIdList": [0
],
"searchType": 0,
"billingTransactionCodeIdList": [0
],
"description": "string",
"termIdList": [0
],
"paymentPeriodStartDateFrom": "2019-08-24T14:15:22Z",
"paymentPeriodStartDateTo": "2019-08-24T14:15:22Z",
"transactionDateFrom": "2019-08-24T14:15:22Z",
"transactionDateTo": "2019-08-24T14:15:22Z",
"postDateFrom": "2019-08-24T14:15:22Z",
"postDateTo": "2019-08-24T14:15:22Z",
"paymentDueDateFrom": "2019-08-24T14:15:22Z",
"paymentDueDateTo": "2019-08-24T14:15:22Z"
}
}

Response samples

Content type

application/json

{"payload": {"data": {"updateTransactionSearchList": [{"transactionId": 0,
"studentId": 0,
"academicYear": "string",
"studentName": "string",
"studentNumber": "string",
"transactionNumber": 0,
"transactionDate": "2019-08-24T14:15:22Z",
"postDate": "2019-08-24T14:15:22Z",
"paymentDueDate": "2019-08-24T14:15:22Z",
"transactionType": "string",
"transactionBillCode": "string",
"transactionName": "string",
"transactionAmount": 0,
"termId": 0,
"termName": "string",
"academicYearSequence": 0,
"reference": "string",
"campusId": 0,
"campusName": "string"
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Update Print Receipt Date

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-updateprintreceiptdate-request-payload)

id	number <int32>
lastModifiedUserId	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"id": 0,
"lastModifiedUserId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Update Student Account Status

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-updatestudentaccountstatus-request-payload)

studentEnrollmentPeriodId	number <int32>
studentAccountStatusList	Array of numbers <int32> [ items <int32 > ]
studentAdvisorId	number <int32>
staffGroupId	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentEnrollmentPeriodId": 0,
"studentAccountStatusList": [0
],
"studentAdvisorId": 0,
"staffGroupId": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Void Account Transaction Payment

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-voidaccounttransactionpayment-request-payload)

studentAccountTransactionId	number <int32>
studentSubsidiaryAccountTransactionId	number <int32>
studentId	number <int32>
studentEnrollmentPeriodId	number <int32>
continueIfAmountLessThanRefund	boolean
note	string
isPreviousYear	boolean

Responses

Request samples

Payload

Content type

application/json

{"payload": {"studentAccountTransactionId": 0,
"studentSubsidiaryAccountTransactionId": 0,
"studentId": 0,
"studentEnrollmentPeriodId": 0,
"continueIfAmountLessThanRefund": true,
"note": "string",
"isPreviousYear": true
}
}

Response samples

Content type

application/json

{"payload": {"data": {"studentAccountTransaction": {"id": 0,
"academicYearSequence": 0,
"achBatchFileId": 0,
"admissionsRepId": 0,
"afterTaxAmount": 0,
"agencyBranchCreditCardId": 0,
"amountPaid": 0,
"appliedDate": "2019-08-24T14:15:22Z",
"awardBursaryConfigDetailId": 0,
"bankAccountId": 0,
"bankDepositId": 0,
"batchNumber": "string",
"billingTransactionCode": "string",
"campusId": 0,
"cashDrawerSessionId": 0,
"checkClearedDate": "2019-08-24T14:15:22Z",
"checkNumber": "string",
"checkStatus": "string",
"classSectionId": 0,
"courseAmountToRetain": 0,
"courseId": 0,
"courseRefundPolicyId": 0,
"createdByUserId": 0,
"createdDateTime": "2019-08-24T14:15:22Z",
"creditCardAuthorizationNumber": "string",
"creditCardBatchTransactionId": 0,
"creditCardDeclineCode": "string",
"depositId": 0,
"description": "string",
"discountAmount": 0,
"drn": "string",
"eftClearedDate": "2019-08-24T14:15:22Z",
"eftNumber": "string",
"eftStatus": "string",
"exchangeRate": 0,
"foreignExchangeGainLoss": 0,
"invoiceAddedDate": "2019-08-24T14:15:22Z",
"invoiceNumber": "string",
"isAutomatedProcess": true,
"isGeneralLedgerStatusFlag": true,
"isInPendingQueue": true,
"isManualCheckExtract": true,
"isPenaltyProcessed": true,
"isPostedToGeneralLedger": true,
"isPreviousYear1098t": true,
"isReconciledInCnf": true,
"isReissued": true,
"isSentBack": true,
"isTaxIncluded": true,
"isVoidedTransaction": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"merchantProcessingCode": "string",
"originalStudentAccountTransactionId": 0,
"paidDisbursementId": 0,
"paymentDueDate": "2019-08-24T14:15:22Z",
"paymentPeriodId": 0,
"paymentType": "string",
"postDate": "2019-08-24T14:15:22Z",
"preferredCurrencyAmount": 0,
"primaryCurrencyCodeId": 0,
"receiptNumber": "string",
"receiptPrintedDate": "2019-08-24T14:15:22Z",
"reference": "string",
"refundCalculationId": 0,
"refundId": 0,
"registrationTermId": 0,
"rowVersion": "string",
"sa1098T": "string",
"source": "string",
"status": "string",
"studentAcademicYearPaymentPeriodId": 0,
"studentAccountBatchBillingId": 0,
"studentAccountPendingTransactionIdReference": 0,
"studentAwardId": 0,
"studentBankAccountId": 0,
"studentCreditCardId": 0,
"studentEnrollmentPeriodFeeId": 0,
"studentEnrollmentPeriodId": 0,
"studentId": 0,
"studentRevenueDetailId": 0,
"syAddressId": 0,
"termId": 0,
"transactionAmount": 0,
"transactionCurrencyCodeId": 0,
"transactionDate": "2019-08-24T14:15:22Z",
"transactionNumber": 0,
"tuitionDiscountPolicyId": 0,
"type": "string",
"vendorReferenceNumber": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"studentSubsidiaryAccountTransaction": {"id": 0,
"academicYearSequence": { },
"afterTaxAmount": 0,
"amount": 0,
"bankAccountId": 0,
"bankDepositId": 0,
"billingTransactionCodeId": 0,
"campusId": 0,
"cashDrawerSessionId": 0,
"checkDate": "2019-08-24T14:15:22Z",
"checkNumber": "string",
"checkStatus": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"creditCardAuthorizationNumber": "string",
"creditCardDeclineCode": "string",
"description": "string",
"drn": "string",
"eftClearedDate": "2019-08-24T14:15:22Z",
"eftNumber": "string",
"eftStatus": "string",
"exchangeRate": 0,
"foreignExchangeGainLoss": 0,
"isGeneralLedgerStatusFlag": true,
"isIncludedIn1098T": true,
"isInPendingQueue": true,
"isPostedToGeneralLedger": true,
"isPreviousYear": true,
"isReconciledInCnf": true,
"isReissued": true,
"isScholarshipOrGrant": true,
"isSentBack": true,
"isTaxIncluded": true,
"lastModifiedDateTime": "2019-08-24T14:15:22Z",
"lastModifiedUserId": 0,
"paymentDueDate": "2019-08-24T14:15:22Z",
"paymentType": "string",
"preferredCurrencyAmount": 0,
"primaryCurrencyCodeId": 0,
"receiptNumber": "string",
"reference": "string",
"rowVersion": "string",
"source": "string",
"studentCreditCardId": 0,
"studentRelationshipAddressId": 0,
"studentSubsidiaryAccountId": 0,
"studentSubsidiaryAccountRefundId": 0,
"termId": 0,
"transactionCurrencyCodeId": 0,
"transactionDate": "2019-08-24T14:15:22Z",
"transactionNumber": { },
"type": "string",
"vendorReferenceNumber": "string",
"originalState": "string",
"secureState": "string",
"extendedProperties": [null
],
"entityState": 0
},
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Void Master Check

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-voidmastercheck-request-payload)

reschedule	number <int32>
transactionID	object
userID	number <int32>
checkNumber	string
amount	number <double>
	Array of objects (cmc-nexus-studentAccounts-services-billingTransaction)

Responses

Request samples

Payload

Content type

application/json

{"payload": {"reschedule": 0,
"transactionID": { },
"userID": 0,
"checkNumber": "string",
"amount": 0,
"masterChecks": [{"transactionID": "string",
"studentName": "string",
"studentId": 0,
"studentNumber": "string",
"checkNumber": "string",
"checkAmount": 0
}
]
}
}

Response samples

Content type

application/json

{"payload": {"data": {"masterCheckResponse": [{"transID": "string",
"isVoidMasterCheckSuccess": true
}
],
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}

Void Security Check

Authorizations:

apikey

Request Body schema: application/json

Payload for the command

object (studentaccounts-studentaccounttransaction-voidsecuritycheck-request-payload)

transIdList	Array of numbers <int32> [ items <int32 > ]
staffID	number <int32>
campusID	number <int32>

Responses

Request samples

Payload

Content type

application/json

{"payload": {"transIdList": [0
],
"staffID": 0,
"campusID": 0
}
}

Response samples

Content type

application/json

{"payload": {"data": {"isRescheduleEnable": true,
"validationMessages": {"hasErrors": true,
"count": 0,
"item": {"message": "string",
"messageType": 0
}
}
}
},
"notifications": [null
],
"hasError": false,
"hasFault": false,
"hasWarning": false,
"hasValidationError": false,
"hasValidationWarning": false,
"hasValidationInformation": false,
"hasSecurityError": false
}