POST v1/Generic/CustomerOrderList

Request Information

URI Parameters

None.

Body Parameters

CustomerOrderListClosedDateRequest
NameDescriptionTypeAdditional information
ShowClosed

boolean

None.
CustomerID

integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "CustomerID": 2,
  "ShowClosed": true
}

application/xml, text/xml

Sample: 
<CustomerOrderListClosedDateRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CustomerID>2</CustomerID>
  <ShowClosed>true</ShowClosed>
</CustomerOrderListClosedDateRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CustomerOrderListClosedDateRequest'.

Response Information

Resource Description

Collection of CustomerOrderListResponse
NameDescriptionTypeAdditional information
JobID

integer

None.
JobNumber

string

None.
JobName

string

None.
TotalDue

decimal number

None.
BalanceDue

decimal number

None.
FilterCriteria

string

None.
Quantity

decimal number

None.
VersionCount

integer

None.
HasPostage

boolean

None.
Note

string

None.
InvoiceLineGuid

string

None.
InvoiceAmt

decimal number

None.
Tax

decimal number

None.
LineSubTotal

decimal number

None.
TotalAndTax

decimal number

None.
DepositAccountID

integer

None.
OrderVersionAssociatedInvoce

Collection of OrderVersionAssociatedInvoce

None.
DueDate

string

None.
BillToAddress

BillToAddress

None.
Company

string

None.
ContactName

string

None.
EmailAddress

string

None.
PurchaseOrderNumber

string

None.
CloseDate

string

None.
HasExistingBalance

boolean

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "JobID": 1,
    "JobNumber": "sample string 2",
    "JobName": "sample string 3",
    "TotalDue": 4.0,
    "BalanceDue": 5.0,
    "FilterCriteria": "sample string 6",
    "Quantity": 7.0,
    "VersionCount": 8,
    "HasPostage": true,
    "Note": "sample string 10",
    "InvoiceLineGuid": "sample string 11",
    "InvoiceAmt": 12.0,
    "Tax": 13.0,
    "LineSubTotal": 14.0,
    "TotalAndTax": 15.0,
    "DepositAccountID": 16,
    "OrderVersionAssociatedInvoce": [
      {
        "VersionID": 1,
        "OrderVersionDetailID": 2,
        "ServiceID": 1,
        "OrderID": 3,
        "InvoicedAmt": 4.0,
        "InvoiceNumber": "sample string 5",
        "InvoiceId": 6,
        "InvoiceIsDraft": true
      },
      {
        "VersionID": 1,
        "OrderVersionDetailID": 2,
        "ServiceID": 1,
        "OrderID": 3,
        "InvoicedAmt": 4.0,
        "InvoiceNumber": "sample string 5",
        "InvoiceId": 6,
        "InvoiceIsDraft": true
      }
    ],
    "DueDate": "sample string 17",
    "BillToAddress": {
      "Attn": "sample string 7",
      "Address1": "sample string 8",
      "Address2": "sample string 9",
      "Address3": "sample string 10",
      "City": "sample string 11",
      "State": "sample string 12",
      "Zip": "sample string 13",
      "Country": "sample string 14"
    },
    "Company": "sample string 18",
    "ContactName": "sample string 19",
    "EmailAddress": "sample string 20",
    "PurchaseOrderNumber": "sample string 21",
    "CloseDate": "sample string 22",
    "HasExistingBalance": true
  },
  {
    "JobID": 1,
    "JobNumber": "sample string 2",
    "JobName": "sample string 3",
    "TotalDue": 4.0,
    "BalanceDue": 5.0,
    "FilterCriteria": "sample string 6",
    "Quantity": 7.0,
    "VersionCount": 8,
    "HasPostage": true,
    "Note": "sample string 10",
    "InvoiceLineGuid": "sample string 11",
    "InvoiceAmt": 12.0,
    "Tax": 13.0,
    "LineSubTotal": 14.0,
    "TotalAndTax": 15.0,
    "DepositAccountID": 16,
    "OrderVersionAssociatedInvoce": [
      {
        "VersionID": 1,
        "OrderVersionDetailID": 2,
        "ServiceID": 1,
        "OrderID": 3,
        "InvoicedAmt": 4.0,
        "InvoiceNumber": "sample string 5",
        "InvoiceId": 6,
        "InvoiceIsDraft": true
      },
      {
        "VersionID": 1,
        "OrderVersionDetailID": 2,
        "ServiceID": 1,
        "OrderID": 3,
        "InvoicedAmt": 4.0,
        "InvoiceNumber": "sample string 5",
        "InvoiceId": 6,
        "InvoiceIsDraft": true
      }
    ],
    "DueDate": "sample string 17",
    "BillToAddress": {
      "Attn": "sample string 7",
      "Address1": "sample string 8",
      "Address2": "sample string 9",
      "Address3": "sample string 10",
      "City": "sample string 11",
      "State": "sample string 12",
      "Zip": "sample string 13",
      "Country": "sample string 14"
    },
    "Company": "sample string 18",
    "ContactName": "sample string 19",
    "EmailAddress": "sample string 20",
    "PurchaseOrderNumber": "sample string 21",
    "CloseDate": "sample string 22",
    "HasExistingBalance": true
  }
]

application/xml, text/xml

