POST api/customerrecurring/{id}/{option}

Updates the Recurring Rate (Effective Date, Reason for increase/decrease, and Monthly/Cycle Amounts) by CustomerRecurringID; also used to cancel a recurring record

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required
option	Available options: RateChange, Cancel	string	Required

Body Parameters

CustomerRecurringChange

Name	Description	Type	Additional information
CustomerRecurringId	Sedona internal autonumber for the Customer Recurring record	integer	None.
BillCycle	M = Monthly, Q = Quarterly, S = Semi-annual, A = Annual	string	Required String length: inclusive between 0 and 1
MonthlyAmount	The new recurring amount on a monthly basis (entire amount) required for RateChange	decimal number	Required
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.
EffectiveDate	Date on which the old rate is canceled (MM/DD/YYYY format); for Rate Changes the new start Date will automatically be set to the next day	string	Required
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	used for RateChange only	string	String length: inclusive between 0 and 1024
Cancelled	Set to true to cancel this recurring	boolean	None.
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

Request Formats

application/json, text/json

Sample:

{
  "CustomerRecurringId": 1,
  "BillCycle": "sample string 2",
  "MonthlyAmount": 3.0,
  "CycleAmount": 4.0,
  "EffectiveDate": "sample string 5",
  "RMRReasonCode": "sample string 6",
  "RMRTrackingComments": "sample string 7",
  "Cancelled": true,
  "UserCode": "sample string 9"
}

application/xml, text/xml

Sample:

<CustomerRecurringChange xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models">
  <BillCycle>sample string 2</BillCycle>
  <Cancelled>true</Cancelled>
  <CustomerRecurringId>1</CustomerRecurringId>
  <CycleAmount>4</CycleAmount>
  <EffectiveDate>sample string 5</EffectiveDate>
  <MonthlyAmount>3</MonthlyAmount>
  <RMRReasonCode>sample string 6</RMRReasonCode>
  <RMRTrackingComments>sample string 7</RMRTrackingComments>
  <UserCode>sample string 9</UserCode>
</CustomerRecurringChange>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CustomerRecurringChange'.

Response Information

Resource Description

CustomerRecurringChange

Name	Description	Type	Additional information
CustomerRecurringId	Sedona internal autonumber for the Customer Recurring record	integer	None.
BillCycle	M = Monthly, Q = Quarterly, S = Semi-annual, A = Annual	string	Required String length: inclusive between 0 and 1
MonthlyAmount	The new recurring amount on a monthly basis (entire amount) required for RateChange	decimal number	Required
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.
EffectiveDate	Date on which the old rate is canceled (MM/DD/YYYY format); for Rate Changes the new start Date will automatically be set to the next day	string	Required
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	used for RateChange only	string	String length: inclusive between 0 and 1024
Cancelled	Set to true to cancel this recurring	boolean	None.
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

Response Formats

application/json, text/json

Sample:

{
  "CustomerRecurringId": 1,
  "BillCycle": "sample string 2",
  "MonthlyAmount": 3.0,
  "CycleAmount": 4.0,
  "EffectiveDate": "sample string 5",
  "RMRReasonCode": "sample string 6",
  "RMRTrackingComments": "sample string 7",
  "Cancelled": true,
  "UserCode": "sample string 9"
}

application/xml, text/xml

Sample:

<CustomerRecurringChange xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models">
  <BillCycle>sample string 2</BillCycle>
  <Cancelled>true</Cancelled>
  <CustomerRecurringId>1</CustomerRecurringId>
  <CycleAmount>4</CycleAmount>
  <EffectiveDate>sample string 5</EffectiveDate>
  <MonthlyAmount>3</MonthlyAmount>
  <RMRReasonCode>sample string 6</RMRReasonCode>
  <RMRTrackingComments>sample string 7</RMRTrackingComments>
  <UserCode>sample string 9</UserCode>
</CustomerRecurringChange>