GET api/v2/Inventory/SpecialOrders/ReceivedOrders?ReceivedDate={ReceivedDate}&IncludePOS={IncludePOS}&IncludeService={IncludeService}

Retrieve a list of received special orders.

Request Information

URI Parameters

Name	Description	Type	Additional information
ReceivedDate	Select Special Orders with parts received as of this date.	date	Required
IncludePOS	Include Special Orders from Point of Sale. Defauly is True.	boolean	Default value is True
IncludeService	Include Special Orders from Service Work Orders. Default is true.	boolean	Default value is True

Body Parameters

None.

Response Information

Resource Description

Collection of SpecialOrder

Name	Type	Additional information
Id	string	None.
CustomerId	string	None.
BoatId	string	None.
ClerkId	string	None.
VendorId	string	None.
OrderNumber	string	None.
Comments	string	None.
DateEntered	string	None.
DatePromised	string	None.
DepositAmount	decimal number	None.
Module	string	None.
SourceDocument	string	None.
PurchaseOrder	string	None.
DepositFixed	boolean	None.
DepositApplied	decimal number	None.
AppliedTicket	string	None.
LocationCode	string	None.
LocationValue	integer	None.
DepositReturned	decimal number	None.
POSFreight	decimal number	None.
POSAppliedFreight	decimal number	None.
SpecialOrderParts	Collection of SpecialOrderPart	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": "sample string 1",
    "CustomerId": "sample string 2",
    "BoatId": "sample string 3",
    "ClerkId": "sample string 4",
    "VendorId": "sample string 5",
    "OrderNumber": "sample string 6",
    "Comments": "sample string 7",
    "DateEntered": "sample string 8",
    "DatePromised": "sample string 9",
    "DepositAmount": 10.0,
    "Module": "sample string 11",
    "SourceDocument": "sample string 12",
    "PurchaseOrder": "sample string 13",
    "DepositFixed": true,
    "DepositApplied": 15.0,
    "AppliedTicket": "sample string 16",
    "LocationCode": "sample string 17",
    "LocationValue": 18,
    "DepositReturned": 19.0,
    "POSFreight": 20.0,
    "POSAppliedFreight": 21.0,
    "SpecialOrderParts": [
      {
        "PartId": "sample string 1",
        "QtyOrdered": 2.0,
        "Price": 3.0,
        "Extension": 4.0,
        "QtyReceived": 5.0,
        "DateReceived": "sample string 6",
        "QtyClosed": 7.0,
        "DateClosed": "sample string 8",
        "QtyDelivered": 9.0,
        "DateDelivered": "sample string 10",
        "TaxSchema": "sample string 11",
        "OpCodeTechId": "sample string 12",
        "PriveOverride": true
      },
      {
        "PartId": "sample string 1",
        "QtyOrdered": 2.0,
        "Price": 3.0,
        "Extension": 4.0,
        "QtyReceived": 5.0,
        "DateReceived": "sample string 6",
        "QtyClosed": 7.0,
        "DateClosed": "sample string 8",
        "QtyDelivered": 9.0,
        "DateDelivered": "sample string 10",
        "TaxSchema": "sample string 11",
        "OpCodeTechId": "sample string 12",
        "PriveOverride": true
      }
    ]
  },
  {
    "Id": "sample string 1",
    "CustomerId": "sample string 2",
    "BoatId": "sample string 3",
    "ClerkId": "sample string 4",
    "VendorId": "sample string 5",
    "OrderNumber": "sample string 6",
    "Comments": "sample string 7",
    "DateEntered": "sample string 8",
    "DatePromised": "sample string 9",
    "DepositAmount": 10.0,
    "Module": "sample string 11",
    "SourceDocument": "sample string 12",
    "PurchaseOrder": "sample string 13",
    "DepositFixed": true,
    "DepositApplied": 15.0,
    "AppliedTicket": "sample string 16",
    "LocationCode": "sample string 17",
    "LocationValue": 18,
    "DepositReturned": 19.0,
    "POSFreight": 20.0,
    "POSAppliedFreight": 21.0,
    "SpecialOrderParts": [
      {
        "PartId": "sample string 1",
        "QtyOrdered": 2.0,
        "Price": 3.0,
        "Extension": 4.0,
        "QtyReceived": 5.0,
        "DateReceived": "sample string 6",
        "QtyClosed": 7.0,
        "DateClosed": "sample string 8",
        "QtyDelivered": 9.0,
        "DateDelivered": "sample string 10",
        "TaxSchema": "sample string 11",
        "OpCodeTechId": "sample string 12",
        "PriveOverride": true
      },
      {
        "PartId": "sample string 1",
        "QtyOrdered": 2.0,
        "Price": 3.0,
        "Extension": 4.0,
        "QtyReceived": 5.0,
        "DateReceived": "sample string 6",
        "QtyClosed": 7.0,
        "DateClosed": "sample string 8",
        "QtyDelivered": 9.0,
        "DateDelivered": "sample string 10",
        "TaxSchema": "sample string 11",
        "OpCodeTechId": "sample string 12",
        "PriveOverride": true
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfSpecialOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/com.dockmaster.lib.models">
  <SpecialOrder>
    <AppliedTicket>sample string 16</AppliedTicket>
    <BoatId>sample string 3</BoatId>
    <ClerkId>sample string 4</ClerkId>
    <Comments>sample string 7</Comments>
    <CustomerId>sample string 2</CustomerId>
    <DateEntered>sample string 8</DateEntered>
    <DatePromised>sample string 9</DatePromised>
    <DepositAmount>10</DepositAmount>
    <DepositApplied>15</DepositApplied>
    <DepositFixed>true</DepositFixed>
    <DepositReturned>19</DepositReturned>
    <Id>sample string 1</Id>
    <LocationCode>sample string 17</LocationCode>
    <LocationValue>18</LocationValue>
    <Module>sample string 11</Module>
    <OrderNumber>sample string 6</OrderNumber>
    <POSAppliedFreight>21</POSAppliedFreight>
    <POSFreight>20</POSFreight>
    <PurchaseOrder>sample string 13</PurchaseOrder>
    <SourceDocument>sample string 12</SourceDocument>
    <SpecialOrderParts>
      <SpecialOrderPart>
        <DateClosed>sample string 8</DateClosed>
        <DateDelivered>sample string 10</DateDelivered>
        <DateReceived>sample string 6</DateReceived>
        <Extension>4</Extension>
        <OpCodeTechId>sample string 12</OpCodeTechId>
        <PartId>sample string 1</PartId>
        <Price>3</Price>
        <PriveOverride>true</PriveOverride>
        <QtyClosed>7</QtyClosed>
        <QtyDelivered>9</QtyDelivered>
        <QtyOrdered>2</QtyOrdered>
        <QtyReceived>5</QtyReceived>
        <TaxSchema>sample string 11</TaxSchema>
      </SpecialOrderPart>
      <SpecialOrderPart>
        <DateClosed>sample string 8</DateClosed>
        <DateDelivered>sample string 10</DateDelivered>
        <DateReceived>sample string 6</DateReceived>
        <Extension>4</Extension>
        <OpCodeTechId>sample string 12</OpCodeTechId>
        <PartId>sample string 1</PartId>
        <Price>3</Price>
        <PriveOverride>true</PriveOverride>
        <QtyClosed>7</QtyClosed>
        <QtyDelivered>9</QtyDelivered>
        <QtyOrdered>2</QtyOrdered>
        <QtyReceived>5</QtyReceived>
        <TaxSchema>sample string 11</TaxSchema>
      </SpecialOrderPart>
    </SpecialOrderParts>
    <VendorId>sample string 5</VendorId>
  </SpecialOrder>
  <SpecialOrder>
    <AppliedTicket>sample string 16</AppliedTicket>
    <BoatId>sample string 3</BoatId>
    <ClerkId>sample string 4</ClerkId>
    <Comments>sample string 7</Comments>
    <CustomerId>sample string 2</CustomerId>
    <DateEntered>sample string 8</DateEntered>
    <DatePromised>sample string 9</DatePromised>
    <DepositAmount>10</DepositAmount>
    <DepositApplied>15</DepositApplied>
    <DepositFixed>true</DepositFixed>
    <DepositReturned>19</DepositReturned>
    <Id>sample string 1</Id>
    <LocationCode>sample string 17</LocationCode>
    <LocationValue>18</LocationValue>
    <Module>sample string 11</Module>
    <OrderNumber>sample string 6</OrderNumber>
    <POSAppliedFreight>21</POSAppliedFreight>
    <POSFreight>20</POSFreight>
    <PurchaseOrder>sample string 13</PurchaseOrder>
    <SourceDocument>sample string 12</SourceDocument>
    <SpecialOrderParts>
      <SpecialOrderPart>
        <DateClosed>sample string 8</DateClosed>
        <DateDelivered>sample string 10</DateDelivered>
        <DateReceived>sample string 6</DateReceived>
        <Extension>4</Extension>
        <OpCodeTechId>sample string 12</OpCodeTechId>
        <PartId>sample string 1</PartId>
        <Price>3</Price>
        <PriveOverride>true</PriveOverride>
        <QtyClosed>7</QtyClosed>
        <QtyDelivered>9</QtyDelivered>
        <QtyOrdered>2</QtyOrdered>
        <QtyReceived>5</QtyReceived>
        <TaxSchema>sample string 11</TaxSchema>
      </SpecialOrderPart>
      <SpecialOrderPart>
        <DateClosed>sample string 8</DateClosed>
        <DateDelivered>sample string 10</DateDelivered>
        <DateReceived>sample string 6</DateReceived>
        <Extension>4</Extension>
        <OpCodeTechId>sample string 12</OpCodeTechId>
        <PartId>sample string 1</PartId>
        <Price>3</Price>
        <PriveOverride>true</PriveOverride>
        <QtyClosed>7</QtyClosed>
        <QtyDelivered>9</QtyDelivered>
        <QtyOrdered>2</QtyOrdered>
        <QtyReceived>5</QtyReceived>
        <TaxSchema>sample string 11</TaxSchema>
      </SpecialOrderPart>
    </SpecialOrderParts>
    <VendorId>sample string 5</VendorId>
  </SpecialOrder>
</ArrayOfSpecialOrder>