POST api/import/subscriptiontransaction
Import a subscription transaction
Request Information
URI Parameters
None.
Body Parameters
Specify the data of the transaction
importsubscriptiontransactionargumentsName | Description | Type | Additional information |
---|---|---|---|
transactiondatetime |
The date and time of the transaction |
date |
None. |
productcode |
The product code of the subscription product |
string |
None. |
description |
The description of the transaction |
string |
None. |
quantity |
The number of terms of this transaction |
decimal number |
None. |
amount |
The total amount of this transaction |
decimal number |
None. |
first |
Indicates if this is a first/new subscription term |
boolean |
None. |
datestart |
The start date indicated by the transaction |
date |
None. |
dateend |
The start date indicated by the transaction |
date |
None. |
paymentmethod |
Payment method from the external system |
string |
None. |
transactionid |
Transaction Id from the external system |
string |
None. |
customerid |
Customer Id from the external system |
string |
None. |
Request Formats
application/json, text/json
Sample:
{ "transactiondatetime": "2024-11-24T12:52:08.0922229+01:00", "productcode": "sample string 2", "description": "sample string 3", "quantity": 4.0, "amount": 5.0, "first": true, "datestart": "2024-11-24T12:52:08.0922229+01:00", "dateend": "2024-11-24T12:52:08.0922229+01:00", "paymentmethod": "sample string 9", "transactionid": "sample string 10", "customerid": "sample string 11" }
application/xml, text/xml
Sample:
<importsubscriptiontransactionarguments xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechnoDataSystems.Enterprise.TotalWash.Web.API"> <amount>5</amount> <customerid>sample string 11</customerid> <dateend>2024-11-24T12:52:08.0922229+01:00</dateend> <datestart>2024-11-24T12:52:08.0922229+01:00</datestart> <description>sample string 3</description> <first>true</first> <paymentmethod>sample string 9</paymentmethod> <productcode>sample string 2</productcode> <quantity>4</quantity> <transactiondatetime>2024-11-24T12:52:08.0922229+01:00</transactiondatetime> <transactionid>sample string 10</transactionid> </importsubscriptiontransactionarguments>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
The result of this action
importsubscriptiontransactionresultName | Description | Type | Additional information |
---|---|---|---|
success |
Indicates if the action was successfull |
boolean |
None. |
remark |
A description regarding the result |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "success": true, "remark": "sample string 2" }
application/xml, text/xml
Sample:
<importsubscriptiontransactionresult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechnoDataSystems.Enterprise.TotalWash.Web.API"> <remark>sample string 2</remark> <success>true</success> </importsubscriptiontransactionresult>