GET api/salesexport/{apikey}/{ext}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
apikey

string

Required

ext

string

None.

Body Parameters

None.

Response Information

Resource Description

Collection of SalesRecord
NameDescriptionTypeAdditional information
Type

string

None.

CustomerID

string

None.

CustomerName

string

None.

CompanyUniqueID

string

None.

Number

string

None.

PONumber

string

None.

SalesPerson

string

None.

DateSalesRecord

string

None.

ShipMethod

string

None.

TaxPercent

string

None.

PaymentMethod

string

None.

BillTo

string

None.

ShipTo

string

None.

Comments

string

None.

PrivateNotes

string

None.

LineItems

Collection of LineItem

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Type": "sample string 1",
    "CustomerID": "sample string 2",
    "CustomerName": "sample string 3",
    "CompanyUniqueID": "sample string 4",
    "Number": "sample string 5",
    "PONumber": "sample string 6",
    "SalesPerson": "sample string 7",
    "DateSalesRecord": "sample string 8",
    "ShipMethod": "sample string 9",
    "TaxPercent": "sample string 10",
    "PaymentMethod": "sample string 11",
    "BillTo": "sample string 12",
    "ShipTo": "sample string 13",
    "Comments": "sample string 14",
    "PrivateNotes": "sample string 15",
    "LineItems": [
      {
        "UniqueID": "sample string 1",
        "CoreCharge": "sample string 2",
        "Price": "sample string 3",
        "Quantity": "sample string 4",
        "Description": "sample string 5",
        "Taxable": "sample string 6",
        "PartUniqueID": "sample string 7",
        "TruckUniqueID": "sample string 8",
        "ItemName": "sample string 9"
      },
      {
        "UniqueID": "sample string 1",
        "CoreCharge": "sample string 2",
        "Price": "sample string 3",
        "Quantity": "sample string 4",
        "Description": "sample string 5",
        "Taxable": "sample string 6",
        "PartUniqueID": "sample string 7",
        "TruckUniqueID": "sample string 8",
        "ItemName": "sample string 9"
      }
    ]
  },
  {
    "Type": "sample string 1",
    "CustomerID": "sample string 2",
    "CustomerName": "sample string 3",
    "CompanyUniqueID": "sample string 4",
    "Number": "sample string 5",
    "PONumber": "sample string 6",
    "SalesPerson": "sample string 7",
    "DateSalesRecord": "sample string 8",
    "ShipMethod": "sample string 9",
    "TaxPercent": "sample string 10",
    "PaymentMethod": "sample string 11",
    "BillTo": "sample string 12",
    "ShipTo": "sample string 13",
    "Comments": "sample string 14",
    "PrivateNotes": "sample string 15",
    "LineItems": [
      {
        "UniqueID": "sample string 1",
        "CoreCharge": "sample string 2",
        "Price": "sample string 3",
        "Quantity": "sample string 4",
        "Description": "sample string 5",
        "Taxable": "sample string 6",
        "PartUniqueID": "sample string 7",
        "TruckUniqueID": "sample string 8",
        "ItemName": "sample string 9"
      },
      {
        "UniqueID": "sample string 1",
        "CoreCharge": "sample string 2",
        "Price": "sample string 3",
        "Quantity": "sample string 4",
        "Description": "sample string 5",
        "Taxable": "sample string 6",
        "PartUniqueID": "sample string 7",
        "TruckUniqueID": "sample string 8",
        "ItemName": "sample string 9"
      }
    ]
  }
]

text/html

Sample:
[{"Type":"sample string 1","CustomerID":"sample string 2","CustomerName":"sample string 3","CompanyUniqueID":"sample string 4","Number":"sample string 5","PONumber":"sample string 6","SalesPerson":"sample string 7","DateSalesRecord":"sample string 8","ShipMethod":"sample string 9","TaxPercent":"sample string 10","PaymentMethod":"sample string 11","BillTo":"sample string 12","ShipTo":"sample string 13","Comments":"sample string 14","PrivateNotes":"sample string 15","LineItems":[{"UniqueID":"sample string 1","CoreCharge":"sample string 2","Price":"sample string 3","Quantity":"sample string 4","Description":"sample string 5","Taxable":"sample string 6","PartUniqueID":"sample string 7","TruckUniqueID":"sample string 8","ItemName":"sample string 9"},{"UniqueID":"sample string 1","CoreCharge":"sample string 2","Price":"sample string 3","Quantity":"sample string 4","Description":"sample string 5","Taxable":"sample string 6","PartUniqueID":"sample string 7","TruckUniqueID":"sample string 8","ItemName":"sample string 9"}]},{"Type":"sample string 1","CustomerID":"sample string 2","CustomerName":"sample string 3","CompanyUniqueID":"sample string 4","Number":"sample string 5","PONumber":"sample string 6","SalesPerson":"sample string 7","DateSalesRecord":"sample string 8","ShipMethod":"sample string 9","TaxPercent":"sample string 10","PaymentMethod":"sample string 11","BillTo":"sample string 12","ShipTo":"sample string 13","Comments":"sample string 14","PrivateNotes":"sample string 15","LineItems":[{"UniqueID":"sample string 1","CoreCharge":"sample string 2","Price":"sample string 3","Quantity":"sample string 4","Description":"sample string 5","Taxable":"sample string 6","PartUniqueID":"sample string 7","TruckUniqueID":"sample string 8","ItemName":"sample string 9"},{"UniqueID":"sample string 1","CoreCharge":"sample string 2","Price":"sample string 3","Quantity":"sample string 4","Description":"sample string 5","Taxable":"sample string 6","PartUniqueID":"sample string 7","TruckUniqueID":"sample string 8","ItemName":"sample string 9"}]}]

