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
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type PurchaseOrderLine() = 
        member val PurchaseOrderLineID:Int32 = new Int32() with get,set
        member val PurchaseOrderID:Int32 = new Int32() with get,set
        member val MaterialID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Description:String = null with get,set
        member val Unit:String = null with get,set
        member val Qty:Decimal = new Decimal() with get,set
        member val UnitPrice:Decimal = new Decimal() with get,set
        member val QtyReceived:Decimal = new Decimal() with get,set
        member val CostCode:String = null with get,set
        member val SortOrder:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type PurchaseOrder() = 
        member val PurchaseOrderID:Int32 = new Int32() with get,set
        member val PurchaseOrderUID:Guid = new Guid() with get,set
        member val ProjectID:Int32 = new Int32() with get,set
        member val PONumber:String = null with get,set
        member val Vendor:String = null with get,set
        member val Status:String = null with get,set
        member val AmountUSD:Decimal = new Decimal() with get,set
        member val CostCode:String = null with get,set
        member val NeedByDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Notes:String = null with get,set
        member val IssuedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ReceivedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val CreatedBy:String = null with get,set
        member val CreatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val UpdatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val LineCount:Int32 = new Int32() with get,set
        member val FirstItem:String = null with get,set
        member val DaysToNeed:Int32 = new Int32() with get,set
        member val Lines:ResizeArray<PurchaseOrderLine> = new ResizeArray<PurchaseOrderLine>() with get,set

    [<AllowNullLiteral>]
    type PurchaseOrderBuyoutSummary() = 
        member val ProjectID:Int32 = new Int32() with get,set
        member val MaterialBudget:Decimal = new Decimal() with get,set
        member val Committed:Decimal = new Decimal() with get,set
        member val Received:Decimal = new Decimal() with get,set
        member val OpenPOs:Int32 = new Int32() with get,set
        member val LatePOs:Int32 = new Int32() with get,set
        member val POCount:Int32 = new Int32() with get,set
        member val RemainingBuyout:Decimal = new Decimal() with get,set

    [<AllowNullLiteral>]
    type PurchaseOrderListResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val ProjectID:Int32 = new Int32() with get,set
        member val Orders:ResizeArray<PurchaseOrder> = new ResizeArray<PurchaseOrder>() with get,set
        member val Summary:PurchaseOrderBuyoutSummary = null with get,set

    [<AllowNullLiteral>]
    type PurchaseOrderListRequest() = 
        member val ProjectID:Int32 = new Int32() with get,set

F# 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
	}
}