CreateCharge (V1)
This activity was migrated to a new namespace. For new workflows use CreateCharge (V2) in Cmc.Nexus.StudentAccounts.Workflow.
Use the CreateCharge activity to post a Charge to an account associated with a Person Id.
The Charge is the output of the workflow activity. You specify input properties such as Charge Code, Transaction Type, Person or Prospect Id, Transaction Date, Post Date, Description, Student Enrollment Period, and Reference.
You can use this activity to automate the process of posting charges when a condition that you create is true. A condition could be, for example, a change in enrollment, a grade change, or any other applicable event.
This activity creates an instance of a Charge; it does not save it to the database. To persist the Charge in the database, insert a SaveCharge (V1) activity.
Properties
| Property | Value | Required | Notes |
|---|---|---|---|
| Amount | InArgument<Decimal>
|
Yes | Specify the charge amount, for example, 150.00d. |
| Charge | OutArgument<AccountChargeTransaction>
|
Yes | The Charge that is posted to the account. |
| Charge Code | InArgument<Int32>
|
Yes | Select a value in the drop-down list of the activity in the Designer window. |
| Description | InArgument<String>
|
Yes | Specify a description of the Charge using a string, for example, "Activity fee". |
| DisplayName | String
|
No | Specify a name for the activity or accept the default. |
| Enrollment Period | InArgument<Int32>
|
No | Specify the student enrollment period to which the Charge applies using a VB expression, for example, entity.Id. |
| Person | InArgument<Int32>
|
Yes | Specify the Person Id using a VB expression, for example, entity.PersonId.Note: If a preceding activity in a workflow returns an Id that is not a Person Id, insert a CVueIdToPersonIdActivity into the workflow before using this property. |
| Post Date | InArgument<DateTime>
|
Yes | Specify the date when the Charge is posted using a VB expression, for example, DateTime.Now. |
| Prospect | OutArgument<Int32>
|
No | Specify the Prospect Id using a VB expression or variable, for example, entity.Id.Note: If a preceding activity in a workflow returns a Person Id, insert a PersonIdToCVueIdActivity into the workflow before using this property. |
| Reference | InArgument<String>
|
No | Specify a reference for the Charge using a string, for example, "Engineering Lab". |
| Term | InArgument<Nullable<Int32>>
|
No | Specify the Term Id using a VB expression or variable. |
| Transaction Date | InArgument<DateTime>
|
Yes | Specify the transaction date using a VB expression, for example, DateTime.Now. |
| Transaction Type | InArgument<TransactionType>
|
Yes | Select a value in the drop-down list of the activity in the Designer window. |
To see how this activity can be used in a workflow, refer to Charge a Fee when the Enrollment Status Changes.
