GET | /Queries/QO_Main | Retrieves a list of sales quotes. |
---|
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 | |
LastSavedDateTime | query | DateTime? | No | |
LastSavedDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
LastSavedDateTimeGreaterThan | query | DateTime? | No | |
LastSavedDateTimeLessThan | query | DateTime? | No | |
LastSavedDateTimeLessThanOrEqualTo | query | DateTime? | No | |
LastSavedDateTimeNotEqualTo | query | DateTime? | No | |
LastSavedDateTimeBetween | query | DateTime[] | No | |
LastSavedDateTimeIn | query | DateTime[] | No | |
DebtorID | query | string | No | |
DebtorIDStartsWith | query | string | No | |
DebtorIDEndsWith | query | string | No | |
DebtorIDContains | query | string | No | |
DebtorIDLike | query | string | No | |
DebtorIDBetween | query | string[] | No | |
DebtorIDIn | query | string[] | No | |
StaffID | query | string | No | |
StaffIDStartsWith | query | string | No | |
StaffIDEndsWith | query | string | No | |
StaffIDContains | query | string | No | |
StaffIDLike | query | string | No | |
StaffIDBetween | query | string[] | No | |
StaffIDIn | query | string[] | No | |
InvoiceNo | query | string | No | |
InvoiceNoStartsWith | query | string | No | |
InvoiceNoEndsWith | query | string | No | |
InvoiceNoContains | query | string | No | |
InvoiceNoLike | query | string | No | |
InvoiceNoBetween | query | string[] | No | |
InvoiceNoIn | query | string[] | No | |
InvoiceInitDate | query | DateTime? | No | |
InvoiceInitDateGreaterThanOrEqualTo | query | DateTime? | No | |
InvoiceInitDateGreaterThan | query | DateTime? | No | |
InvoiceInitDateLessThan | query | DateTime? | No | |
InvoiceInitDateLessThanOrEqualTo | query | DateTime? | No | |
InvoiceInitDateNotEqualTo | query | DateTime? | No | |
InvoiceInitDateBetween | query | DateTime[] | No | |
InvoiceInitDateIn | query | DateTime[] | No | |
InvoiceLastDate | query | DateTime? | No | |
InvoiceLastDateGreaterThanOrEqualTo | query | DateTime? | No | |
InvoiceLastDateGreaterThan | query | DateTime? | No | |
InvoiceLastDateLessThan | query | DateTime? | No | |
InvoiceLastDateLessThanOrEqualTo | query | DateTime? | No | |
InvoiceLastDateNotEqualTo | query | DateTime? | No | |
InvoiceLastDateBetween | query | DateTime[] | No | |
InvoiceLastDateIn | query | DateTime[] | No | |
OrderNo | query | string | No | |
OrderNoStartsWith | query | string | No | |
OrderNoEndsWith | query | string | No | |
OrderNoContains | query | string | No | |
OrderNoLike | query | string | No | |
OrderNoBetween | query | string[] | No | |
OrderNoIn | query | string[] | No | |
TaxExemptNo | query | string | No | |
TaxExemptNoStartsWith | query | string | No | |
TaxExemptNoEndsWith | query | string | No | |
TaxExemptNoContains | query | string | No | |
TaxExemptNoLike | query | string | No | |
TaxExemptNoBetween | query | string[] | No | |
TaxExemptNoIn | query | string[] | No | |
WholeSaleInvoice | query | bool? | No | |
InvoiceTotal | query | decimal? | No | |
InvoiceTotalGreaterThanOrEqualTo | query | decimal? | No | |
InvoiceTotalGreaterThan | query | decimal? | No | |
InvoiceTotalLessThan | query | decimal? | No | |
InvoiceTotalLessThanOrEqualTo | query | decimal? | No | |
InvoiceTotalNotEqualTo | query | decimal? | No | |
InvoiceTotalBetween | query | Nullable<Decimal>[] | No | |
InvoiceTotalIn | query | Nullable<Decimal>[] | No | |
InvoicePrinted | query | bool? | No | |
CurrentHistoryNo | query | short? | No | |
CurrentHistoryNoGreaterThanOrEqualTo | query | short? | No | |
CurrentHistoryNoGreaterThan | query | short? | No | |
CurrentHistoryNoLessThan | query | short? | No | |
CurrentHistoryNoLessThanOrEqualTo | query | short? | No | |
CurrentHistoryNoNotEqualTo | query | short? | No | |
CurrentHistoryNoBetween | query | Nullable<Int16>[] | No | |
CurrentHistoryNoIn | query | Nullable<Int16>[] | No | |
Status | query | short? | No | |
StatusGreaterThanOrEqualTo | query | short? | No | |
StatusGreaterThan | query | short? | No | |
StatusLessThan | query | short? | No | |
StatusLessThanOrEqualTo | query | short? | No | |
StatusNotEqualTo | query | short? | No | |
StatusBetween | query | Nullable<Int16>[] | No | |
StatusIn | query | Nullable<Int16>[] | No | |
BillWhenComplete | query | short? | No | |
BillWhenCompleteGreaterThanOrEqualTo | query | short? | No | |
BillWhenCompleteGreaterThan | query | short? | No | |
BillWhenCompleteLessThan | query | short? | No | |
BillWhenCompleteLessThanOrEqualTo | query | short? | No | |
BillWhenCompleteNotEqualTo | query | short? | No | |
BillWhenCompleteBetween | query | short[] | No | |
BillWhenCompleteIn | query | short[] | No | |
InvoiceType | query | short? | No | |
InvoiceTypeGreaterThanOrEqualTo | query | short? | No | |
InvoiceTypeGreaterThan | query | short? | No | |
InvoiceTypeLessThan | query | short? | No | |
InvoiceTypeLessThanOrEqualTo | query | short? | No | |
InvoiceTypeNotEqualTo | query | short? | No | |
InvoiceTypeBetween | query | Nullable<Int16>[] | No | |
InvoiceTypeIn | query | Nullable<Int16>[] | No | |
GroupSupplierID | query | string | No | |
GroupSupplierIDStartsWith | query | string | No | |
GroupSupplierIDEndsWith | query | string | No | |
GroupSupplierIDContains | query | string | No | |
GroupSupplierIDLike | query | string | No | |
GroupSupplierIDBetween | query | string[] | No | |
GroupSupplierIDIn | query | string[] | No | |
GroupOrdered | query | bool? | No | |
IN_LogicalID | query | string | No | |
IN_LogicalIDStartsWith | query | string | No | |
IN_LogicalIDEndsWith | query | string | No | |
IN_LogicalIDContains | query | string | No | |
IN_LogicalIDLike | query | string | No | |
IN_LogicalIDBetween | query | string[] | No | |
IN_LogicalIDIn | query | string[] | No | |
BranchID | query | string | No | |
BranchIDStartsWith | query | string | No | |
BranchIDEndsWith | query | string | No | |
BranchIDContains | query | string | No | |
BranchIDLike | query | string | No | |
BranchIDBetween | query | string[] | No | |
BranchIDIn | query | string[] | No | |
QOReference | query | string | No | |
QOReferenceStartsWith | query | string | No | |
QOReferenceEndsWith | query | string | No | |
QOReferenceContains | query | string | No | |
QOReferenceLike | query | string | No | |
QOReferenceBetween | query | string[] | No | |
QOReferenceIn | query | string[] | No | |
JobCostID | query | string | No | |
JobCostIDStartsWith | query | string | No | |
JobCostIDEndsWith | query | string | No | |
JobCostIDContains | query | string | No | |
JobCostIDLike | query | string | No | |
JobCostIDBetween | query | string[] | No | |
JobCostIDIn | query | string[] | No | |
DocType | query | int? | No | |
DocTypeGreaterThanOrEqualTo | query | int? | No | |
DocTypeGreaterThan | query | int? | No | |
DocTypeLessThan | query | int? | No | |
DocTypeLessThanOrEqualTo | query | int? | No | |
DocTypeNotEqualTo | query | int? | No | |
DocTypeBetween | query | int[] | No | |
DocTypeIn | query | int[] | No | |
BackOrderMode | query | short? | No | |
BackOrderModeGreaterThanOrEqualTo | query | short? | No | |
BackOrderModeGreaterThan | query | short? | No | |
BackOrderModeLessThan | query | short? | No | |
BackOrderModeLessThanOrEqualTo | query | short? | No | |
BackOrderModeNotEqualTo | query | short? | No | |
BackOrderModeBetween | query | short[] | No | |
BackOrderModeIn | query | short[] | No | |
ExpectedDeliveryDate | query | DateTime? | No | |
ExpectedDeliveryDateGreaterThanOrEqualTo | query | DateTime? | No | |
ExpectedDeliveryDateGreaterThan | query | DateTime? | No | |
ExpectedDeliveryDateLessThan | query | DateTime? | No | |
ExpectedDeliveryDateLessThanOrEqualTo | query | DateTime? | No | |
ExpectedDeliveryDateNotEqualTo | query | DateTime? | No | |
ExpectedDeliveryDateBetween | query | Nullable<DateTime>[] | No | |
ExpectedDeliveryDateIn | query | Nullable<DateTime>[] | No | |
DebtorContactName | query | string | No | |
DebtorContactNameStartsWith | query | string | No | |
DebtorContactNameEndsWith | query | string | No | |
DebtorContactNameContains | query | string | No | |
DebtorContactNameLike | query | string | No | |
DebtorContactNameBetween | query | string[] | No | |
DebtorContactNameIn | query | string[] | No | |
ParentDebtorID | query | string | No | |
ParentDebtorIDStartsWith | query | string | No | |
ParentDebtorIDEndsWith | query | string | No | |
ParentDebtorIDContains | query | string | No | |
ParentDebtorIDLike | query | string | No | |
ParentDebtorIDBetween | query | string[] | No | |
ParentDebtorIDIn | query | string[] | No | |
PriceSchemeID | query | string | No | |
PriceSchemeIDStartsWith | query | string | No | |
PriceSchemeIDEndsWith | query | string | No | |
PriceSchemeIDContains | query | string | No | |
PriceSchemeIDLike | query | string | No | |
PriceSchemeIDBetween | query | string[] | No | |
PriceSchemeIDIn | query | string[] | No | |
InvoiceEmailed | query | bool? | 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 | |
WholeSaleInvoice | form | bool | No | |
InvoiceTotal | form | decimal? | No | |
InvoicePrinted | form | bool | No | |
CurrentHistoryNo | form | short? | No | |
Status | form | short? | No | |
BillWhenComplete | form | short | No | |
InvoiceType | form | short? | No | |
GroupSupplierID | form | string | No | |
GroupOrdered | form | bool | No | |
IN_LogicalID | form | string | No | |
BranchID | form | string | No | |
QOReference | form | string | No | |
JobCostID | form | string | No | |
DocType | form | int | No | |
BackOrderMode | form | short | No | |
ExpectedDeliveryDate | form | DateTime? | No | |
DebtorContactName | form | string | No | |
ParentDebtorID | form | string | No | |
PriceSchemeID | form | string | No | |
InvoiceEmailed | form | bool? | 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 .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Queries/QO_Main HTTP/1.1 Host: api.jiwa.com.au Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <QueryResponseOfQO_Main7kRqkrSv xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types"> <Offset>0</Offset> <Total>0</Total> <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Tables"> <d2p1:QO_Main> <d2p1:_x003C_BackOrderMode_x003E_k__BackingField>0</d2p1:_x003C_BackOrderMode_x003E_k__BackingField> <d2p1:_x003C_BillWhenComplete_x003E_k__BackingField>0</d2p1:_x003C_BillWhenComplete_x003E_k__BackingField> <d2p1:_x003C_BranchID_x003E_k__BackingField>String</d2p1:_x003C_BranchID_x003E_k__BackingField> <d2p1:_x003C_CurrentHistoryNo_x003E_k__BackingField>0</d2p1:_x003C_CurrentHistoryNo_x003E_k__BackingField> <d2p1:_x003C_DebtorContactName_x003E_k__BackingField>String</d2p1:_x003C_DebtorContactName_x003E_k__BackingField> <d2p1:_x003C_DebtorID_x003E_k__BackingField>String</d2p1:_x003C_DebtorID_x003E_k__BackingField> <d2p1:_x003C_DocType_x003E_k__BackingField>0</d2p1:_x003C_DocType_x003E_k__BackingField> <d2p1:_x003C_ExpectedDeliveryDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_ExpectedDeliveryDate_x003E_k__BackingField> <d2p1:_x003C_GroupOrdered_x003E_k__BackingField>false</d2p1:_x003C_GroupOrdered_x003E_k__BackingField> <d2p1:_x003C_GroupSupplierID_x003E_k__BackingField>String</d2p1:_x003C_GroupSupplierID_x003E_k__BackingField> <d2p1:_x003C_IN_LogicalID_x003E_k__BackingField>String</d2p1:_x003C_IN_LogicalID_x003E_k__BackingField> <d2p1:_x003C_InvoiceEmailed_x003E_k__BackingField>false</d2p1:_x003C_InvoiceEmailed_x003E_k__BackingField> <d2p1:_x003C_InvoiceID_x003E_k__BackingField>String</d2p1:_x003C_InvoiceID_x003E_k__BackingField> <d2p1:_x003C_InvoiceInitDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_InvoiceInitDate_x003E_k__BackingField> <d2p1:_x003C_InvoiceLastDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_InvoiceLastDate_x003E_k__BackingField> <d2p1:_x003C_InvoiceNo_x003E_k__BackingField>String</d2p1:_x003C_InvoiceNo_x003E_k__BackingField> <d2p1:_x003C_InvoicePrinted_x003E_k__BackingField>false</d2p1:_x003C_InvoicePrinted_x003E_k__BackingField> <d2p1:_x003C_InvoiceTotal_x003E_k__BackingField>0</d2p1:_x003C_InvoiceTotal_x003E_k__BackingField> <d2p1:_x003C_InvoiceType_x003E_k__BackingField>0</d2p1:_x003C_InvoiceType_x003E_k__BackingField> <d2p1:_x003C_JobCostID_x003E_k__BackingField>String</d2p1:_x003C_JobCostID_x003E_k__BackingField> <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField> <d2p1:_x003C_OrderNo_x003E_k__BackingField>String</d2p1:_x003C_OrderNo_x003E_k__BackingField> <d2p1:_x003C_ParentDebtorID_x003E_k__BackingField>String</d2p1:_x003C_ParentDebtorID_x003E_k__BackingField> <d2p1:_x003C_PriceSchemeID_x003E_k__BackingField>String</d2p1:_x003C_PriceSchemeID_x003E_k__BackingField> <d2p1:_x003C_QOReference_x003E_k__BackingField>String</d2p1:_x003C_QOReference_x003E_k__BackingField> <d2p1:_x003C_StaffID_x003E_k__BackingField>String</d2p1:_x003C_StaffID_x003E_k__BackingField> <d2p1:_x003C_Status_x003E_k__BackingField>0</d2p1:_x003C_Status_x003E_k__BackingField> <d2p1:_x003C_TaxExemptNo_x003E_k__BackingField>String</d2p1:_x003C_TaxExemptNo_x003E_k__BackingField> <d2p1:_x003C_WholeSaleInvoice_x003E_k__BackingField>false</d2p1:_x003C_WholeSaleInvoice_x003E_k__BackingField> </d2p1:QO_Main> </Results> <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringstring> <d2p1:Key>String</d2p1:Key> <d2p1:Value>String</d2p1:Value> </d2p1:KeyValueOfstringstring> </Meta> <ResponseStatus> <ErrorCode>String</ErrorCode> <Message>String</Message> <StackTrace>String</StackTrace> <Errors> <ResponseError> <ErrorCode>String</ErrorCode> <FieldName>String</FieldName> <Message>String</Message> <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </Meta> </ResponseError> </Errors> <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </Meta> </ResponseStatus> </QueryResponseOfQO_Main7kRqkrSv>