Hmx Accounts

<back to all web services

GetPurchaseOrder

The following routes are available for this service:
GET/api/purchaseorders/{id}Get a PurchaseOrder
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class GetPurchaseOrder
{
    var id:Int? = null
}

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
}

Kotlin GetPurchaseOrder 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/{id} HTTP/1.1 
Host: accounts.dev.healthmonix.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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