Hmx Accounts

<back to all web services

GetPurchaseOrders

The following routes are available for this service:
GET/api/purchaseordersSearch for PurchaseOrders

export class PurchaseOrderItem
{
    public id?: number;
    // @References("typeof(Hmx.Accounts.Models.PurchaseOrder)")
    public purchaseOrderId?: number;

    // @References("typeof(Hmx.Accounts.Models.Product)")
    public productId?: string;

    public productName?: string;
    public quantity?: number;
    public price?: number;
    public discountDescription?: string;
    public discountSource?: string;
    public discount?: number;
    public createdDate?: string;

    public constructor(init?: Partial<PurchaseOrderItem>) { (Object as any).assign(this, init); }
}

export class PurchaseOrderDto
{
    public id?: number;
    public userId?: string;
    public createdDate?: string;
    public paymentType?: string;
    public void?: boolean;
    public paid?: boolean;
    public transactionIdentifier?: string;
    public couponCode?: string;
    public orderItems?: PurchaseOrderItem[];
    public payer?: string;
    public billingAddressLine1?: string;
    public billingAddressCity?: string;
    public billingAddressState?: string;
    public billingAddressPostalCode?: string;
    public billingAddressCountryCode?: string;

    public constructor(init?: Partial<PurchaseOrderDto>) { (Object as any).assign(this, init); }
}

export class GetPurchaseOrdersResponse
{
    public results?: PurchaseOrderDto[];

    public constructor(init?: Partial<GetPurchaseOrdersResponse>) { (Object as any).assign(this, init); }
}

export class GetPurchaseOrders
{
    public userId?: string;
    public fromDate?: string;
    public toDate?: string;
    public void?: boolean;
    public paid?: boolean;
    public transactionIdentifier?: string;
    public couponCode?: string;

    public constructor(init?: Partial<GetPurchaseOrders>) { (Object as any).assign(this, init); }
}

TypeScript GetPurchaseOrders 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 HTTP/1.1 
Host: accounts.dev.healthmonix.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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