| GET | /Queries/sh_SalesOrders | Retrieves a list of sh sales orders |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| InvoiceID | query | string | No | |
| InvoiceIDStartsWith | query | string | No | |
| InvoiceIDEndsWith | query | string | No | |
| InvoiceIDContains | query | string | No | |
| InvoiceIDLike | query | string | No | |
| InvoiceIDBetween | query | string[] | No | |
| InvoiceIDIn | query | string[] | No | |
| Source | query | string | No | |
| DocType | query | int | No | |
| DebtorID | 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 |
|---|---|---|---|---|
| InvoiceID | form | string | No | |
| LastSavedDateTime | form | DateTime | No | |
| DebtorID | form | string | No | |
| StaffID | form | string | No | |
| InvoiceNo | form | string | No | |
| InvoiceInitDate | form | DateTime | No | |
| InvoiceLastDate | form | DateTime | No | |
| OrderNo | form | string | No | |
| TaxExemptNo | form | string | No | |
| InvoiceTotal | form | decimal? | No | |
| CurrentHistoryNo | form | short? | No | |
| Status | form | int? | No | |
| BillWhenComplete | form | short | No | |
| CreditNote | form | bool | No | |
| InvoiceType | form | short? | No | |
| GroupSupplierID | form | string | No | |
| IN_LogicalID | form | string | No | |
| BranchID | form | string | No | |
| SOReference | form | string | No | |
| ParentDebtorID | form | string | No | |
| BackOrderMode | form | short | No | |
| DocType | form | int | No | |
| GSTInvoice | form | bool | No | |
| ExpectedDeliveryDate | form | DateTime? | No | |
| SourceQuoteID | form | string | No | |
| PriceSchemeID | form | string | No | |
| LastModifiedBy | form | string | No | |
| InvoiceHistoryID | form | string | No | |
| RecordDate | form | DateTime | No | |
| Ref | form | string | No | |
| HistoryNo | form | short? | No | |
| HistoryTotal | form | decimal? | No | |
| DelAddress1 | form | string | No | |
| DelAddress2 | form | string | No | |
| DelAddress3 | form | string | No | |
| DelAddress4 | form | string | No | |
| HistoryPostCode | form | string | No | |
| Notes | form | string | No | |
| CourierDetails | form | string | No | |
| PaymentTypeID | form | string | No | |
| PaymentRef | form | string | No | |
| AmountPaid | form | decimal? | No | |
| RunNo | form | string | No | |
| DelContactName | form | string | No | |
| Delivered | form | bool | No | |
| DeliveredDate | form | DateTime? | No | |
| FreightForwardAddress1 | form | string | No | |
| FreightForwardAddress2 | form | string | No | |
| FreightForwardAddress3 | form | string | No | |
| FreightForwardAddress4 | form | string | No | |
| FreightForwardNotes | form | string | No | |
| HistoryStatus | form | byte? | No | |
| EmailAddress | form | string | No | |
| ConsignmentNote | form | string | No | |
| DateCreated | form | DateTime? | No | |
| DateLastSaved | form | DateTime? | No | |
| DatePosted | form | DateTime? | No | |
| DateProcessed | form | DateTime? | No | |
| DropShipment | form | bool | No | |
| DeliveryAddressee | form | string | No | |
| DeliveryAddressCountry | form | string | No | |
| FreightForwardAddressCountry | form | string | No | |
| OrderedByID | form | string | No | |
| DeliveryContactID | form | string | No | |
| CostCenter | form | string | No | |
| ExpressedInterestInInsurance | form | bool | No | |
| PrimaryOrderID | form | string | No | |
| InsuranceOrderID | form | string | No | |
| HasWarrantyUplift | form | bool | No | |
| HasLicensing | form | bool | No | |
| WarrantyUpliftDocumentCount | form | int | No | |
| LicenseDocumentCount | form | int | No | |
| Source | form | string | No | |
| DispatchedOn | form | DateTime | 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Queries/sh_SalesOrders HTTP/1.1 Host: localhost Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Results":[{"InvoiceID":"String","DebtorID":"String","StaffID":"String","InvoiceNo":"String","OrderNo":"String","TaxExemptNo":"String","InvoiceTotal":0,"CurrentHistoryNo":0,"Status":0,"InvoiceType":0,"GroupSupplierID":"String","IN_LogicalID":"String","BranchID":"String","SOReference":"String","ParentDebtorID":"String","ExpectedDeliveryDate":"0001-01-01T00:00:00.0000000","SourceQuoteID":"String","PriceSchemeID":"String","LastModifiedBy":"String","InvoiceHistoryID":"String","Ref":"String","HistoryNo":0,"HistoryTotal":0,"DelAddress1":"String","DelAddress2":"String","DelAddress3":"String","DelAddress4":"String","HistoryPostCode":"String","Notes":"String","CourierDetails":"String","PaymentTypeID":"String","PaymentRef":"String","AmountPaid":0,"RunNo":"String","DelContactName":"String","DeliveredDate":"0001-01-01T00:00:00.0000000","FreightForwardAddress1":"String","FreightForwardAddress2":"String","FreightForwardAddress3":"String","FreightForwardAddress4":"String","FreightForwardNotes":"String","HistoryStatus":0,"EmailAddress":"String","ConsignmentNote":"String","DateCreated":"0001-01-01T00:00:00.0000000","DateLastSaved":"0001-01-01T00:00:00.0000000","DatePosted":"0001-01-01T00:00:00.0000000","DateProcessed":"0001-01-01T00:00:00.0000000","DeliveryAddressee":"String","DeliveryAddressCountry":"String","FreightForwardAddressCountry":"String","OrderedByID":"String","DeliveryContactID":"String","CostCenter":"String","PrimaryOrderID":"String","InsuranceOrderID":"String","Source":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}