POST v1/Generic/CustomerOrderVersionList

Return all of Customer's Order version

Request Information

URI Parameters

None.

Body Parameters

Term Input Request (OrderID)

Name	Description	Type	Additional information
OrderID	Returns Customer ID - 11690	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "OrderID": 1
}

application/xml, text/xml

Sample:

<CustomerOrderVersionListRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <OrderID>1</OrderID>
</CustomerOrderVersionListRequest>

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 'CustomerOrderVersionListRequest'.

Response Information

Resource Description

Collection of CustomerOrderVersionListResponse

Name	Description	Type	Additional information
VersionID		integer	None.
OrderID		integer	None.
OrderVersionDetailID		integer	None.
Suffix	Version table suffix	integer	None.
Type	Determines whether line is Service or Postage	string	None.
Name	Actual service/postage name e.g "Print 1-up Label"	string	None.
Quantity		decimal number	None.
Rate		decimal number	None.
Total	Sum of services and postages	decimal number	None.
Balance	Remaining amount to be paid	decimal number	None.
Filter Criteria		string	None.
Order Version Details		Collection of OrderVersionDetailList	None.
Note	Service / Postage note	string	None.
AccountingGLID		string	None.
PaymentAccountID		string	None.
InvoiceLineGuid		string	None.
InvoiceAmt	Amount that was invoiced	decimal number	None.
Tax		decimal number	None.
LineSubTotal		decimal number	None.
TotalAndTax	Total amount with tax added	decimal number	None.
OrderVersionAssociatedInvoce		Collection of OrderVersionAssociatedInvoce	None.
IsVisible	Old property used to determine to show service / postage if it has remaining balance	boolean	None.
DueDate		string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "VersionID": 1,
    "OrderID": 2,
    "OrderVersionDetailID": 1,
    "Suffix": 1,
    "Type": "sample string 3",
    "Name": "sample string 4",
    "Quantity": 5.0,
    "Rate": 6.0,
    "Total": 7.0,
    "Balance": 8.0,
    "Filter Criteria": "sample string 9",
    "Order Version Details": [
      {
        "VersionID": 1,
        "OrderVersionDetailID": 2,
        "ServiceID": 1,
        "Type": "sample string 3",
        "Name": "sample string 4",
        "Quantity": 5.0,
        "Rate": 6.0,
        "Total": 7.0,
        "Balance": 8.0,
        "Filter Criteria": "sample string 9",
        "Note": "sample string 10",
        "AccountingGLID": "sample string 11",
        "PaymentAccountID": "sample string 12",
        "InvoiceAmt": 13.0,
        "Tax": 14.0,
        "LineSubTotal": 15.0,
        "TotalAndTax": 16.0,
        "IsVisible": true,
        "DepartmentType": {
          "Id": 1,
          "Name": "sample string 2",
          "Sort": 3
        },
        "Group": {
          "ID": 1,
          "UnitOfMeasure": "sample string 1",
          "Name": "sample string 2",
          "Quantity": 1.0,
          "Sort": 1,
          "UnitName": "sample string 3",
          "UnitCalculationValue": 1.0
        }
      },
      {
        "VersionID": 1,
        "OrderVersionDetailID": 2,
        "ServiceID": 1,
        "Type": "sample string 3",
        "Name": "sample string 4",
        "Quantity": 5.0,
        "Rate": 6.0,
        "Total": 7.0,
        "Balance": 8.0,
        "Filter Criteria": "sample string 9",
        "Note": "sample string 10",
        "AccountingGLID": "sample string 11",
        "PaymentAccountID": "sample string 12",
        "InvoiceAmt": 13.0,
        "Tax": 14.0,
        "LineSubTotal": 15.0,
        "TotalAndTax": 16.0,
        "IsVisible": true,
        "DepartmentType": {
          "Id": 1,
          "Name": "sample string 2",
          "Sort": 3
        },
        "Group": {
          "ID": 1,
          "UnitOfMeasure": "sample string 1",
          "Name": "sample string 2",
          "Quantity": 1.0,
          "Sort": 1,
          "UnitName": "sample string 3",
          "UnitCalculationValue": 1.0
        }
      }
    ],
    "Note": "sample string 10",
    "AccountingGLID": "sample string 11",
    "PaymentAccountID": "sample string 12",
    "InvoiceLineGuid": "sample string 13",
    "InvoiceAmt": 14.0,
    "Tax": 15.0,
    "LineSubTotal": 16.0,
    "TotalAndTax": 17.0,
    "OrderVersionAssociatedInvoce": [
      {
        "VersionID": 1,
        "OrderVersionDetailID": 2,
        "ServiceID": 1,
        "OrderID": 3,
        "InvoicedAmt": 4.0,
        "InvoiceNumber": "sample string 5",
        "InvoiceId": 6,
        "InvoiceIsDraft": true,
        "Tax": 8.0
      },
      {
        "VersionID": 1,
        "OrderVersionDetailID": 2,
        "ServiceID": 1,
        "OrderID": 3,
        "InvoicedAmt": 4.0,
        "InvoiceNumber": "sample string 5",
        "InvoiceId": 6,
        "InvoiceIsDraft": true,
        "Tax": 8.0
      }
    ],
    "IsVisible": true,
    "DueDate": "sample string 19"
  },
  {
    "VersionID": 1,
    "OrderID": 2,
    "OrderVersionDetailID": 1,
    "Suffix": 1,
    "Type": "sample string 3",
    "Name": "sample string 4",
    "Quantity": 5.0,
    "Rate": 6.0,
    "Total": 7.0,
    "Balance": 8.0,
    "Filter Criteria": "sample string 9",
    "Order Version Details": [
      {
        "VersionID": 1,
        "OrderVersionDetailID": 2,
        "ServiceID": 1,
        "Type": "sample string 3",
        "Name": "sample string 4",
        "Quantity": 5.0,
        "Rate": 6.0,
        "Total": 7.0,
        "Balance": 8.0,
        "Filter Criteria": "sample string 9",
        "Note": "sample string 10",
        "AccountingGLID": "sample string 11",
        "PaymentAccountID": "sample string 12",
        "InvoiceAmt": 13.0,
        "Tax": 14.0,
        "LineSubTotal": 15.0,
        "TotalAndTax": 16.0,
        "IsVisible": true,
        "DepartmentType": {
          "Id": 1,
          "Name": "sample string 2",
          "Sort": 3
        },
        "Group": {
          "ID": 1,
          "UnitOfMeasure": "sample string 1",
          "Name": "sample string 2",
          "Quantity": 1.0,
          "Sort": 1,
          "UnitName": "sample string 3",
          "UnitCalculationValue": 1.0
        }
      },
      {
        "VersionID": 1,
        "OrderVersionDetailID": 2,
        "ServiceID": 1,
        "Type": "sample string 3",
        "Name": "sample string 4",
        "Quantity": 5.0,
        "Rate": 6.0,
        "Total": 7.0,
        "Balance": 8.0,
        "Filter Criteria": "sample string 9",
        "Note": "sample string 10",
        "AccountingGLID": "sample string 11",
        "PaymentAccountID": "sample string 12",
        "InvoiceAmt": 13.0,
        "Tax": 14.0,
        "LineSubTotal": 15.0,
        "TotalAndTax": 16.0,
        "IsVisible": true,
        "DepartmentType": {
          "Id": 1,
          "Name": "sample string 2",
          "Sort": 3
        },
        "Group": {
          "ID": 1,
          "UnitOfMeasure": "sample string 1",
          "Name": "sample string 2",
          "Quantity": 1.0,
          "Sort": 1,
          "UnitName": "sample string 3",
          "UnitCalculationValue": 1.0
        }
      }
    ],
    "Note": "sample string 10",
    "AccountingGLID": "sample string 11",
    "PaymentAccountID": "sample string 12",
    "InvoiceLineGuid": "sample string 13",
    "InvoiceAmt": 14.0,
    "Tax": 15.0,
    "LineSubTotal": 16.0,
    "TotalAndTax": 17.0,
    "OrderVersionAssociatedInvoce": [
      {
        "VersionID": 1,
        "OrderVersionDetailID": 2,
        "ServiceID": 1,
        "OrderID": 3,
        "InvoicedAmt": 4.0,
        "InvoiceNumber": "sample string 5",
        "InvoiceId": 6,
        "InvoiceIsDraft": true,
        "Tax": 8.0
      },
      {
        "VersionID": 1,
        "OrderVersionDetailID": 2,
        "ServiceID": 1,
        "OrderID": 3,
        "InvoicedAmt": 4.0,
        "InvoiceNumber": "sample string 5",
        "InvoiceId": 6,
        "InvoiceIsDraft": true,
        "Tax": 8.0
      }
    ],
    "IsVisible": true,
    "DueDate": "sample string 19"
  }
]

