POST api/SubscriptionPayment
Add subscription payment
Request Information
URI Parameters
None.
Body Parameters
SubscriptionPaymentRequestModelName | Description | Type | Additional information |
---|---|---|---|
CompanyID | integer |
None. |
|
SubscriptionPlanID | integer |
None. |
|
TotalAmount | decimal number |
None. |
|
PaidAmount | decimal number |
None. |
|
BalanceAmount | decimal number |
None. |
|
PaymentDate | date |
None. |
|
Remarks | string |
None. |
Request Formats
application/json, text/json, text/plain, text/html
Sample:
{ "companyID": 1, "subscriptionPlanID": 2, "totalAmount": 3.0, "paidAmount": 4.0, "balanceAmount": 5.0, "paymentDate": "2025-07-17T04:19:12.2883272+00:00", "remarks": "sample string 6" }
application/xml, text/xml
Sample:
<SubscriptionPaymentRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.RequestModel"> <BalanceAmount>5</BalanceAmount> <CompanyID>1</CompanyID> <PaidAmount>4</PaidAmount> <PaymentDate>2025-07-17T04:19:12.2883272+00:00</PaymentDate> <Remarks>sample string 6</Remarks> <SubscriptionPlanID>2</SubscriptionPlanID> <TotalAmount>3</TotalAmount> </SubscriptionPaymentRequestModel>
multipart/form-data
Sample:
<SubscriptionPaymentRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.RequestModel"><BalanceAmount>5</BalanceAmount><CompanyID>1</CompanyID><PaidAmount>4</PaidAmount><PaymentDate>2025-07-17T04:19:12.2883272+00:00</PaymentDate><Remarks>sample string 6</Remarks><SubscriptionPlanID>2</SubscriptionPlanID><TotalAmount>3</TotalAmount></SubscriptionPaymentRequestModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
CommonResponseDataModelName | Description | Type | Additional information |
---|---|---|---|
ReturnID | integer |
Required |
|
Message | string |
Required |
|
Successful | boolean |
Required |
|
Code | integer |
None. |
|
TotalRecord | integer |
None. |
Response Formats
application/json, text/json, text/plain, text/html
Sample:
{ "returnID": 1, "message": "sample string 2", "successful": true, "code": 4, "totalRecord": 5 }
application/xml, text/xml
Sample:
<CommonResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel"> <Code>4</Code> <Message>sample string 2</Message> <ReturnID>1</ReturnID> <Successful>true</Successful> <TotalRecord>5</TotalRecord> </CommonResponseDataModel>
multipart/form-data
Sample:
<CommonResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel"><Code>4</Code><Message>sample string 2</Message><ReturnID>1</ReturnID><Successful>true</Successful><TotalRecord>5</TotalRecord></CommonResponseDataModel>