JiwaAPI

<back to all web services

CR_TransQuery

Requires Authentication
CR_TransQuery Parameters:
NameParameterData TypeRequiredDescription
TransIDquerystringNo
TransIDStartsWithquerystringNo
TransIDEndsWithquerystringNo
TransIDContainsquerystringNo
TransIDLikequerystringNo
TransIDBetweenquerystring[]No
TransIDInquerystring[]No
CreditorIDquerystringNo
CreditorIDStartsWithquerystringNo
CreditorIDEndsWithquerystringNo
CreditorIDContainsquerystringNo
CreditorIDLikequerystringNo
CreditorIDBetweenquerystring[]No
CreditorIDInquerystring[]No
DebitCreditquerybool?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
FXAmountquerydecimal?No
FXAmountGreaterThanOrEqualToquerydecimal?No
FXAmountGreaterThanquerydecimal?No
FXAmountLessThanquerydecimal?No
FXAmountLessThanOrEqualToquerydecimal?No
FXAmountNotEqualToquerydecimal?No
FXAmountBetweenqueryNullable<Decimal>[]No
FXAmountInqueryNullable<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
BatchNoquerystringNo
BatchNoStartsWithquerystringNo
BatchNoEndsWithquerystringNo
BatchNoContainsquerystringNo
BatchNoLikequerystringNo
BatchNoBetweenquerystring[]No
BatchNoInquerystring[]No
ChequePrintingquerybool?No
ChequeRunIDquerystringNo
ChequeRunIDStartsWithquerystringNo
ChequeRunIDEndsWithquerystringNo
ChequeRunIDContainsquerystringNo
ChequeRunIDLikequerystringNo
ChequeRunIDBetweenquerystring[]No
ChequeRunIDInquerystring[]No
DueDatequeryDateTime?No
DueDateGreaterThanOrEqualToqueryDateTime?No
DueDateGreaterThanqueryDateTime?No
DueDateLessThanqueryDateTime?No
DueDateLessThanOrEqualToqueryDateTime?No
DueDateNotEqualToqueryDateTime?No
DueDateBetweenqueryNullable<DateTime>[]No
DueDateInqueryNullable<DateTime>[]No
Amountquerydecimal?No
AmountGreaterThanOrEqualToquerydecimal?No
AmountGreaterThanquerydecimal?No
AmountLessThanquerydecimal?No
AmountLessThanOrEqualToquerydecimal?No
AmountNotEqualToquerydecimal?No
AmountBetweenqueryNullable<Decimal>[]No
AmountInqueryNullable<Decimal>[]No
CurrencyRateUsedquerydecimal?No
CurrencyRateUsedGreaterThanOrEqualToquerydecimal?No
CurrencyRateUsedGreaterThanquerydecimal?No
CurrencyRateUsedLessThanquerydecimal?No
CurrencyRateUsedLessThanOrEqualToquerydecimal?No
CurrencyRateUsedNotEqualToquerydecimal?No
CurrencyRateUsedBetweenqueryNullable<Decimal>[]No
CurrencyRateUsedInqueryNullable<Decimal>[]No
FXAllocAmountquerydecimal?No
FXAllocAmountGreaterThanOrEqualToquerydecimal?No
FXAllocAmountGreaterThanquerydecimal?No
FXAllocAmountLessThanquerydecimal?No
FXAllocAmountLessThanOrEqualToquerydecimal?No
FXAllocAmountNotEqualToquerydecimal?No
FXAllocAmountBetweenqueryNullable<Decimal>[]No
FXAllocAmountInqueryNullable<Decimal>[]No
GSTAmountquerydecimal?No
GSTAmountGreaterThanOrEqualToquerydecimal?No
GSTAmountGreaterThanquerydecimal?No
GSTAmountLessThanquerydecimal?No
GSTAmountLessThanOrEqualToquerydecimal?No
GSTAmountNotEqualToquerydecimal?No
GSTAmountBetweenqueryNullable<Decimal>[]No
GSTAmountInqueryNullable<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
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
CurrencyIDquerystringNo
CurrencyIDStartsWithquerystringNo
CurrencyIDEndsWithquerystringNo
CurrencyIDContainsquerystringNo
CurrencyIDLikequerystringNo
CurrencyIDBetweenquerystring[]No
CurrencyIDInquerystring[]No
SourcequerystringNo
SourceStartsWithquerystringNo
SourceEndsWithquerystringNo
SourceContainsquerystringNo
SourceLikequerystringNo
SourceBetweenquerystring[]No
SourceInquerystring[]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
CR_Trans Parameters:
NameParameterData TypeRequiredDescription
TransIDformstringNo
CreditorIDformstringNo
DebitCreditformboolNo
RefformstringNo
RemarkformstringNo
TranDateformDateTime?No
InvRemitNoformstringNo
FXAmountformdecimal?No
DiscountedAmountformdecimal?No
AgedOutformboolNo
SourceIDformstringNo
AllocatedAmountformdecimal?No
InitDateTimeformDateTime?No
LastSavedDateTimeformDateTime?No
BatchNoformstringNo
ChequePrintingformboolNo
ChequeRunIDformstringNo
DueDateformDateTime?No
Amountformdecimal?No
CurrencyRateUsedformdecimal?No
FXAllocAmountformdecimal?No
GSTAmountformdecimal?No
RealisedGainLossformdecimal?No
UnRealisedGainLossformdecimal?No
FXDecimalPlacesformshort?No
DecimalPlacesformshort?No
CurrencyIDformstringNo
SourceformstringNo
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.

