JiwaAPI

<back to all web services

PO_MainQuery

Requires Authentication
The following routes are available for this service:
GET/Queries/PO_MainRetrieves a list of purchase orders.
PO_MainQuery Parameters:
NameParameterData TypeRequiredDescription
OrderIDquerystringNo
OrderIDStartsWithquerystringNo
OrderIDEndsWithquerystringNo
OrderIDContainsquerystringNo
OrderIDLikequerystringNo
OrderIDBetweenquerystring[]No
OrderIDInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryNullable<DateTime>[]No
LastSavedDateTimeInqueryNullable<DateTime>[]No
CreditorIDquerystringNo
CreditorIDStartsWithquerystringNo
CreditorIDEndsWithquerystringNo
CreditorIDContainsquerystringNo
CreditorIDLikequerystringNo
CreditorIDBetweenquerystring[]No
CreditorIDInquerystring[]No
OrderNoquerystringNo
OrderNoStartsWithquerystringNo
OrderNoEndsWithquerystringNo
OrderNoContainsquerystringNo
OrderNoLikequerystringNo
OrderNoBetweenquerystring[]No
OrderNoInquerystring[]No
OrderedDatequeryDateTime?No
OrderedDateGreaterThanOrEqualToqueryDateTime?No
OrderedDateGreaterThanqueryDateTime?No
OrderedDateLessThanqueryDateTime?No
OrderedDateLessThanOrEqualToqueryDateTime?No
OrderedDateNotEqualToqueryDateTime?No
OrderedDateBetweenqueryDateTime[]No
OrderedDateInqueryDateTime[]No
Header1querystringNo
Header1StartsWithquerystringNo
Header1EndsWithquerystringNo
Header1ContainsquerystringNo
Header1LikequerystringNo
Header1Betweenquerystring[]No
Header1Inquerystring[]No
Header2querystringNo
Header2StartsWithquerystringNo
Header2EndsWithquerystringNo
Header2ContainsquerystringNo
Header2LikequerystringNo
Header2Betweenquerystring[]No
Header2Inquerystring[]No
Header5querystringNo
Header5StartsWithquerystringNo
Header5EndsWithquerystringNo
Header5ContainsquerystringNo
Header5LikequerystringNo
Header5Betweenquerystring[]No
Header5Inquerystring[]No
Statusqueryshort?No
StatusGreaterThanOrEqualToqueryshort?No
StatusGreaterThanqueryshort?No
StatusLessThanqueryshort?No
StatusLessThanOrEqualToqueryshort?No
StatusNotEqualToqueryshort?No
StatusBetweenqueryshort[]No
StatusInqueryshort[]No
OrderTypequeryshort?No
OrderTypeGreaterThanOrEqualToqueryshort?No
OrderTypeGreaterThanqueryshort?No
OrderTypeLessThanqueryshort?No
OrderTypeLessThanOrEqualToqueryshort?No
OrderTypeNotEqualToqueryshort?No
OrderTypeBetweenqueryNullable<Int16>[]No
OrderTypeInqueryNullable<Int16>[]No
OrderTypeInvIDquerystringNo
OrderTypeInvIDStartsWithquerystringNo
OrderTypeInvIDEndsWithquerystringNo
OrderTypeInvIDContainsquerystringNo
OrderTypeInvIDLikequerystringNo
OrderTypeInvIDBetweenquerystring[]No
OrderTypeInvIDInquerystring[]No
IN_LogicalIDquerystringNo
IN_LogicalIDStartsWithquerystringNo
IN_LogicalIDEndsWithquerystringNo
IN_LogicalIDContainsquerystringNo
IN_LogicalIDLikequerystringNo
IN_LogicalIDBetweenquerystring[]No
IN_LogicalIDInquerystring[]No
OrderSupplierTypequeryshort?No
OrderSupplierTypeGreaterThanOrEqualToqueryshort?No
OrderSupplierTypeGreaterThanqueryshort?No
OrderSupplierTypeLessThanqueryshort?No
OrderSupplierTypeLessThanOrEqualToqueryshort?No
OrderSupplierTypeNotEqualToqueryshort?No
OrderSupplierTypeBetweenqueryshort[]No
OrderSupplierTypeInqueryshort[]No
CentralWarehouseIDquerystringNo
CentralWarehouseIDStartsWithquerystringNo
CentralWarehouseIDEndsWithquerystringNo
CentralWarehouseIDContainsquerystringNo
CentralWarehouseIDLikequerystringNo
CentralWarehouseIDBetweenquerystring[]No
CentralWarehouseIDInquerystring[]No
TaxTotalquerydecimal?No
TaxTotalGreaterThanOrEqualToquerydecimal?No
TaxTotalGreaterThanquerydecimal?No
TaxTotalLessThanquerydecimal?No
TaxTotalLessThanOrEqualToquerydecimal?No
TaxTotalNotEqualToquerydecimal?No
TaxTotalBetweenqueryNullable<Decimal>[]No
TaxTotalInqueryNullable<Decimal>[]No
CurrencyIDquerystringNo
CurrencyIDStartsWithquerystringNo
CurrencyIDEndsWithquerystringNo
CurrencyIDContainsquerystringNo
CurrencyIDLikequerystringNo
CurrencyIDBetweenquerystring[]No
CurrencyIDInquerystring[]No
InTransitWarehouseIDquerystringNo
InTransitWarehouseIDStartsWithquerystringNo
InTransitWarehouseIDEndsWithquerystringNo
InTransitWarehouseIDContainsquerystringNo
InTransitWarehouseIDLikequerystringNo
InTransitWarehouseIDBetweenquerystring[]No
InTransitWarehouseIDInquerystring[]No
ReferencequerystringNo
ReferenceStartsWithquerystringNo
ReferenceEndsWithquerystringNo
ReferenceContainsquerystringNo
ReferenceLikequerystringNo
ReferenceBetweenquerystring[]No
ReferenceInquerystring[]No
PO_Workflows_RecIDquerystringNo
PO_Workflows_RecIDStartsWithquerystringNo
PO_Workflows_RecIDEndsWithquerystringNo
PO_Workflows_RecIDContainsquerystringNo
PO_Workflows_RecIDLikequerystringNo
PO_Workflows_RecIDBetweenquerystring[]No
PO_Workflows_RecIDInquerystring[]No
HR_Staff_RecIDquerystringNo
HR_Staff_RecIDStartsWithquerystringNo
HR_Staff_RecIDEndsWithquerystringNo
HR_Staff_RecIDContainsquerystringNo
HR_Staff_RecIDLikequerystringNo
HR_Staff_RecIDBetweenquerystring[]No
HR_Staff_RecIDInquerystring[]No
CR_Warehouse_WarehouseIDquerystringNo
CR_Warehouse_WarehouseIDStartsWithquerystringNo
CR_Warehouse_WarehouseIDEndsWithquerystringNo
CR_Warehouse_WarehouseIDContainsquerystringNo
CR_Warehouse_WarehouseIDLikequerystringNo
CR_Warehouse_WarehouseIDBetweenquerystring[]No
CR_Warehouse_WarehouseIDInquerystring[]No
Freightquerydecimal?No
FreightGreaterThanOrEqualToquerydecimal?No
FreightGreaterThanquerydecimal?No
FreightLessThanquerydecimal?No
FreightLessThanOrEqualToquerydecimal?No
FreightNotEqualToquerydecimal?No
FreightBetweenquerydecimal[]No
FreightInquerydecimal[]No
Dutyquerydecimal?No
DutyGreaterThanOrEqualToquerydecimal?No
DutyGreaterThanquerydecimal?No
DutyLessThanquerydecimal?No
DutyLessThanOrEqualToquerydecimal?No
DutyNotEqualToquerydecimal?No
DutyBetweenquerydecimal[]No
DutyInquerydecimal[]No
Insurancequerydecimal?No
InsuranceGreaterThanOrEqualToquerydecimal?No
InsuranceGreaterThanquerydecimal?No
InsuranceLessThanquerydecimal?No
InsuranceLessThanOrEqualToquerydecimal?No
InsuranceNotEqualToquerydecimal?No
InsuranceBetweenquerydecimal[]No
InsuranceInquerydecimal[]No
FreightTaxIDquerystringNo
FreightTaxIDStartsWithquerystringNo
FreightTaxIDEndsWithquerystringNo
FreightTaxIDContainsquerystringNo
FreightTaxIDLikequerystringNo
FreightTaxIDBetweenquerystring[]No
FreightTaxIDInquerystring[]No
FreightTaxRatequerydecimal?No
FreightTaxRateGreaterThanOrEqualToquerydecimal?No
FreightTaxRateGreaterThanquerydecimal?No
FreightTaxRateLessThanquerydecimal?No
FreightTaxRateLessThanOrEqualToquerydecimal?No
FreightTaxRateNotEqualToquerydecimal?No
FreightTaxRateBetweenquerydecimal[]No
FreightTaxRateInquerydecimal[]No
FreightTaxAmountquerydecimal?No
FreightTaxAmountGreaterThanOrEqualToquerydecimal?No
FreightTaxAmountGreaterThanquerydecimal?No
FreightTaxAmountLessThanquerydecimal?No
FreightTaxAmountLessThanOrEqualToquerydecimal?No
FreightTaxAmountNotEqualToquerydecimal?No
FreightTaxAmountBetweenquerydecimal[]No
FreightTaxAmountInquerydecimal[]No
DutyTaxIDquerystringNo
DutyTaxIDStartsWithquerystringNo
DutyTaxIDEndsWithquerystringNo
DutyTaxIDContainsquerystringNo
DutyTaxIDLikequerystringNo
DutyTaxIDBetweenquerystring[]No
DutyTaxIDInquerystring[]No
DutyTaxRatequerydecimal?No
DutyTaxRateGreaterThanOrEqualToquerydecimal?No
DutyTaxRateGreaterThanquerydecimal?No
DutyTaxRateLessThanquerydecimal?No
DutyTaxRateLessThanOrEqualToquerydecimal?No
DutyTaxRateNotEqualToquerydecimal?No
DutyTaxRateBetweenquerydecimal[]No
DutyTaxRateInquerydecimal[]No
DutyTaxAmountquerydecimal?No
DutyTaxAmountGreaterThanOrEqualToquerydecimal?No
DutyTaxAmountGreaterThanquerydecimal?No
DutyTaxAmountLessThanquerydecimal?No
DutyTaxAmountLessThanOrEqualToquerydecimal?No
DutyTaxAmountNotEqualToquerydecimal?No
DutyTaxAmountBetweenquerydecimal[]No
DutyTaxAmountInquerydecimal[]No
InsuranceTaxIDquerystringNo
InsuranceTaxIDStartsWithquerystringNo
InsuranceTaxIDEndsWithquerystringNo
InsuranceTaxIDContainsquerystringNo
InsuranceTaxIDLikequerystringNo
InsuranceTaxIDBetweenquerystring[]No
InsuranceTaxIDInquerystring[]No
InsuranceTaxRatequerydecimal?No
InsuranceTaxRateGreaterThanOrEqualToquerydecimal?No
InsuranceTaxRateGreaterThanquerydecimal?No
InsuranceTaxRateLessThanquerydecimal?No
InsuranceTaxRateLessThanOrEqualToquerydecimal?No
InsuranceTaxRateNotEqualToquerydecimal?No
InsuranceTaxRateBetweenquerydecimal[]No
InsuranceTaxRateInquerydecimal[]No
InsuranceTaxAmountquerydecimal?No
InsuranceTaxAmountGreaterThanOrEqualToquerydecimal?No
InsuranceTaxAmountGreaterThanquerydecimal?No
InsuranceTaxAmountLessThanquerydecimal?No
InsuranceTaxAmountLessThanOrEqualToquerydecimal?No
InsuranceTaxAmountNotEqualToquerydecimal?No
InsuranceTaxAmountBetweenquerydecimal[]No
InsuranceTaxAmountInquerydecimal[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
PO_Main Parameters:
NameParameterData TypeRequiredDescription
OrderIDformstringNo
LastSavedDateTimeformDateTime?No
CreditorIDformstringNo
OrderNoformstringNo
OrderedDateformDateTimeNo
Header1formstringNo
Header2formstringNo
Header5formstringNo
StatusformshortNo
OrderTypeformshort?No
OrderTypeInvIDformstringNo
IN_LogicalIDformstringNo
OrderSupplierTypeformshortNo
CentralWarehouseIDformstringNo
TaxTotalformdecimal?No
CurrencyIDformstringNo
InTransitWarehouseIDformstringNo
ReferenceformstringNo
PO_Workflows_RecIDformstringNo
HR_Staff_RecIDformstringNo
CR_Warehouse_WarehouseIDformstringNo
FreightformdecimalNo
DutyformdecimalNo
InsuranceformdecimalNo
FreightTaxIDformstringNo
FreightTaxRateformdecimalNo
FreightTaxAmountformdecimalNo
DutyTaxIDformstringNo
DutyTaxRateformdecimalNo
DutyTaxAmountformdecimalNo
InsuranceTaxIDformstringNo
InsuranceTaxRateformdecimalNo
InsuranceTaxAmountformdecimalNo
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 /Queries/PO_Main HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Results":[{"OrderID":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","CreditorID":"String","OrderNo":"String","Header1":"String","Header2":"String","Header5":"String","OrderType":0,"OrderTypeInvID":"String","IN_LogicalID":"String","CentralWarehouseID":"String","TaxTotal":0,"CurrencyID":"String","InTransitWarehouseID":"String","Reference":"String","PO_Workflows_RecID":"String","HR_Staff_RecID":"String","CR_Warehouse_WarehouseID":"String","FreightTaxID":"String","DutyTaxID":"String","InsuranceTaxID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}