application/xml, text/xml

Sample:
<ArrayOfSalesRecord xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPI.Web.Api">
  <SalesRecord>
    <BillTo>sample string 12</BillTo>
    <Comments>sample string 14</Comments>
    <CompanyUniqueID>sample string 4</CompanyUniqueID>
    <CustomerID>sample string 2</CustomerID>
    <CustomerName>sample string 3</CustomerName>
    <DateSalesRecord>sample string 8</DateSalesRecord>
    <LineItems>
      <LineItem>
        <CoreCharge>sample string 2</CoreCharge>
        <Description>sample string 5</Description>
        <ItemName>sample string 9</ItemName>
        <PartUniqueID>sample string 7</PartUniqueID>
        <Price>sample string 3</Price>
        <Quantity>sample string 4</Quantity>
        <Taxable>sample string 6</Taxable>
        <TruckUniqueID>sample string 8</TruckUniqueID>
        <UniqueID>sample string 1</UniqueID>
      </LineItem>
      <LineItem>
        <CoreCharge>sample string 2</CoreCharge>
        <Description>sample string 5</Description>
        <ItemName>sample string 9</ItemName>
        <PartUniqueID>sample string 7</PartUniqueID>
        <Price>sample string 3</Price>
        <Quantity>sample string 4</Quantity>
        <Taxable>sample string 6</Taxable>
        <TruckUniqueID>sample string 8</TruckUniqueID>
        <UniqueID>sample string 1</UniqueID>
      </LineItem>
    </LineItems>
    <Number>sample string 5</Number>
    <PONumber>sample string 6</PONumber>
    <PaymentMethod>sample string 11</PaymentMethod>
    <PrivateNotes>sample string 15</PrivateNotes>
    <SalesPerson>sample string 7</SalesPerson>
    <ShipMethod>sample string 9</ShipMethod>
    <ShipTo>sample string 13</ShipTo>
    <TaxPercent>sample string 10</TaxPercent>
    <Type>sample string 1</Type>
  </SalesRecord>
  <SalesRecord>
    <BillTo>sample string 12</BillTo>
    <Comments>sample string 14</Comments>
    <CompanyUniqueID>sample string 4</CompanyUniqueID>
    <CustomerID>sample string 2</CustomerID>
    <CustomerName>sample string 3</CustomerName>
    <DateSalesRecord>sample string 8</DateSalesRecord>
    <LineItems>
      <LineItem>
        <CoreCharge>sample string 2</CoreCharge>
        <Description>sample string 5</Description>
        <ItemName>sample string 9</ItemName>
        <PartUniqueID>sample string 7</PartUniqueID>
        <Price>sample string 3</Price>
        <Quantity>sample string 4</Quantity>
        <Taxable>sample string 6</Taxable>
        <TruckUniqueID>sample string 8</TruckUniqueID>
        <UniqueID>sample string 1</UniqueID>
      </LineItem>
      <LineItem>
        <CoreCharge>sample string 2</CoreCharge>
        <Description>sample string 5</Description>
        <ItemName>sample string 9</ItemName>
        <PartUniqueID>sample string 7</PartUniqueID>
        <Price>sample string 3</Price>
        <Quantity>sample string 4</Quantity>
        <Taxable>sample string 6</Taxable>
        <TruckUniqueID>sample string 8</TruckUniqueID>
        <UniqueID>sample string 1</UniqueID>
      </LineItem>
    </LineItems>
    <Number>sample string 5</Number>
    <PONumber>sample string 6</PONumber>
    <PaymentMethod>sample string 11</PaymentMethod>
    <PrivateNotes>sample string 15</PrivateNotes>
    <SalesPerson>sample string 7</SalesPerson>
    <ShipMethod>sample string 9</ShipMethod>
    <ShipTo>sample string 13</ShipTo>
    <TaxPercent>sample string 10</TaxPercent>
    <Type>sample string 1</Type>
  </SalesRecord>
</ArrayOfSalesRecord>