JiwaAPI

<back to all web services

DB_ClassificationQuery

Requires Authentication
The following routes are available for this service:
GET/Queries/DB_ClassificationRetrieves a list of debtor classifications.
DB_ClassificationQuery Parameters:
NameParameterData TypeRequiredDescription
DebtorClassificationIDquerystringNo
DebtorClassificationIDStartsWithquerystringNo
DebtorClassificationIDEndsWithquerystringNo
DebtorClassificationIDContainsquerystringNo
DebtorClassificationIDLikequerystringNo
DebtorClassificationIDBetweenquerystring[]No
DebtorClassificationIDInquerystring[]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
LedgerIDDebtorControlquerystringNo
LedgerIDDebtorControlStartsWithquerystringNo
LedgerIDDebtorControlEndsWithquerystringNo
LedgerIDDebtorControlContainsquerystringNo
LedgerIDDebtorControlLikequerystringNo
LedgerIDDebtorControlBetweenquerystring[]No
LedgerIDDebtorControlInquerystring[]No
LedgerIDDebtorSalesquerystringNo
LedgerIDDebtorSalesStartsWithquerystringNo
LedgerIDDebtorSalesEndsWithquerystringNo
LedgerIDDebtorSalesContainsquerystringNo
LedgerIDDebtorSalesLikequerystringNo
LedgerIDDebtorSalesBetweenquerystring[]No
LedgerIDDebtorSalesInquerystring[]No
LedgerIDDebtorDiscountsquerystringNo
LedgerIDDebtorDiscountsStartsWithquerystringNo
LedgerIDDebtorDiscountsEndsWithquerystringNo
LedgerIDDebtorDiscountsContainsquerystringNo
LedgerIDDebtorDiscountsLikequerystringNo
LedgerIDDebtorDiscountsBetweenquerystring[]No
LedgerIDDebtorDiscountsInquerystring[]No
LedgerIDDebtorSourcedInvoicesquerystringNo
LedgerIDDebtorSourcedInvoicesStartsWithquerystringNo
LedgerIDDebtorSourcedInvoicesEndsWithquerystringNo
LedgerIDDebtorSourcedInvoicesContainsquerystringNo
LedgerIDDebtorSourcedInvoicesLikequerystringNo
LedgerIDDebtorSourcedInvoicesBetweenquerystring[]No
LedgerIDDebtorSourcedInvoicesInquerystring[]No
LedgerIDDebtorDebitAdjustmentquerystringNo
LedgerIDDebtorDebitAdjustmentStartsWithquerystringNo
LedgerIDDebtorDebitAdjustmentEndsWithquerystringNo
LedgerIDDebtorDebitAdjustmentContainsquerystringNo
LedgerIDDebtorDebitAdjustmentLikequerystringNo
LedgerIDDebtorDebitAdjustmentBetweenquerystring[]No
LedgerIDDebtorDebitAdjustmentInquerystring[]No
LedgerIDDebtorSourcedReceiptsquerystringNo
LedgerIDDebtorSourcedReceiptsStartsWithquerystringNo
LedgerIDDebtorSourcedReceiptsEndsWithquerystringNo
LedgerIDDebtorSourcedReceiptsContainsquerystringNo
LedgerIDDebtorSourcedReceiptsLikequerystringNo
LedgerIDDebtorSourcedReceiptsBetweenquerystring[]No
LedgerIDDebtorSourcedReceiptsInquerystring[]No
LedgerIDDebtorCreditAdjustmentquerystringNo
LedgerIDDebtorCreditAdjustmentStartsWithquerystringNo
LedgerIDDebtorCreditAdjustmentEndsWithquerystringNo
LedgerIDDebtorCreditAdjustmentContainsquerystringNo
LedgerIDDebtorCreditAdjustmentLikequerystringNo
LedgerIDDebtorCreditAdjustmentBetweenquerystring[]No
LedgerIDDebtorCreditAdjustmentInquerystring[]No
LedgerIDDebtorFreightquerystringNo
LedgerIDDebtorFreightStartsWithquerystringNo
LedgerIDDebtorFreightEndsWithquerystringNo
LedgerIDDebtorFreightContainsquerystringNo
LedgerIDDebtorFreightLikequerystringNo
LedgerIDDebtorFreightBetweenquerystring[]No
LedgerIDDebtorFreightInquerystring[]No
LedgerIDDebtorInsurancequerystringNo
LedgerIDDebtorInsuranceStartsWithquerystringNo
LedgerIDDebtorInsuranceEndsWithquerystringNo
LedgerIDDebtorInsuranceContainsquerystringNo
LedgerIDDebtorInsuranceLikequerystringNo
LedgerIDDebtorInsuranceBetweenquerystring[]No
LedgerIDDebtorInsuranceInquerystring[]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
PriceSchemeIDquerystringNo
PriceSchemeIDStartsWithquerystringNo
PriceSchemeIDEndsWithquerystringNo
PriceSchemeIDContainsquerystringNo
PriceSchemeIDLikequerystringNo
PriceSchemeIDBetweenquerystring[]No
PriceSchemeIDInquerystring[]No
PricingGroupIDquerystringNo
PricingGroupIDStartsWithquerystringNo
PricingGroupIDEndsWithquerystringNo
PricingGroupIDContainsquerystringNo
PricingGroupIDLikequerystringNo
PricingGroupIDBetweenquerystring[]No
PricingGroupIDInquerystring[]No
LedgerIDDebtorRealisedGainLossquerystringNo
LedgerIDDebtorRealisedGainLossStartsWithquerystringNo
LedgerIDDebtorRealisedGainLossEndsWithquerystringNo
LedgerIDDebtorRealisedGainLossContainsquerystringNo
LedgerIDDebtorRealisedGainLossLikequerystringNo
LedgerIDDebtorRealisedGainLossBetweenquerystring[]No
LedgerIDDebtorRealisedGainLossInquerystring[]No
LedgerIDDebtorUnRealisedGainLossquerystringNo
LedgerIDDebtorUnRealisedGainLossStartsWithquerystringNo
LedgerIDDebtorUnRealisedGainLossEndsWithquerystringNo
LedgerIDDebtorUnRealisedGainLossContainsquerystringNo
LedgerIDDebtorUnRealisedGainLossLikequerystringNo
LedgerIDDebtorUnRealisedGainLossBetweenquerystring[]No
LedgerIDDebtorUnRealisedGainLossInquerystring[]No
IsDefaultquerybool?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
DB_Classification Parameters:
NameParameterData TypeRequiredDescription
DebtorClassificationIDformstringNo
LastSavedDateTimeformDateTime?No
DescriptionformstringNo
LedgerIDDebtorControlformstringNo
LedgerIDDebtorSalesformstringNo
LedgerIDDebtorDiscountsformstringNo
LedgerIDDebtorSourcedInvoicesformstringNo
LedgerIDDebtorDebitAdjustmentformstringNo
LedgerIDDebtorSourcedReceiptsformstringNo
LedgerIDDebtorCreditAdjustmentformstringNo
LedgerIDDebtorFreightformstringNo
LedgerIDDebtorInsuranceformstringNo
TermsDaysformshort?No
TermsTypeformshortNo
PriceSchemeIDformstringNo
PricingGroupIDformstringNo
LedgerIDDebtorRealisedGainLossformstringNo
LedgerIDDebtorUnRealisedGainLossformstringNo
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 .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/DB_Classification HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Results":[{"DebtorClassificationID":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","Description":"String","LedgerIDDebtorControl":"String","LedgerIDDebtorSales":"String","LedgerIDDebtorDiscounts":"String","LedgerIDDebtorSourcedInvoices":"String","LedgerIDDebtorDebitAdjustment":"String","LedgerIDDebtorSourcedReceipts":"String","LedgerIDDebtorCreditAdjustment":"String","LedgerIDDebtorFreight":"String","LedgerIDDebtorInsurance":"String","TermsDays":0,"PriceSchemeID":"String","PricingGroupID":"String","LedgerIDDebtorRealisedGainLoss":"String","LedgerIDDebtorUnRealisedGainLoss":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}