JiwaAPI

<back to all web services

CR_ClassificationQuery

Requires Authentication
CR_ClassificationQuery Parameters:
NameParameterData TypeRequiredDescription
CreditorClassificationIDquerystringNo
CreditorClassificationIDStartsWithquerystringNo
CreditorClassificationIDEndsWithquerystringNo
CreditorClassificationIDContainsquerystringNo
CreditorClassificationIDLikequerystringNo
CreditorClassificationIDBetweenquerystring[]No
CreditorClassificationIDInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryNullable<DateTime>[]No
LastSavedDateTimeInqueryNullable<DateTime>[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
LedgerIDCreditorControlquerystringNo
LedgerIDCreditorControlStartsWithquerystringNo
LedgerIDCreditorControlEndsWithquerystringNo
LedgerIDCreditorControlContainsquerystringNo
LedgerIDCreditorControlLikequerystringNo
LedgerIDCreditorControlBetweenquerystring[]No
LedgerIDCreditorControlInquerystring[]No
LedgerIDCreditorPurchasesquerystringNo
LedgerIDCreditorPurchasesStartsWithquerystringNo
LedgerIDCreditorPurchasesEndsWithquerystringNo
LedgerIDCreditorPurchasesContainsquerystringNo
LedgerIDCreditorPurchasesLikequerystringNo
LedgerIDCreditorPurchasesBetweenquerystring[]No
LedgerIDCreditorPurchasesInquerystring[]No
LedgerIDCreditorDiscountsquerystringNo
LedgerIDCreditorDiscountsStartsWithquerystringNo
LedgerIDCreditorDiscountsEndsWithquerystringNo
LedgerIDCreditorDiscountsContainsquerystringNo
LedgerIDCreditorDiscountsLikequerystringNo
LedgerIDCreditorDiscountsBetweenquerystring[]No
LedgerIDCreditorDiscountsInquerystring[]No
LedgerIDCreditorSourcedPaymentsquerystringNo
LedgerIDCreditorSourcedPaymentsStartsWithquerystringNo
LedgerIDCreditorSourcedPaymentsEndsWithquerystringNo
LedgerIDCreditorSourcedPaymentsContainsquerystringNo
LedgerIDCreditorSourcedPaymentsLikequerystringNo
LedgerIDCreditorSourcedPaymentsBetweenquerystring[]No
LedgerIDCreditorSourcedPaymentsInquerystring[]No
LedgerIDCreditorSourcedDebitAdjustmentquerystringNo
LedgerIDCreditorSourcedDebitAdjustmentStartsWithquerystringNo
LedgerIDCreditorSourcedDebitAdjustmentEndsWithquerystringNo
LedgerIDCreditorSourcedDebitAdjustmentContainsquerystringNo
LedgerIDCreditorSourcedDebitAdjustmentLikequerystringNo
LedgerIDCreditorSourcedDebitAdjustmentBetweenquerystring[]No
LedgerIDCreditorSourcedDebitAdjustmentInquerystring[]No
LedgerIDCreditorSourcedPurchasequerystringNo
LedgerIDCreditorSourcedPurchaseStartsWithquerystringNo
LedgerIDCreditorSourcedPurchaseEndsWithquerystringNo
LedgerIDCreditorSourcedPurchaseContainsquerystringNo
LedgerIDCreditorSourcedPurchaseLikequerystringNo
LedgerIDCreditorSourcedPurchaseBetweenquerystring[]No
LedgerIDCreditorSourcedPurchaseInquerystring[]No
LedgerIDCreditorSourcedCreditAdjustmentquerystringNo
LedgerIDCreditorSourcedCreditAdjustmentStartsWithquerystringNo
LedgerIDCreditorSourcedCreditAdjustmentEndsWithquerystringNo
LedgerIDCreditorSourcedCreditAdjustmentContainsquerystringNo
LedgerIDCreditorSourcedCreditAdjustmentLikequerystringNo
LedgerIDCreditorSourcedCreditAdjustmentBetweenquerystring[]No
LedgerIDCreditorSourcedCreditAdjustmentInquerystring[]No
LedgerIDCreditorFreightquerystringNo
LedgerIDCreditorFreightStartsWithquerystringNo
LedgerIDCreditorFreightEndsWithquerystringNo
LedgerIDCreditorFreightContainsquerystringNo
LedgerIDCreditorFreightLikequerystringNo
LedgerIDCreditorFreightBetweenquerystring[]No
LedgerIDCreditorFreightInquerystring[]No
LedgerIDCreditorInsurancequerystringNo
LedgerIDCreditorInsuranceStartsWithquerystringNo
LedgerIDCreditorInsuranceEndsWithquerystringNo
LedgerIDCreditorInsuranceContainsquerystringNo
LedgerIDCreditorInsuranceLikequerystringNo
LedgerIDCreditorInsuranceBetweenquerystring[]No
LedgerIDCreditorInsuranceInquerystring[]No
LedgerIDCreditorDutyquerystringNo
LedgerIDCreditorDutyStartsWithquerystringNo
LedgerIDCreditorDutyEndsWithquerystringNo
LedgerIDCreditorDutyContainsquerystringNo
LedgerIDCreditorDutyLikequerystringNo
LedgerIDCreditorDutyBetweenquerystring[]No
LedgerIDCreditorDutyInquerystring[]No
LedgerIDCreditorRealisedGainLossquerystringNo
LedgerIDCreditorRealisedGainLossStartsWithquerystringNo
LedgerIDCreditorRealisedGainLossEndsWithquerystringNo
LedgerIDCreditorRealisedGainLossContainsquerystringNo
LedgerIDCreditorRealisedGainLossLikequerystringNo
LedgerIDCreditorRealisedGainLossBetweenquerystring[]No
LedgerIDCreditorRealisedGainLossInquerystring[]No
LedgerIDCreditorUnRealisedGainLossquerystringNo
LedgerIDCreditorUnRealisedGainLossStartsWithquerystringNo
LedgerIDCreditorUnRealisedGainLossEndsWithquerystringNo
LedgerIDCreditorUnRealisedGainLossContainsquerystringNo
LedgerIDCreditorUnRealisedGainLossLikequerystringNo
LedgerIDCreditorUnRealisedGainLossBetweenquerystring[]No
LedgerIDCreditorUnRealisedGainLossInquerystring[]No
TermsDaysqueryshort?No
TermsDaysGreaterThanOrEqualToqueryshort?No
TermsDaysGreaterThanqueryshort?No
TermsDaysLessThanqueryshort?No
TermsDaysLessThanOrEqualToqueryshort?No
TermsDaysNotEqualToqueryshort?No
TermsDaysBetweenqueryNullable<Int16>[]No
TermsDaysInqueryNullable<Int16>[]No
TermsTypequeryshort?No
TermsTypeGreaterThanOrEqualToqueryshort?No
TermsTypeGreaterThanqueryshort?No
TermsTypeLessThanqueryshort?No
TermsTypeLessThanOrEqualToqueryshort?No
TermsTypeNotEqualToqueryshort?No
TermsTypeBetweenqueryshort[]No
TermsTypeInqueryshort[]No
PO_Workflows_RecIDquerystringNo
PO_Workflows_RecIDStartsWithquerystringNo
PO_Workflows_RecIDEndsWithquerystringNo
PO_Workflows_RecIDContainsquerystringNo
PO_Workflows_RecIDLikequerystringNo
PO_Workflows_RecIDBetweenquerystring[]No
PO_Workflows_RecIDInquerystring[]No
IsDefaultquerybool?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
CR_Classification Parameters:
NameParameterData TypeRequiredDescription
CreditorClassificationIDformstringNo
LastSavedDateTimeformDateTime?No
DescriptionformstringNo
LedgerIDCreditorControlformstringNo
LedgerIDCreditorPurchasesformstringNo
LedgerIDCreditorDiscountsformstringNo
LedgerIDCreditorSourcedPaymentsformstringNo
LedgerIDCreditorSourcedDebitAdjustmentformstringNo
LedgerIDCreditorSourcedPurchaseformstringNo
LedgerIDCreditorSourcedCreditAdjustmentformstringNo
LedgerIDCreditorFreightformstringNo
LedgerIDCreditorInsuranceformstringNo
LedgerIDCreditorDutyformstringNo
LedgerIDCreditorRealisedGainLossformstringNo
LedgerIDCreditorUnRealisedGainLossformstringNo
TermsDaysformshort?No
TermsTypeformshortNo
PO_Workflows_RecIDformstringNo
IsDefaultformboolNo
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.

POST /json/reply/CR_ClassificationQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"CreditorClassificationID":"String","CreditorClassificationIDStartsWith":"String","CreditorClassificationIDEndsWith":"String","CreditorClassificationIDContains":"String","CreditorClassificationIDLike":"String","CreditorClassificationIDBetween":["String"],"CreditorClassificationIDIn":["String"],"LastSavedDateTime":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeBetween":["0001-01-01T00:00:00.0000000"],"LastSavedDateTimeIn":["0001-01-01T00:00:00.0000000"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"LedgerIDCreditorControl":"String","LedgerIDCreditorControlStartsWith":"String","LedgerIDCreditorControlEndsWith":"String","LedgerIDCreditorControlContains":"String","LedgerIDCreditorControlLike":"String","LedgerIDCreditorControlBetween":["String"],"LedgerIDCreditorControlIn":["String"],"LedgerIDCreditorPurchases":"String","LedgerIDCreditorPurchasesStartsWith":"String","LedgerIDCreditorPurchasesEndsWith":"String","LedgerIDCreditorPurchasesContains":"String","LedgerIDCreditorPurchasesLike":"String","LedgerIDCreditorPurchasesBetween":["String"],"LedgerIDCreditorPurchasesIn":["String"],"LedgerIDCreditorDiscounts":"String","LedgerIDCreditorDiscountsStartsWith":"String","LedgerIDCreditorDiscountsEndsWith":"String","LedgerIDCreditorDiscountsContains":"String","LedgerIDCreditorDiscountsLike":"String","LedgerIDCreditorDiscountsBetween":["String"],"LedgerIDCreditorDiscountsIn":["String"],"LedgerIDCreditorSourcedPayments":"String","LedgerIDCreditorSourcedPaymentsStartsWith":"String","LedgerIDCreditorSourcedPaymentsEndsWith":"String","LedgerIDCreditorSourcedPaymentsContains":"String","LedgerIDCreditorSourcedPaymentsLike":"String","LedgerIDCreditorSourcedPaymentsBetween":["String"],"LedgerIDCreditorSourcedPaymentsIn":["String"],"LedgerIDCreditorSourcedDebitAdjustment":"String","LedgerIDCreditorSourcedDebitAdjustmentStartsWith":"String","LedgerIDCreditorSourcedDebitAdjustmentEndsWith":"String","LedgerIDCreditorSourcedDebitAdjustmentContains":"String","LedgerIDCreditorSourcedDebitAdjustmentLike":"String","LedgerIDCreditorSourcedDebitAdjustmentBetween":["String"],"LedgerIDCreditorSourcedDebitAdjustmentIn":["String"],"LedgerIDCreditorSourcedPurchase":"String","LedgerIDCreditorSourcedPurchaseStartsWith":"String","LedgerIDCreditorSourcedPurchaseEndsWith":"String","LedgerIDCreditorSourcedPurchaseContains":"String","LedgerIDCreditorSourcedPurchaseLike":"String","LedgerIDCreditorSourcedPurchaseBetween":["String"],"LedgerIDCreditorSourcedPurchaseIn":["String"],"LedgerIDCreditorSourcedCreditAdjustment":"String","LedgerIDCreditorSourcedCreditAdjustmentStartsWith":"String","LedgerIDCreditorSourcedCreditAdjustmentEndsWith":"String","LedgerIDCreditorSourcedCreditAdjustmentContains":"String","LedgerIDCreditorSourcedCreditAdjustmentLike":"String","LedgerIDCreditorSourcedCreditAdjustmentBetween":["String"],"LedgerIDCreditorSourcedCreditAdjustmentIn":["String"],"LedgerIDCreditorFreight":"String","LedgerIDCreditorFreightStartsWith":"String","LedgerIDCreditorFreightEndsWith":"String","LedgerIDCreditorFreightContains":"String","LedgerIDCreditorFreightLike":"String","LedgerIDCreditorFreightBetween":["String"],"LedgerIDCreditorFreightIn":["String"],"LedgerIDCreditorInsurance":"String","LedgerIDCreditorInsuranceStartsWith":"String","LedgerIDCreditorInsuranceEndsWith":"String","LedgerIDCreditorInsuranceContains":"String","LedgerIDCreditorInsuranceLike":"String","LedgerIDCreditorInsuranceBetween":["String"],"LedgerIDCreditorInsuranceIn":["String"],"LedgerIDCreditorDuty":"String","LedgerIDCreditorDutyStartsWith":"String","LedgerIDCreditorDutyEndsWith":"String","LedgerIDCreditorDutyContains":"String","LedgerIDCreditorDutyLike":"String","LedgerIDCreditorDutyBetween":["String"],"LedgerIDCreditorDutyIn":["String"],"LedgerIDCreditorRealisedGainLoss":"String","LedgerIDCreditorRealisedGainLossStartsWith":"String","LedgerIDCreditorRealisedGainLossEndsWith":"String","LedgerIDCreditorRealisedGainLossContains":"String","LedgerIDCreditorRealisedGainLossLike":"String","LedgerIDCreditorRealisedGainLossBetween":["String"],"LedgerIDCreditorRealisedGainLossIn":["String"],"LedgerIDCreditorUnRealisedGainLoss":"String","LedgerIDCreditorUnRealisedGainLossStartsWith":"String","LedgerIDCreditorUnRealisedGainLossEndsWith":"String","LedgerIDCreditorUnRealisedGainLossContains":"String","LedgerIDCreditorUnRealisedGainLossLike":"String","LedgerIDCreditorUnRealisedGainLossBetween":["String"],"LedgerIDCreditorUnRealisedGainLossIn":["String"],"TermsDays":0,"TermsDaysGreaterThanOrEqualTo":0,"TermsDaysGreaterThan":0,"TermsDaysLessThan":0,"TermsDaysLessThanOrEqualTo":0,"TermsDaysNotEqualTo":0,"TermsDaysBetween":[0],"TermsDaysIn":[0],"TermsType":0,"TermsTypeGreaterThanOrEqualTo":0,"TermsTypeGreaterThan":0,"TermsTypeLessThan":0,"TermsTypeLessThanOrEqualTo":0,"TermsTypeNotEqualTo":0,"TermsTypeBetween":[0],"TermsTypeIn":[0],"PO_Workflows_RecID":"String","PO_Workflows_RecIDStartsWith":"String","PO_Workflows_RecIDEndsWith":"String","PO_Workflows_RecIDContains":"String","PO_Workflows_RecIDLike":"String","PO_Workflows_RecIDBetween":["String"],"PO_Workflows_RecIDIn":["String"],"IsDefault":false,"Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Results":[{"CreditorClassificationID":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","Description":"String","LedgerIDCreditorControl":"String","LedgerIDCreditorPurchases":"String","LedgerIDCreditorDiscounts":"String","LedgerIDCreditorSourcedPayments":"String","LedgerIDCreditorSourcedDebitAdjustment":"String","LedgerIDCreditorSourcedPurchase":"String","LedgerIDCreditorSourcedCreditAdjustment":"String","LedgerIDCreditorFreight":"String","LedgerIDCreditorInsurance":"String","LedgerIDCreditorDuty":"String","LedgerIDCreditorRealisedGainLoss":"String","LedgerIDCreditorUnRealisedGainLoss":"String","TermsDays":0,"PO_Workflows_RecID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}