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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfDB_Classification7kRqkrSv 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:DB_Classification>
      <d2p1:_x003C_DebtorClassificationID_x003E_k__BackingField>String</d2p1:_x003C_DebtorClassificationID_x003E_k__BackingField>
      <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
      <d2p1:_x003C_IsDefault_x003E_k__BackingField>false</d2p1:_x003C_IsDefault_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_LedgerIDDebtorControl_x003E_k__BackingField>String</d2p1:_x003C_LedgerIDDebtorControl_x003E_k__BackingField>
      <d2p1:_x003C_LedgerIDDebtorCreditAdjustment_x003E_k__BackingField>String</d2p1:_x003C_LedgerIDDebtorCreditAdjustment_x003E_k__BackingField>
      <d2p1:_x003C_LedgerIDDebtorDebitAdjustment_x003E_k__BackingField>String</d2p1:_x003C_LedgerIDDebtorDebitAdjustment_x003E_k__BackingField>
      <d2p1:_x003C_LedgerIDDebtorDiscounts_x003E_k__BackingField>String</d2p1:_x003C_LedgerIDDebtorDiscounts_x003E_k__BackingField>
      <d2p1:_x003C_LedgerIDDebtorFreight_x003E_k__BackingField>String</d2p1:_x003C_LedgerIDDebtorFreight_x003E_k__BackingField>
      <d2p1:_x003C_LedgerIDDebtorInsurance_x003E_k__BackingField>String</d2p1:_x003C_LedgerIDDebtorInsurance_x003E_k__BackingField>
      <d2p1:_x003C_LedgerIDDebtorRealisedGainLoss_x003E_k__BackingField>String</d2p1:_x003C_LedgerIDDebtorRealisedGainLoss_x003E_k__BackingField>
      <d2p1:_x003C_LedgerIDDebtorSales_x003E_k__BackingField>String</d2p1:_x003C_LedgerIDDebtorSales_x003E_k__BackingField>
      <d2p1:_x003C_LedgerIDDebtorSourcedInvoices_x003E_k__BackingField>String</d2p1:_x003C_LedgerIDDebtorSourcedInvoices_x003E_k__BackingField>
      <d2p1:_x003C_LedgerIDDebtorSourcedReceipts_x003E_k__BackingField>String</d2p1:_x003C_LedgerIDDebtorSourcedReceipts_x003E_k__BackingField>
      <d2p1:_x003C_LedgerIDDebtorUnRealisedGainLoss_x003E_k__BackingField>String</d2p1:_x003C_LedgerIDDebtorUnRealisedGainLoss_x003E_k__BackingField>
      <d2p1:_x003C_PriceSchemeID_x003E_k__BackingField>String</d2p1:_x003C_PriceSchemeID_x003E_k__BackingField>
      <d2p1:_x003C_PricingGroupID_x003E_k__BackingField>String</d2p1:_x003C_PricingGroupID_x003E_k__BackingField>
      <d2p1:_x003C_TermsDays_x003E_k__BackingField>0</d2p1:_x003C_TermsDays_x003E_k__BackingField>
      <d2p1:_x003C_TermsType_x003E_k__BackingField>0</d2p1:_x003C_TermsType_x003E_k__BackingField>
    </d2p1:DB_Classification>
  </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>
</QueryResponseOfDB_Classification7kRqkrSv>