PUT api/customerrecurring/{id}
Updates a specific customer recurring record by CustomerRecurringID; only the following fields can be updated: Recurring Item Code, Description, Master Item Code, Bill Cycle, and Memo. To update all other fields, cancel and recreate the recur line.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id | integer |
Required |
Body Parameters
CustomerRecurringUpdateName | Description | Type | Additional information |
---|---|---|---|
CustomerRecurringId |
Sedona internal autonumber for the Customer Recurring record |
integer |
None. |
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 |
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 |
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 |
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 |
CustomerBillId |
Optional - update the CustomerBillId this recurring record is pointing to; if MasterAccountCode is being set, this should be the CustomerBillId for the Master |
integer |
None. |
Request Formats
application/json, text/json
{ "CustomerRecurringId": 1, "ItemCode": "sample string 2", "MasterItemCode": "sample string 3", "MasterAccountCode": "sample string 4", "BillCycle": "sample string 5", "UserDescription": "sample string 6", "InvoiceItemMemo": "sample string 7", "CustomerBillId": 8 }
application/xml, text/xml
<CustomerRecurringUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models"> <BillCycle>sample string 5</BillCycle> <CustomerBillId>8</CustomerBillId> <CustomerRecurringId>1</CustomerRecurringId> <InvoiceItemMemo>sample string 7</InvoiceItemMemo> <ItemCode>sample string 2</ItemCode> <MasterAccountCode>sample string 4</MasterAccountCode> <MasterItemCode>sample string 3</MasterItemCode> <UserDescription>sample string 6</UserDescription> </CustomerRecurringUpdate>
application/x-www-form-urlencoded
Response Information
Resource Description
None.