Sample: 
<ArrayOfCustomerOrderListResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CustomerOrderListResponse>
    <JobID>1</JobID>
    <JobNumber>sample string 2</JobNumber>
    <JobName>sample string 3</JobName>
    <TotalDue>4</TotalDue>
    <BalanceDue>5</BalanceDue>
    <FilterCriteria>sample string 6</FilterCriteria>
    <Quantity>7</Quantity>
    <VersionCount>8</VersionCount>
    <HasPostage>true</HasPostage>
    <Note>sample string 10</Note>
    <InvoiceLineGuid>sample string 11</InvoiceLineGuid>
    <InvoiceAmt>12</InvoiceAmt>
    <Tax>13</Tax>
    <LineSubTotal>14</LineSubTotal>
    <TotalAndTax>15</TotalAndTax>
    <DepositAccountID>16</DepositAccountID>
    <OrderVersionAssociatedInvoce>
      <OrderVersionAssociatedInvoce>
        <VersionID>1</VersionID>
        <OrderVersionDetailID>2</OrderVersionDetailID>
        <ServiceID>1</ServiceID>
        <OrderID>3</OrderID>
        <InvoicedAmt>4</InvoicedAmt>
        <InvoiceNumber>sample string 5</InvoiceNumber>
        <InvoiceId>6</InvoiceId>
        <InvoiceIsDraft>true</InvoiceIsDraft>
      </OrderVersionAssociatedInvoce>
      <OrderVersionAssociatedInvoce>
        <VersionID>1</VersionID>
        <OrderVersionDetailID>2</OrderVersionDetailID>
        <ServiceID>1</ServiceID>
        <OrderID>3</OrderID>
        <InvoicedAmt>4</InvoicedAmt>
        <InvoiceNumber>sample string 5</InvoiceNumber>
        <InvoiceId>6</InvoiceId>
        <InvoiceIsDraft>true</InvoiceIsDraft>
      </OrderVersionAssociatedInvoce>
    </OrderVersionAssociatedInvoce>
    <DueDate>sample string 17</DueDate>
    <BillToAddress>
      <AddressType>sample string 1</AddressType>
      <Attn>sample string 7</Attn>
      <Address1>sample string 8</Address1>
      <Address2>sample string 9</Address2>
      <Address3>sample string 10</Address3>
      <City>sample string 11</City>
      <State>sample string 12</State>
      <Zip>sample string 13</Zip>
      <Country>sample string 14</Country>
      <Phone1>sample string 2</Phone1>
      <ExtPhone1>sample string 3</ExtPhone1>
      <Phone2>sample string 4</Phone2>
      <ExtPhone2>sample string 5</ExtPhone2>
      <Email>sample string 6</Email>
    </BillToAddress>
    <Company>sample string 18</Company>
    <ContactName>sample string 19</ContactName>
    <EmailAddress>sample string 20</EmailAddress>
    <PurchaseOrderNumber>sample string 21</PurchaseOrderNumber>
    <CloseDate>sample string 22</CloseDate>
    <HasExistingBalance>true</HasExistingBalance>
  </CustomerOrderListResponse>
  <CustomerOrderListResponse>
    <JobID>1</JobID>
    <JobNumber>sample string 2</JobNumber>
    <JobName>sample string 3</JobName>
    <TotalDue>4</TotalDue>
    <BalanceDue>5</BalanceDue>
    <FilterCriteria>sample string 6</FilterCriteria>
    <Quantity>7</Quantity>
    <VersionCount>8</VersionCount>
    <HasPostage>true</HasPostage>
    <Note>sample string 10</Note>
    <InvoiceLineGuid>sample string 11</InvoiceLineGuid>
    <InvoiceAmt>12</InvoiceAmt>
    <Tax>13</Tax>
    <LineSubTotal>14</LineSubTotal>
    <TotalAndTax>15</TotalAndTax>
    <DepositAccountID>16</DepositAccountID>
    <OrderVersionAssociatedInvoce>
      <OrderVersionAssociatedInvoce>
        <VersionID>1</VersionID>
        <OrderVersionDetailID>2</OrderVersionDetailID>
        <ServiceID>1</ServiceID>
        <OrderID>3</OrderID>
        <InvoicedAmt>4</InvoicedAmt>
        <InvoiceNumber>sample string 5</InvoiceNumber>
        <InvoiceId>6</InvoiceId>
        <InvoiceIsDraft>true</InvoiceIsDraft>
      </OrderVersionAssociatedInvoce>
      <OrderVersionAssociatedInvoce>
        <VersionID>1</VersionID>
        <OrderVersionDetailID>2</OrderVersionDetailID>
        <ServiceID>1</ServiceID>
        <OrderID>3</OrderID>
        <InvoicedAmt>4</InvoicedAmt>
        <InvoiceNumber>sample string 5</InvoiceNumber>
        <InvoiceId>6</InvoiceId>
        <InvoiceIsDraft>true</InvoiceIsDraft>
      </OrderVersionAssociatedInvoce>
    </OrderVersionAssociatedInvoce>
    <DueDate>sample string 17</DueDate>
    <BillToAddress>
      <AddressType>sample string 1</AddressType>
      <Attn>sample string 7</Attn>
      <Address1>sample string 8</Address1>
      <Address2>sample string 9</Address2>
      <Address3>sample string 10</Address3>
      <City>sample string 11</City>
      <State>sample string 12</State>
      <Zip>sample string 13</Zip>
      <Country>sample string 14</Country>
      <Phone1>sample string 2</Phone1>
      <ExtPhone1>sample string 3</ExtPhone1>
      <Phone2>sample string 4</Phone2>
      <ExtPhone2>sample string 5</ExtPhone2>
      <Email>sample string 6</Email>
    </BillToAddress>
    <Company>sample string 18</Company>
    <ContactName>sample string 19</ContactName>
    <EmailAddress>sample string 20</EmailAddress>
    <PurchaseOrderNumber>sample string 21</PurchaseOrderNumber>
    <CloseDate>sample string 22</CloseDate>
    <HasExistingBalance>true</HasExistingBalance>
  </CustomerOrderListResponse>
</ArrayOfCustomerOrderListResponse>