All Verbs | /service/QueryInvoiceLines |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Search | query | string | No | |
InvoiceNumber | query | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | int? | No | |
Take | form | int? | No | |
OrderBy | form | string | No | |
OrderByDesc | form | string | No | |
Include | form | string | No | |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
InvoiceNumber | form | string | No | |
Position | form | int | No | |
ProductId | form | string | No | |
Product | form | Product | No | |
Description | form | string | No | |
QtyOrdered | form | int | No | |
QtyShipped | form | int | No | |
QtyBackordered | form | int | No | |
Price | form | decimal | No | |
ListPrice | form | decimal | No | |
Notes | form | string | No | |
UOM | form | string | No | |
VendorId | form | string | No | |
LineTotal | form | decimal | No | |
ExtendedTotal | form | decimal | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
ProductLineId | form | string | No | |
ManufacturerNumber | form | string | No | |
ShortDescription | form | string | No | |
LongDescription | form | string | No | |
AltDescription | form | string | No | |
UpcCode | form | string | No | |
Status | form | string | No | |
Pricing | form | IDictionary<int, double> | No | |
ListPrice | form | decimal | No | |
WholesalePrice | form | decimal | No | |
RetailPrice | form | decimal? | No | |
RetailListPrice | form | decimal | No | |
UnitsInStock | form | int | No | |
CategoryId | form | string | No | |
MinimumOrderQty | form | double | No | |
AvailableQty | form | double | No | |
AvailableOn | form | DateTime? | No | |
IncomingQty | form | double | No | |
PurchaseIncrement | form | double | No | |
OptionGroup | form | string | No | |
OptionGroupList | form | string | No | |
VendorId | form | string | No | |
ItemType | form | string | No | |
ImageUrl | form | string | No | |
OnDemandProductEuid | form | string | No | |
Keywords | form | string | No | |
SuperCategory | form | string | No | |
IsNew | form | bool | No | |
IsRestricted | form | bool | No | |
CreatedOn | form | DateTime | No | |
Weight | form | double | No | |
Height | form | decimal | No | |
Length | form | decimal | No | |
CubicVolume | form | double | No | |
Cost | form | decimal | No | |
UOM | form | string | No | |
SubCategory | form | string | No | |
ShipOn | form | DateTime? | No | |
Featured | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<T> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | 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.
POST /service/QueryInvoiceLines HTTP/1.1
Host: www.bernhardt.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
search: String,
invoiceNumber: String,
skip: 0,
take: 0,
orderBy: String,
orderByDesc: String,
include: String,
fields: String,
meta:
{
String: String
}
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { offset: 0, total: 0, results: [ { invoiceNumber: String, position: 0, productId: String, product: { id: String, productLineId: String, manufacturerNumber: String, shortDescription: String, longDescription: String, altDescription: String, upcCode: String, status: String, listPrice: 0, wholesalePrice: 0, retailPrice: 0, retailListPrice: 0, unitsInStock: 0, categoryId: String, minimumOrderQty: 0, availableQty: 0, availableOn: 0001-01-01, incomingQty: 0, purchaseIncrement: 0, optionGroup: String, optionGroupList: String, vendorId: String, itemType: String, imageUrl: String, onDemandProductEuid: String, keywords: String, superCategory: String, isNew: False, isRestricted: False, createdOn: 0001-01-01, weight: 0, height: 0, length: 0, cubicVolume: 0, cost: 0, uom: String, subCategory: String, shipOn: 0001-01-01, featured: 0 }, description: String, qtyOrdered: 0, qtyShipped: 0, qtyBackordered: 0, price: 0, listPrice: 0, notes: String, uom: String, vendorId: String, lineTotal: 0, extendedTotal: 0, meta: { String: String } } ], meta: { String: String }, responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } } }