POST api/CustomerRecurringProrate
Returns the credit amount and the total prorated bill amount for the recurring change. The change can be committed by setting the commit parameter of the CustomerRecurringProrate model to true.
Request Information
URI Parameters
None.
Body Parameters
CustomerRecurringProrateName | Description | Type | Additional information |
---|---|---|---|
CustomerRecurringId |
Sedona internal autonumber for the Customer Recurring record |
integer |
Required |
MonthlyAmount |
The new recurring amount on a monthly basis (entire amount); cycle amount will be calculated automatically; if not set calculated from cycle amount |
decimal number |
None. |
CycleAmount |
Amount for the entire BillCycle; if not set, calculated from MonthlyAmount |
decimal number |
None. |
EffectiveDate |
Date on which the old rate is canceled (MM/DD/YYYY format) |
string |
Required |
EndDate |
The last day of the proration; if not supplied, the Last cycle Date of the recurring will be used |
string |
None. |
BillCycle |
Bill Cycle for the new recurring; if not provided, the Bill Cycle of the recurring will be used |
string |
None. |
RMRReasonCode |
Reason for the RMR change; value from AR_RMR_Reason table (for Tracking record); required when Commit is set to true. |
string |
String length: inclusive between 0 and 25 |
RMRTrackingComments |
Additional comments for the RMR Tracking table |
string |
String length: inclusive between 0 and 1024 |
CreditReasonCode |
Value from AR_Credit_Reason table; required when Commit is set to true. |
string |
String length: inclusive between 0 and 25 |
InvoiceDescriptionCode |
the Invoice Description Code, from AR_Invoice_Description table |
string |
String length: inclusive between 0 and 25 |
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 |
Commit |
Set to true if you would like to commit the change to Sedona, otherwise, the results are more information purposes |
boolean |
None. |
CreditAmount |
Returns the amount of the credit created if and when the rate is changed. Do not set, used to return the results. Anything provided will be overwritten. |
decimal number |
None. |
BillAmount |
Returns the amount owed if and when the rate is changed. Do not set, used to return the results. Anything provided will be overwritten. |
decimal number |
None. |
NewCreditId |
Returns the CustomerCreditId created for the rate change when Commit is set to true. Do not set, used to return the results. Anything provided will be overwritten. |
integer |
None. |
NewCustomerRecurringId |
Deprecated |
integer |
None. |
Request Formats
application/json, text/json
{ "CustomerRecurringId": 1, "MonthlyAmount": 2.0, "CycleAmount": 3.0, "EffectiveDate": "sample string 4", "EndDate": "sample string 5", "BillCycle": "sample string 6", "RMRReasonCode": "sample string 7", "RMRTrackingComments": "sample string 8", "CreditReasonCode": "sample string 9", "InvoiceDescriptionCode": "sample string 10", "UserCode": "sample string 11", "Commit": true, "CreditAmount": 1.0, "BillAmount": 1.0, "NewCreditId": 1, "NewCustomerRecurringId": 1 }
application/xml, text/xml
<CustomerRecurringProrate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models"> <BillAmount>1</BillAmount> <BillCycle>sample string 6</BillCycle> <Commit>true</Commit> <CreditAmount>1</CreditAmount> <CreditReasonCode>sample string 9</CreditReasonCode> <CustomerRecurringId>1</CustomerRecurringId> <CycleAmount>3</CycleAmount> <EffectiveDate>sample string 4</EffectiveDate> <EndDate>sample string 5</EndDate> <InvoiceDescriptionCode>sample string 10</InvoiceDescriptionCode> <MonthlyAmount>2</MonthlyAmount> <NewCreditId>1</NewCreditId> <NewCustomerRecurringId>1</NewCustomerRecurringId> <RMRReasonCode>sample string 7</RMRReasonCode> <RMRTrackingComments>sample string 8</RMRTrackingComments> <UserCode>sample string 11</UserCode> </CustomerRecurringProrate>
application/x-www-form-urlencoded
Response Information
Resource Description
CustomerRecurringProrateName | Description | Type | Additional information |
---|---|---|---|
CustomerRecurringId |
Sedona internal autonumber for the Customer Recurring record |
integer |
Required |
MonthlyAmount |
The new recurring amount on a monthly basis (entire amount); cycle amount will be calculated automatically; if not set calculated from cycle amount |
decimal number |
None. |
CycleAmount |
Amount for the entire BillCycle; if not set, calculated from MonthlyAmount |
decimal number |
None. |
EffectiveDate |
Date on which the old rate is canceled (MM/DD/YYYY format) |
string |
Required |
EndDate |
The last day of the proration; if not supplied, the Last cycle Date of the recurring will be used |
string |
None. |
BillCycle |
Bill Cycle for the new recurring; if not provided, the Bill Cycle of the recurring will be used |
string |
None. |
RMRReasonCode |
Reason for the RMR change; value from AR_RMR_Reason table (for Tracking record); required when Commit is set to true. |
string |
String length: inclusive between 0 and 25 |
RMRTrackingComments |
Additional comments for the RMR Tracking table |
string |
String length: inclusive between 0 and 1024 |
CreditReasonCode |
Value from AR_Credit_Reason table; required when Commit is set to true. |
string |
String length: inclusive between 0 and 25 |
InvoiceDescriptionCode |
the Invoice Description Code, from AR_Invoice_Description table |
string |
String length: inclusive between 0 and 25 |
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 |
Commit |
Set to true if you would like to commit the change to Sedona, otherwise, the results are more information purposes |
boolean |
None. |
CreditAmount |
Returns the amount of the credit created if and when the rate is changed. Do not set, used to return the results. Anything provided will be overwritten. |
decimal number |
None. |
BillAmount |
Returns the amount owed if and when the rate is changed. Do not set, used to return the results. Anything provided will be overwritten. |
decimal number |
None. |
NewCreditId |
Returns the CustomerCreditId created for the rate change when Commit is set to true. Do not set, used to return the results. Anything provided will be overwritten. |
integer |
None. |
NewCustomerRecurringId |
Deprecated |
integer |
None. |
Response Formats
application/json, text/json
{ "CustomerRecurringId": 1, "MonthlyAmount": 2.0, "CycleAmount": 3.0, "EffectiveDate": "sample string 4", "EndDate": "sample string 5", "BillCycle": "sample string 6", "RMRReasonCode": "sample string 7", "RMRTrackingComments": "sample string 8", "CreditReasonCode": "sample string 9", "InvoiceDescriptionCode": "sample string 10", "UserCode": "sample string 11", "Commit": true, "CreditAmount": 1.0, "BillAmount": 1.0, "NewCreditId": 1, "NewCustomerRecurringId": 1 }
application/xml, text/xml
<CustomerRecurringProrate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models"> <BillAmount>1</BillAmount> <BillCycle>sample string 6</BillCycle> <Commit>true</Commit> <CreditAmount>1</CreditAmount> <CreditReasonCode>sample string 9</CreditReasonCode> <CustomerRecurringId>1</CustomerRecurringId> <CycleAmount>3</CycleAmount> <EffectiveDate>sample string 4</EffectiveDate> <EndDate>sample string 5</EndDate> <InvoiceDescriptionCode>sample string 10</InvoiceDescriptionCode> <MonthlyAmount>2</MonthlyAmount> <NewCreditId>1</NewCreditId> <NewCustomerRecurringId>1</NewCustomerRecurringId> <RMRReasonCode>sample string 7</RMRReasonCode> <RMRTrackingComments>sample string 8</RMRTrackingComments> <UserCode>sample string 11</UserCode> </CustomerRecurringProrate>