GET | /api/purchaseorders | Search for PurchaseOrders |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UserId | query | string | No | |
FromDate | query | DateTime? | No | |
ToDate | query | DateTime? | No | |
Void | query | bool? | No | |
Paid | query | bool? | No | |
TransactionIdentifier | query | string | No | |
CouponCode | query | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Results | form | List<PurchaseOrderDto> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
UserId | form | string | No | |
CreatedDate | form | DateTime | No | |
PaymentType | form | string | No | |
Void | form | bool | No | |
Paid | form | bool | No | |
TransactionIdentifier | form | string | No | |
CouponCode | form | string | No | |
OrderItems | form | List<PurchaseOrderItem> | No | |
Payer | form | string | No | |
BillingAddressLine1 | form | string | No | |
BillingAddressCity | form | string | No | |
BillingAddressState | form | string | No | |
BillingAddressPostalCode | form | string | No | |
BillingAddressCountryCode | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
PurchaseOrderId | form | int | No | |
ProductId | form | string | No | |
ProductName | form | string | No | |
Quantity | form | int | No | |
Price | form | decimal | No | |
DiscountDescription | form | string | No | |
DiscountSource | form | string | No | |
Discount | form | decimal | No | |
CreatedDate | form | DateTime | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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 } ] }