| Name | Description | Type | Additional information |
|---|---|---|---|
| CustomerRecurringId |
Sedona internal autonumber for the Customer Recurring record |
integer |
None. |
| CustomerId |
Foreign key from AR_Customer table |
integer |
Required |
| CustomerBillId |
Foreign key from AR_Customer_Bill table; if MasterAccountCode is set, this should be the CustomerBillId for the Master |
integer |
Required |
| CustomerSiteId |
Foreign key from AR_Customer_Site table |
integer |
Required |
| CustomerSystemId |
Foreign key from AR_Customer_System table |
integer |
Required |
| ItemCode |
Value from AR_Item table; list of valid options can be retrieved from GET: api/item |
string |
Required String length: inclusive between 0 and 25 |
| BillCycle |
M = Monthly, Q = Quarterly, S = Semi-annual, A = Annual |
string |
Required String length: inclusive between 0 and 1 |
| MonthlyAmount |
recurring amount on a monthly basis |
decimal number |
Required |
| CycleStartDate |
Date on which the Cycle charges should begin. |
string |
Required |
| CycleEndDate |
Date on which the Cycle charges should end (or cancel); defaults to null date (12/30/1899) if not set explicitly. |
string |
None. |
| LastCycleDate |
Date on which this Customer last received a Cycle Invoice for this Recurring Charge; defaults to null date (12/30/1899) if not set explicitly. |
string |
None. |
| NextCycleDate |
Date on which this Customer will be invoiced next for this Recurring Charge. |
string |
Required |
| PendingAmt |
GET only; set automatically on POST |
decimal number |
None. |
| JobCode |
Value from OE_Job table; defaults to 000 if not set explicitly |
string |
String length: inclusive between 0 and 25 |
| IsCancelled |
GET only; use Cancel Recurring function to cancel a recur line |
boolean |
None. |
| CancelledRMRTrackingId |
GET only; set automatically on POST/PUT |
integer |
None. |
| LastRateIncrease |
GET only |
string |
None. |
| MasterItemCode |
Item_Code from AR_Item table; the Recurring Revenue item that this item will be “rolled up” into. Items of like Master Item and cycle are grouped together in the application. Defaults to N/A if not set explicitly. |
string |
String length: inclusive between 0 and 25 |
| MasterAccountCode |
Master_Account_Code from AR_Master_Account table; used to set "Receivable to Master" flag; if set, should also pass Master's CustomerBillId |
string |
None. |
| CycleAmount |
recurring amount for the entire BillCycle; if not supplied, calculated automatically as MonthlyAmount * # months in the cycle (i.e. BillCycle = M, this will be equal to the MonthlyAmount; BillCycle = Q, this will be 3x the MonthlyAmount) |
decimal number |
None. |
| BillOnDay |
Day of the month to process the invoice on, between 1 and 28. If 29, 30 or 31, must set to 28. Defaults to 1 if not set explicitly. |
integer |
None. |
| UserDescription |
Description of the Recurring Charges; defaults to the Item Description if not set explicitly. |
string |
String length: inclusive between 0 and 50 |
| InvoiceItemMemo |
Memo field in the AR_Invoice_Item table |
string |
String length: inclusive between 0 and 2000 |
| BranchCode |
Value from AR_Branch table; list of valid options can be retrieved from GET: api/branch |
string |
Required String length: inclusive between 0 and 25 |
| RMRReasonCode |
Reason for the RMR change; value from AR_RMR_Reason table (for Tracking record) |
string |
Required String length: inclusive between 0 and 25 |
| RMRTrackingComments |
Additional comments for the RMR Tracking table |
string |
String length: inclusive between 0 and 1024 |
| UserCode |
the user making this change; defaults to UserCode value from config file if not set explicitly |
string |
String length: inclusive between 0 and 30 |