All Verbs | /service/QueryInvoices |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Search | query | string | No | |
InvoiceNumber | query | string | No | |
OrderNumber | query | string | No | |
DateRange | query | string | No | |
currentDate | query | DateTime | No | |
clientDateTime | 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 |
---|---|---|---|---|
Lines | form | List<TLine> | No | |
LineCount | form | int | No | |
QtyShipped | form | int | No | |
QtyOrdered | form | int | No | |
Weight | form | double | No | |
CubicVolume | form | double | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
InvoiceNumber | form | string | No | |
RetailerId | form | string | No | |
ShipId | form | string | No | |
OrderNumber | form | string | No | |
Status | form | string | No | |
PONumber | form | string | No | |
TransactionType | form | string | No | |
DueDate | form | DateTime | No | |
OrderDate | form | DateTime | No | |
InvoiceDate | form | DateTime | No | |
ShipOn | form | DateTime | No | |
InvoiceTotal | form | decimal | No | |
InvoiceBalance | form | decimal | No | |
OrderTotal | form | decimal | No | |
TotalOrder | form | decimal | No | |
TotalOrderAmount | form | decimal | No | |
ActivationCode | form | string | No | |
TaxCharges | form | decimal | No | |
AdditionalCharges | form | decimal | No | |
TotalShipped | form | decimal | No | |
TotalFreight | form | decimal | No | |
TotalDiscount | form | decimal | No | |
DaysPastDue | form | int | No | |
Revision | form | int | No | |
Custom1 | form | string | No | |
Custom2 | form | string | No | |
CustomerPORef | form | string | No | |
TagFor | form | string | No | |
CompanyName | form | string | No | |
BillAddress | form | string | No | |
BillAddress2 | form | string | No | |
BillCity | form | string | No | |
BillState | form | string | No | |
BillZip | form | string | No | |
BillCountry | form | string | No | |
BillPhone | form | string | No | |
BillName | form | string | No | |
BillingLocation | form | AddressInfo | No | |
ShippingLocationAddress | form | string | No | |
ShippingLocationAddress2 | form | string | No | |
ShippingLocationCity | form | string | No | |
ShippingLocationState | form | string | No | |
ShippingLocationZip | form | string | No | |
ShippingLocationCountry | form | string | No | |
ShippingLocationPhone | form | string | No | |
ShippingLocationName | form | string | No | |
Source | form | string | No | |
Buyer | form | string | No | |
ShippingLocation | form | AddressInfo | No | |
PaymentTermsId | form | string | No | |
PaymentTermInvoice | form | PaymentTermInvoice | No | |
ShippingMethodId | form | string | No | |
ShippingMethodInvoice | form | ShippingMethodInvoice | No | |
CreditCardType | form | string | No | |
SalesRepID | form | string | No | |
SalesRep | form | SalesRep | No | |
WritingRepID | form | string | No | |
WritingRep | form | InvoiceWritingRep | No | |
RetailerEmail | form | string | No | |
VendorId | form | string | No | |
Vendor | form | Vendor | No | |
SourceId | form | string | No | |
Messages | form | IList<string> | No | |
ParcelCount | form | int | No | |
Meta | form | Dictionary<string, string> | No | |
Tags | form | Dictionary<string, HashSet<String>> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | K | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
CompanyName | form | string | No | |
PersonName | form | PersonNameInfo | No | |
Address | form | string | No | |
Address1 | form | string | No | |
Address2 | form | string | No | |
City | form | string | No | |
State | form | string | No | |
Zip | form | string | No | |
Country | form | string | No | |
Phone | form | string | No | |
Fax | form | string | No | |
form | string | No | ||
StoreSize | form | string | No | |
Custom2 | form | string | No | |
AccountType | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Salutation | form | string | No | |
First | form | string | No | |
Middle | form | string | No | |
Last | form | string | No | |
Suffix | form | string | No | |
Full | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Name | form | string | No | |
IsCredit | form | bool | No | |
IsStandard | form | bool | No | |
IsB2B | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Name | form | string | No | |
IsStandard | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Name | form | string | No | |
form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Name | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Label | form | string | No | |
VendorName | form | string | No | |
Abbreviation | form | string | No | |
OrderMinimum | form | decimal | No | |
ReOrderMinimum | form | decimal | No | |
MinimumBalance | form | decimal | No | |
Active | form | bool | No | |
IsInvoiceOnly | form | bool | No | |
AllowPriceOverride | form | bool | No | |
DefaultShipDatePrevious | form | bool | No | |
EnforceMinimums | form | bool | No | |
EnforcePurchaseIncrement | form | bool | No | |
AllowDiscounts | form | bool | No | |
EmailOrders | form | bool | No | |
AllowBackorders | form | bool | No | |
UseVendorCustId | form | bool | No | |
UseVendorShipId | form | bool | No | |
UseVendorTerms | form | bool | No | |
ExportReviewOrders | form | bool | No | |
EmailUrlToExport | form | bool | No | |
IncludeInBatch | form | bool | No | |
DecryptCCOnExport | form | bool | No | |
CustomerNumber | form | string | No | |
ExportOrders | form | bool | No | |
SplitByProductLine | form | bool | No | |
IsShowroomVendor | form | bool | No | |
AllowManualItemEntry | form | bool | No | |
RequireCreditSheet | form | bool | No | |
Address | form | string | No | |
City | form | string | No | |
State | form | string | No | |
Zip | form | string | No | |
Phone | form | string | No | |
Fax | form | string | No | |
form | string | No | ||
Website | form | string | No | |
Note | form | string | No | |
CommissionPercent | form | decimal | No | |
OrderTagLine | form | string | No | |
ProductTags | form | List<VendorProductTag> | No | |
Settings | form | List<VendorSetting> | No | |
LastLoginAttempt | form | DateTime | No | |
LastOrderedOn | form | DateTime | No | |
Meta | form | Dictionary<string, string> | No | |
Tags | form | Dictionary<string, HashSet<String>> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Tag | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
VendorId | form | string | No | |
Key | form | string | No | |
Value | form | 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/QueryInvoices HTTP/1.1
Host: www.bernhardthospitality.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
search: String,
invoiceNumber: String,
orderNumber: String,
dateRange: String,
currentDate: 0001-01-01,
clientDateTime: 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: [ { lines: [ { 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 } } ], lineCount: 1, qtyShipped: 0, qtyOrdered: 0, weight: 0, cubicVolume: 0, id: String, invoiceNumber: String, retailerId: String, shipId: String, orderNumber: String, status: String, poNumber: String, transactionType: String, dueDate: 0001-01-01, orderDate: 0001-01-01, invoiceDate: 0001-01-01, shipOn: 0001-01-01, invoiceTotal: 0, invoiceBalance: 0, orderTotal: 0, totalOrder: 0, totalOrderAmount: 0, activationCode: String, taxCharges: 0, additionalCharges: 0, totalShipped: 0, totalFreight: 0, totalDiscount: 0, daysPastDue: 0, revision: 0, custom1: String, custom2: String, customerPORef: String, tagFor: String, companyName: String, billAddress: String, billAddress2: String, billCity: String, billState: String, billZip: String, billCountry: String, billPhone: String, billName: String, billingLocation: { id: String, companyName: String, personName: { salutation: "", first: String, middle: "", last: "", suffix: "", full: String }, address: String, address1: String, address2: String, city: String, state: String, zip: String, country: String, meta: {} }, shippingLocationAddress: String, shippingLocationAddress2: String, shippingLocationCity: String, shippingLocationState: String, shippingLocationZip: String, shippingLocationCountry: String, shippingLocationPhone: String, shippingLocationName: String, source: String, buyer: String, shippingLocation: { id: String, companyName: String, personName: { salutation: "", first: String, middle: "", last: "", suffix: "", full: String }, address: String, address1: String, address2: String, city: String, state: String, zip: String, country: String, meta: {} }, paymentTermsId: String, paymentTermInvoice: { id: String, name: String, isCredit: False, isStandard: False, isB2B: False }, shippingMethodId: String, shippingMethodInvoice: { id: String, name: String, isStandard: False }, creditCardType: String, salesRepID: String, salesRep: { id: String, name: String, email: String }, writingRepID: String, writingRep: { id: String, name: String }, retailerEmail: String, vendorId: String, vendor: { id: String, label: String, vendorName: String, abbreviation: String, orderMinimum: 0, reOrderMinimum: 0, minimumBalance: 0, active: False, isInvoiceOnly: False, allowPriceOverride: False, defaultShipDatePrevious: False, enforceMinimums: False, enforcePurchaseIncrement: False, allowDiscounts: False, emailOrders: False, allowBackorders: False, useVendorCustId: False, useVendorShipId: False, useVendorTerms: False, exportReviewOrders: False, emailUrlToExport: False, includeInBatch: False, decryptCCOnExport: False, customerNumber: String, exportOrders: False, splitByProductLine: False, isShowroomVendor: False, allowManualItemEntry: False, requireCreditSheet: False, address: String, city: String, state: String, zip: String, phone: String, fax: String, email: String, website: String, note: String, commissionPercent: 0, orderTagLine: String, productTags: [ { id: String, tag: String } ], settings: [ { vendorId: String, key: String, value: String } ], lastLoginAttempt: 0001-01-01, lastOrderedOn: 0001-01-01, meta: { String: String }, tags: { String: [ String ] } }, sourceId: String, parcelCount: 0, meta: { String: String }, tags: { 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 } } }