Chinook

<back to all web services

QueryInvoices

AutoQueryStore
The following routes are available for this service:
GET/invoices
GET/invoices/{InvoiceId}
QueryInvoices Parameters:
NameParameterData TypeRequiredDescription
InvoiceIdpathlong?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
Invoices Parameters:
NameParameterData TypeRequiredDescription
InvoiceIdformlongNo
CustomerIdformlongNo
InvoiceDateformDateTimeNo
BillingAddressformstringNo
BillingCityformstringNo
BillingStateformstringNo
BillingCountryformstringNo
BillingPostalCodeformstringNo
TotalformdecimalNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /invoices HTTP/1.1 
Host: chinook.netcore.io 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"offset":0,"total":0,"results":[{"invoiceId":0,"customerId":0,"invoiceDate":"\/Date(-62135596800000-0000)\/","billingAddress":"String","billingCity":"String","billingState":"String","billingCountry":"String","billingPostalCode":"String","total":0}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}