POST jxc_api/SalesOrderSummary/Search

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Start	date	None.
End	date	None.
AggregateCriteria	AggregateCriteria	None.
IsAp	boolean	None.
IsGrossProfit	boolean	None.
PageIndex	integer	None.
PageSize	integer	None.
UsePager	boolean	None.
KeyWord	string	None.
IsShowSubTotal	boolean	None.
BillOrigins	Collection of integer	None.
CustomSearchAndOrderCondition	CustomSearchAndOrderCondition	None.

Request Formats

application/json, text/json

Sample:

{
  "Start": "2025-04-04 20:49:45",
  "End": "2025-04-04 20:49:45",
  "AggregateCriteria": 1010,
  "IsAp": true,
  "IsGrossProfit": true,
  "PageIndex": 5,
  "PageSize": 6,
  "UsePager": true,
  "KeyWord": "sample string 8",
  "IsShowSubTotal": true,
  "BillOrigins": [
    1,
    2
  ],
  "CustomSearchAndOrderCondition": {
    "OrderColumnName": "sample string 1",
    "OrderType": 0,
    "CustomSearchParams": [
      {
        "ColumnName": "sample string 1",
        "Params": [
          {},
          {}
        ]
      },
      {
        "ColumnName": "sample string 1",
        "Params": [
          {},
          {}
        ]
      }
    ]
  }
}

application/xml, text/xml

Sample:

<SalesOrderSummaryConditions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LemonScm.Model.Abstraction.Sell">
  <AggregateCriteria>Order</AggregateCriteria>
  <BillOrigins xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </BillOrigins>
  <CustomSearchAndOrderCondition xmlns:d2p1="http://schemas.datacontract.org/2004/07/LemonScm.Model.Abstraction.NewApi.BaseData">
    <d2p1:CustomSearchParams>
      <d2p1:CustomSearchParam>
        <d2p1:ColumnName>sample string 1</d2p1:ColumnName>
        <d2p1:Params xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:anyType />
          <d5p1:anyType />
        </d2p1:Params>
      </d2p1:CustomSearchParam>
      <d2p1:CustomSearchParam>
        <d2p1:ColumnName>sample string 1</d2p1:ColumnName>
        <d2p1:Params xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:anyType />
          <d5p1:anyType />
        </d2p1:Params>
      </d2p1:CustomSearchParam>
    </d2p1:CustomSearchParams>
    <d2p1:OrderColumnName>sample string 1</d2p1:OrderColumnName>
    <d2p1:OrderType>None</d2p1:OrderType>
  </CustomSearchAndOrderCondition>
  <End>2025-04-04T20:49:45.38986+08:00</End>
  <IsAp>true</IsAp>
  <IsGrossProfit>true</IsGrossProfit>
  <IsShowSubTotal>true</IsShowSubTotal>
  <KeyWord>sample string 8</KeyWord>
  <PageIndex>5</PageIndex>
  <PageSize>6</PageSize>
  <Start>2025-04-04T20:49:45.38986+08:00</Start>
  <UsePager>true</UsePager>
</SalesOrderSummaryConditions>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

NewApiPagedListOfSalesOrderSummaryListModel

