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
PurchaseOrderReceiveRequest Parameters:
NameParameterData TypeRequiredDescription
ProjectIDpathintNo
PurchaseOrderIDpathintNo
LinesbodyList<PurchaseOrderLine>No
ClosebodyboolNo
PurchaseOrderLine Parameters:
NameParameterData TypeRequiredDescription
PurchaseOrderLineIDformintNo
PurchaseOrderIDformintNo
MaterialIDformint?No
DescriptionformstringNo
UnitformstringNo
QtyformdecimalNo
UnitPriceformdecimalNo
QtyReceivedformdecimalNo
CostCodeformstringNo
SortOrderformintNo
PurchaseOrderResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
OrderformPurchaseOrderNo
SummaryformPurchaseOrderBuyoutSummaryNo
PurchaseOrder Parameters:
NameParameterData TypeRequiredDescription
PurchaseOrderIDformintNo
PurchaseOrderUIDformGuidNo
ProjectIDformintNo
PONumberformstringNo
VendorformstringNo
StatusformstringNo
AmountUSDformdecimalNo
CostCodeformstringNo
NeedByDateformDateTime?No
NotesformstringNo
IssuedAtformDateTime?No
ReceivedAtformDateTime?No
CreatedByformstringNo
CreatedAtformDateTime?No
UpdatedAtformDateTime?No
LineCountformintNo
FirstItemformstringNo
DaysToNeedformintNo
LinesformList<PurchaseOrderLine>No
PurchaseOrderBuyoutSummary Parameters:
NameParameterData TypeRequiredDescription
ProjectIDformintNo
MaterialBudgetformdecimalNo
CommittedformdecimalNo
ReceivedformdecimalNo
OpenPOsformintNo
LatePOsformintNo
POCountformintNo
RemainingBuyoutformdecimalNo

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.

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

{"ProjectID":0,"PurchaseOrderID":0,"Lines":[{"PurchaseOrderLineID":0,"PurchaseOrderID":0,"MaterialID":0,"Description":"String","Unit":"String","Qty":0,"UnitPrice":0,"QtyReceived":0,"CostCode":"String","SortOrder":0}],"Close":false}
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"}},"Order":{"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}}