Hmx Accounts

<back to all web services

CreatePurchaseOrder

The following routes are available for this service:
POST/api/purchaseordersCreate a new PurchaseOrder
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class CreatePurchaseOrder
{
    var userId:String? = null
    var userEmail:String? = null
    var createdDate:Date? = null
    @SerializedName("void") var Void:Boolean? = null
    var couponCode:String? = null
    var orderItems:ArrayList<PurchaseOrderItemDto> = ArrayList<PurchaseOrderItemDto>()
    var paymentType:String? = null
    var billingInformationDto:BillingInformationDto? = null
}

open class PurchaseOrderItemDto
{
    var id:Int? = null
    var purchaseOrderId:Int? = null
    var productId:String? = null
    var productName:String? = null
    var quantity:Int? = null
    var price:BigDecimal? = null
    var discountDescription:String? = null
    var discountSource:String? = null
    var discount:BigDecimal? = null
    var createdDate:Date? = null
}

open class BillingInformationDto
{
    var cardNumber:String? = null
    var cardType:String? = null
    var expireMonth:Int? = null
    var expireYear:Int? = null
    var cvv2:String? = null
    var firstName:String? = null
    var lastName:String? = null
    var city:String? = null
    var countryCode:String? = null
    var line1:String? = null
    var postalCode:String? = null
    var state:String? = null
}

open class CreatePurchaseOrderResponse
{
    var message:String? = null
    var status:HttpStatusCode? = null
    var purchaseOrder:PurchaseOrderDto? = null
    var details:ArrayList<Details> = ArrayList<Details>()
}

open class PurchaseOrderDto
{
    var id:Int? = null
    var userId:String? = null
    var createdDate:Date? = null
    var paymentType:String? = null
    @SerializedName("void") var Void:Boolean? = null
    var paid:Boolean? = null
    var transactionIdentifier:String? = null
    var couponCode:String? = null
    var orderItems:ArrayList<PurchaseOrderItem> = ArrayList<PurchaseOrderItem>()
    var payer:String? = null
    var billingAddressLine1:String? = null
    var billingAddressCity:String? = null
    var billingAddressState:String? = null
    var billingAddressPostalCode:String? = null
    var billingAddressCountryCode:String? = null
}

open class PurchaseOrderItem
{
    var id:Int? = null
    @References(PurchaseOrder.class)
    var purchaseOrderId:Int? = null

    @References(Product.class)
    var productId:String? = null

    var productName:String? = null
    var quantity:Int? = null
    var price:BigDecimal? = null
    var discountDescription:String? = null
    var discountSource:String? = null
    var discount:BigDecimal? = null
    var createdDate:Date? = null
}

open class Details
{
    var code:String? = null
    var field:String? = null
    var issue:String? = null
}

Kotlin 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>