POST api/Document/PurchaseOrder

Request Information

URI Parameters

None.

Body Parameters

POCreateDocParams
NameDescriptionTypeAdditional information
PurchaseOrderID

integer

None.

SaveOnly

boolean

None.

AddViewModel

AddCoverSheetViewModel

None.

Request Formats

application/json, text/json

Sample:
{
  "purchaseOrderID": 1,
  "saveOnly": true,
  "addViewModel": {
    "specialQuoteNumber": "sample string 1",
    "salesAllowanceGTSplit": 2.0,
    "nonGTItems": 3.0,
    "showGTEquipment": true,
    "gtEquipmentList": 5.0,
    "discount": 6.0,
    "gtEquipmentFreight": 7.0,
    "materialSurcharge": 8.0,
    "showGTShade": true,
    "showGTSite": true,
    "gtShadeList": 11.0,
    "gtSiteList": 12.0,
    "installation": 13.0,
    "gtShadeFreight": 14.0,
    "gtSiteFreight": 15.0,
    "miscellaneous": 16.0,
    "showImpax": true,
    "gtImpaxList": 18.0,
    "gtImpaxFreight": 19.0,
    "hasCreditCard": true,
    "showTax": true,
    "taxRate": 22.0,
    "taxInstallation": true,
    "taxFreight": true,
    "taxExclusions": "sample string 25",
    "gtImpaxQuoteNumber": "sample string 26",
    "gtImpaxQuoteInfo": "sample string 27",
    "gtShadeNumber": "sample string 28",
    "gtShadeInfo": "sample string 29",
    "gtSiteNumber": "sample string 30",
    "gtSiteInfo": "sample string 31",
    "showPlayWorx": true,
    "playWorxLabel": "sample string 33",
    "playWorxNumber": "sample string 34",
    "playWorxInfo": "sample string 35",
    "otherQuoteNumber": "sample string 36",
    "otherQuoteInfo": "sample string 37",
    "freightQuoteNumber": "sample string 38",
    "freightQuoteInfo": "sample string 39",
    "installationInstructions": "sample string 40",
    "orderEntryNotes": "sample string 41",
    "age": {
      "ageID": 1,
      "ageDescription": "sample string 2"
    },
    "orderProcessingNotes": "sample string 42"
  }
}

application/xml, text/xml

Sample:
<POCreateDocParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GameTimeBAL.ViewModels">
  <AddViewModel>
    <Age xmlns:d3p1="http://schemas.datacontract.org/2004/07/GameTimeDAL.AdditionalModel">
      <d3p1:AgeDescription>sample string 2</d3p1:AgeDescription>
      <d3p1:AgeID>1</d3p1:AgeID>
    </Age>
    <Discount>6</Discount>
    <FreightQuoteInfo>sample string 39</FreightQuoteInfo>
    <FreightQuoteNumber>sample string 38</FreightQuoteNumber>
    <GTEquipmentFreight>7</GTEquipmentFreight>
    <GTEquipmentList>5</GTEquipmentList>
    <GTImpaxFreight>19</GTImpaxFreight>
    <GTImpaxList>18</GTImpaxList>
    <GTImpaxQuoteInfo>sample string 27</GTImpaxQuoteInfo>
    <GTImpaxQuoteNumber>sample string 26</GTImpaxQuoteNumber>
    <GTShadeFreight>14</GTShadeFreight>
    <GTShadeInfo>sample string 29</GTShadeInfo>
    <GTShadeList>11</GTShadeList>
    <GTShadeNumber>sample string 28</GTShadeNumber>
    <GTSiteFreight>15</GTSiteFreight>
    <GTSiteInfo>sample string 31</GTSiteInfo>
    <GTSiteList>12</GTSiteList>
    <GTSiteNumber>sample string 30</GTSiteNumber>
    <HasCreditCard>true</HasCreditCard>
    <Installation>13</Installation>
    <InstallationInstructions>sample string 40</InstallationInstructions>
    <MaterialSurcharge>8</MaterialSurcharge>
    <Miscellaneous>16</Miscellaneous>
    <NonGTItems>3</NonGTItems>
    <OrderEntryNotes>sample string 41</OrderEntryNotes>
    <OrderProcessingNotes>sample string 42</OrderProcessingNotes>
    <OtherQuoteInfo>sample string 37</OtherQuoteInfo>
    <OtherQuoteNumber>sample string 36</OtherQuoteNumber>
    <PlayWorxInfo>sample string 35</PlayWorxInfo>
    <PlayWorxLabel>sample string 33</PlayWorxLabel>
    <PlayWorxNumber>sample string 34</PlayWorxNumber>
    <SalesAllowanceGTSplit>2</SalesAllowanceGTSplit>
    <ShowGTEquipment>true</ShowGTEquipment>
    <ShowGTShade>true</ShowGTShade>
    <ShowGTSite>true</ShowGTSite>
    <ShowImpax>true</ShowImpax>
    <ShowPlayWorx>true</ShowPlayWorx>
    <ShowTax>true</ShowTax>
    <SpecialQuoteNumber>sample string 1</SpecialQuoteNumber>
    <TaxExclusions>sample string 25</TaxExclusions>
    <TaxFreight>true</TaxFreight>
    <TaxInstallation>true</TaxInstallation>
    <TaxRate>22</TaxRate>
  </AddViewModel>
  <PurchaseOrderID>1</PurchaseOrderID>
  <SaveOnly>true</SaveOnly>
</POCreateDocParams>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.