Name	Type	Additional information
Items	Collection of SalesOrderSummaryListModel	None.
SumModel	SalesOrderSummaryListModel	None.
PageIndex	integer	None.
PageSize	integer	None.
Total	integer	None.
UsePager	boolean	None.
CategoriesFounded	Collection of integer	None.
RDocumentStartDate	string	None.
RDocumentEndDate	string	None.
RDeliveryStartDate	string	None.
RDeliveryEndDate	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Items": [
    {
      "Id": 1,
      "SoeId": 2,
      "Date": "2025-04-04 20:49:45",
      "DateFmt": "2025-04-04",
      "No": "sample string 4",
      "CustId": 5,
      "CustNo": "sample string 6",
      "CustName": "sample string 7",
      "CustTypeName": "sample string 8",
      "AccountingItemId": 9,
      "AccountingItemNo": "sample string 10",
      "AccountingItemName": "sample string 11",
      "DepartmentId": 12,
      "DepartmentNo": "sample string 13",
      "DepartmentName": "sample string 14",
      "Sales": 15,
      "SalesNo": "sample string 16",
      "SalesName": "sample string 17",
      "ProdId": 18,
      "ProdNo": "sample string 19",
      "ProdName": "sample string 20",
      "CatName": "sample string 21",
      "Brand": "sample string 22",
      "ProdLocation": "sample string 23",
      "Spec": "sample string 24",
      "ApId": 25,
      "ApName": "sample string 26",
      "Rate": 27.0,
      "QTY": 28.0,
      "AvailableQTY": 1.0,
      "WholeLooseQty": "sample string 29",
      "BaseUnitName": "sample string 30",
      "BaseQty": 31.0,
      "Price": 32.0,
      "Amount": 33.0,
      "Tax": 34.0,
      "AmountTax": 35.0,
      "PricePur": 36.0,
      "ReferenceCost": 37.0,
      "ReferenceGrossProfit": -4.0,
      "ReferenceGrossProfitMargin": -12.121212121212121,
      "SalesCost": 39.0,
      "GrossProfit": -6.0,
      "Expense": 41.0,
      "NetProfit": 42.0,
      "GrossProfitMargin": -18.181818181818183,
      "NetProfitMargin": 127.27272727272727,
      "IsCountRow": true
    },
    {
      "Id": 1,
      "SoeId": 2,
      "Date": "2025-04-04 20:49:45",
      "DateFmt": "2025-04-04",
      "No": "sample string 4",
      "CustId": 5,
      "CustNo": "sample string 6",
      "CustName": "sample string 7",
      "CustTypeName": "sample string 8",
      "AccountingItemId": 9,
      "AccountingItemNo": "sample string 10",
      "AccountingItemName": "sample string 11",
      "DepartmentId": 12,
      "DepartmentNo": "sample string 13",
      "DepartmentName": "sample string 14",
      "Sales": 15,
      "SalesNo": "sample string 16",
      "SalesName": "sample string 17",
      "ProdId": 18,
      "ProdNo": "sample string 19",
      "ProdName": "sample string 20",
      "CatName": "sample string 21",
      "Brand": "sample string 22",
      "ProdLocation": "sample string 23",
      "Spec": "sample string 24",
      "ApId": 25,
      "ApName": "sample string 26",
      "Rate": 27.0,
      "QTY": 28.0,
      "AvailableQTY": 1.0,
      "WholeLooseQty": "sample string 29",
      "BaseUnitName": "sample string 30",
      "BaseQty": 31.0,
      "Price": 32.0,
      "Amount": 33.0,
      "Tax": 34.0,
      "AmountTax": 35.0,
      "PricePur": 36.0,
      "ReferenceCost": 37.0,
      "ReferenceGrossProfit": -4.0,
      "ReferenceGrossProfitMargin": -12.121212121212121,
      "SalesCost": 39.0,
      "GrossProfit": -6.0,
      "Expense": 41.0,
      "NetProfit": 42.0,
      "GrossProfitMargin": -18.181818181818183,
      "NetProfitMargin": 127.27272727272727,
      "IsCountRow": true
    }
  ],
  "SumModel": {
    "Id": 1,
    "SoeId": 2,
    "Date": "2025-04-04 20:49:45",
    "DateFmt": "2025-04-04",
    "No": "sample string 4",
    "CustId": 5,
    "CustNo": "sample string 6",
    "CustName": "sample string 7",
    "CustTypeName": "sample string 8",
    "AccountingItemId": 9,
    "AccountingItemNo": "sample string 10",
    "AccountingItemName": "sample string 11",
    "DepartmentId": 12,
    "DepartmentNo": "sample string 13",
    "DepartmentName": "sample string 14",
    "Sales": 15,
    "SalesNo": "sample string 16",
    "SalesName": "sample string 17",
    "ProdId": 18,
    "ProdNo": "sample string 19",
    "ProdName": "sample string 20",
    "CatName": "sample string 21",
    "Brand": "sample string 22",
    "ProdLocation": "sample string 23",
    "Spec": "sample string 24",
    "ApId": 25,
    "ApName": "sample string 26",
    "Rate": 27.0,
    "QTY": 28.0,
    "AvailableQTY": 1.0,
    "WholeLooseQty": "sample string 29",
    "BaseUnitName": "sample string 30",
    "BaseQty": 31.0,
    "Price": 32.0,
    "Amount": 33.0,
    "Tax": 34.0,
    "AmountTax": 35.0,
    "PricePur": 36.0,
    "ReferenceCost": 37.0,
    "ReferenceGrossProfit": -4.0,
    "ReferenceGrossProfitMargin": -12.121212121212121,
    "SalesCost": 39.0,
    "GrossProfit": -6.0,
    "Expense": 41.0,
    "NetProfit": 42.0,
    "GrossProfitMargin": -18.181818181818183,
    "NetProfitMargin": 127.27272727272727,
    "IsCountRow": true
  },
  "PageIndex": 1,
  "PageSize": 2,
  "Total": 3,
  "UsePager": true,
  "CategoriesFounded": [
    1,
    2
  ],
  "RDocumentStartDate": "sample string 5",
  "RDocumentEndDate": "sample string 6",
  "RDeliveryStartDate": "sample string 7",
  "RDeliveryEndDate": "sample string 8"
}

