JiwaAPI

<back to all web services

DB_TransQuery

Requires Authentication
The following routes are available for this service:
GET/Queries/DB_TransRetrieves a list of debtor transactions
DB_TransQuery Parameters:
NameParameterData TypeRequiredDescription
TransIDquerystringNo
TransIDStartsWithquerystringNo
TransIDEndsWithquerystringNo
TransIDContainsquerystringNo
TransIDLikequerystringNo
TransIDBetweenquerystring[]No
TransIDInquerystring[]No
DebtorIDquerystringNo
DebtorIDStartsWithquerystringNo
DebtorIDEndsWithquerystringNo
DebtorIDContainsquerystringNo
DebtorIDLikequerystringNo
DebtorIDBetweenquerystring[]No
DebtorIDInquerystring[]No
DebitCreditquerybool?No
SourcequerystringNo
SourceStartsWithquerystringNo
SourceEndsWithquerystringNo
SourceContainsquerystringNo
SourceLikequerystringNo
SourceBetweenquerystring[]No
SourceInquerystring[]No
RefquerystringNo
RefStartsWithquerystringNo
RefEndsWithquerystringNo
RefContainsquerystringNo
RefLikequerystringNo
RefBetweenquerystring[]No
RefInquerystring[]No
RemarkquerystringNo
RemarkStartsWithquerystringNo
RemarkEndsWithquerystringNo
RemarkContainsquerystringNo
RemarkLikequerystringNo
RemarkBetweenquerystring[]No
RemarkInquerystring[]No
TranDatequeryDateTime?No
TranDateGreaterThanOrEqualToqueryDateTime?No
TranDateGreaterThanqueryDateTime?No
TranDateLessThanqueryDateTime?No
TranDateLessThanOrEqualToqueryDateTime?No
TranDateNotEqualToqueryDateTime?No
TranDateBetweenqueryNullable<DateTime>[]No
TranDateInqueryNullable<DateTime>[]No
InvRemitNoquerystringNo
InvRemitNoStartsWithquerystringNo
InvRemitNoEndsWithquerystringNo
InvRemitNoContainsquerystringNo
InvRemitNoLikequerystringNo
InvRemitNoBetweenquerystring[]No
InvRemitNoInquerystring[]No
Amountquerydecimal?No
AmountGreaterThanOrEqualToquerydecimal?No
AmountGreaterThanquerydecimal?No
AmountLessThanquerydecimal?No
AmountLessThanOrEqualToquerydecimal?No
AmountNotEqualToquerydecimal?No
AmountBetweenqueryNullable<Decimal>[]No
AmountInqueryNullable<Decimal>[]No
DiscountedAmountquerydecimal?No
DiscountedAmountGreaterThanOrEqualToquerydecimal?No
DiscountedAmountGreaterThanquerydecimal?No
DiscountedAmountLessThanquerydecimal?No
DiscountedAmountLessThanOrEqualToquerydecimal?No
DiscountedAmountNotEqualToquerydecimal?No
DiscountedAmountBetweenqueryNullable<Decimal>[]No
DiscountedAmountInqueryNullable<Decimal>[]No
AgedOutquerybool?No
SourceIDquerystringNo
SourceIDStartsWithquerystringNo
SourceIDEndsWithquerystringNo
SourceIDContainsquerystringNo
SourceIDLikequerystringNo
SourceIDBetweenquerystring[]No
SourceIDInquerystring[]No
AllocatedAmountquerydecimal?No
AllocatedAmountGreaterThanOrEqualToquerydecimal?No
AllocatedAmountGreaterThanquerydecimal?No
AllocatedAmountLessThanquerydecimal?No
AllocatedAmountLessThanOrEqualToquerydecimal?No
AllocatedAmountNotEqualToquerydecimal?No
AllocatedAmountBetweenqueryNullable<Decimal>[]No
AllocatedAmountInqueryNullable<Decimal>[]No
InitDateTimequeryDateTime?No
InitDateTimeGreaterThanOrEqualToqueryDateTime?No
InitDateTimeGreaterThanqueryDateTime?No
InitDateTimeLessThanqueryDateTime?No
InitDateTimeLessThanOrEqualToqueryDateTime?No
InitDateTimeNotEqualToqueryDateTime?No
InitDateTimeBetweenqueryNullable<DateTime>[]No
InitDateTimeInqueryNullable<DateTime>[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryNullable<DateTime>[]No
LastSavedDateTimeInqueryNullable<DateTime>[]No
SubTypequeryshort?No
SubTypeGreaterThanOrEqualToqueryshort?No
SubTypeGreaterThanqueryshort?No
SubTypeLessThanqueryshort?No
SubTypeLessThanOrEqualToqueryshort?No
SubTypeNotEqualToqueryshort?No
SubTypeBetweenqueryNullable<Int16>[]No
SubTypeInqueryNullable<Int16>[]No
BatchNoquerystringNo
BatchNoStartsWithquerystringNo
BatchNoEndsWithquerystringNo
BatchNoContainsquerystringNo
BatchNoLikequerystringNo
BatchNoBetweenquerystring[]No
BatchNoInquerystring[]No
ChildDebtorIDquerystringNo
ChildDebtorIDStartsWithquerystringNo
ChildDebtorIDEndsWithquerystringNo
ChildDebtorIDContainsquerystringNo
ChildDebtorIDLikequerystringNo
ChildDebtorIDBetweenquerystring[]No
ChildDebtorIDInquerystring[]No
GSTAmountquerydecimal?No
GSTAmountGreaterThanOrEqualToquerydecimal?No
GSTAmountGreaterThanquerydecimal?No
GSTAmountLessThanquerydecimal?No
GSTAmountLessThanOrEqualToquerydecimal?No
GSTAmountNotEqualToquerydecimal?No
GSTAmountBetweenqueryNullable<Decimal>[]No
GSTAmountInqueryNullable<Decimal>[]No
DueDatequeryDateTime?No
DueDateGreaterThanOrEqualToqueryDateTime?No
DueDateGreaterThanqueryDateTime?No
DueDateLessThanqueryDateTime?No
DueDateLessThanOrEqualToqueryDateTime?No
DueDateNotEqualToqueryDateTime?No
DueDateBetweenqueryNullable<DateTime>[]No
DueDateInqueryNullable<DateTime>[]No
FXAmountquerydecimal?No
FXAmountGreaterThanOrEqualToquerydecimal?No
FXAmountGreaterThanquerydecimal?No
FXAmountLessThanquerydecimal?No
FXAmountLessThanOrEqualToquerydecimal?No
FXAmountNotEqualToquerydecimal?No
FXAmountBetweenqueryNullable<Decimal>[]No
FXAmountInqueryNullable<Decimal>[]No
FXAllocAmountquerydecimal?No
FXAllocAmountGreaterThanOrEqualToquerydecimal?No
FXAllocAmountGreaterThanquerydecimal?No
FXAllocAmountLessThanquerydecimal?No
FXAllocAmountLessThanOrEqualToquerydecimal?No
FXAllocAmountNotEqualToquerydecimal?No
FXAllocAmountBetweenqueryNullable<Decimal>[]No
FXAllocAmountInqueryNullable<Decimal>[]No
CurrencyRateUsedquerydecimal?No
CurrencyRateUsedGreaterThanOrEqualToquerydecimal?No
CurrencyRateUsedGreaterThanquerydecimal?No
CurrencyRateUsedLessThanquerydecimal?No
CurrencyRateUsedLessThanOrEqualToquerydecimal?No
CurrencyRateUsedNotEqualToquerydecimal?No
CurrencyRateUsedBetweenqueryNullable<Decimal>[]No
CurrencyRateUsedInqueryNullable<Decimal>[]No
RealisedGainLossquerydecimal?No
RealisedGainLossGreaterThanOrEqualToquerydecimal?No
RealisedGainLossGreaterThanquerydecimal?No
RealisedGainLossLessThanquerydecimal?No
RealisedGainLossLessThanOrEqualToquerydecimal?No
RealisedGainLossNotEqualToquerydecimal?No
RealisedGainLossBetweenqueryNullable<Decimal>[]No
RealisedGainLossInqueryNullable<Decimal>[]No
UnRealisedGainLossquerydecimal?No
UnRealisedGainLossGreaterThanOrEqualToquerydecimal?No
UnRealisedGainLossGreaterThanquerydecimal?No
UnRealisedGainLossLessThanquerydecimal?No
UnRealisedGainLossLessThanOrEqualToquerydecimal?No
UnRealisedGainLossNotEqualToquerydecimal?No
UnRealisedGainLossBetweenqueryNullable<Decimal>[]No
UnRealisedGainLossInqueryNullable<Decimal>[]No
CurrencyIDquerystringNo
CurrencyIDStartsWithquerystringNo
CurrencyIDEndsWithquerystringNo
CurrencyIDContainsquerystringNo
CurrencyIDLikequerystringNo
CurrencyIDBetweenquerystring[]No
CurrencyIDInquerystring[]No
Cartage1Amountquerydecimal?No
Cartage1AmountGreaterThanOrEqualToquerydecimal?No
Cartage1AmountGreaterThanquerydecimal?No
Cartage1AmountLessThanquerydecimal?No
Cartage1AmountLessThanOrEqualToquerydecimal?No
Cartage1AmountNotEqualToquerydecimal?No
Cartage1AmountBetweenqueryNullable<Decimal>[]No
Cartage1AmountInqueryNullable<Decimal>[]No
Cartage1TaxAmountquerydecimal?No
Cartage1TaxAmountGreaterThanOrEqualToquerydecimal?No
Cartage1TaxAmountGreaterThanquerydecimal?No
Cartage1TaxAmountLessThanquerydecimal?No
Cartage1TaxAmountLessThanOrEqualToquerydecimal?No
Cartage1TaxAmountNotEqualToquerydecimal?No
Cartage1TaxAmountBetweenqueryNullable<Decimal>[]No
Cartage1TaxAmountInqueryNullable<Decimal>[]No
Cartage2Amountquerydecimal?No
Cartage2AmountGreaterThanOrEqualToquerydecimal?No
Cartage2AmountGreaterThanquerydecimal?No
Cartage2AmountLessThanquerydecimal?No
Cartage2AmountLessThanOrEqualToquerydecimal?No
Cartage2AmountNotEqualToquerydecimal?No
Cartage2AmountBetweenqueryNullable<Decimal>[]No
Cartage2AmountInqueryNullable<Decimal>[]No
Cartage2TaxAmountquerydecimal?No
Cartage2TaxAmountGreaterThanOrEqualToquerydecimal?No
Cartage2TaxAmountGreaterThanquerydecimal?No
Cartage2TaxAmountLessThanquerydecimal?No
Cartage2TaxAmountLessThanOrEqualToquerydecimal?No
Cartage2TaxAmountNotEqualToquerydecimal?No
Cartage2TaxAmountBetweenqueryNullable<Decimal>[]No
Cartage2TaxAmountInqueryNullable<Decimal>[]No
Cartage3Amountquerydecimal?No
Cartage3AmountGreaterThanOrEqualToquerydecimal?No
Cartage3AmountGreaterThanquerydecimal?No
Cartage3AmountLessThanquerydecimal?No
Cartage3AmountLessThanOrEqualToquerydecimal?No
Cartage3AmountNotEqualToquerydecimal?No
Cartage3AmountBetweenqueryNullable<Decimal>[]No
Cartage3AmountInqueryNullable<Decimal>[]No
Cartage3TaxAmountquerydecimal?No
Cartage3TaxAmountGreaterThanOrEqualToquerydecimal?No
Cartage3TaxAmountGreaterThanquerydecimal?No
Cartage3TaxAmountLessThanquerydecimal?No
Cartage3TaxAmountLessThanOrEqualToquerydecimal?No
Cartage3TaxAmountNotEqualToquerydecimal?No
Cartage3TaxAmountBetweenqueryNullable<Decimal>[]No
Cartage3TaxAmountInqueryNullable<Decimal>[]No
FXDecimalPlacesqueryshort?No
FXDecimalPlacesGreaterThanOrEqualToqueryshort?No
FXDecimalPlacesGreaterThanqueryshort?No
FXDecimalPlacesLessThanqueryshort?No
FXDecimalPlacesLessThanOrEqualToqueryshort?No
FXDecimalPlacesNotEqualToqueryshort?No
FXDecimalPlacesBetweenqueryNullable<Int16>[]No
FXDecimalPlacesInqueryNullable<Int16>[]No
DecimalPlacesqueryshort?No
DecimalPlacesGreaterThanOrEqualToqueryshort?No
DecimalPlacesGreaterThanqueryshort?No
DecimalPlacesLessThanqueryshort?No
DecimalPlacesLessThanOrEqualToqueryshort?No
DecimalPlacesNotEqualToqueryshort?No
DecimalPlacesBetweenqueryNullable<Int16>[]No
DecimalPlacesInqueryNullable<Int16>[]No
NotequerystringNo
NoteStartsWithquerystringNo
NoteEndsWithquerystringNo
NoteContainsquerystringNo
NoteLikequerystringNo
NoteBetweenquerystring[]No
NoteInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
DB_Trans Parameters:
NameParameterData TypeRequiredDescription
TransIDformstringNo
DebtorIDformstringNo
DebitCreditformboolNo
SourceformstringNo
RefformstringNo
RemarkformstringNo
TranDateformDateTime?No
InvRemitNoformstringNo
Amountformdecimal?No
DiscountedAmountformdecimal?No
AgedOutformboolNo
SourceIDformstringNo
AllocatedAmountformdecimal?No
InitDateTimeformDateTime?No
LastSavedDateTimeformDateTime?No
SubTypeformshort?No
BatchNoformstringNo
ChildDebtorIDformstringNo
GSTAmountformdecimal?No
DueDateformDateTime?No
FXAmountformdecimal?No
FXAllocAmountformdecimal?No
CurrencyRateUsedformdecimal?No
RealisedGainLossformdecimal?No
UnRealisedGainLossformdecimal?No
CurrencyIDformstringNo
Cartage1Amountformdecimal?No
Cartage1TaxAmountformdecimal?No
Cartage2Amountformdecimal?No
Cartage2TaxAmountformdecimal?No
Cartage3Amountformdecimal?No
Cartage3TaxAmountformdecimal?No
FXDecimalPlacesformshort?No
DecimalPlacesformshort?No
NoteformstringNo
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_Trans HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Results":[{"TransID":"String","DebtorID":"String","Source":"String","Ref":"String","Remark":"String","TranDate":"0001-01-01T00:00:00.0000000","InvRemitNo":"String","Amount":0,"DiscountedAmount":0,"SourceID":"String","AllocatedAmount":0,"InitDateTime":"0001-01-01T00:00:00.0000000","LastSavedDateTime":"0001-01-01T00:00:00.0000000","SubType":0,"BatchNo":"String","ChildDebtorID":"String","GSTAmount":0,"DueDate":"0001-01-01T00:00:00.0000000","FXAmount":0,"FXAllocAmount":0,"CurrencyRateUsed":0,"RealisedGainLoss":0,"UnRealisedGainLoss":0,"CurrencyID":"String","Cartage1Amount":0,"Cartage1TaxAmount":0,"Cartage2Amount":0,"Cartage2TaxAmount":0,"Cartage3Amount":0,"Cartage3TaxAmount":0,"FXDecimalPlaces":0,"DecimalPlaces":0,"Note":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}