JiwaAPI

<back to all web services

SO_MainQuery

Requires Authentication
The following routes are available for this service:
GET/Queries/SO_MainRetrieves a list of sales orders.
SO_MainQuery Parameters:
NameParameterData TypeRequiredDescription
InvoiceIDquerystringNo
InvoiceIDStartsWithquerystringNo
InvoiceIDEndsWithquerystringNo
InvoiceIDContainsquerystringNo
InvoiceIDLikequerystringNo
InvoiceIDBetweenquerystring[]No
InvoiceIDInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
DebtorIDquerystringNo
DebtorIDStartsWithquerystringNo
DebtorIDEndsWithquerystringNo
DebtorIDContainsquerystringNo
DebtorIDLikequerystringNo
DebtorIDBetweenquerystring[]No
DebtorIDInquerystring[]No
StaffIDquerystringNo
StaffIDStartsWithquerystringNo
StaffIDEndsWithquerystringNo
StaffIDContainsquerystringNo
StaffIDLikequerystringNo
StaffIDBetweenquerystring[]No
StaffIDInquerystring[]No
InvoiceNoquerystringNo
InvoiceNoStartsWithquerystringNo
InvoiceNoEndsWithquerystringNo
InvoiceNoContainsquerystringNo
InvoiceNoLikequerystringNo
InvoiceNoBetweenquerystring[]No
InvoiceNoInquerystring[]No
InvoiceInitDatequeryDateTime?No
InvoiceInitDateGreaterThanOrEqualToqueryDateTime?No
InvoiceInitDateGreaterThanqueryDateTime?No
InvoiceInitDateLessThanqueryDateTime?No
InvoiceInitDateLessThanOrEqualToqueryDateTime?No
InvoiceInitDateNotEqualToqueryDateTime?No
InvoiceInitDateBetweenqueryDateTime[]No
InvoiceInitDateInqueryDateTime[]No
InvoiceLastDatequeryDateTime?No
InvoiceLastDateGreaterThanOrEqualToqueryDateTime?No
InvoiceLastDateGreaterThanqueryDateTime?No
InvoiceLastDateLessThanqueryDateTime?No
InvoiceLastDateLessThanOrEqualToqueryDateTime?No
InvoiceLastDateNotEqualToqueryDateTime?No
InvoiceLastDateBetweenqueryDateTime[]No
InvoiceLastDateInqueryDateTime[]No
OrderNoquerystringNo
OrderNoStartsWithquerystringNo
OrderNoEndsWithquerystringNo
OrderNoContainsquerystringNo
OrderNoLikequerystringNo
OrderNoBetweenquerystring[]No
OrderNoInquerystring[]No
TaxExemptNoquerystringNo
TaxExemptNoStartsWithquerystringNo
TaxExemptNoEndsWithquerystringNo
TaxExemptNoContainsquerystringNo
TaxExemptNoLikequerystringNo
TaxExemptNoBetweenquerystring[]No
TaxExemptNoInquerystring[]No
WholeSaleInvoicequerybool?No
InvoiceTotalquerydecimal?No
InvoiceTotalGreaterThanOrEqualToquerydecimal?No
InvoiceTotalGreaterThanquerydecimal?No
InvoiceTotalLessThanquerydecimal?No
InvoiceTotalLessThanOrEqualToquerydecimal?No
InvoiceTotalNotEqualToquerydecimal?No
InvoiceTotalBetweenqueryNullable<Decimal>[]No
InvoiceTotalInqueryNullable<Decimal>[]No
CurrentHistoryNoqueryshort?No
CurrentHistoryNoGreaterThanOrEqualToqueryshort?No
CurrentHistoryNoGreaterThanqueryshort?No
CurrentHistoryNoLessThanqueryshort?No
CurrentHistoryNoLessThanOrEqualToqueryshort?No
CurrentHistoryNoNotEqualToqueryshort?No
CurrentHistoryNoBetweenqueryNullable<Int16>[]No
CurrentHistoryNoInqueryNullable<Int16>[]No
Statusqueryshort?No
StatusGreaterThanOrEqualToqueryshort?No
StatusGreaterThanqueryshort?No
StatusLessThanqueryshort?No
StatusLessThanOrEqualToqueryshort?No
StatusNotEqualToqueryshort?No
StatusBetweenqueryNullable<Int16>[]No
StatusInqueryNullable<Int16>[]No
BillWhenCompletequeryshort?No
BillWhenCompleteGreaterThanOrEqualToqueryshort?No
BillWhenCompleteGreaterThanqueryshort?No
BillWhenCompleteLessThanqueryshort?No
BillWhenCompleteLessThanOrEqualToqueryshort?No
BillWhenCompleteNotEqualToqueryshort?No
BillWhenCompleteBetweenqueryshort[]No
BillWhenCompleteInqueryshort[]No
CreditNotequerybool?No
InvoiceTypequeryshort?No
InvoiceTypeGreaterThanOrEqualToqueryshort?No
InvoiceTypeGreaterThanqueryshort?No
InvoiceTypeLessThanqueryshort?No
InvoiceTypeLessThanOrEqualToqueryshort?No
InvoiceTypeNotEqualToqueryshort?No
InvoiceTypeBetweenqueryNullable<Int16>[]No
InvoiceTypeInqueryNullable<Int16>[]No
GroupSupplierIDquerystringNo
GroupSupplierIDStartsWithquerystringNo
GroupSupplierIDEndsWithquerystringNo
GroupSupplierIDContainsquerystringNo
GroupSupplierIDLikequerystringNo
GroupSupplierIDBetweenquerystring[]No
GroupSupplierIDInquerystring[]No
GroupOrderedquerybool?No
IN_LogicalIDquerystringNo
IN_LogicalIDStartsWithquerystringNo
IN_LogicalIDEndsWithquerystringNo
IN_LogicalIDContainsquerystringNo
IN_LogicalIDLikequerystringNo
IN_LogicalIDBetweenquerystring[]No
IN_LogicalIDInquerystring[]No
BranchIDquerystringNo
BranchIDStartsWithquerystringNo
BranchIDEndsWithquerystringNo
BranchIDContainsquerystringNo
BranchIDLikequerystringNo
BranchIDBetweenquerystring[]No
BranchIDInquerystring[]No
SOReferencequerystringNo
SOReferenceStartsWithquerystringNo
SOReferenceEndsWithquerystringNo
SOReferenceContainsquerystringNo
SOReferenceLikequerystringNo
SOReferenceBetweenquerystring[]No
SOReferenceInquerystring[]No
JobCostIDquerystringNo
JobCostIDStartsWithquerystringNo
JobCostIDEndsWithquerystringNo
JobCostIDContainsquerystringNo
JobCostIDLikequerystringNo
JobCostIDBetweenquerystring[]No
JobCostIDInquerystring[]No
ParentDebtorIDquerystringNo
ParentDebtorIDStartsWithquerystringNo
ParentDebtorIDEndsWithquerystringNo
ParentDebtorIDContainsquerystringNo
ParentDebtorIDLikequerystringNo
ParentDebtorIDBetweenquerystring[]No
ParentDebtorIDInquerystring[]No
BackOrderModequeryshort?No
BackOrderModeGreaterThanOrEqualToqueryshort?No
BackOrderModeGreaterThanqueryshort?No
BackOrderModeLessThanqueryshort?No
BackOrderModeLessThanOrEqualToqueryshort?No
BackOrderModeNotEqualToqueryshort?No
BackOrderModeBetweenqueryshort[]No
BackOrderModeInqueryshort[]No
DebtorContactNamequerystringNo
DebtorContactNameStartsWithquerystringNo
DebtorContactNameEndsWithquerystringNo
DebtorContactNameContainsquerystringNo
DebtorContactNameLikequerystringNo
DebtorContactNameBetweenquerystring[]No
DebtorContactNameInquerystring[]No
DocTypequeryint?No
DocTypeGreaterThanOrEqualToqueryint?No
DocTypeGreaterThanqueryint?No
DocTypeLessThanqueryint?No
DocTypeLessThanOrEqualToqueryint?No
DocTypeNotEqualToqueryint?No
DocTypeBetweenqueryNullable<Int32>[]No
DocTypeInqueryNullable<Int32>[]No
GSTInvoicequerybool?No
ExpectedDeliveryDatequeryDateTime?No
ExpectedDeliveryDateGreaterThanOrEqualToqueryDateTime?No
ExpectedDeliveryDateGreaterThanqueryDateTime?No
ExpectedDeliveryDateLessThanqueryDateTime?No
ExpectedDeliveryDateLessThanOrEqualToqueryDateTime?No
ExpectedDeliveryDateNotEqualToqueryDateTime?No
ExpectedDeliveryDateBetweenqueryNullable<DateTime>[]No
ExpectedDeliveryDateInqueryNullable<DateTime>[]No
SourceQuoteHistoryIDquerystringNo
SourceQuoteHistoryIDStartsWithquerystringNo
SourceQuoteHistoryIDEndsWithquerystringNo
SourceQuoteHistoryIDContainsquerystringNo
SourceQuoteHistoryIDLikequerystringNo
SourceQuoteHistoryIDBetweenquerystring[]No
SourceQuoteHistoryIDInquerystring[]No
PriceSchemeIDquerystringNo
PriceSchemeIDStartsWithquerystringNo
PriceSchemeIDEndsWithquerystringNo
PriceSchemeIDContainsquerystringNo
PriceSchemeIDLikequerystringNo
PriceSchemeIDBetweenquerystring[]No
PriceSchemeIDInquerystring[]No
CreditReasonIDquerystringNo
CreditReasonIDStartsWithquerystringNo
CreditReasonIDEndsWithquerystringNo
CreditReasonIDContainsquerystringNo
CreditReasonIDLikequerystringNo
CreditReasonIDBetweenquerystring[]No
CreditReasonIDInquerystring[]No
CreditIntoStockquerybool?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SO_Main Parameters:
NameParameterData TypeRequiredDescription
InvoiceIDformstringNo
LastSavedDateTimeformDateTimeNo
DebtorIDformstringNo
StaffIDformstringNo
InvoiceNoformstringNo
InvoiceInitDateformDateTimeNo
InvoiceLastDateformDateTimeNo
OrderNoformstringNo
TaxExemptNoformstringNo
WholeSaleInvoiceformboolNo
InvoiceTotalformdecimal?No
CurrentHistoryNoformshort?No
Statusformshort?No
BillWhenCompleteformshortNo
CreditNoteformboolNo
InvoiceTypeformshort?No
GroupSupplierIDformstringNo
GroupOrderedformboolNo
IN_LogicalIDformstringNo
BranchIDformstringNo
SOReferenceformstringNo
JobCostIDformstringNo
ParentDebtorIDformstringNo
BackOrderModeformshortNo
DebtorContactNameformstringNo
DocTypeformint?No
GSTInvoiceformboolNo
ExpectedDeliveryDateformDateTime?No
SourceQuoteHistoryIDformstringNo
PriceSchemeIDformstringNo
CreditReasonIDformstringNo
CreditIntoStockformboolNo
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /Queries/SO_Main HTTP/1.1 
Host: api.jiwa.com.au 
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","JobCostID":"String","ParentDebtorID":"String","DebtorContactName":"String","DocType":0,"ExpectedDeliveryDate":"0001-01-01T00:00:00.0000000","SourceQuoteHistoryID":"String","PriceSchemeID":"String","CreditReasonID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}