Hmx Accounts

<back to all web services

GetPurchaseOrders

The following routes are available for this service:
GET/api/purchaseordersSearch for PurchaseOrders
GetPurchaseOrders Parameters:
NameParameterData TypeRequiredDescription
UserIdquerystringNo
FromDatequeryDateTime?No
ToDatequeryDateTime?No
Voidquerybool?No
Paidquerybool?No
TransactionIdentifierquerystringNo
CouponCodequerystringNo
GetPurchaseOrdersResponse Parameters:
NameParameterData TypeRequiredDescription
ResultsformList<PurchaseOrderDto>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

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	results: 
	[
		{
			id: 0,
			userId: String,
			createdDate: 0001-01-01,
			paymentType: String,
			void: False,
			paid: False,
			transactionIdentifier: String,
			couponCode: String,
			orderItems: 
			[
				{
					id: 0,
					purchaseOrderId: 0,
					productId: String,
					productName: String,
					quantity: 0,
					price: 0,
					discountDescription: String,
					discountSource: String,
					discount: 0,
					createdDate: 0001-01-01
				}
			],
			payer: String,
			billingAddressLine1: String,
			billingAddressCity: String,
			billingAddressState: String,
			billingAddressPostalCode: String,
			billingAddressCountryCode: String
		}
	]
}