| Name | Description | Type | Additional information |
|---|---|---|---|
| BuildingId |
[Required] Building Id |
integer |
Range: inclusive between 1 and 2147483647 |
| ChargeCodeId |
[Required] Charge Code Id |
integer |
Range: inclusive between 1 and 2147483647 |
| UnitId |
[Required when AppliesTo = Unit] It will default to 0 for ApplyTo is All\UnitType |
integer |
None. |
| UnitType |
[Required when AppliesTo = UnitType] It will default to 0 for ApplyTo is All\Shares\Unit |
integer |
None. |
| ChargeCodeAdjustedCodeId |
[Required when Type = Credit] Adjusted Code Id |
integer |
None. |
| OverrideDueDay |
[Required] Day of the month the charge/credit is going to be posted. Valid values are betwee 1 and 31. |
integer |
Range: inclusive between 1 and 31 |
| StartDate |
[Required] Date the Recurring Transaction begins. |
date |
Required |
| EndDate |
[Required] Date the Recurring Transaction ends. |
date |
Required |
| Rate |
[Required when ApplyTo = Shares] Will default to 0.00M when ApplyTo is not Shares |
decimal number |
None. |
| Amount |
[Required when ApplyTo is not Shares]. Will default to 0.00M when ApplyTo = Shares. |
decimal number |
None. |
| Type |
[Required] Type of the Recurring Transaction. Possible values for charge: 'Charge' or 0. Possible values for credit: 'Credit' or 1. If Type isn't passed in then it is defaulted to Charge |
RecurringTransactionType |
None. |
| ApplyToId |
[Required] Id of Apply To configuration. |
RecurringTransactionAppliesTo |
None. |
| CreatedBy |
[Required] Id of User who created the recurring transaction |
integer |
Range: inclusive between 1 and 2147483647 |
| IsLinkedCredit |
Indicates if the new recurring credit is associated with a recurring charge. |
boolean |
None. |
| LinkedCreditGroupId |
Id of recurring charge that is going to be associated with new recurring credit. Provide if IsLinkedCredit is set to True. |
integer |
None. |
| Id |
Id of Linked Credit |
integer |
None. |
| RetroGLPostDate |
Retro GL Post Date |
date |
None. |