Trendsic Platform Service

<back to all web services

PurchaseOrderListRequest

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

public class PurchaseOrderListRequest : Codable
{
    public var projectID:Int

    required public init(){}
}

public class PurchaseOrderListResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var projectID:Int
    public var orders:[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 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 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 PurchaseOrderListRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /v1/projects/{ProjectID}/purchase-orders HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"ProjectID":0,"Orders":[{"PurchaseOrderID":0,"PurchaseOrderUID":"00000000000000000000000000000000","ProjectID":0,"PONumber":"String","Vendor":"String","Status":"String","AmountUSD":0,"CostCode":"String","NeedByDate":"0001-01-01T00:00:00.0000000","Notes":"String","IssuedAt":"0001-01-01T00:00:00.0000000","ReceivedAt":"0001-01-01T00:00:00.0000000","CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000","LineCount":0,"FirstItem":"String","DaysToNeed":0,"Lines":[{"PurchaseOrderLineID":0,"PurchaseOrderID":0,"MaterialID":0,"Description":"String","Unit":"String","Qty":0,"UnitPrice":0,"QtyReceived":0,"CostCode":"String","SortOrder":0}]}],"Summary":{"ProjectID":0,"MaterialBudget":0,"Committed":0,"Received":0,"OpenPOs":0,"LatePOs":0,"POCount":0,"RemainingBuyout":0}}