Hmx Accounts

<back to all web services

GetPurchaseOrder

The following routes are available for this service:
GET/api/purchaseorders/{id}Get a PurchaseOrder
GetPurchaseOrder Parameters:
NameParameterData TypeRequiredDescription
IdpathintNo
PurchaseOrderDto Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
UserIdformstringNo
CreatedDateformDateTimeNo
PaymentTypeformstringNo
VoidformboolNo
PaidformboolNo
TransactionIdentifierformstringNo
CouponCodeformstringNo
OrderItemsformList<PurchaseOrderItem>No
PayerformstringNo
BillingAddressLine1formstringNo
BillingAddressCityformstringNo
BillingAddressStateformstringNo
BillingAddressPostalCodeformstringNo
BillingAddressCountryCodeformstringNo
PurchaseOrderItem Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
PurchaseOrderIdformintNo
ProductIdformstringNo
ProductNameformstringNo
QuantityformintNo
PriceformdecimalNo
DiscountDescriptionformstringNo
DiscountSourceformstringNo
DiscountformdecimalNo
CreatedDateformDateTimeNo

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>