application/xml, text/xml

Sample:

<ArrayOfCustomerOrderVersionListResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CustomerOrderVersionListResponse>
    <VersionID>1</VersionID>
    <OrderID>2</OrderID>
    <OrderVersionDetailID>1</OrderVersionDetailID>
    <Suffix>1</Suffix>
    <Type>sample string 3</Type>
    <Name>sample string 4</Name>
    <Quantity>5</Quantity>
    <Rate>6</Rate>
    <Total>7</Total>
    <Balance>8</Balance>
    <FilterCriteria>sample string 9</FilterCriteria>
    <OrderVersionDetailList>
      <OrderVersionDetailList>
        <VersionID>1</VersionID>
        <OrderVersionDetailID>2</OrderVersionDetailID>
        <ServiceID>1</ServiceID>
        <Type>sample string 3</Type>
        <Name>sample string 4</Name>
        <Quantity>5</Quantity>
        <Rate>6</Rate>
        <Total>7</Total>
        <Balance>8</Balance>
        <FilterCriteria>sample string 9</FilterCriteria>
        <Note>sample string 10</Note>
        <AccountingGLID>sample string 11</AccountingGLID>
        <PaymentAccountID>sample string 12</PaymentAccountID>
        <InvoiceAmt>13</InvoiceAmt>
        <Tax>14</Tax>
        <LineSubTotal>15</LineSubTotal>
        <TotalAndTax>16</TotalAndTax>
        <IsVisible>true</IsVisible>
        <Department>
          <Id>1</Id>
          <Name>sample string 2</Name>
          <Sort>3</Sort>
        </Department>
        <Group>
          <ID>1</ID>
          <UnitOfMeasure>sample string 1</UnitOfMeasure>
          <Name>sample string 2</Name>
          <Quantity>1</Quantity>
          <Sort>1</Sort>
          <UnitName>sample string 3</UnitName>
          <UnitCalculationValue>1</UnitCalculationValue>
        </Group>
      </OrderVersionDetailList>
      <OrderVersionDetailList>
        <VersionID>1</VersionID>
        <OrderVersionDetailID>2</OrderVersionDetailID>
        <ServiceID>1</ServiceID>
        <Type>sample string 3</Type>
        <Name>sample string 4</Name>
        <Quantity>5</Quantity>
        <Rate>6</Rate>
        <Total>7</Total>
        <Balance>8</Balance>
        <FilterCriteria>sample string 9</FilterCriteria>
        <Note>sample string 10</Note>
        <AccountingGLID>sample string 11</AccountingGLID>
        <PaymentAccountID>sample string 12</PaymentAccountID>
        <InvoiceAmt>13</InvoiceAmt>
        <Tax>14</Tax>
        <LineSubTotal>15</LineSubTotal>
        <TotalAndTax>16</TotalAndTax>
        <IsVisible>true</IsVisible>
        <Department>
          <Id>1</Id>
          <Name>sample string 2</Name>
          <Sort>3</Sort>
        </Department>
        <Group>
          <ID>1</ID>
          <UnitOfMeasure>sample string 1</UnitOfMeasure>
          <Name>sample string 2</Name>
          <Quantity>1</Quantity>
          <Sort>1</Sort>
          <UnitName>sample string 3</UnitName>
          <UnitCalculationValue>1</UnitCalculationValue>
        </Group>
      </OrderVersionDetailList>
    </OrderVersionDetailList>
    <Note>sample string 10</Note>
    <AccountingGLID>sample string 11</AccountingGLID>
    <PaymentAccountID>sample string 12</PaymentAccountID>
    <InvoiceLineGuid>sample string 13</InvoiceLineGuid>
    <InvoiceAmt>14</InvoiceAmt>
    <Tax>15</Tax>
    <LineSubTotal>16</LineSubTotal>
    <TotalAndTax>17</TotalAndTax>
    <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>
        <Tax>8</Tax>
      </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>
        <Tax>8</Tax>
      </OrderVersionAssociatedInvoce>
    </OrderVersionAssociatedInvoce>
    <IsVisible>true</IsVisible>
    <DueDate>sample string 19</DueDate>
  </CustomerOrderVersionListResponse>
  <CustomerOrderVersionListResponse>
    <VersionID>1</VersionID>
    <OrderID>2</OrderID>
    <OrderVersionDetailID>1</OrderVersionDetailID>
    <Suffix>1</Suffix>
    <Type>sample string 3</Type>
    <Name>sample string 4</Name>
    <Quantity>5</Quantity>
    <Rate>6</Rate>
    <Total>7</Total>
    <Balance>8</Balance>
    <FilterCriteria>sample string 9</FilterCriteria>
    <OrderVersionDetailList>
      <OrderVersionDetailList>
        <VersionID>1</VersionID>
        <OrderVersionDetailID>2</OrderVersionDetailID>
        <ServiceID>1</ServiceID>
        <Type>sample string 3</Type>
        <Name>sample string 4</Name>
        <Quantity>5</Quantity>
        <Rate>6</Rate>
        <Total>7</Total>
        <Balance>8</Balance>
        <FilterCriteria>sample string 9</FilterCriteria>
        <Note>sample string 10</Note>
        <AccountingGLID>sample string 11</AccountingGLID>
        <PaymentAccountID>sample string 12</PaymentAccountID>
        <InvoiceAmt>13</InvoiceAmt>
        <Tax>14</Tax>
        <LineSubTotal>15</LineSubTotal>
        <TotalAndTax>16</TotalAndTax>
        <IsVisible>true</IsVisible>
        <Department>
          <Id>1</Id>
          <Name>sample string 2</Name>
          <Sort>3</Sort>
        </Department>
        <Group>
          <ID>1</ID>
          <UnitOfMeasure>sample string 1</UnitOfMeasure>
          <Name>sample string 2</Name>
          <Quantity>1</Quantity>
          <Sort>1</Sort>
          <UnitName>sample string 3</UnitName>
          <UnitCalculationValue>1</UnitCalculationValue>
        </Group>
      </OrderVersionDetailList>
      <OrderVersionDetailList>
        <VersionID>1</VersionID>
        <OrderVersionDetailID>2</OrderVersionDetailID>
        <ServiceID>1</ServiceID>
        <Type>sample string 3</Type>
        <Name>sample string 4</Name>
        <Quantity>5</Quantity>
        <Rate>6</Rate>
        <Total>7</Total>
        <Balance>8</Balance>
        <FilterCriteria>sample string 9</FilterCriteria>
        <Note>sample string 10</Note>
        <AccountingGLID>sample string 11</AccountingGLID>
        <PaymentAccountID>sample string 12</PaymentAccountID>
        <InvoiceAmt>13</InvoiceAmt>
        <Tax>14</Tax>
        <LineSubTotal>15</LineSubTotal>
        <TotalAndTax>16</TotalAndTax>
        <IsVisible>true</IsVisible>
        <Department>
          <Id>1</Id>
          <Name>sample string 2</Name>
          <Sort>3</Sort>
        </Department>
        <Group>
          <ID>1</ID>
          <UnitOfMeasure>sample string 1</UnitOfMeasure>
          <Name>sample string 2</Name>
          <Quantity>1</Quantity>
          <Sort>1</Sort>
          <UnitName>sample string 3</UnitName>
          <UnitCalculationValue>1</UnitCalculationValue>
        </Group>
      </OrderVersionDetailList>
    </OrderVersionDetailList>
    <Note>sample string 10</Note>
    <AccountingGLID>sample string 11</AccountingGLID>
    <PaymentAccountID>sample string 12</PaymentAccountID>
    <InvoiceLineGuid>sample string 13</InvoiceLineGuid>
    <InvoiceAmt>14</InvoiceAmt>
    <Tax>15</Tax>
    <LineSubTotal>16</LineSubTotal>
    <TotalAndTax>17</TotalAndTax>
    <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>
        <Tax>8</Tax>
      </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>
        <Tax>8</Tax>
      </OrderVersionAssociatedInvoce>
    </OrderVersionAssociatedInvoce>
    <IsVisible>true</IsVisible>
    <DueDate>sample string 19</DueDate>
  </CustomerOrderVersionListResponse>
</ArrayOfCustomerOrderVersionListResponse>

POST v1/Generic/CustomerOrderVersionList

Request Information

URI Parameters

Body Parameters

Request Formats

application/json, text/json

application/xml, text/xml

application/x-www-form-urlencoded

Response Information

Resource Description

Response Formats

application/json, text/json

application/xml, text/xml

URI parameters

Headers | Add header

Body

Status

Headers

Body