POST /csv/reply/CR_TransQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"TransID":"String","TransIDStartsWith":"String","TransIDEndsWith":"String","TransIDContains":"String","TransIDLike":"String","TransIDBetween":["String"],"TransIDIn":["String"],"CreditorID":"String","CreditorIDStartsWith":"String","CreditorIDEndsWith":"String","CreditorIDContains":"String","CreditorIDLike":"String","CreditorIDBetween":["String"],"CreditorIDIn":["String"],"DebitCredit":false,"Ref":"String","RefStartsWith":"String","RefEndsWith":"String","RefContains":"String","RefLike":"String","RefBetween":["String"],"RefIn":["String"],"Remark":"String","RemarkStartsWith":"String","RemarkEndsWith":"String","RemarkContains":"String","RemarkLike":"String","RemarkBetween":["String"],"RemarkIn":["String"],"TranDate":"0001-01-01T00:00:00.0000000","TranDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","TranDateGreaterThan":"0001-01-01T00:00:00.0000000","TranDateLessThan":"0001-01-01T00:00:00.0000000","TranDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","TranDateNotEqualTo":"0001-01-01T00:00:00.0000000","TranDateBetween":["0001-01-01T00:00:00.0000000"],"TranDateIn":["0001-01-01T00:00:00.0000000"],"InvRemitNo":"String","InvRemitNoStartsWith":"String","InvRemitNoEndsWith":"String","InvRemitNoContains":"String","InvRemitNoLike":"String","InvRemitNoBetween":["String"],"InvRemitNoIn":["String"],"FXAmount":0,"FXAmountGreaterThanOrEqualTo":0,"FXAmountGreaterThan":0,"FXAmountLessThan":0,"FXAmountLessThanOrEqualTo":0,"FXAmountNotEqualTo":0,"FXAmountBetween":[0],"FXAmountIn":[0],"DiscountedAmount":0,"DiscountedAmountGreaterThanOrEqualTo":0,"DiscountedAmountGreaterThan":0,"DiscountedAmountLessThan":0,"DiscountedAmountLessThanOrEqualTo":0,"DiscountedAmountNotEqualTo":0,"DiscountedAmountBetween":[0],"DiscountedAmountIn":[0],"AgedOut":false,"SourceID":"String","SourceIDStartsWith":"String","SourceIDEndsWith":"String","SourceIDContains":"String","SourceIDLike":"String","SourceIDBetween":["String"],"SourceIDIn":["String"],"AllocatedAmount":0,"AllocatedAmountGreaterThanOrEqualTo":0,"AllocatedAmountGreaterThan":0,"AllocatedAmountLessThan":0,"AllocatedAmountLessThanOrEqualTo":0,"AllocatedAmountNotEqualTo":0,"AllocatedAmountBetween":[0],"AllocatedAmountIn":[0],"InitDateTime":"0001-01-01T00:00:00.0000000","InitDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","InitDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","InitDateTimeLessThan":"0001-01-01T00:00:00.0000000","InitDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","InitDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","InitDateTimeBetween":["0001-01-01T00:00:00.0000000"],"InitDateTimeIn":["0001-01-01T00:00:00.0000000"],"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"],"BatchNo":"String","BatchNoStartsWith":"String","BatchNoEndsWith":"String","BatchNoContains":"String","BatchNoLike":"String","BatchNoBetween":["String"],"BatchNoIn":["String"],"ChequePrinting":false,"ChequeRunID":"String","ChequeRunIDStartsWith":"String","ChequeRunIDEndsWith":"String","ChequeRunIDContains":"String","ChequeRunIDLike":"String","ChequeRunIDBetween":["String"],"ChequeRunIDIn":["String"],"DueDate":"0001-01-01T00:00:00.0000000","DueDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","DueDateGreaterThan":"0001-01-01T00:00:00.0000000","DueDateLessThan":"0001-01-01T00:00:00.0000000","DueDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","DueDateNotEqualTo":"0001-01-01T00:00:00.0000000","DueDateBetween":["0001-01-01T00:00:00.0000000"],"DueDateIn":["0001-01-01T00:00:00.0000000"],"Amount":0,"AmountGreaterThanOrEqualTo":0,"AmountGreaterThan":0,"AmountLessThan":0,"AmountLessThanOrEqualTo":0,"AmountNotEqualTo":0,"AmountBetween":[0],"AmountIn":[0],"CurrencyRateUsed":0,"CurrencyRateUsedGreaterThanOrEqualTo":0,"CurrencyRateUsedGreaterThan":0,"CurrencyRateUsedLessThan":0,"CurrencyRateUsedLessThanOrEqualTo":0,"CurrencyRateUsedNotEqualTo":0,"CurrencyRateUsedBetween":[0],"CurrencyRateUsedIn":[0],"FXAllocAmount":0,"FXAllocAmountGreaterThanOrEqualTo":0,"FXAllocAmountGreaterThan":0,"FXAllocAmountLessThan":0,"FXAllocAmountLessThanOrEqualTo":0,"FXAllocAmountNotEqualTo":0,"FXAllocAmountBetween":[0],"FXAllocAmountIn":[0],"GSTAmount":0,"GSTAmountGreaterThanOrEqualTo":0,"GSTAmountGreaterThan":0,"GSTAmountLessThan":0,"GSTAmountLessThanOrEqualTo":0,"GSTAmountNotEqualTo":0,"GSTAmountBetween":[0],"GSTAmountIn":[0],"RealisedGainLoss":0,"RealisedGainLossGreaterThanOrEqualTo":0,"RealisedGainLossGreaterThan":0,"RealisedGainLossLessThan":0,"RealisedGainLossLessThanOrEqualTo":0,"RealisedGainLossNotEqualTo":0,"RealisedGainLossBetween":[0],"RealisedGainLossIn":[0],"UnRealisedGainLoss":0,"UnRealisedGainLossGreaterThanOrEqualTo":0,"UnRealisedGainLossGreaterThan":0,"UnRealisedGainLossLessThan":0,"UnRealisedGainLossLessThanOrEqualTo":0,"UnRealisedGainLossNotEqualTo":0,"UnRealisedGainLossBetween":[0],"UnRealisedGainLossIn":[0],"FXDecimalPlaces":0,"FXDecimalPlacesGreaterThanOrEqualTo":0,"FXDecimalPlacesGreaterThan":0,"FXDecimalPlacesLessThan":0,"FXDecimalPlacesLessThanOrEqualTo":0,"FXDecimalPlacesNotEqualTo":0,"FXDecimalPlacesBetween":[0],"FXDecimalPlacesIn":[0],"DecimalPlaces":0,"DecimalPlacesGreaterThanOrEqualTo":0,"DecimalPlacesGreaterThan":0,"DecimalPlacesLessThan":0,"DecimalPlacesLessThanOrEqualTo":0,"DecimalPlacesNotEqualTo":0,"DecimalPlacesBetween":[0],"DecimalPlacesIn":[0],"CurrencyID":"String","CurrencyIDStartsWith":"String","CurrencyIDEndsWith":"String","CurrencyIDContains":"String","CurrencyIDLike":"String","CurrencyIDBetween":["String"],"CurrencyIDIn":["String"],"Source":"String","SourceStartsWith":"String","SourceEndsWith":"String","SourceContains":"String","SourceLike":"String","SourceBetween":["String"],"SourceIn":["String"],"Note":"String","NoteStartsWith":"String","NoteEndsWith":"String","NoteContains":"String","NoteLike":"String","NoteBetween":["String"],"NoteIn":["String"],"Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Results":[{"TransID":"String","CreditorID":"String","Ref":"String","Remark":"String","TranDate":"0001-01-01T00:00:00.0000000","InvRemitNo":"String","FXAmount":0,"DiscountedAmount":0,"SourceID":"String","AllocatedAmount":0,"InitDateTime":"0001-01-01T00:00:00.0000000","LastSavedDateTime":"0001-01-01T00:00:00.0000000","BatchNo":"String","ChequeRunID":"String","DueDate":"0001-01-01T00:00:00.0000000","Amount":0,"CurrencyRateUsed":0,"FXAllocAmount":0,"GSTAmount":0,"RealisedGainLoss":0,"UnRealisedGainLoss":0,"FXDecimalPlaces":0,"DecimalPlaces":0,"CurrencyID":"String","Source":"String","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"}}}