GET api/folderproducts/getforfolder/{cfid}

Request Information

URI Parameters

Name	Description	Type	Additional information
cfid		integer	Required

Body Parameters

None.

Response Information

Resource Description

Collection of FolderProduct

Name	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.
ChargeDateStr	string	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.
BookingSourceActionId	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-11-01T00:58:08.0939104+02:00",
    "EndDate": "2025-11-01T00:58:08.0939104+02:00",
    "ChargeDateStr": "sample string 9",
    "Duration": 10.1,
    "AddAsDayScheduled": true,
    "Quantity": 12.1,
    "DiscountPrcnt": 13.1,
    "DiscountValue": 14.1,
    "IsArrangement": true,
    "PayerType": 0,
    "PromoterId": 16,
    "PromoterId2": 17,
    "Key": "sample string 18",
    "CancelledDate": "2025-11-01T00:58:08.0939104+02:00",
    "StoppedDate": "2025-11-01T00:58:08.0939104+02:00",
    "CreationDate": "2025-11-01T00:58:08.0939104+02:00",
    "Notes": "sample string 22",
    "ChargeMethod": 0,
    "MaxTreatments": 23,
    "ActualTreatments": 24,
    "ChargedTreatments": 25,
    "ValidDuration": 26,
    "FinancialState": 0,
    "ChargeId": 27,
    "SaleTypeId": 28,
    "UnitPrice": 29.1,
    "TotalCharged": 30.1,
    "LeaderId": 31,
    "AssistantId": 32,
    "ProductDescr": "sample string 33",
    "PriceListDescr": "sample string 34",
    "LeaderDescr": "sample string 35",
    "AssistantDescr": "sample string 36",
    "SaleTypeDescr": "sample string 37",
    "TotalPaid": 38.1,
    "CustId": 39,
    "IsMaison": true,
    "CustomerSurname": "sample string 41",
    "CustomerName": "sample string 42",
    "CustomerFather": "sample string 43",
    "CustomerPhone1": "sample string 44",
    "CustomerPhone2": "sample string 45",
    "CustomerMobilePhone": "sample string 46",
    "CustomerEmail": "sample string 47",
    "PrepayDate": "2025-11-01T00:58:08.0949051+02:00",
    "ProductDeptId": 49,
    "ProductDeptDescr": "sample string 50",
    "LastUpdate": "2025-11-01T00:58:08.0949051+02:00",
    "FreezeStartDate": "2025-11-01T00:58:08.0949051+02:00",
    "FreezeEndDate": "2025-11-01T00:58:08.0949051+02:00",
    "SCListId": 54,
    "CampaignId": 55,
    "FolderAlias": "sample string 56",
    "PMSHotelAlias": "sample string 57",
    "PMSHotelRoom": "sample string 58",
    "IsHidden": true,
    "VATPercent": 60.1,
    "PayerId": 61,
    "BookingSourceId": 62,
    "BookingSourceActionId": 63,
    "PayoutValue": 64.1,
    "ExtReference1": "sample string 65",
    "ExtReference2": "sample string 66",
    "IsForCouple": true,
    "ParentProdId": 68,
    "SiblingCFPrId": 69,
    "ProductRecommendationId": 70,
    "SourceApplicationType": 0,
    "FolderProductTreatments": null,
    "DeletedTreatments": [
      1,
      2
    ]
  },
  {
    "Id": 1,
    "CFId": 2,
    "FolderId": 3,
    "ProductId": 4,
    "ProductType": 0,
    "PriceListId": 5,
    "BkPrId": 6,
    "State": 0,
    "StartDate": "2025-11-01T00:58:08.0939104+02:00",
    "EndDate": "2025-11-01T00:58:08.0939104+02:00",
    "ChargeDateStr": "sample string 9",
    "Duration": 10.1,
    "AddAsDayScheduled": true,
    "Quantity": 12.1,
    "DiscountPrcnt": 13.1,
    "DiscountValue": 14.1,
    "IsArrangement": true,
    "PayerType": 0,
    "PromoterId": 16,
    "PromoterId2": 17,
    "Key": "sample string 18",
    "CancelledDate": "2025-11-01T00:58:08.0939104+02:00",
    "StoppedDate": "2025-11-01T00:58:08.0939104+02:00",
    "CreationDate": "2025-11-01T00:58:08.0939104+02:00",
    "Notes": "sample string 22",
    "ChargeMethod": 0,
    "MaxTreatments": 23,
    "ActualTreatments": 24,
    "ChargedTreatments": 25,
    "ValidDuration": 26,
    "FinancialState": 0,
    "ChargeId": 27,
    "SaleTypeId": 28,
    "UnitPrice": 29.1,
    "TotalCharged": 30.1,
    "LeaderId": 31,
    "AssistantId": 32,
    "ProductDescr": "sample string 33",
    "PriceListDescr": "sample string 34",
    "LeaderDescr": "sample string 35",
    "AssistantDescr": "sample string 36",
    "SaleTypeDescr": "sample string 37",
    "TotalPaid": 38.1,
    "CustId": 39,
    "IsMaison": true,
    "CustomerSurname": "sample string 41",
    "CustomerName": "sample string 42",
    "CustomerFather": "sample string 43",
    "CustomerPhone1": "sample string 44",
    "CustomerPhone2": "sample string 45",
    "CustomerMobilePhone": "sample string 46",
    "CustomerEmail": "sample string 47",
    "PrepayDate": "2025-11-01T00:58:08.0949051+02:00",
    "ProductDeptId": 49,
    "ProductDeptDescr": "sample string 50",
    "LastUpdate": "2025-11-01T00:58:08.0949051+02:00",
    "FreezeStartDate": "2025-11-01T00:58:08.0949051+02:00",
    "FreezeEndDate": "2025-11-01T00:58:08.0949051+02:00",
    "SCListId": 54,
    "CampaignId": 55,
    "FolderAlias": "sample string 56",
    "PMSHotelAlias": "sample string 57",
    "PMSHotelRoom": "sample string 58",
    "IsHidden": true,
    "VATPercent": 60.1,
    "PayerId": 61,
    "BookingSourceId": 62,
    "BookingSourceActionId": 63,
    "PayoutValue": 64.1,
    "ExtReference1": "sample string 65",
    "ExtReference2": "sample string 66",
    "IsForCouple": true,
    "ParentProdId": 68,
    "SiblingCFPrId": 69,
    "ProductRecommendationId": 70,
    "SourceApplicationType": 0,
    "FolderProductTreatments": null,
    "DeletedTreatments": [
      1,
      2
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfFolderProduct xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Atlantis.Web.Api.Models">
  <FolderProduct>
    <ActualTreatments>24</ActualTreatments>
    <AddAsDayScheduled>true</AddAsDayScheduled>
    <AssistantDescr>sample string 36</AssistantDescr>
    <AssistantId>32</AssistantId>
    <BkPrId>6</BkPrId>
    <BookingSourceActionId>63</BookingSourceActionId>
    <BookingSourceId>62</BookingSourceId>
    <CFId>2</CFId>
    <CampaignId>55</CampaignId>
    <CancelledDate>2025-11-01T00:58:08.0939104+02:00</CancelledDate>
    <ChargeDateStr>sample string 9</ChargeDateStr>
    <ChargeId>27</ChargeId>
    <ChargeMethod>PCM_NOTSPECIFIED</ChargeMethod>
    <ChargedTreatments>25</ChargedTreatments>
    <CreationDate>2025-11-01T00:58:08.0939104+02:00</CreationDate>
    <CustId>39</CustId>
    <CustomerEmail>sample string 47</CustomerEmail>
    <CustomerFather>sample string 43</CustomerFather>
    <CustomerMobilePhone>sample string 46</CustomerMobilePhone>
    <CustomerName>sample string 42</CustomerName>
    <CustomerPhone1>sample string 44</CustomerPhone1>
    <CustomerPhone2>sample string 45</CustomerPhone2>
    <CustomerSurname>sample string 41</CustomerSurname>
    <DeletedTreatments xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </DeletedTreatments>
    <DiscountPrcnt>13.1</DiscountPrcnt>
    <DiscountValue>14.1</DiscountValue>
    <Duration>10.1</Duration>
    <EndDate>2025-11-01T00:58:08.0939104+02:00</EndDate>
    <ExtReference1>sample string 65</ExtReference1>
    <ExtReference2>sample string 66</ExtReference2>
    <FinancialState>NOFIST_</FinancialState>
    <FolderAlias>sample string 56</FolderAlias>
    <FolderId>3</FolderId>
    <FolderProductTreatments i:nil="true" />
    <FreezeEndDate>2025-11-01T00:58:08.0949051+02:00</FreezeEndDate>
    <FreezeStartDate>2025-11-01T00:58:08.0949051+02:00</FreezeStartDate>
    <Id>1</Id>
    <IsArrangement>true</IsArrangement>
    <IsForCouple>true</IsForCouple>
    <IsHidden>true</IsHidden>
    <IsMaison>true</IsMaison>
    <Key>sample string 18</Key>
    <LastUpdate>2025-11-01T00:58:08.0949051+02:00</LastUpdate>
    <LeaderDescr>sample string 35</LeaderDescr>
    <LeaderId>31</LeaderId>
    <MaxTreatments>23</MaxTreatments>
    <Notes>sample string 22</Notes>
    <PMSHotelAlias>sample string 57</PMSHotelAlias>
    <PMSHotelRoom>sample string 58</PMSHotelRoom>
    <ParentProdId>68</ParentProdId>
    <PayerId>61</PayerId>
    <PayerType>PTCUSTOMER</PayerType>
    <PayoutValue>64.1</PayoutValue>
    <PrepayDate>2025-11-01T00:58:08.0949051+02:00</PrepayDate>
    <PriceListDescr>sample string 34</PriceListDescr>
    <PriceListId>5</PriceListId>
    <ProductDeptDescr>sample string 50</ProductDeptDescr>
    <ProductDeptId>49</ProductDeptId>
    <ProductDescr>sample string 33</ProductDescr>
    <ProductId>4</ProductId>
    <ProductRecommendationId>70</ProductRecommendationId>
    <ProductType>PT_THERAPY</ProductType>
    <PromoterId>16</PromoterId>
    <PromoterId2>17</PromoterId2>
    <Quantity>12.1</Quantity>
    <SCListId>54</SCListId>
    <SaleTypeDescr>sample string 37</SaleTypeDescr>
    <SaleTypeId>28</SaleTypeId>
    <SiblingCFPrId>69</SiblingCFPrId>
    <SourceApplicationType>SystemUser</SourceApplicationType>
    <StartDate>2025-11-01T00:58:08.0939104+02:00</StartDate>
    <State>CFP_CANCELLED</State>
    <StoppedDate>2025-11-01T00:58:08.0939104+02:00</StoppedDate>
    <TotalCharged>30.1</TotalCharged>
    <TotalPaid>38.1</TotalPaid>
    <UnitPrice>29.1</UnitPrice>
    <VATPercent>60.1</VATPercent>
    <ValidDuration>26</ValidDuration>
  </FolderProduct>
  <FolderProduct>
    <ActualTreatments>24</ActualTreatments>
    <AddAsDayScheduled>true</AddAsDayScheduled>
    <AssistantDescr>sample string 36</AssistantDescr>
    <AssistantId>32</AssistantId>
    <BkPrId>6</BkPrId>
    <BookingSourceActionId>63</BookingSourceActionId>
    <BookingSourceId>62</BookingSourceId>
    <CFId>2</CFId>
    <CampaignId>55</CampaignId>
    <CancelledDate>2025-11-01T00:58:08.0939104+02:00</CancelledDate>
    <ChargeDateStr>sample string 9</ChargeDateStr>
    <ChargeId>27</ChargeId>
    <ChargeMethod>PCM_NOTSPECIFIED</ChargeMethod>
    <ChargedTreatments>25</ChargedTreatments>
    <CreationDate>2025-11-01T00:58:08.0939104+02:00</CreationDate>
    <CustId>39</CustId>
    <CustomerEmail>sample string 47</CustomerEmail>
    <CustomerFather>sample string 43</CustomerFather>
    <CustomerMobilePhone>sample string 46</CustomerMobilePhone>
    <CustomerName>sample string 42</CustomerName>
    <CustomerPhone1>sample string 44</CustomerPhone1>
    <CustomerPhone2>sample string 45</CustomerPhone2>
    <CustomerSurname>sample string 41</CustomerSurname>
    <DeletedTreatments xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </DeletedTreatments>
    <DiscountPrcnt>13.1</DiscountPrcnt>
    <DiscountValue>14.1</DiscountValue>
    <Duration>10.1</Duration>
    <EndDate>2025-11-01T00:58:08.0939104+02:00</EndDate>
    <ExtReference1>sample string 65</ExtReference1>
    <ExtReference2>sample string 66</ExtReference2>
    <FinancialState>NOFIST_</FinancialState>
    <FolderAlias>sample string 56</FolderAlias>
    <FolderId>3</FolderId>
    <FolderProductTreatments i:nil="true" />
    <FreezeEndDate>2025-11-01T00:58:08.0949051+02:00</FreezeEndDate>
    <FreezeStartDate>2025-11-01T00:58:08.0949051+02:00</FreezeStartDate>
    <Id>1</Id>
    <IsArrangement>true</IsArrangement>
    <IsForCouple>true</IsForCouple>
    <IsHidden>true</IsHidden>
    <IsMaison>true</IsMaison>
    <Key>sample string 18</Key>
    <LastUpdate>2025-11-01T00:58:08.0949051+02:00</LastUpdate>
    <LeaderDescr>sample string 35</LeaderDescr>
    <LeaderId>31</LeaderId>
    <MaxTreatments>23</MaxTreatments>
    <Notes>sample string 22</Notes>
    <PMSHotelAlias>sample string 57</PMSHotelAlias>
    <PMSHotelRoom>sample string 58</PMSHotelRoom>
    <ParentProdId>68</ParentProdId>
    <PayerId>61</PayerId>
    <PayerType>PTCUSTOMER</PayerType>
    <PayoutValue>64.1</PayoutValue>
    <PrepayDate>2025-11-01T00:58:08.0949051+02:00</PrepayDate>
    <PriceListDescr>sample string 34</PriceListDescr>
    <PriceListId>5</PriceListId>
    <ProductDeptDescr>sample string 50</ProductDeptDescr>
    <ProductDeptId>49</ProductDeptId>
    <ProductDescr>sample string 33</ProductDescr>
    <ProductId>4</ProductId>
    <ProductRecommendationId>70</ProductRecommendationId>
    <ProductType>PT_THERAPY</ProductType>
    <PromoterId>16</PromoterId>
    <PromoterId2>17</PromoterId2>
    <Quantity>12.1</Quantity>
    <SCListId>54</SCListId>
    <SaleTypeDescr>sample string 37</SaleTypeDescr>
    <SaleTypeId>28</SaleTypeId>
    <SiblingCFPrId>69</SiblingCFPrId>
    <SourceApplicationType>SystemUser</SourceApplicationType>
    <StartDate>2025-11-01T00:58:08.0939104+02:00</StartDate>
    <State>CFP_CANCELLED</State>
    <StoppedDate>2025-11-01T00:58:08.0939104+02:00</StoppedDate>
    <TotalCharged>30.1</TotalCharged>
    <TotalPaid>38.1</TotalPaid>
    <UnitPrice>29.1</UnitPrice>
    <VATPercent>60.1</VATPercent>
    <ValidDuration>26</ValidDuration>
  </FolderProduct>
</ArrayOfFolderProduct>