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
"use strict";
export class PurchaseOrderLine {
    /** @param {{PurchaseOrderLineID?:number,PurchaseOrderID?:number,MaterialID?:number,Description?:string,Unit?:string,Qty?:number,UnitPrice?:number,QtyReceived?:number,CostCode?:string,SortOrder?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    PurchaseOrderLineID;
    /** @type {number} */
    PurchaseOrderID;
    /** @type {?number} */
    MaterialID;
    /** @type {string} */
    Description;
    /** @type {string} */
    Unit;
    /** @type {number} */
    Qty;
    /** @type {number} */
    UnitPrice;
    /** @type {number} */
    QtyReceived;
    /** @type {string} */
    CostCode;
    /** @type {number} */
    SortOrder;
}
export class PurchaseOrder {
    /** @param {{PurchaseOrderID?:number,PurchaseOrderUID?:string,ProjectID?:number,PONumber?:string,Vendor?:string,Status?:string,AmountUSD?:number,CostCode?:string,NeedByDate?:string,Notes?:string,IssuedAt?:string,ReceivedAt?:string,CreatedBy?:string,CreatedAt?:string,UpdatedAt?:string,LineCount?:number,FirstItem?:string,DaysToNeed?:number,Lines?:PurchaseOrderLine[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    PurchaseOrderID;
    /** @type {string} */
    PurchaseOrderUID;
    /** @type {number} */
    ProjectID;
    /** @type {string} */
    PONumber;
    /** @type {string} */
    Vendor;
    /** @type {string} */
    Status;
    /** @type {number} */
    AmountUSD;
    /** @type {string} */
    CostCode;
    /** @type {?string} */
    NeedByDate;
    /** @type {string} */
    Notes;
    /** @type {?string} */
    IssuedAt;
    /** @type {?string} */
    ReceivedAt;
    /** @type {string} */
    CreatedBy;
    /** @type {?string} */
    CreatedAt;
    /** @type {?string} */
    UpdatedAt;
    /** @type {number} */
    LineCount;
    /** @type {string} */
    FirstItem;
    /** @type {number} */
    DaysToNeed;
    /** @type {PurchaseOrderLine[]} */
    Lines = [];
}
export class PurchaseOrderBuyoutSummary {
    /** @param {{ProjectID?:number,MaterialBudget?:number,Committed?:number,Received?:number,OpenPOs?:number,LatePOs?:number,POCount?:number,RemainingBuyout?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ProjectID;
    /** @type {number} */
    MaterialBudget;
    /** @type {number} */
    Committed;
    /** @type {number} */
    Received;
    /** @type {number} */
    OpenPOs;
    /** @type {number} */
    LatePOs;
    /** @type {number} */
    POCount;
    /** @type {number} */
    RemainingBuyout;
}
export class PurchaseOrderResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Order?:PurchaseOrder,Summary?:PurchaseOrderBuyoutSummary}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {PurchaseOrder} */
    Order;
    /** @type {PurchaseOrderBuyoutSummary} */
    Summary;
}
export class PurchaseOrderReceiveRequest {
    /** @param {{ProjectID?:number,PurchaseOrderID?:number,Lines?:PurchaseOrderLine[],Close?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ProjectID;
    /** @type {number} */
    PurchaseOrderID;
    /** @type {PurchaseOrderLine[]} */
    Lines = [];
    /** @type {boolean} */
    Close;
}

JavaScript PurchaseOrderReceiveRequest DTOs

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
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: text/csv
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}}