Trendsic Platform Service

<back to all web services

PurchaseOrderReceiveRequest

"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

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

<PurchaseOrderReceiveRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Close>false</Close>
  <Lines>
    <PurchaseOrderLine>
      <CostCode>String</CostCode>
      <Description>String</Description>
      <MaterialID>0</MaterialID>
      <PurchaseOrderID>0</PurchaseOrderID>
      <PurchaseOrderLineID>0</PurchaseOrderLineID>
      <Qty>0</Qty>
      <QtyReceived>0</QtyReceived>
      <SortOrder>0</SortOrder>
      <Unit>String</Unit>
      <UnitPrice>0</UnitPrice>
    </PurchaseOrderLine>
  </Lines>
  <ProjectID>0</ProjectID>
  <PurchaseOrderID>0</PurchaseOrderID>
</PurchaseOrderReceiveRequest>

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

<PurchaseOrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Order>
    <AmountUSD>0</AmountUSD>
    <CostCode>String</CostCode>
    <CreatedAt>0001-01-01T00:00:00</CreatedAt>
    <CreatedBy>String</CreatedBy>
    <DaysToNeed>0</DaysToNeed>
    <FirstItem>String</FirstItem>
    <IssuedAt>0001-01-01T00:00:00</IssuedAt>
    <LineCount>0</LineCount>
    <Lines>
      <PurchaseOrderLine>
        <CostCode>String</CostCode>
        <Description>String</Description>
        <MaterialID>0</MaterialID>
        <PurchaseOrderID>0</PurchaseOrderID>
        <PurchaseOrderLineID>0</PurchaseOrderLineID>
        <Qty>0</Qty>
        <QtyReceived>0</QtyReceived>
        <SortOrder>0</SortOrder>
        <Unit>String</Unit>
        <UnitPrice>0</UnitPrice>
      </PurchaseOrderLine>
    </Lines>
    <NeedByDate>0001-01-01T00:00:00</NeedByDate>
    <Notes>String</Notes>
    <PONumber>String</PONumber>
    <ProjectID>0</ProjectID>
    <PurchaseOrderID>0</PurchaseOrderID>
    <PurchaseOrderUID>00000000-0000-0000-0000-000000000000</PurchaseOrderUID>
    <ReceivedAt>0001-01-01T00:00:00</ReceivedAt>
    <Status>String</Status>
    <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
    <Vendor>String</Vendor>
  </Order>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Summary>
    <Committed>0</Committed>
    <LatePOs>0</LatePOs>
    <MaterialBudget>0</MaterialBudget>
    <OpenPOs>0</OpenPOs>
    <POCount>0</POCount>
    <ProjectID>0</ProjectID>
    <Received>0</Received>
    <RemainingBuyout>0</RemainingBuyout>
  </Summary>
</PurchaseOrderResponse>