GET https://api.d-tools.com/SI/Subscribe/PurchaseOrders?id={id}

Get a purchase order for a given purchase order id.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The purchase order id.	string	Required

Body Parameters

None.

Response Information

Resource Description

PurchaseOrder

Name	Description	Type	Additional information
Id	Unique Id	string	None.
Vendor	Vendor name (Rrequired)	string	None.
Projects	Projects	string	None.
Number	Number (Required)	string	None.
Status	Status (Required)	string	None.
Date	Date	date	None.
RequestDeliveryDate	Request delivery date	date	None.
ShipPref	Shipment preference	string	None.
VendorRefNumber	Vendor reference number	string	None.
TrackingNumber	Tracking number	string	None.
AcctgNumber	Accounting number	string	None.
Terms	Terms	string	None.
Notes	Notes	string	None.
ServiceOrders	Service Orders	string	None.
CurrencyCode	Currency code	string	None.
CurrencyRate	Currency rate	decimal number	None.
CreatedOn	Date the purchase order was created (UTC Time)	date	None.
UpdatedOn	Date the purchase order was updated (UTC Time)	date	None.
CreatedBy	Purchase order Created By	string	None.
UpdatedBy	Purchase order Updated By	string	None.
PublishedBy	Purchase order Published By	string	None.
Contacts	Contacts information	Collection of PurchaseOrderContact	None.
VendorAddress	Vendor address information	Address	None.
ShipToAddress	Ship To address information	ShipToAddress	None.
PurchaseOrderItems		Collection of PurchaseOrderItem	None.
PurchaseOrderTaxes		Collection of PurchaseOrderTax	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": "sample string 1",
  "Vendor": "sample string 2",
  "Projects": "sample string 3",
  "Number": "sample string 4",
  "Status": "sample string 5",
  "Date": "2024-04-29T12:34:01.082022+00:00",
  "RequestDeliveryDate": "2024-04-29T12:34:01.082022+00:00",
  "ShipPref": "sample string 7",
  "VendorRefNumber": "sample string 8",
  "TrackingNumber": "sample string 9",
  "AcctgNumber": "sample string 10",
  "Terms": "sample string 11",
  "Notes": "sample string 12",
  "ServiceOrders": "sample string 13",
  "CurrencyCode": "sample string 14",
  "CurrencyRate": 1.0,
  "CreatedOn": "2024-04-29T12:34:01.082022+00:00",
  "UpdatedOn": "2024-04-29T12:34:01.082022+00:00",
  "CreatedBy": "sample string 15",
  "UpdatedBy": "sample string 16",
  "PublishedBy": "sample string 17",
  "Contacts": [
    {
      "Name": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "Group": "sample string 4",
      "Company": "sample string 5",
      "Title": "sample string 6",
      "Email": "sample string 7",
      "Mobile": "sample string 8",
      "Notes": "sample string 9"
    },
    {
      "Name": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "Group": "sample string 4",
      "Company": "sample string 5",
      "Title": "sample string 6",
      "Email": "sample string 7",
      "Mobile": "sample string 8",
      "Notes": "sample string 9"
    }
  ],
  "VendorAddress": {
    "Street1": "sample string 1",
    "Street2": "sample string 2",
    "City": "sample string 3",
    "State": "sample string 4",
    "PostalCode": "sample string 5",
    "Country": "sample string 6",
    "Phone": "sample string 7",
    "Fax": "sample string 8"
  },
  "ShipToAddress": {
    "Name": "sample string 1",
    "Street1": "sample string 2",
    "Street2": "sample string 3",
    "City": "sample string 4",
    "State": "sample string 5",
    "PostalCode": "sample string 6",
    "Country": "sample string 7",
    "Phone": "sample string 8",
    "Fax": "sample string 9"
  },
  "PurchaseOrderItems": [
    {
      "Id": "sample string 1",
      "TypeId": 64,
      "ManufacturerId": "sample string 3",
      "Manufacturer": "sample string 4",
      "Model": "sample string 5",
      "Quantity": 6.0,
      "PackageName": "sample string 7",
      "CatalogId": "sample string 8",
      "PartNumber": "sample string 9",
      "CategoryType": "sample string 10",
      "Description": "sample string 11",
      "ProjectId": "sample string 12",
      "ProjectName": "sample string 13",
      "ProjectSIItemIds": "sample string 14",
      "ServiceOrderId": "sample string 15",
      "ServiceOrderName": "sample string 16",
      "LaborHours": 1.0,
      "Uom": "sample string 17",
      "UomUnits": 1,
      "ProjectUnits": 1,
      "Price": 18.0,
      "TotalPrice": 19.0,
      "ReceivedQuantity": 1,
      "EDD": "2024-04-29T12:34:01.082022+00:00",
      "TrackingNumber": "sample string 20",
      "TaxId": 1
    },
    {
      "Id": "sample string 1",
      "TypeId": 64,
      "ManufacturerId": "sample string 3",
      "Manufacturer": "sample string 4",
      "Model": "sample string 5",
      "Quantity": 6.0,
      "PackageName": "sample string 7",
      "CatalogId": "sample string 8",
      "PartNumber": "sample string 9",
      "CategoryType": "sample string 10",
      "Description": "sample string 11",
      "ProjectId": "sample string 12",
      "ProjectName": "sample string 13",
      "ProjectSIItemIds": "sample string 14",
      "ServiceOrderId": "sample string 15",
      "ServiceOrderName": "sample string 16",
      "LaborHours": 1.0,
      "Uom": "sample string 17",
      "UomUnits": 1,
      "ProjectUnits": 1,
      "Price": 18.0,
      "TotalPrice": 19.0,
      "ReceivedQuantity": 1,
      "EDD": "2024-04-29T12:34:01.082022+00:00",
      "TrackingNumber": "sample string 20",
      "TaxId": 1
    }
  ],
  "PurchaseOrderTaxes": [
    {
      "TaxId": 1,
      "Name": "sample string 2",
      "Rate": 3.0,
      "Group": true,
      "Items": [
        1,
        2
      ]
    },
    {
      "TaxId": 1,
      "Name": "sample string 2",
      "Rate": 3.0,
      "Group": true,
      "Items": [
        1,
        2
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<PurchaseOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DTools.SICloudAPI.DataObjects">
  <AcctgNumber>sample string 10</AcctgNumber>
  <Contacts>
    <PurchaseOrderContact>
      <Company>sample string 5</Company>
      <Email>sample string 7</Email>
      <FirstName>sample string 2</FirstName>
      <Group>sample string 4</Group>
      <LastName>sample string 3</LastName>
      <Mobile>sample string 8</Mobile>
      <Name>sample string 1</Name>
      <Notes>sample string 9</Notes>
      <Title>sample string 6</Title>
    </PurchaseOrderContact>
    <PurchaseOrderContact>
      <Company>sample string 5</Company>
      <Email>sample string 7</Email>
      <FirstName>sample string 2</FirstName>
      <Group>sample string 4</Group>
      <LastName>sample string 3</LastName>
      <Mobile>sample string 8</Mobile>
      <Name>sample string 1</Name>
      <Notes>sample string 9</Notes>
      <Title>sample string 6</Title>
    </PurchaseOrderContact>
  </Contacts>
  <CreatedBy>sample string 15</CreatedBy>
  <CreatedOn>2024-04-29T12:34:01.082022+00:00</CreatedOn>
  <CurrencyCode>sample string 14</CurrencyCode>
  <CurrencyRate>1</CurrencyRate>
  <Date>2024-04-29T12:34:01.082022+00:00</Date>
  <Id>sample string 1</Id>
  <Notes>sample string 12</Notes>
  <Number>sample string 4</Number>
  <Projects>sample string 3</Projects>
  <PublishedBy>sample string 17</PublishedBy>
  <PurchaseOrderItems>
    <PurchaseOrderItem>
      <CatalogId>sample string 8</CatalogId>
      <CategoryType>sample string 10</CategoryType>
      <Description>sample string 11</Description>
      <EDD>2024-04-29T12:34:01.082022+00:00</EDD>
      <Id>sample string 1</Id>
      <LaborHours>1</LaborHours>
      <Manufacturer>sample string 4</Manufacturer>
      <ManufacturerId>sample string 3</ManufacturerId>
      <Model>sample string 5</Model>
      <PackageName>sample string 7</PackageName>
      <PartNumber>sample string 9</PartNumber>
      <Price>18</Price>
      <ProjectId>sample string 12</ProjectId>
      <ProjectName>sample string 13</ProjectName>
      <ProjectSIItemIds>sample string 14</ProjectSIItemIds>
      <ProjectUnits>1</ProjectUnits>
      <Quantity>6</Quantity>
      <ReceivedQuantity>1</ReceivedQuantity>
      <ServiceOrderId>sample string 15</ServiceOrderId>
      <ServiceOrderName>sample string 16</ServiceOrderName>
      <TaxId>1</TaxId>
      <TotalPrice>19</TotalPrice>
      <TrackingNumber>sample string 20</TrackingNumber>
      <TypeId>64</TypeId>
      <Uom>sample string 17</Uom>
      <UomUnits>1</UomUnits>
    </PurchaseOrderItem>
    <PurchaseOrderItem>
      <CatalogId>sample string 8</CatalogId>
      <CategoryType>sample string 10</CategoryType>
      <Description>sample string 11</Description>
      <EDD>2024-04-29T12:34:01.082022+00:00</EDD>
      <Id>sample string 1</Id>
      <LaborHours>1</LaborHours>
      <Manufacturer>sample string 4</Manufacturer>
      <ManufacturerId>sample string 3</ManufacturerId>
      <Model>sample string 5</Model>
      <PackageName>sample string 7</PackageName>
      <PartNumber>sample string 9</PartNumber>
      <Price>18</Price>
      <ProjectId>sample string 12</ProjectId>
      <ProjectName>sample string 13</ProjectName>
      <ProjectSIItemIds>sample string 14</ProjectSIItemIds>
      <ProjectUnits>1</ProjectUnits>
      <Quantity>6</Quantity>
      <ReceivedQuantity>1</ReceivedQuantity>
      <ServiceOrderId>sample string 15</ServiceOrderId>
      <ServiceOrderName>sample string 16</ServiceOrderName>
      <TaxId>1</TaxId>
      <TotalPrice>19</TotalPrice>
      <TrackingNumber>sample string 20</TrackingNumber>
      <TypeId>64</TypeId>
      <Uom>sample string 17</Uom>
      <UomUnits>1</UomUnits>
    </PurchaseOrderItem>
  </PurchaseOrderItems>
  <PurchaseOrderTaxes>
    <PurchaseOrderTax>
      <Group>true</Group>
      <Items xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </Items>
      <Name>sample string 2</Name>
      <Rate>3</Rate>
      <TaxId>1</TaxId>
    </PurchaseOrderTax>
    <PurchaseOrderTax>
      <Group>true</Group>
      <Items xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </Items>
      <Name>sample string 2</Name>
      <Rate>3</Rate>
      <TaxId>1</TaxId>
    </PurchaseOrderTax>
  </PurchaseOrderTaxes>
  <RequestDeliveryDate>2024-04-29T12:34:01.082022+00:00</RequestDeliveryDate>
  <ServiceOrders>sample string 13</ServiceOrders>
  <ShipPref>sample string 7</ShipPref>
  <ShipToAddress>
    <City>sample string 4</City>
    <Country>sample string 7</Country>
    <Fax>sample string 9</Fax>
    <Phone>sample string 8</Phone>
    <PostalCode>sample string 6</PostalCode>
    <State>sample string 5</State>
    <Street1>sample string 2</Street1>
    <Street2>sample string 3</Street2>
    <Name>sample string 1</Name>
  </ShipToAddress>
  <Status>sample string 5</Status>
  <Terms>sample string 11</Terms>
  <TrackingNumber>sample string 9</TrackingNumber>
  <UpdatedBy>sample string 16</UpdatedBy>
  <UpdatedOn>2024-04-29T12:34:01.082022+00:00</UpdatedOn>
  <Vendor>sample string 2</Vendor>
  <VendorAddress>
    <City>sample string 3</City>
    <Country>sample string 6</Country>
    <Fax>sample string 8</Fax>
    <Phone>sample string 7</Phone>
    <PostalCode>sample string 5</PostalCode>
    <State>sample string 4</State>
    <Street1>sample string 1</Street1>
    <Street2>sample string 2</Street2>
  </VendorAddress>
  <VendorRefNumber>sample string 8</VendorRefNumber>
</PurchaseOrder>