SalesOrderController..::..List Method

gets a list of sales orders, given optional filters, top, skip and orderby.

Namespace:  Controllers
Assembly:  JiwaWebAPI (in JiwaWebAPI.dll)

Syntax


[HttpGetAttribute]
public List<SalesOrder> List(
	string filter,
	string top,
	string skip,
	string orderby
)
<HttpGetAttribute> _
Public Function List ( _
	filter As String, _
	top As String, _
	skip As String, _
	orderby As String _
) As List(Of SalesOrder)
[HttpGetAttribute]
public:
List<SalesOrder^>^ List(
	String^ filter, 
	String^ top, 
	String^ skip, 
	String^ orderby
)

Parameters

filter
Type: String
top
Type: String
a query parameter (Sets the filter for the results to return)a query parameter (Sets the maximum number of results to return)
skip
Type: String
a query parameter (Sets the number of results to skip, before return up the $top number of matching items.)
orderby
Type: String

Return Value

A List of JiwaFinancials.Jiwa.JiwaSales.SalesOrder.XML.SalesOrder

Remarks


Use this call to retrieve a list of sales orders. - $filter supports the following fields in the SalesOrder model: InvoiceID, LastSavedDateTime, InvoiceNo, InitiatedDate, InvoiceInitDate, OrderNo, Status, CreditNote, LogicalID, BranchID, SOReference, ExpectedDeliveryDate, OrderType, BillType, EDIStatus, Debtor/DebtorID, Debtor/AccountNo, Debtor/Phone, Debtor/Fax, Debtor.AccountOnHold, Debtor/CurrentBalance - $filter supports the following operators: eq, lt, le, gt, ge, ne - $filter supports the following functions: startswith, endswith, substringof, trim - $top - $skip - $orderby ##Examples## - Example 1: return a list ordered by OrderNo, but only return the 21st and 22nd rows
C#
List?$orderby=OrderNo&$top=2&$skip=20
- Example 2: return a list of sales orders where the SOReference is 'Web' and the LastSavedDateTime is newer than Jan 1 2015, and the status is Entered
C#
List?$filter=SOReference eq 'Web' and LastSavedDateTime ge 2015-01-01T00:00:00Z and Status eq '0'
- Example 3: return a list of sales orders where the SOReference begins with the letters 'we' and the Debtor Account No is '1001'
C#
List?$filter=startswith(SOReference, 'we') and Debtor/AccountNo eq '1001'