Usage
Use CreateBudgetItem to create or update a Budget Item in an event.
Basic Steps
- Create an instance of one or more individual BudgetItem objects. For each Budget Item object, you populate its fields with the data you want to add.
- Construct a BudgetItem array and populate that array with the budget Item you want to create or update.
- Optionally, specify the MessageId if you need to track the result of each record. Message IDs can represent unique identifiers from your system. Message IDs will be returned as Reference IDs in the result array for your tracking purposes.
- Call CreateBudgetItem, passing in the Budget Item array.
- Process the results in the CreateBudgetItemResultArray object to verify whether the BudgetItem have been successfully created or updated.
General Syntax
CreateBudgetItemResultArray = cventapi.CreateBudgetItem (BudgetItems)Input
| Name | Type | Description |
|---|---|---|
| BudgetItem | BudgetItem Array | Array of one or more Budget Items (up to 200) to be created or updated, and optionally MessageIds which will be returned as ReferenceIds. |
Output
| Name | Type | Description |
|---|---|---|
| Id | ID | ID of the Budget Item that was created or updated. If this field contains a value, then the Budget Item was successfully created or updated. If this field is empty, then the Budget Item was not created or updated and instead returned an error. |
| ReferenceId | ID | The MessageId value in the input CvObject. |
| Success | Boolean | Indicates whether the Upsert call succeeded (True) or not (False) for the object instance. |
| NewBudgetItem | Boolean | Indicates whether the Upsert call resulted in a new BudgetItem (True) or updated an existing BudgetItem (False). |
| Errors | Error Array | If an error occurred during the Upsert call, an array of one or more one Error objects providing the error code and description. |
Notes
Take into account the following notes when using the CreateBudgetItem call:
- Budget Feature: This must be turned on at the event level in order to make this call.
- Default Budget Version: Newly created Budget Item will apply to default budget version.
- Budget Policy: Budget Policies do not apply when BudgetItems are created with this call.
To update an existing BudgetItem, include the Id of the BudgetItem in the call. You must also provide the Budgeted cost along with any other costs.
Last updated on