JiwaAPI

<back to all web services

IN_ClassificationQuery

Requires Authentication
The following routes are available for this service:
GET/Queries/IN_ClassificationRetrieves a list of inventory classifications.
IN_ClassificationQuery Parameters:
NameParameterData TypeRequiredDescription
InventoryClassificationIDquerystringNo
InventoryClassificationIDStartsWithquerystringNo
InventoryClassificationIDEndsWithquerystringNo
InventoryClassificationIDContainsquerystringNo
InventoryClassificationIDLikequerystringNo
InventoryClassificationIDBetweenquerystring[]No
InventoryClassificationIDInquerystring[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryNullable<DateTime>[]No
LastSavedDateTimeInqueryNullable<DateTime>[]No
LedgerInvValuequerystringNo
LedgerInvValueStartsWithquerystringNo
LedgerInvValueEndsWithquerystringNo
LedgerInvValueContainsquerystringNo
LedgerInvValueLikequerystringNo
LedgerInvValueBetweenquerystring[]No
LedgerInvValueInquerystring[]No
LedgerMovement_COGquerystringNo
LedgerMovement_COGStartsWithquerystringNo
LedgerMovement_COGEndsWithquerystringNo
LedgerMovement_COGContainsquerystringNo
LedgerMovement_COGLikequerystringNo
LedgerMovement_COGBetweenquerystring[]No
LedgerMovement_COGInquerystring[]No
LedgerExpAssetquerystringNo
LedgerExpAssetStartsWithquerystringNo
LedgerExpAssetEndsWithquerystringNo
LedgerExpAssetContainsquerystringNo
LedgerExpAssetLikequerystringNo
LedgerExpAssetBetweenquerystring[]No
LedgerExpAssetInquerystring[]No
LedgerExpLiabquerystringNo
LedgerExpLiabStartsWithquerystringNo
LedgerExpLiabEndsWithquerystringNo
LedgerExpLiabContainsquerystringNo
LedgerExpLiabLikequerystringNo
LedgerExpLiabBetweenquerystring[]No
LedgerExpLiabInquerystring[]No
LedgerDelAssetquerystringNo
LedgerDelAssetStartsWithquerystringNo
LedgerDelAssetEndsWithquerystringNo
LedgerDelAssetContainsquerystringNo
LedgerDelAssetLikequerystringNo
LedgerDelAssetBetweenquerystring[]No
LedgerDelAssetInquerystring[]No
LedgerDelLiabquerystringNo
LedgerDelLiabStartsWithquerystringNo
LedgerDelLiabEndsWithquerystringNo
LedgerDelLiabContainsquerystringNo
LedgerDelLiabLikequerystringNo
LedgerDelLiabBetweenquerystring[]No
LedgerDelLiabInquerystring[]No
LedgerAssignedValuequerystringNo
LedgerAssignedValueStartsWithquerystringNo
LedgerAssignedValueEndsWithquerystringNo
LedgerAssignedValueContainsquerystringNo
LedgerAssignedValueLikequerystringNo
LedgerAssignedValueBetweenquerystring[]No
LedgerAssignedValueInquerystring[]No
LedgerCogVariancequerystringNo
LedgerCogVarianceStartsWithquerystringNo
LedgerCogVarianceEndsWithquerystringNo
LedgerCogVarianceContainsquerystringNo
LedgerCogVarianceLikequerystringNo
LedgerCogVarianceBetweenquerystring[]No
LedgerCogVarianceInquerystring[]No
LedgerInvSalesquerystringNo
LedgerInvSalesStartsWithquerystringNo
LedgerInvSalesEndsWithquerystringNo
LedgerInvSalesContainsquerystringNo
LedgerInvSalesLikequerystringNo
LedgerInvSalesBetweenquerystring[]No
LedgerInvSalesInquerystring[]No
LedgerAccumulatorquerystringNo
LedgerAccumulatorStartsWithquerystringNo
LedgerAccumulatorEndsWithquerystringNo
LedgerAccumulatorContainsquerystringNo
LedgerAccumulatorLikequerystringNo
LedgerAccumulatorBetweenquerystring[]No
LedgerAccumulatorInquerystring[]No
LedgerPurchasesquerystringNo
LedgerPurchasesStartsWithquerystringNo
LedgerPurchasesEndsWithquerystringNo
LedgerPurchasesContainsquerystringNo
LedgerPurchasesLikequerystringNo
LedgerPurchasesBetweenquerystring[]No
LedgerPurchasesInquerystring[]No
LedgerShipCompletequerystringNo
LedgerShipCompleteStartsWithquerystringNo
LedgerShipCompleteEndsWithquerystringNo
LedgerShipCompleteContainsquerystringNo
LedgerShipCompleteLikequerystringNo
LedgerShipCompleteBetweenquerystring[]No
LedgerShipCompleteInquerystring[]No
LedgerWriteOnquerystringNo
LedgerWriteOnStartsWithquerystringNo
LedgerWriteOnEndsWithquerystringNo
LedgerWriteOnContainsquerystringNo
LedgerWriteOnLikequerystringNo
LedgerWriteOnBetweenquerystring[]No
LedgerWriteOnInquerystring[]No
LedgerWriteOffquerystringNo
LedgerWriteOffStartsWithquerystringNo
LedgerWriteOffEndsWithquerystringNo
LedgerWriteOffContainsquerystringNo
LedgerWriteOffLikequerystringNo
LedgerWriteOffBetweenquerystring[]No
LedgerWriteOffInquerystring[]No
LedgerCostPriceAdjquerystringNo
LedgerCostPriceAdjStartsWithquerystringNo
LedgerCostPriceAdjEndsWithquerystringNo
LedgerCostPriceAdjContainsquerystringNo
LedgerCostPriceAdjLikequerystringNo
LedgerCostPriceAdjBetweenquerystring[]No
LedgerCostPriceAdjInquerystring[]No
GSTInwardsIDquerystringNo
GSTInwardsIDStartsWithquerystringNo
GSTInwardsIDEndsWithquerystringNo
GSTInwardsIDContainsquerystringNo
GSTInwardsIDLikequerystringNo
GSTInwardsIDBetweenquerystring[]No
GSTInwardsIDInquerystring[]No
GSTOutwardsIDquerystringNo
GSTOutwardsIDStartsWithquerystringNo
GSTOutwardsIDEndsWithquerystringNo
GSTOutwardsIDContainsquerystringNo
GSTOutwardsIDLikequerystringNo
GSTOutwardsIDBetweenquerystring[]No
GSTOutwardsIDInquerystring[]No
GSTAdjustmentsINIDquerystringNo
GSTAdjustmentsINIDStartsWithquerystringNo
GSTAdjustmentsINIDEndsWithquerystringNo
GSTAdjustmentsINIDContainsquerystringNo
GSTAdjustmentsINIDLikequerystringNo
GSTAdjustmentsINIDBetweenquerystring[]No
GSTAdjustmentsINIDInquerystring[]No
GSTAdjustmentsOUTIDquerystringNo
GSTAdjustmentsOUTIDStartsWithquerystringNo
GSTAdjustmentsOUTIDEndsWithquerystringNo
GSTAdjustmentsOUTIDContainsquerystringNo
GSTAdjustmentsOUTIDLikequerystringNo
GSTAdjustmentsOUTIDBetweenquerystring[]No
GSTAdjustmentsOUTIDInquerystring[]No
WebEnabledquerybool?No
DefaultClassificationquerybool?No
PricingGroupIDquerystringNo
PricingGroupIDStartsWithquerystringNo
PricingGroupIDEndsWithquerystringNo
PricingGroupIDContainsquerystringNo
PricingGroupIDLikequerystringNo
PricingGroupIDBetweenquerystring[]No
PricingGroupIDInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
IN_Classification Parameters:
NameParameterData TypeRequiredDescription
InventoryClassificationIDformstringNo
DescriptionformstringNo
LastSavedDateTimeformDateTime?No
LedgerInvValueformstringNo
LedgerMovement_COGformstringNo
LedgerExpAssetformstringNo
LedgerExpLiabformstringNo
LedgerDelAssetformstringNo
LedgerDelLiabformstringNo
LedgerAssignedValueformstringNo
LedgerCogVarianceformstringNo
LedgerInvSalesformstringNo
LedgerAccumulatorformstringNo
LedgerPurchasesformstringNo
LedgerShipCompleteformstringNo
LedgerWriteOnformstringNo
LedgerWriteOffformstringNo
LedgerCostPriceAdjformstringNo
GSTInwardsIDformstringNo
GSTOutwardsIDformstringNo
GSTAdjustmentsINIDformstringNo
GSTAdjustmentsOUTIDformstringNo
WebEnabledformboolNo
DefaultClassificationformbool?No
PricingGroupIDformstringNo
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/IN_Classification HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Results":[{"InventoryClassificationID":"String","Description":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","LedgerInvValue":"String","LedgerMovement_COG":"String","LedgerExpAsset":"String","LedgerExpLiab":"String","LedgerDelAsset":"String","LedgerDelLiab":"String","LedgerAssignedValue":"String","LedgerCogVariance":"String","LedgerInvSales":"String","LedgerAccumulator":"String","LedgerPurchases":"String","LedgerShipComplete":"String","LedgerWriteOn":"String","LedgerWriteOff":"String","LedgerCostPriceAdj":"String","GSTInwardsID":"String","GSTOutwardsID":"String","GSTAdjustmentsINID":"String","GSTAdjustmentsOUTID":"String","DefaultClassification":false,"PricingGroupID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}