Hmx Accounts

<back to all web services

CreatePurchaseOrder

The following routes are available for this service:
POST/api/purchaseordersCreate a new PurchaseOrder
CreatePurchaseOrder Parameters:
NameParameterData TypeRequiredDescription
UserIdbodystringNo
UserEmailbodystringNo
CreatedDatebodyDateTimeNo
VoidbodyboolNo
CouponCodebodystringNo
OrderItemsbodyList<PurchaseOrderItemDto>No
PaymentTypebodystringNo
BillingInformationDtobodyBillingInformationDtoNo
PurchaseOrderItemDto Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
PurchaseOrderIdformintNo
ProductIdformstringNo
ProductNameformstringNo
QuantityformintNo
PriceformdecimalNo
DiscountDescriptionformstringNo
DiscountSourceformstringNo
DiscountformdecimalNo
CreatedDateformDateTimeNo
BillingInformationDto Parameters:
NameParameterData TypeRequiredDescription
CardNumberformstringNo
CardTypeformstringNo
ExpireMonthformintNo
ExpireYearformintNo
Cvv2formstringNo
FirstNameformstringNo
LastNameformstringNo
CityformstringNo
CountryCodeformstringNo
Line1formstringNo
PostalCodeformstringNo
StateformstringNo
CreatePurchaseOrderResponse Parameters:
NameParameterData TypeRequiredDescription
MessageformstringNo
StatusformHttpStatusCodeNo
PurchaseOrderformPurchaseOrderDtoNo
DetailsformList<Details>No
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
Details Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
FieldformstringNo
IssueformstringNo

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>