application/xml, text/xml

Sample:

<NewApiPagedListOfSalesOrderSummaryListModelUtyeXF6X xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LemonScm.Model.NewApi">
  <_x003C_RDeliveryEndDate_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/LemonScm.Model.Abstraction.CommonData">sample string 8</_x003C_RDeliveryEndDate_x003E_k__BackingField>
  <_x003C_RDeliveryStartDate_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/LemonScm.Model.Abstraction.CommonData">sample string 7</_x003C_RDeliveryStartDate_x003E_k__BackingField>
  <_x003C_RDocumentEndDate_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/LemonScm.Model.Abstraction.CommonData">sample string 6</_x003C_RDocumentEndDate_x003E_k__BackingField>
  <_x003C_RDocumentStartDate_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/LemonScm.Model.Abstraction.CommonData">sample string 5</_x003C_RDocumentStartDate_x003E_k__BackingField>
  <_x003C_CategoriesFounded_x003E_k__BackingField xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </_x003C_CategoriesFounded_x003E_k__BackingField>
  <_x003C_Items_x003E_k__BackingField xmlns:d2p1="http://schemas.datacontract.org/2004/07/LemonScm.Model.Abstraction.Sell">
    <d2p1:SalesOrderSummaryListModel>
      <d2p1:AccountingItemId>9</d2p1:AccountingItemId>
      <d2p1:AccountingItemName>sample string 11</d2p1:AccountingItemName>
      <d2p1:AccountingItemNo>sample string 10</d2p1:AccountingItemNo>
      <d2p1:Amount>33</d2p1:Amount>
      <d2p1:AmountTax>35</d2p1:AmountTax>
      <d2p1:ApId>25</d2p1:ApId>
      <d2p1:ApName>sample string 26</d2p1:ApName>
      <d2p1:AvailableQTY>1</d2p1:AvailableQTY>
      <d2p1:BaseQty>31</d2p1:BaseQty>
      <d2p1:BaseUnitName>sample string 30</d2p1:BaseUnitName>
      <d2p1:Brand>sample string 22</d2p1:Brand>
      <d2p1:CatName>sample string 21</d2p1:CatName>
      <d2p1:CustId>5</d2p1:CustId>
      <d2p1:CustName>sample string 7</d2p1:CustName>
      <d2p1:CustNo>sample string 6</d2p1:CustNo>
      <d2p1:CustTypeName>sample string 8</d2p1:CustTypeName>
      <d2p1:Date>2025-04-04T20:49:45.4055567+08:00</d2p1:Date>
      <d2p1:DepartmentId>12</d2p1:DepartmentId>
      <d2p1:DepartmentName>sample string 14</d2p1:DepartmentName>
      <d2p1:DepartmentNo>sample string 13</d2p1:DepartmentNo>
      <d2p1:Expense>41</d2p1:Expense>
      <d2p1:GrossProfit>-6</d2p1:GrossProfit>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsCountRow>true</d2p1:IsCountRow>
      <d2p1:NetProfit>42</d2p1:NetProfit>
      <d2p1:No>sample string 4</d2p1:No>
      <d2p1:Price>32</d2p1:Price>
      <d2p1:PricePur>36</d2p1:PricePur>
      <d2p1:ProdId>18</d2p1:ProdId>
      <d2p1:ProdLocation>sample string 23</d2p1:ProdLocation>
      <d2p1:ProdName>sample string 20</d2p1:ProdName>
      <d2p1:ProdNo>sample string 19</d2p1:ProdNo>
      <d2p1:QTY>28</d2p1:QTY>
      <d2p1:Rate>27</d2p1:Rate>
      <d2p1:ReferenceCost>37</d2p1:ReferenceCost>
      <d2p1:ReferenceGrossProfit>-4</d2p1:ReferenceGrossProfit>
      <d2p1:Sales>15</d2p1:Sales>
      <d2p1:SalesCost>39</d2p1:SalesCost>
      <d2p1:SalesName>sample string 17</d2p1:SalesName>
      <d2p1:SalesNo>sample string 16</d2p1:SalesNo>
      <d2p1:SoeId>2</d2p1:SoeId>
      <d2p1:Spec>sample string 24</d2p1:Spec>
      <d2p1:Tax>34</d2p1:Tax>
      <d2p1:WholeLooseQty>sample string 29</d2p1:WholeLooseQty>
    </d2p1:SalesOrderSummaryListModel>
    <d2p1:SalesOrderSummaryListModel>
      <d2p1:AccountingItemId>9</d2p1:AccountingItemId>
      <d2p1:AccountingItemName>sample string 11</d2p1:AccountingItemName>
      <d2p1:AccountingItemNo>sample string 10</d2p1:AccountingItemNo>
      <d2p1:Amount>33</d2p1:Amount>
      <d2p1:AmountTax>35</d2p1:AmountTax>
      <d2p1:ApId>25</d2p1:ApId>
      <d2p1:ApName>sample string 26</d2p1:ApName>
      <d2p1:AvailableQTY>1</d2p1:AvailableQTY>
      <d2p1:BaseQty>31</d2p1:BaseQty>
      <d2p1:BaseUnitName>sample string 30</d2p1:BaseUnitName>
      <d2p1:Brand>sample string 22</d2p1:Brand>
      <d2p1:CatName>sample string 21</d2p1:CatName>
      <d2p1:CustId>5</d2p1:CustId>
      <d2p1:CustName>sample string 7</d2p1:CustName>
      <d2p1:CustNo>sample string 6</d2p1:CustNo>
      <d2p1:CustTypeName>sample string 8</d2p1:CustTypeName>
      <d2p1:Date>2025-04-04T20:49:45.4055567+08:00</d2p1:Date>
      <d2p1:DepartmentId>12</d2p1:DepartmentId>
      <d2p1:DepartmentName>sample string 14</d2p1:DepartmentName>
      <d2p1:DepartmentNo>sample string 13</d2p1:DepartmentNo>
      <d2p1:Expense>41</d2p1:Expense>
      <d2p1:GrossProfit>-6</d2p1:GrossProfit>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsCountRow>true</d2p1:IsCountRow>
      <d2p1:NetProfit>42</d2p1:NetProfit>
      <d2p1:No>sample string 4</d2p1:No>
      <d2p1:Price>32</d2p1:Price>
      <d2p1:PricePur>36</d2p1:PricePur>
      <d2p1:ProdId>18</d2p1:ProdId>
      <d2p1:ProdLocation>sample string 23</d2p1:ProdLocation>
      <d2p1:ProdName>sample string 20</d2p1:ProdName>
      <d2p1:ProdNo>sample string 19</d2p1:ProdNo>
      <d2p1:QTY>28</d2p1:QTY>
      <d2p1:Rate>27</d2p1:Rate>
      <d2p1:ReferenceCost>37</d2p1:ReferenceCost>
      <d2p1:ReferenceGrossProfit>-4</d2p1:ReferenceGrossProfit>
      <d2p1:Sales>15</d2p1:Sales>
      <d2p1:SalesCost>39</d2p1:SalesCost>
      <d2p1:SalesName>sample string 17</d2p1:SalesName>
      <d2p1:SalesNo>sample string 16</d2p1:SalesNo>
      <d2p1:SoeId>2</d2p1:SoeId>
      <d2p1:Spec>sample string 24</d2p1:Spec>
      <d2p1:Tax>34</d2p1:Tax>
      <d2p1:WholeLooseQty>sample string 29</d2p1:WholeLooseQty>
    </d2p1:SalesOrderSummaryListModel>
  </_x003C_Items_x003E_k__BackingField>
  <_x003C_PageIndex_x003E_k__BackingField>1</_x003C_PageIndex_x003E_k__BackingField>
  <_x003C_PageSize_x003E_k__BackingField>2</_x003C_PageSize_x003E_k__BackingField>
  <_x003C_SumModel_x003E_k__BackingField xmlns:d2p1="http://schemas.datacontract.org/2004/07/LemonScm.Model.Abstraction.Sell">
    <d2p1:AccountingItemId>9</d2p1:AccountingItemId>
    <d2p1:AccountingItemName>sample string 11</d2p1:AccountingItemName>
    <d2p1:AccountingItemNo>sample string 10</d2p1:AccountingItemNo>
    <d2p1:Amount>33</d2p1:Amount>
    <d2p1:AmountTax>35</d2p1:AmountTax>
    <d2p1:ApId>25</d2p1:ApId>
    <d2p1:ApName>sample string 26</d2p1:ApName>
    <d2p1:AvailableQTY>1</d2p1:AvailableQTY>
    <d2p1:BaseQty>31</d2p1:BaseQty>
    <d2p1:BaseUnitName>sample string 30</d2p1:BaseUnitName>
    <d2p1:Brand>sample string 22</d2p1:Brand>
    <d2p1:CatName>sample string 21</d2p1:CatName>
    <d2p1:CustId>5</d2p1:CustId>
    <d2p1:CustName>sample string 7</d2p1:CustName>
    <d2p1:CustNo>sample string 6</d2p1:CustNo>
    <d2p1:CustTypeName>sample string 8</d2p1:CustTypeName>
    <d2p1:Date>2025-04-04T20:49:45.4055567+08:00</d2p1:Date>
    <d2p1:DepartmentId>12</d2p1:DepartmentId>
    <d2p1:DepartmentName>sample string 14</d2p1:DepartmentName>
    <d2p1:DepartmentNo>sample string 13</d2p1:DepartmentNo>
    <d2p1:Expense>41</d2p1:Expense>
    <d2p1:GrossProfit>-6</d2p1:GrossProfit>
    <d2p1:Id>1</d2p1:Id>
    <d2p1:IsCountRow>true</d2p1:IsCountRow>
    <d2p1:NetProfit>42</d2p1:NetProfit>
    <d2p1:No>sample string 4</d2p1:No>
    <d2p1:Price>32</d2p1:Price>
    <d2p1:PricePur>36</d2p1:PricePur>
    <d2p1:ProdId>18</d2p1:ProdId>
    <d2p1:ProdLocation>sample string 23</d2p1:ProdLocation>
    <d2p1:ProdName>sample string 20</d2p1:ProdName>
    <d2p1:ProdNo>sample string 19</d2p1:ProdNo>
    <d2p1:QTY>28</d2p1:QTY>
    <d2p1:Rate>27</d2p1:Rate>
    <d2p1:ReferenceCost>37</d2p1:ReferenceCost>
    <d2p1:ReferenceGrossProfit>-4</d2p1:ReferenceGrossProfit>
    <d2p1:Sales>15</d2p1:Sales>
    <d2p1:SalesCost>39</d2p1:SalesCost>
    <d2p1:SalesName>sample string 17</d2p1:SalesName>
    <d2p1:SalesNo>sample string 16</d2p1:SalesNo>
    <d2p1:SoeId>2</d2p1:SoeId>
    <d2p1:Spec>sample string 24</d2p1:Spec>
    <d2p1:Tax>34</d2p1:Tax>
    <d2p1:WholeLooseQty>sample string 29</d2p1:WholeLooseQty>
  </_x003C_SumModel_x003E_k__BackingField>
  <_x003C_Total_x003E_k__BackingField>3</_x003C_Total_x003E_k__BackingField>
  <_x003C_UsePager_x003E_k__BackingField>true</_x003C_UsePager_x003E_k__BackingField>
</NewApiPagedListOfSalesOrderSummaryListModelUtyeXF6X>