Trendsic Platform Service

<back to all web services

PurchaseOrderCreateRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/projects/{ProjectID}/purchase-orders
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 PurchaseOrderCreateRequest:
    project_i_d: int = 0
    po_number: Optional[str] = None
    vendor: Optional[str] = None
    cost_code: Optional[str] = None
    need_by_date: Optional[datetime.datetime] = None
    notes: Optional[str] = None
    lines: List[PurchaseOrderLine] = field(default_factory=list)

Python PurchaseOrderCreateRequest DTOs

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

HTTP + OTHER

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

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

{"ProjectID":0,"PONumber":"String","Vendor":"String","CostCode":"String","NeedByDate":"0001-01-01T00:00:00.0000000","Notes":"String","Lines":[{"PurchaseOrderLineID":0,"PurchaseOrderID":0,"MaterialID":0,"Description":"String","Unit":"String","Qty":0,"UnitPrice":0,"QtyReceived":0,"CostCode":"String","SortOrder":0}]}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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}}