Hmx Accounts

<back to all web services

CreatePurchaseOrder

The following routes are available for this service:
POST/api/purchaseordersCreate a new PurchaseOrder
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 Details:
    code: Optional[str] = None
    field: Optional[str] = None
    issue: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreatePurchaseOrderResponse:
    message: Optional[str] = None
    status: Optional[HttpStatusCode] = None
    purchase_order: Optional[PurchaseOrderDto] = None
    details: Optional[List[Details]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PurchaseOrderItemDto:
    id: Optional[int] = None
    purchase_order_id: Optional[int] = None
    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 BillingInformationDto:
    card_number: Optional[str] = None
    card_type: Optional[str] = None
    expire_month: Optional[int] = None
    expire_year: Optional[int] = None
    cvv2: Optional[str] = None
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    city: Optional[str] = None
    country_code: Optional[str] = None
    line1: Optional[str] = None
    postal_code: Optional[str] = None
    state: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreatePurchaseOrder:
    user_id: Optional[str] = None
    user_email: Optional[str] = None
    created_date: Optional[datetime.datetime] = None
    void: Optional[bool] = None
    coupon_code: Optional[str] = None
    order_items: Optional[List[PurchaseOrderItemDto]] = None
    payment_type: Optional[str] = None
    billing_information_dto: Optional[BillingInformationDto] = None

Python CreatePurchaseOrder 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.

POST /api/purchaseorders HTTP/1.1 
Host: accounts.dev.healthmonix.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreatePurchaseOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hmx.Accounts.ServiceModels">
  <BillingInformationDto>
    <CardNumber>String</CardNumber>
    <CardType>String</CardType>
    <City>String</City>
    <CountryCode>String</CountryCode>
    <Cvv2>String</Cvv2>
    <ExpireMonth>0</ExpireMonth>
    <ExpireYear>0</ExpireYear>
    <FirstName>String</FirstName>
    <LastName>String</LastName>
    <Line1>String</Line1>
    <PostalCode>String</PostalCode>
    <State>String</State>
  </BillingInformationDto>
  <CouponCode>String</CouponCode>
  <CreatedDate>0001-01-01T00:00:00</CreatedDate>
  <OrderItems>
    <PurchaseOrderItemDto>
      <CreatedDate>0001-01-01T00:00:00</CreatedDate>
      <Discount>0</Discount>
      <DiscountDescription>String</DiscountDescription>
      <DiscountSource>String</DiscountSource>
      <Id>0</Id>
      <Price>0</Price>
      <ProductId>String</ProductId>
      <ProductName>String</ProductName>
      <PurchaseOrderId>0</PurchaseOrderId>
      <Quantity>0</Quantity>
    </PurchaseOrderItemDto>
  </OrderItems>
  <PaymentType>String</PaymentType>
  <UserEmail>String</UserEmail>
  <UserId>String</UserId>
  <Void>false</Void>
</CreatePurchaseOrder>

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

<CreatePurchaseOrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hmx.Accounts.ServiceModels">
  <Details>
    <Details>
      <Code>String</Code>
      <Field>String</Field>
      <Issue>String</Issue>
    </Details>
  </Details>
  <Message>String</Message>
  <PurchaseOrder>
    <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:d3p1="http://schemas.datacontract.org/2004/07/Hmx.Accounts.Models">
      <d3p1:PurchaseOrderItem>
        <d3p1:CreatedDate>0001-01-01T00:00:00</d3p1:CreatedDate>
        <d3p1:Discount>0</d3p1:Discount>
        <d3p1:DiscountDescription>String</d3p1:DiscountDescription>
        <d3p1:DiscountSource>String</d3p1:DiscountSource>
        <d3p1:Id>0</d3p1:Id>
        <d3p1:Price>0</d3p1:Price>
        <d3p1:ProductId>String</d3p1:ProductId>
        <d3p1:ProductName>String</d3p1:ProductName>
        <d3p1:PurchaseOrderId>0</d3p1:PurchaseOrderId>
        <d3p1:Quantity>0</d3p1:Quantity>
      </d3p1:PurchaseOrderItem>
    </OrderItems>
    <Paid>false</Paid>
    <Payer>String</Payer>
    <PaymentType>String</PaymentType>
    <TransactionIdentifier>String</TransactionIdentifier>
    <UserId>String</UserId>
    <Void>false</Void>
  </PurchaseOrder>
  <Status>Continue</Status>
</CreatePurchaseOrderResponse>