POST api/ARRecurringPaymentSetup/Add
Request Information
URI Parameters
None.
Body Parameters
ARRecurringPaymentSetup| Name | Description | Type | Additional information |
|---|---|---|---|
| ARCustomerMasterId | string |
None. |
|
| ARCustomerName | string |
None. |
|
| CreditCardId | integer |
None. |
|
| AmountToCharge | decimal number |
None. |
|
| MaxAmountToCharge | decimal number |
None. |
|
| IsActive | boolean |
None. |
|
| IsRecurring | boolean |
None. |
|
| StartDate | date |
None. |
|
| EndDate | date |
None. |
|
| NextBillingDate | date |
None. |
|
| BillingFrequency | string |
None. |
|
| Comments | string |
None. |
|
| Status | string |
None. |
|
| NextBillingDateTimeZone | date |
None. |
|
| AccountId | integer |
None. |
|
| CompanyId | string |
None. |
|
| CreatedOn | date |
None. |
|
| CreatedBy | string |
None. |
|
| UpdatedOn | date |
None. |
|
| UpdatedBy | string |
None. |
|
| IsLockedForEditing | boolean |
None. |
|
| LockedBy | string |
None. |
|
| Id | string |
None. |
|
| FieldPermissions | Collection of DTOFieldPermission |
None. |
Request Formats
application/json, text/json
Sample:
{
"ARCustomerMasterId": "sample string 1",
"ARCustomerName": "sample string 2",
"CreditCardId": 3,
"AmountToCharge": 4.0,
"MaxAmountToCharge": 5.0,
"IsActive": true,
"IsRecurring": true,
"StartDate": "2025-12-16T16:34:36.3566259+00:00",
"EndDate": "2025-12-16T16:34:36.3566259+00:00",
"NextBillingDate": "2025-12-16T16:34:36.3566259+00:00",
"BillingFrequency": "sample string 9",
"Comments": "sample string 10",
"Status": "sample string 11",
"NextBillingDateTimeZone": "2025-12-16T16:34:36.3566259+00:00",
"AccountId": 12,
"CompanyId": "sample string 13",
"CreatedOn": "2025-12-16T16:34:36.3566259+00:00",
"CreatedBy": "sample string 15",
"UpdatedOn": "2025-12-16T16:34:36.3566259+00:00",
"UpdatedBy": "sample string 16",
"IsLockedForEditing": true,
"LockedBy": "sample string 18",
"Id": "sample string 19",
"FieldPermissions": []
}
application/xml, text/xml
Sample:
<ARRecurringPaymentSetup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.AR"> <Id xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">sample string 19</Id> <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">sample string 15</CreatedBy> <CreatedOn xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">2025-12-16T16:34:36.3566259+00:00</CreatedOn> <IsLockedForEditing xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">true</IsLockedForEditing> <LockedBy xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">sample string 18</LockedBy> <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">sample string 16</UpdatedBy> <UpdatedOn xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">2025-12-16T16:34:36.3566259+00:00</UpdatedOn> <AccountId xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">12</AccountId> <CompanyId xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AccountSpecific.Base">sample string 13</CompanyId> <ARCustomerMasterId>sample string 1</ARCustomerMasterId> <ARCustomerName>sample string 2</ARCustomerName> <AmountToCharge>4</AmountToCharge> <BillingFrequency>sample string 9</BillingFrequency> <Comments>sample string 10</Comments> <CreditCardId>3</CreditCardId> <EndDate>2025-12-16T16:34:36.3566259+00:00</EndDate> <IsActive>true</IsActive> <IsRecurring>true</IsRecurring> <MaxAmountToCharge>5</MaxAmountToCharge> <NextBillingDate>2025-12-16T16:34:36.3566259+00:00</NextBillingDate> <NextBillingDateTimeZone>2025-12-16T16:34:36.3566259+00:00</NextBillingDateTimeZone> <StartDate>2025-12-16T16:34:36.3566259+00:00</StartDate> <Status>sample string 11</Status> </ARRecurringPaymentSetup>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ObjectNone.
Response Formats
application/json, text/json
Sample:
{}
application/xml, text/xml
Sample:
<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />