Trendsic Platform Service

<back to all web services

PurchaseOrderDetailRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/projects/{ProjectID}/purchase-orders/{PurchaseOrderID}
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PurchaseOrderLine:
    purchase_order_line_i_d: int = 0
    purchase_order_i_d: int = 0
    material_i_d: Optional[int] = None
    description: Optional[str] = None
    unit: Optional[str] = None
    qty: Decimal = decimal.Decimal(0)
    unit_price: Decimal = decimal.Decimal(0)
    qty_received: Decimal = decimal.Decimal(0)
    cost_code: Optional[str] = None
    sort_order: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PurchaseOrder:
    purchase_order_i_d: int = 0
    purchase_order_u_i_d: Optional[str] = None
    project_i_d: int = 0
    po_number: Optional[str] = None
    vendor: Optional[str] = None
    status: Optional[str] = None
    amount_u_s_d: Decimal = decimal.Decimal(0)
    cost_code: Optional[str] = None
    need_by_date: Optional[datetime.datetime] = None
    notes: Optional[str] = None
    issued_at: Optional[datetime.datetime] = None
    received_at: Optional[datetime.datetime] = None
    created_by: Optional[str] = None
    created_at: Optional[datetime.datetime] = None
    updated_at: Optional[datetime.datetime] = None
    line_count: int = 0
    first_item: Optional[str] = None
    days_to_need: int = 0
    lines: List[PurchaseOrderLine] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PurchaseOrderBuyoutSummary:
    project_i_d: int = 0
    material_budget: Decimal = decimal.Decimal(0)
    committed: Decimal = decimal.Decimal(0)
    received: Decimal = decimal.Decimal(0)
    open_p_os: int = 0
    late_p_os: int = 0
    po_count: int = 0
    remaining_buyout: Decimal = decimal.Decimal(0)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PurchaseOrderResponse:
    response_status: Optional[ResponseStatus] = None
    order: Optional[PurchaseOrder] = None
    summary: Optional[PurchaseOrderBuyoutSummary] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PurchaseOrderDetailRequest:
    project_i_d: int = 0
    purchase_order_i_d: int = 0

Python PurchaseOrderDetailRequest DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/projects/{ProjectID}/purchase-orders/{PurchaseOrderID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
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>