Trendsic Platform Service

<back to all web services

PurchaseOrderReceiveRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/projects/{ProjectID}/purchase-orders/{PurchaseOrderID}/receive
import Foundation
import ServiceStack

public class PurchaseOrderReceiveRequest : Codable
{
    public var projectID:Int
    public var purchaseOrderID:Int
    public var lines:[PurchaseOrderLine] = []
    public var close:Bool

    required public init(){}
}

public class PurchaseOrderLine : Codable
{
    public var purchaseOrderLineID:Int
    public var purchaseOrderID:Int
    public var materialID:Int?
    public var Description:String
    public var unit:String
    public var qty:Double
    public var unitPrice:Double
    public var qtyReceived:Double
    public var costCode:String
    public var sortOrder:Int

    required public init(){}
}

public class PurchaseOrderResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var order:PurchaseOrder
    public var summary:PurchaseOrderBuyoutSummary

    required public init(){}
}

public class PurchaseOrder : Codable
{
    public var purchaseOrderID:Int
    public var purchaseOrderUID:String
    public var projectID:Int
    public var poNumber:String
    public var vendor:String
    public var status:String
    public var amountUSD:Double
    public var costCode:String
    public var needByDate:Date?
    public var notes:String
    public var issuedAt:Date?
    public var receivedAt:Date?
    public var createdBy:String
    public var createdAt:Date?
    public var updatedAt:Date?
    public var lineCount:Int
    public var firstItem:String
    public var daysToNeed:Int
    public var lines:[PurchaseOrderLine] = []

    required public init(){}
}

public class PurchaseOrderBuyoutSummary : Codable
{
    public var projectID:Int
    public var materialBudget:Double
    public var committed:Double
    public var received:Double
    public var openPOs:Int
    public var latePOs:Int
    public var poCount:Int
    public var remainingBuyout:Double

    required public init(){}
}


Swift PurchaseOrderReceiveRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/projects/{ProjectID}/purchase-orders/{PurchaseOrderID}/receive HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PurchaseOrderReceiveRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Close>false</Close>
  <Lines>
    <PurchaseOrderLine>
      <CostCode>String</CostCode>
      <Description>String</Description>
      <MaterialID>0</MaterialID>
      <PurchaseOrderID>0</PurchaseOrderID>
      <PurchaseOrderLineID>0</PurchaseOrderLineID>
      <Qty>0</Qty>
      <QtyReceived>0</QtyReceived>
      <SortOrder>0</SortOrder>
      <Unit>String</Unit>
      <UnitPrice>0</UnitPrice>
    </PurchaseOrderLine>
  </Lines>
  <ProjectID>0</ProjectID>
  <PurchaseOrderID>0</PurchaseOrderID>
</PurchaseOrderReceiveRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PurchaseOrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Order>
    <AmountUSD>0</AmountUSD>
    <CostCode>String</CostCode>
    <CreatedAt>0001-01-01T00:00:00</CreatedAt>
    <CreatedBy>String</CreatedBy>
    <DaysToNeed>0</DaysToNeed>
    <FirstItem>String</FirstItem>
    <IssuedAt>0001-01-01T00:00:00</IssuedAt>
    <LineCount>0</LineCount>
    <Lines>
      <PurchaseOrderLine>
        <CostCode>String</CostCode>
        <Description>String</Description>
        <MaterialID>0</MaterialID>
        <PurchaseOrderID>0</PurchaseOrderID>
        <PurchaseOrderLineID>0</PurchaseOrderLineID>
        <Qty>0</Qty>
        <QtyReceived>0</QtyReceived>
        <SortOrder>0</SortOrder>
        <Unit>String</Unit>
        <UnitPrice>0</UnitPrice>
      </PurchaseOrderLine>
    </Lines>
    <NeedByDate>0001-01-01T00:00:00</NeedByDate>
    <Notes>String</Notes>
    <PONumber>String</PONumber>
    <ProjectID>0</ProjectID>
    <PurchaseOrderID>0</PurchaseOrderID>
    <PurchaseOrderUID>00000000-0000-0000-0000-000000000000</PurchaseOrderUID>
    <ReceivedAt>0001-01-01T00:00:00</ReceivedAt>
    <Status>String</Status>
    <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
    <Vendor>String</Vendor>
  </Order>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Summary>
    <Committed>0</Committed>
    <LatePOs>0</LatePOs>
    <MaterialBudget>0</MaterialBudget>
    <OpenPOs>0</OpenPOs>
    <POCount>0</POCount>
    <ProjectID>0</ProjectID>
    <Received>0</Received>
    <RemainingBuyout>0</RemainingBuyout>
  </Summary>
</PurchaseOrderResponse>