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 java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class PurchaseOrderListRequest
{
    open var ProjectID:Int? = null
}

open class PurchaseOrderListResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var ProjectID:Int? = null
    open var Orders:ArrayList<PurchaseOrder> = ArrayList<PurchaseOrder>()
    open var Summary:PurchaseOrderBuyoutSummary? = null
}

open class PurchaseOrder
{
    open var PurchaseOrderID:Int? = null
    open var PurchaseOrderUID:UUID? = null
    open var ProjectID:Int? = null
    open var PONumber:String? = null
    open var Vendor:String? = null
    open var Status:String? = null
    open var AmountUSD:BigDecimal? = null
    open var CostCode:String? = null
    open var NeedByDate:Date? = null
    open var Notes:String? = null
    open var IssuedAt:Date? = null
    open var ReceivedAt:Date? = null
    open var CreatedBy:String? = null
    open var CreatedAt:Date? = null
    open var UpdatedAt:Date? = null
    open var LineCount:Int? = null
    open var FirstItem:String? = null
    open var DaysToNeed:Int? = null
    open var Lines:ArrayList<PurchaseOrderLine> = ArrayList<PurchaseOrderLine>()
}

open class PurchaseOrderLine
{
    open var PurchaseOrderLineID:Int? = null
    open var PurchaseOrderID:Int? = null
    open var MaterialID:Int? = null
    open var Description:String? = null
    open var Unit:String? = null
    open var Qty:BigDecimal? = null
    open var UnitPrice:BigDecimal? = null
    open var QtyReceived:BigDecimal? = null
    open var CostCode:String? = null
    open var SortOrder:Int? = null
}

open class PurchaseOrderBuyoutSummary
{
    open var ProjectID:Int? = null
    open var MaterialBudget:BigDecimal? = null
    open var Committed:BigDecimal? = null
    open var Received:BigDecimal? = null
    open var OpenPOs:Int? = null
    open var LatePOs:Int? = null
    open var POCount:Int? = null
    open var RemainingBuyout:BigDecimal? = null
}

Kotlin PurchaseOrderListRequest DTOs

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

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
			Notes: String,
			IssuedAt: 0001-01-01,
			ReceivedAt: 0001-01-01,
			CreatedBy: String,
			CreatedAt: 0001-01-01,
			UpdatedAt: 0001-01-01,
			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
	}
}