GET | /Queries/DB_Classification | Retrieves a list of debtor classifications. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DebtorClassificationID | query | string | No | |
DebtorClassificationIDStartsWith | query | string | No | |
DebtorClassificationIDEndsWith | query | string | No | |
DebtorClassificationIDContains | query | string | No | |
DebtorClassificationIDLike | query | string | No | |
DebtorClassificationIDBetween | query | string[] | No | |
DebtorClassificationIDIn | query | string[] | No | |
LastSavedDateTime | query | DateTime? | No | |
LastSavedDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
LastSavedDateTimeGreaterThan | query | DateTime? | No | |
LastSavedDateTimeLessThan | query | DateTime? | No | |
LastSavedDateTimeLessThanOrEqualTo | query | DateTime? | No | |
LastSavedDateTimeNotEqualTo | query | DateTime? | No | |
LastSavedDateTimeBetween | query | Nullable<DateTime>[] | No | |
LastSavedDateTimeIn | query | Nullable<DateTime>[] | No | |
Description | query | string | No | |
DescriptionStartsWith | query | string | No | |
DescriptionEndsWith | query | string | No | |
DescriptionContains | query | string | No | |
DescriptionLike | query | string | No | |
DescriptionBetween | query | string[] | No | |
DescriptionIn | query | string[] | No | |
LedgerIDDebtorControl | query | string | No | |
LedgerIDDebtorControlStartsWith | query | string | No | |
LedgerIDDebtorControlEndsWith | query | string | No | |
LedgerIDDebtorControlContains | query | string | No | |
LedgerIDDebtorControlLike | query | string | No | |
LedgerIDDebtorControlBetween | query | string[] | No | |
LedgerIDDebtorControlIn | query | string[] | No | |
LedgerIDDebtorSales | query | string | No | |
LedgerIDDebtorSalesStartsWith | query | string | No | |
LedgerIDDebtorSalesEndsWith | query | string | No | |
LedgerIDDebtorSalesContains | query | string | No | |
LedgerIDDebtorSalesLike | query | string | No | |
LedgerIDDebtorSalesBetween | query | string[] | No | |
LedgerIDDebtorSalesIn | query | string[] | No | |
LedgerIDDebtorDiscounts | query | string | No | |
LedgerIDDebtorDiscountsStartsWith | query | string | No | |
LedgerIDDebtorDiscountsEndsWith | query | string | No | |
LedgerIDDebtorDiscountsContains | query | string | No | |
LedgerIDDebtorDiscountsLike | query | string | No | |
LedgerIDDebtorDiscountsBetween | query | string[] | No | |
LedgerIDDebtorDiscountsIn | query | string[] | No | |
LedgerIDDebtorSourcedInvoices | query | string | No | |
LedgerIDDebtorSourcedInvoicesStartsWith | query | string | No | |
LedgerIDDebtorSourcedInvoicesEndsWith | query | string | No | |
LedgerIDDebtorSourcedInvoicesContains | query | string | No | |
LedgerIDDebtorSourcedInvoicesLike | query | string | No | |
LedgerIDDebtorSourcedInvoicesBetween | query | string[] | No | |
LedgerIDDebtorSourcedInvoicesIn | query | string[] | No | |
LedgerIDDebtorDebitAdjustment | query | string | No | |
LedgerIDDebtorDebitAdjustmentStartsWith | query | string | No | |
LedgerIDDebtorDebitAdjustmentEndsWith | query | string | No | |
LedgerIDDebtorDebitAdjustmentContains | query | string | No | |
LedgerIDDebtorDebitAdjustmentLike | query | string | No | |
LedgerIDDebtorDebitAdjustmentBetween | query | string[] | No | |
LedgerIDDebtorDebitAdjustmentIn | query | string[] | No | |
LedgerIDDebtorSourcedReceipts | query | string | No | |
LedgerIDDebtorSourcedReceiptsStartsWith | query | string | No | |
LedgerIDDebtorSourcedReceiptsEndsWith | query | string | No | |
LedgerIDDebtorSourcedReceiptsContains | query | string | No | |
LedgerIDDebtorSourcedReceiptsLike | query | string | No | |
LedgerIDDebtorSourcedReceiptsBetween | query | string[] | No | |
LedgerIDDebtorSourcedReceiptsIn | query | string[] | No | |
LedgerIDDebtorCreditAdjustment | query | string | No | |
LedgerIDDebtorCreditAdjustmentStartsWith | query | string | No | |
LedgerIDDebtorCreditAdjustmentEndsWith | query | string | No | |
LedgerIDDebtorCreditAdjustmentContains | query | string | No | |
LedgerIDDebtorCreditAdjustmentLike | query | string | No | |
LedgerIDDebtorCreditAdjustmentBetween | query | string[] | No | |
LedgerIDDebtorCreditAdjustmentIn | query | string[] | No | |
LedgerIDDebtorFreight | query | string | No | |
LedgerIDDebtorFreightStartsWith | query | string | No | |
LedgerIDDebtorFreightEndsWith | query | string | No | |
LedgerIDDebtorFreightContains | query | string | No | |
LedgerIDDebtorFreightLike | query | string | No | |
LedgerIDDebtorFreightBetween | query | string[] | No | |
LedgerIDDebtorFreightIn | query | string[] | No | |
LedgerIDDebtorInsurance | query | string | No | |
LedgerIDDebtorInsuranceStartsWith | query | string | No | |
LedgerIDDebtorInsuranceEndsWith | query | string | No | |
LedgerIDDebtorInsuranceContains | query | string | No | |
LedgerIDDebtorInsuranceLike | query | string | No | |
LedgerIDDebtorInsuranceBetween | query | string[] | No | |
LedgerIDDebtorInsuranceIn | query | string[] | No | |
TermsDays | query | short? | No | |
TermsDaysGreaterThanOrEqualTo | query | short? | No | |
TermsDaysGreaterThan | query | short? | No | |
TermsDaysLessThan | query | short? | No | |
TermsDaysLessThanOrEqualTo | query | short? | No | |
TermsDaysNotEqualTo | query | short? | No | |
TermsDaysBetween | query | Nullable<Int16>[] | No | |
TermsDaysIn | query | Nullable<Int16>[] | No | |
TermsType | query | short? | No | |
TermsTypeGreaterThanOrEqualTo | query | short? | No | |
TermsTypeGreaterThan | query | short? | No | |
TermsTypeLessThan | query | short? | No | |
TermsTypeLessThanOrEqualTo | query | short? | No | |
TermsTypeNotEqualTo | query | short? | No | |
TermsTypeBetween | query | short[] | No | |
TermsTypeIn | query | short[] | No | |
PriceSchemeID | query | string | No | |
PriceSchemeIDStartsWith | query | string | No | |
PriceSchemeIDEndsWith | query | string | No | |
PriceSchemeIDContains | query | string | No | |
PriceSchemeIDLike | query | string | No | |
PriceSchemeIDBetween | query | string[] | No | |
PriceSchemeIDIn | query | string[] | No | |
PricingGroupID | query | string | No | |
PricingGroupIDStartsWith | query | string | No | |
PricingGroupIDEndsWith | query | string | No | |
PricingGroupIDContains | query | string | No | |
PricingGroupIDLike | query | string | No | |
PricingGroupIDBetween | query | string[] | No | |
PricingGroupIDIn | query | string[] | No | |
LedgerIDDebtorRealisedGainLoss | query | string | No | |
LedgerIDDebtorRealisedGainLossStartsWith | query | string | No | |
LedgerIDDebtorRealisedGainLossEndsWith | query | string | No | |
LedgerIDDebtorRealisedGainLossContains | query | string | No | |
LedgerIDDebtorRealisedGainLossLike | query | string | No | |
LedgerIDDebtorRealisedGainLossBetween | query | string[] | No | |
LedgerIDDebtorRealisedGainLossIn | query | string[] | No | |
LedgerIDDebtorUnRealisedGainLoss | query | string | No | |
LedgerIDDebtorUnRealisedGainLossStartsWith | query | string | No | |
LedgerIDDebtorUnRealisedGainLossEndsWith | query | string | No | |
LedgerIDDebtorUnRealisedGainLossContains | query | string | No | |
LedgerIDDebtorUnRealisedGainLossLike | query | string | No | |
LedgerIDDebtorUnRealisedGainLossBetween | query | string[] | No | |
LedgerIDDebtorUnRealisedGainLossIn | query | string[] | No | |
IsDefault | query | bool? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | int? | No | |
Take | form | int? | No | |
OrderBy | form | string | No | |
OrderByDesc | form | string | No | |
Include | form | string | No | |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DebtorClassificationID | form | string | No | |
LastSavedDateTime | form | DateTime? | No | |
Description | form | string | No | |
LedgerIDDebtorControl | form | string | No | |
LedgerIDDebtorSales | form | string | No | |
LedgerIDDebtorDiscounts | form | string | No | |
LedgerIDDebtorSourcedInvoices | form | string | No | |
LedgerIDDebtorDebitAdjustment | form | string | No | |
LedgerIDDebtorSourcedReceipts | form | string | No | |
LedgerIDDebtorCreditAdjustment | form | string | No | |
LedgerIDDebtorFreight | form | string | No | |
LedgerIDDebtorInsurance | form | string | No | |
TermsDays | form | short? | No | |
TermsType | form | short | No | |
PriceSchemeID | form | string | No | |
PricingGroupID | form | string | No | |
LedgerIDDebtorRealisedGainLoss | form | string | No | |
LedgerIDDebtorUnRealisedGainLoss | form | string | No | |
IsDefault | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<T> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>