Hmx Accounts

<back to all web services

GetPurchaseOrders

The following routes are available for this service:
GET/api/purchaseordersSearch for PurchaseOrders
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 PurchaseOrderItem:
    id: Optional[int] = None
    # @References(typeof(PurchaseOrder))
    purchase_order_id: Optional[int] = None

    # @References(typeof(Product))
    product_id: Optional[str] = None

    product_name: Optional[str] = None
    quantity: Optional[int] = None
    price: Optional[Decimal] = None
    discount_description: Optional[str] = None
    discount_source: Optional[str] = None
    discount: Optional[Decimal] = None
    created_date: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PurchaseOrderDto:
    id: Optional[int] = None
    user_id: Optional[str] = None
    created_date: Optional[datetime.datetime] = None
    payment_type: Optional[str] = None
    void: Optional[bool] = None
    paid: Optional[bool] = None
    transaction_identifier: Optional[str] = None
    coupon_code: Optional[str] = None
    order_items: Optional[List[PurchaseOrderItem]] = None
    payer: Optional[str] = None
    billing_address_line1: Optional[str] = None
    billing_address_city: Optional[str] = None
    billing_address_state: Optional[str] = None
    billing_address_postal_code: Optional[str] = None
    billing_address_country_code: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetPurchaseOrdersResponse:
    results: Optional[List[PurchaseOrderDto]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetPurchaseOrders:
    user_id: Optional[str] = None
    from_date: Optional[datetime.datetime] = None
    to_date: Optional[datetime.datetime] = None
    void: Optional[bool] = None
    paid: Optional[bool] = None
    transaction_identifier: Optional[str] = None
    coupon_code: Optional[str] = None

Python GetPurchaseOrders 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 /api/purchaseorders HTTP/1.1 
Host: accounts.dev.healthmonix.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetPurchaseOrdersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hmx.Accounts.ServiceModels">
  <Results>
    <PurchaseOrderDto>
      <BillingAddressCity>String</BillingAddressCity>
      <BillingAddressCountryCode>String</BillingAddressCountryCode>
      <BillingAddressLine1>String</BillingAddressLine1>
      <BillingAddressPostalCode>String</BillingAddressPostalCode>
      <BillingAddressState>String</BillingAddressState>
      <CouponCode>String</CouponCode>
      <CreatedDate>0001-01-01T00:00:00</CreatedDate>
      <Id>0</Id>
      <OrderItems xmlns:d4p1="http://schemas.datacontract.org/2004/07/Hmx.Accounts.Models">
        <d4p1:PurchaseOrderItem>
          <d4p1:CreatedDate>0001-01-01T00:00:00</d4p1:CreatedDate>
          <d4p1:Discount>0</d4p1:Discount>
          <d4p1:DiscountDescription>String</d4p1:DiscountDescription>
          <d4p1:DiscountSource>String</d4p1:DiscountSource>
          <d4p1:Id>0</d4p1:Id>
          <d4p1:Price>0</d4p1:Price>
          <d4p1:ProductId>String</d4p1:ProductId>
          <d4p1:ProductName>String</d4p1:ProductName>
          <d4p1:PurchaseOrderId>0</d4p1:PurchaseOrderId>
          <d4p1:Quantity>0</d4p1:Quantity>
        </d4p1:PurchaseOrderItem>
      </OrderItems>
      <Paid>false</Paid>
      <Payer>String</Payer>
      <PaymentType>String</PaymentType>
      <TransactionIdentifier>String</TransactionIdentifier>
      <UserId>String</UserId>
      <Void>false</Void>
    </PurchaseOrderDto>
  </Results>
</GetPurchaseOrdersResponse>