PUT api/folderproducts/packageaddtreatments
Request Information
URI Parameters
None.
Body Parameters
FolderProduct| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer |
None. |
|
| CFId | integer |
None. |
|
| FolderId | integer |
None. |
|
| ProductId | integer |
None. |
|
| ProductType | ProductTypes |
None. |
|
| PriceListId | integer |
None. |
|
| BkPrId | integer |
None. |
|
| State | FolderProductStates |
None. |
|
| StartDate | date |
None. |
|
| EndDate | date |
None. |
|
| Duration | decimal number |
None. |
|
| AddAsDayScheduled | boolean |
None. |
|
| Quantity | decimal number |
None. |
|
| DiscountPrcnt | decimal number |
None. |
|
| DiscountValue | decimal number |
None. |
|
| IsArrangement | boolean |
None. |
|
| PayerType | CFPayerTypes |
None. |
|
| PromoterId | integer |
None. |
|
| PromoterId2 | integer |
None. |
|
| Key | string |
None. |
|
| CancelledDate | date |
None. |
|
| StoppedDate | date |
None. |
|
| CreationDate | date |
None. |
|
| Notes | string |
None. |
|
| ChargeMethod | ProductChargeMethod |
None. |
|
| MaxTreatments | integer |
None. |
|
| ActualTreatments | integer |
None. |
|
| ChargedTreatments | integer |
None. |
|
| ValidDuration | integer |
None. |
|
| FinancialState | RPlFinancialState |
None. |
|
| ChargeId | integer |
None. |
|
| SaleTypeId | integer |
None. |
|
| UnitPrice | decimal number |
None. |
|
| TotalCharged | decimal number |
None. |
|
| LeaderId | integer |
None. |
|
| AssistantId | integer |
None. |
|
| ProductDescr | string |
None. |
|
| PriceListDescr | string |
None. |
|
| LeaderDescr | string |
None. |
|
| AssistantDescr | string |
None. |
|
| SaleTypeDescr | string |
None. |
|
| TotalPaid | decimal number |
None. |
|
| CustId | integer |
None. |
|
| IsMaison | boolean |
None. |
|
| CustomerSurname | string |
None. |
|
| CustomerName | string |
None. |
|
| CustomerFather | string |
None. |
|
| CustomerPhone1 | string |
None. |
|
| CustomerPhone2 | string |
None. |
|
| CustomerMobilePhone | string |
None. |
|
| CustomerEmail | string |
None. |
|
| PrepayDate | date |
None. |
|
| ProductDeptId | integer |
None. |
|
| ProductDeptDescr | string |
None. |
|
| LastUpdate | date |
None. |
|
| FreezeStartDate | date |
None. |
|
| FreezeEndDate | date |
None. |
|
| SCListId | integer |
None. |
|
| CampaignId | integer |
None. |
|
| FolderAlias | string |
None. |
|
| PMSHotelAlias | string |
None. |
|
| PMSHotelRoom | string |
None. |
|
| IsHidden | boolean |
None. |
|
| VATPercent | decimal number |
None. |
|
| PayerId | integer |
None. |
|
| BookingSourceId | integer |
None. |
|
| PayoutValue | decimal number |
None. |
|
| ExtReference1 | string |
None. |
|
| ExtReference2 | string |
None. |
|
| IsForCouple | boolean |
None. |
|
| ParentProdId | integer |
None. |
|
| SiblingCFPrId | integer |
None. |
|
| ProductRecommendationId | integer |
None. |
|
| SourceApplicationType | SourceApplicationTypes |
None. |
|
| FolderProductTreatments | Collection of FolderProductTreatment |
None. |
|
| DeletedTreatments | Collection of integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"Id": 1,
"CFId": 2,
"FolderId": 3,
"ProductId": 4,
"ProductType": 0,
"PriceListId": 5,
"BkPrId": 6,
"State": 0,
"StartDate": "2025-05-04T20:19:10.7383387+03:00",
"EndDate": "2025-05-04T20:19:10.7383387+03:00",
"Duration": 9.1,
"AddAsDayScheduled": true,
"Quantity": 11.1,
"DiscountPrcnt": 12.1,
"DiscountValue": 13.1,
"IsArrangement": true,
"PayerType": 0,
"PromoterId": 15,
"PromoterId2": 16,
"Key": "sample string 17",
"CancelledDate": "2025-05-04T20:19:10.7383387+03:00",
"StoppedDate": "2025-05-04T20:19:10.7383387+03:00",
"CreationDate": "2025-05-04T20:19:10.7383387+03:00",
"Notes": "sample string 21",
"ChargeMethod": 0,
"MaxTreatments": 22,
"ActualTreatments": 23,
"ChargedTreatments": 24,
"ValidDuration": 25,
"FinancialState": 0,
"ChargeId": 26,
"SaleTypeId": 27,
"UnitPrice": 28.1,
"TotalCharged": 29.1,
"LeaderId": 30,
"AssistantId": 31,
"ProductDescr": "sample string 32",
"PriceListDescr": "sample string 33",
"LeaderDescr": "sample string 34",
"AssistantDescr": "sample string 35",
"SaleTypeDescr": "sample string 36",
"TotalPaid": 37.1,
"CustId": 38,
"IsMaison": true,
"CustomerSurname": "sample string 40",
"CustomerName": "sample string 41",
"CustomerFather": "sample string 42",
"CustomerPhone1": "sample string 43",
"CustomerPhone2": "sample string 44",
"CustomerMobilePhone": "sample string 45",
"CustomerEmail": "sample string 46",
"PrepayDate": "2025-05-04T20:19:10.7383387+03:00",
"ProductDeptId": 48,
"ProductDeptDescr": "sample string 49",
"LastUpdate": "2025-05-04T20:19:10.7383387+03:00",
"FreezeStartDate": "2025-05-04T20:19:10.7383387+03:00",
"FreezeEndDate": "2025-05-04T20:19:10.7383387+03:00",
"SCListId": 53,
"CampaignId": 54,
"FolderAlias": "sample string 55",
"PMSHotelAlias": "sample string 56",
"PMSHotelRoom": "sample string 57",
"IsHidden": true,
"VATPercent": 59.1,
"PayerId": 60,
"BookingSourceId": 61,
"PayoutValue": 62.1,
"ExtReference1": "sample string 63",
"ExtReference2": "sample string 64",
"IsForCouple": true,
"ParentProdId": 66,
"SiblingCFPrId": 67,
"ProductRecommendationId": 68,
"SourceApplicationType": 0,
"FolderProductTreatments": null,
"DeletedTreatments": [
1,
2
]
}
application/xml, text/xml
Sample:
<FolderProduct xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Atlantis.Web.Api.Models">
<ActualTreatments>23</ActualTreatments>
<AddAsDayScheduled>true</AddAsDayScheduled>
<AssistantDescr>sample string 35</AssistantDescr>
<AssistantId>31</AssistantId>
<BkPrId>6</BkPrId>
<BookingSourceId>61</BookingSourceId>
<CFId>2</CFId>
<CampaignId>54</CampaignId>
<CancelledDate>2025-05-04T20:19:10.7383387+03:00</CancelledDate>
<ChargeId>26</ChargeId>
<ChargeMethod>PCM_NOTSPECIFIED</ChargeMethod>
<ChargedTreatments>24</ChargedTreatments>
<CreationDate>2025-05-04T20:19:10.7383387+03:00</CreationDate>
<CustId>38</CustId>
<CustomerEmail>sample string 46</CustomerEmail>
<CustomerFather>sample string 42</CustomerFather>
<CustomerMobilePhone>sample string 45</CustomerMobilePhone>
<CustomerName>sample string 41</CustomerName>
<CustomerPhone1>sample string 43</CustomerPhone1>
<CustomerPhone2>sample string 44</CustomerPhone2>
<CustomerSurname>sample string 40</CustomerSurname>
<DeletedTreatments xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</DeletedTreatments>
<DiscountPrcnt>12.1</DiscountPrcnt>
<DiscountValue>13.1</DiscountValue>
<Duration>9.1</Duration>
<EndDate>2025-05-04T20:19:10.7383387+03:00</EndDate>
<ExtReference1>sample string 63</ExtReference1>
<ExtReference2>sample string 64</ExtReference2>
<FinancialState>NOFIST_</FinancialState>
<FolderAlias>sample string 55</FolderAlias>
<FolderId>3</FolderId>
<FolderProductTreatments i:nil="true" />
<FreezeEndDate>2025-05-04T20:19:10.7383387+03:00</FreezeEndDate>
<FreezeStartDate>2025-05-04T20:19:10.7383387+03:00</FreezeStartDate>
<Id>1</Id>
<IsArrangement>true</IsArrangement>
<IsForCouple>true</IsForCouple>
<IsHidden>true</IsHidden>
<IsMaison>true</IsMaison>
<Key>sample string 17</Key>
<LastUpdate>2025-05-04T20:19:10.7383387+03:00</LastUpdate>
<LeaderDescr>sample string 34</LeaderDescr>
<LeaderId>30</LeaderId>
<MaxTreatments>22</MaxTreatments>
<Notes>sample string 21</Notes>
<PMSHotelAlias>sample string 56</PMSHotelAlias>
<PMSHotelRoom>sample string 57</PMSHotelRoom>
<ParentProdId>66</ParentProdId>
<PayerId>60</PayerId>
<PayerType>PTCUSTOMER</PayerType>
<PayoutValue>62.1</PayoutValue>
<PrepayDate>2025-05-04T20:19:10.7383387+03:00</PrepayDate>
<PriceListDescr>sample string 33</PriceListDescr>
<PriceListId>5</PriceListId>
<ProductDeptDescr>sample string 49</ProductDeptDescr>
<ProductDeptId>48</ProductDeptId>
<ProductDescr>sample string 32</ProductDescr>
<ProductId>4</ProductId>
<ProductRecommendationId>68</ProductRecommendationId>
<ProductType>PT_THERAPY</ProductType>
<PromoterId>15</PromoterId>
<PromoterId2>16</PromoterId2>
<Quantity>11.1</Quantity>
<SCListId>53</SCListId>
<SaleTypeDescr>sample string 36</SaleTypeDescr>
<SaleTypeId>27</SaleTypeId>
<SiblingCFPrId>67</SiblingCFPrId>
<SourceApplicationType>SystemUser</SourceApplicationType>
<StartDate>2025-05-04T20:19:10.7383387+03:00</StartDate>
<State>CFP_CANCELLED</State>
<StoppedDate>2025-05-04T20:19:10.7383387+03:00</StoppedDate>
<TotalCharged>29.1</TotalCharged>
<TotalPaid>37.1</TotalPaid>
<UnitPrice>28.1</UnitPrice>
<VATPercent>59.1</VATPercent>
<ValidDuration>25</ValidDuration>
</FolderProduct>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
FolderProduct| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer |
None. |
|
| CFId | integer |
None. |
|
| FolderId | integer |
None. |
|
| ProductId | integer |
None. |
|
| ProductType | ProductTypes |
None. |
|
| PriceListId | integer |
None. |
|
| BkPrId | integer |
None. |
|
| State | FolderProductStates |
None. |
|
| StartDate | date |
None. |
|
| EndDate | date |
None. |
|
| Duration | decimal number |
None. |
|
| AddAsDayScheduled | boolean |
None. |
|
| Quantity | decimal number |
None. |
|
| DiscountPrcnt | decimal number |
None. |
|
| DiscountValue | decimal number |
None. |
|
| IsArrangement | boolean |
None. |
|
| PayerType | CFPayerTypes |
None. |
|
| PromoterId | integer |
None. |
|
| PromoterId2 | integer |
None. |
|
| Key | string |
None. |
|
| CancelledDate | date |
None. |
|
| StoppedDate | date |
None. |
|
| CreationDate | date |
None. |
|
| Notes | string |
None. |
|
| ChargeMethod | ProductChargeMethod |
None. |
|
| MaxTreatments | integer |
None. |
|
| ActualTreatments | integer |
None. |
|
| ChargedTreatments | integer |
None. |
|
| ValidDuration | integer |
None. |
|
| FinancialState | RPlFinancialState |
None. |
|
| ChargeId | integer |
None. |
|
| SaleTypeId | integer |
None. |
|
| UnitPrice | decimal number |
None. |
|
| TotalCharged | decimal number |
None. |
|
| LeaderId | integer |
None. |
|
| AssistantId | integer |
None. |
|
| ProductDescr | string |
None. |
|
| PriceListDescr | string |
None. |
|
| LeaderDescr | string |
None. |
|
| AssistantDescr | string |
None. |
|
| SaleTypeDescr | string |
None. |
|
| TotalPaid | decimal number |
None. |
|
| CustId | integer |
None. |
|
| IsMaison | boolean |
None. |
|
| CustomerSurname | string |
None. |
|
| CustomerName | string |
None. |
|
| CustomerFather | string |
None. |
|
| CustomerPhone1 | string |
None. |
|
| CustomerPhone2 | string |
None. |
|
| CustomerMobilePhone | string |
None. |
|
| CustomerEmail | string |
None. |
|
| PrepayDate | date |
None. |
|
| ProductDeptId | integer |
None. |
|
| ProductDeptDescr | string |
None. |
|
| LastUpdate | date |
None. |
|
| FreezeStartDate | date |
None. |
|
| FreezeEndDate | date |
None. |
|
| SCListId | integer |
None. |
|
| CampaignId | integer |
None. |
|
| FolderAlias | string |
None. |
|
| PMSHotelAlias | string |
None. |
|
| PMSHotelRoom | string |
None. |
|
| IsHidden | boolean |
None. |
|
| VATPercent | decimal number |
None. |
|
| PayerId | integer |
None. |
|
| BookingSourceId | integer |
None. |
|
| PayoutValue | decimal number |
None. |
|
| ExtReference1 | string |
None. |
|
| ExtReference2 | string |
None. |
|
| IsForCouple | boolean |
None. |
|
| ParentProdId | integer |
None. |
|
| SiblingCFPrId | integer |
None. |
|
| ProductRecommendationId | integer |
None. |
|
| SourceApplicationType | SourceApplicationTypes |
None. |
|
| FolderProductTreatments | Collection of FolderProductTreatment |
None. |
|
| DeletedTreatments | Collection of integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"Id": 1,
"CFId": 2,
"FolderId": 3,
"ProductId": 4,
"ProductType": 0,
"PriceListId": 5,
"BkPrId": 6,
"State": 0,
"StartDate": "2025-05-04T20:19:10.740359+03:00",
"EndDate": "2025-05-04T20:19:10.740359+03:00",
"Duration": 9.1,
"AddAsDayScheduled": true,
"Quantity": 11.1,
"DiscountPrcnt": 12.1,
"DiscountValue": 13.1,
"IsArrangement": true,
"PayerType": 0,
"PromoterId": 15,
"PromoterId2": 16,
"Key": "sample string 17",
"CancelledDate": "2025-05-04T20:19:10.740359+03:00",
"StoppedDate": "2025-05-04T20:19:10.740359+03:00",
"CreationDate": "2025-05-04T20:19:10.740359+03:00",
"Notes": "sample string 21",
"ChargeMethod": 0,
"MaxTreatments": 22,
"ActualTreatments": 23,
"ChargedTreatments": 24,
"ValidDuration": 25,
"FinancialState": 0,
"ChargeId": 26,
"SaleTypeId": 27,
"UnitPrice": 28.1,
"TotalCharged": 29.1,
"LeaderId": 30,
"AssistantId": 31,
"ProductDescr": "sample string 32",
"PriceListDescr": "sample string 33",
"LeaderDescr": "sample string 34",
"AssistantDescr": "sample string 35",
"SaleTypeDescr": "sample string 36",
"TotalPaid": 37.1,
"CustId": 38,
"IsMaison": true,
"CustomerSurname": "sample string 40",
"CustomerName": "sample string 41",
"CustomerFather": "sample string 42",
"CustomerPhone1": "sample string 43",
"CustomerPhone2": "sample string 44",
"CustomerMobilePhone": "sample string 45",
"CustomerEmail": "sample string 46",
"PrepayDate": "2025-05-04T20:19:10.740359+03:00",
"ProductDeptId": 48,
"ProductDeptDescr": "sample string 49",
"LastUpdate": "2025-05-04T20:19:10.740359+03:00",
"FreezeStartDate": "2025-05-04T20:19:10.740359+03:00",
"FreezeEndDate": "2025-05-04T20:19:10.740359+03:00",
"SCListId": 53,
"CampaignId": 54,
"FolderAlias": "sample string 55",
"PMSHotelAlias": "sample string 56",
"PMSHotelRoom": "sample string 57",
"IsHidden": true,
"VATPercent": 59.1,
"PayerId": 60,
"BookingSourceId": 61,
"PayoutValue": 62.1,
"ExtReference1": "sample string 63",
"ExtReference2": "sample string 64",
"IsForCouple": true,
"ParentProdId": 66,
"SiblingCFPrId": 67,
"ProductRecommendationId": 68,
"SourceApplicationType": 0,
"FolderProductTreatments": null,
"DeletedTreatments": [
1,
2
]
}
application/xml, text/xml
Sample:
<FolderProduct xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Atlantis.Web.Api.Models">
<ActualTreatments>23</ActualTreatments>
<AddAsDayScheduled>true</AddAsDayScheduled>
<AssistantDescr>sample string 35</AssistantDescr>
<AssistantId>31</AssistantId>
<BkPrId>6</BkPrId>
<BookingSourceId>61</BookingSourceId>
<CFId>2</CFId>
<CampaignId>54</CampaignId>
<CancelledDate>2025-05-04T20:19:10.740359+03:00</CancelledDate>
<ChargeId>26</ChargeId>
<ChargeMethod>PCM_NOTSPECIFIED</ChargeMethod>
<ChargedTreatments>24</ChargedTreatments>
<CreationDate>2025-05-04T20:19:10.740359+03:00</CreationDate>
<CustId>38</CustId>
<CustomerEmail>sample string 46</CustomerEmail>
<CustomerFather>sample string 42</CustomerFather>
<CustomerMobilePhone>sample string 45</CustomerMobilePhone>
<CustomerName>sample string 41</CustomerName>
<CustomerPhone1>sample string 43</CustomerPhone1>
<CustomerPhone2>sample string 44</CustomerPhone2>
<CustomerSurname>sample string 40</CustomerSurname>
<DeletedTreatments xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</DeletedTreatments>
<DiscountPrcnt>12.1</DiscountPrcnt>
<DiscountValue>13.1</DiscountValue>
<Duration>9.1</Duration>
<EndDate>2025-05-04T20:19:10.740359+03:00</EndDate>
<ExtReference1>sample string 63</ExtReference1>
<ExtReference2>sample string 64</ExtReference2>
<FinancialState>NOFIST_</FinancialState>
<FolderAlias>sample string 55</FolderAlias>
<FolderId>3</FolderId>
<FolderProductTreatments i:nil="true" />
<FreezeEndDate>2025-05-04T20:19:10.740359+03:00</FreezeEndDate>
<FreezeStartDate>2025-05-04T20:19:10.740359+03:00</FreezeStartDate>
<Id>1</Id>
<IsArrangement>true</IsArrangement>
<IsForCouple>true</IsForCouple>
<IsHidden>true</IsHidden>
<IsMaison>true</IsMaison>
<Key>sample string 17</Key>
<LastUpdate>2025-05-04T20:19:10.740359+03:00</LastUpdate>
<LeaderDescr>sample string 34</LeaderDescr>
<LeaderId>30</LeaderId>
<MaxTreatments>22</MaxTreatments>
<Notes>sample string 21</Notes>
<PMSHotelAlias>sample string 56</PMSHotelAlias>
<PMSHotelRoom>sample string 57</PMSHotelRoom>
<ParentProdId>66</ParentProdId>
<PayerId>60</PayerId>
<PayerType>PTCUSTOMER</PayerType>
<PayoutValue>62.1</PayoutValue>
<PrepayDate>2025-05-04T20:19:10.740359+03:00</PrepayDate>
<PriceListDescr>sample string 33</PriceListDescr>
<PriceListId>5</PriceListId>
<ProductDeptDescr>sample string 49</ProductDeptDescr>
<ProductDeptId>48</ProductDeptId>
<ProductDescr>sample string 32</ProductDescr>
<ProductId>4</ProductId>
<ProductRecommendationId>68</ProductRecommendationId>
<ProductType>PT_THERAPY</ProductType>
<PromoterId>15</PromoterId>
<PromoterId2>16</PromoterId2>
<Quantity>11.1</Quantity>
<SCListId>53</SCListId>
<SaleTypeDescr>sample string 36</SaleTypeDescr>
<SaleTypeId>27</SaleTypeId>
<SiblingCFPrId>67</SiblingCFPrId>
<SourceApplicationType>SystemUser</SourceApplicationType>
<StartDate>2025-05-04T20:19:10.740359+03:00</StartDate>
<State>CFP_CANCELLED</State>
<StoppedDate>2025-05-04T20:19:10.740359+03:00</StoppedDate>
<TotalCharged>29.1</TotalCharged>
<TotalPaid>37.1</TotalPaid>
<UnitPrice>28.1</UnitPrice>
<VATPercent>59.1</VATPercent>
<ValidDuration>25</ValidDuration>
</FolderProduct>