JiwaAPI

DB_TransQuery

The following routes are available for this service:
GET	/Queries/DB_Trans	Retrieves a list of debtor transactions

**DB_TransQuery** Parameters:
Name	Parameter	Data Type	Required
TransID	query	string	No
TransIDStartsWith	query	string	No
TransIDEndsWith	query	string	No
TransIDContains	query	string	No
TransIDLike	query	string	No
TransIDBetween	query	string[]	No
TransIDIn	query	string[]	No
DebtorID	query	string	No
DebtorIDStartsWith	query	string	No
DebtorIDEndsWith	query	string	No
DebtorIDContains	query	string	No
DebtorIDLike	query	string	No
DebtorIDBetween	query	string[]	No
DebtorIDIn	query	string[]	No
DebitCredit	query	bool?	No
Source	query	string	No
SourceStartsWith	query	string	No
SourceEndsWith	query	string	No
SourceContains	query	string	No
SourceLike	query	string	No
SourceBetween	query	string[]	No
SourceIn	query	string[]	No
Ref	query	string	No
RefStartsWith	query	string	No
RefEndsWith	query	string	No
RefContains	query	string	No
RefLike	query	string	No
RefBetween	query	string[]	No
RefIn	query	string[]	No
Remark	query	string	No
RemarkStartsWith	query	string	No
RemarkEndsWith	query	string	No
RemarkContains	query	string	No
RemarkLike	query	string	No
RemarkBetween	query	string[]	No
RemarkIn	query	string[]	No
TranDate	query	DateTime?	No
TranDateGreaterThanOrEqualTo	query	DateTime?	No
TranDateGreaterThan	query	DateTime?	No
TranDateLessThan	query	DateTime?	No
TranDateLessThanOrEqualTo	query	DateTime?	No
TranDateNotEqualTo	query	DateTime?	No
TranDateBetween	query	Nullable<DateTime>[]	No
TranDateIn	query	Nullable<DateTime>[]	No
InvRemitNo	query	string	No
InvRemitNoStartsWith	query	string	No
InvRemitNoEndsWith	query	string	No
InvRemitNoContains	query	string	No
InvRemitNoLike	query	string	No
InvRemitNoBetween	query	string[]	No
InvRemitNoIn	query	string[]	No
Amount	query	decimal?	No
AmountGreaterThanOrEqualTo	query	decimal?	No
AmountGreaterThan	query	decimal?	No
AmountLessThan	query	decimal?	No
AmountLessThanOrEqualTo	query	decimal?	No
AmountNotEqualTo	query	decimal?	No
AmountBetween	query	Nullable<Decimal>[]	No
AmountIn	query	Nullable<Decimal>[]	No
DiscountedAmount	query	decimal?	No
DiscountedAmountGreaterThanOrEqualTo	query	decimal?	No
DiscountedAmountGreaterThan	query	decimal?	No
DiscountedAmountLessThan	query	decimal?	No
DiscountedAmountLessThanOrEqualTo	query	decimal?	No
DiscountedAmountNotEqualTo	query	decimal?	No
DiscountedAmountBetween	query	Nullable<Decimal>[]	No
DiscountedAmountIn	query	Nullable<Decimal>[]	No
AgedOut	query	bool?	No
SourceID	query	string	No
SourceIDStartsWith	query	string	No
SourceIDEndsWith	query	string	No
SourceIDContains	query	string	No
SourceIDLike	query	string	No
SourceIDBetween	query	string[]	No
SourceIDIn	query	string[]	No
AllocatedAmount	query	decimal?	No
AllocatedAmountGreaterThanOrEqualTo	query	decimal?	No
AllocatedAmountGreaterThan	query	decimal?	No
AllocatedAmountLessThan	query	decimal?	No
AllocatedAmountLessThanOrEqualTo	query	decimal?	No
AllocatedAmountNotEqualTo	query	decimal?	No
AllocatedAmountBetween	query	Nullable<Decimal>[]	No
AllocatedAmountIn	query	Nullable<Decimal>[]	No
InitDateTime	query	DateTime?	No
InitDateTimeGreaterThanOrEqualTo	query	DateTime?	No
InitDateTimeGreaterThan	query	DateTime?	No
InitDateTimeLessThan	query	DateTime?	No
InitDateTimeLessThanOrEqualTo	query	DateTime?	No
InitDateTimeNotEqualTo	query	DateTime?	No
InitDateTimeBetween	query	Nullable<DateTime>[]	No
InitDateTimeIn	query	Nullable<DateTime>[]	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
SubType	query	short?	No
SubTypeGreaterThanOrEqualTo	query	short?	No
SubTypeGreaterThan	query	short?	No
SubTypeLessThan	query	short?	No
SubTypeLessThanOrEqualTo	query	short?	No
SubTypeNotEqualTo	query	short?	No
SubTypeBetween	query	Nullable<Int16>[]	No
SubTypeIn	query	Nullable<Int16>[]	No
BatchNo	query	string	No
BatchNoStartsWith	query	string	No
BatchNoEndsWith	query	string	No
BatchNoContains	query	string	No
BatchNoLike	query	string	No
BatchNoBetween	query	string[]	No
BatchNoIn	query	string[]	No
ChildDebtorID	query	string	No
ChildDebtorIDStartsWith	query	string	No
ChildDebtorIDEndsWith	query	string	No
ChildDebtorIDContains	query	string	No
ChildDebtorIDLike	query	string	No
ChildDebtorIDBetween	query	string[]	No
ChildDebtorIDIn	query	string[]	No
GSTAmount	query	decimal?	No
GSTAmountGreaterThanOrEqualTo	query	decimal?	No
GSTAmountGreaterThan	query	decimal?	No
GSTAmountLessThan	query	decimal?	No
GSTAmountLessThanOrEqualTo	query	decimal?	No
GSTAmountNotEqualTo	query	decimal?	No
GSTAmountBetween	query	Nullable<Decimal>[]	No
GSTAmountIn	query	Nullable<Decimal>[]	No
DueDate	query	DateTime?	No
DueDateGreaterThanOrEqualTo	query	DateTime?	No
DueDateGreaterThan	query	DateTime?	No
DueDateLessThan	query	DateTime?	No
DueDateLessThanOrEqualTo	query	DateTime?	No
DueDateNotEqualTo	query	DateTime?	No
DueDateBetween	query	Nullable<DateTime>[]	No
DueDateIn	query	Nullable<DateTime>[]	No
FXAmount	query	decimal?	No
FXAmountGreaterThanOrEqualTo	query	decimal?	No
FXAmountGreaterThan	query	decimal?	No
FXAmountLessThan	query	decimal?	No
FXAmountLessThanOrEqualTo	query	decimal?	No
FXAmountNotEqualTo	query	decimal?	No
FXAmountBetween	query	Nullable<Decimal>[]	No
FXAmountIn	query	Nullable<Decimal>[]	No
FXAllocAmount	query	decimal?	No
FXAllocAmountGreaterThanOrEqualTo	query	decimal?	No
FXAllocAmountGreaterThan	query	decimal?	No
FXAllocAmountLessThan	query	decimal?	No
FXAllocAmountLessThanOrEqualTo	query	decimal?	No
FXAllocAmountNotEqualTo	query	decimal?	No
FXAllocAmountBetween	query	Nullable<Decimal>[]	No
FXAllocAmountIn	query	Nullable<Decimal>[]	No
CurrencyRateUsed	query	decimal?	No
CurrencyRateUsedGreaterThanOrEqualTo	query	decimal?	No
CurrencyRateUsedGreaterThan	query	decimal?	No
CurrencyRateUsedLessThan	query	decimal?	No
CurrencyRateUsedLessThanOrEqualTo	query	decimal?	No
CurrencyRateUsedNotEqualTo	query	decimal?	No
CurrencyRateUsedBetween	query	Nullable<Decimal>[]	No
CurrencyRateUsedIn	query	Nullable<Decimal>[]	No
RealisedGainLoss	query	decimal?	No
RealisedGainLossGreaterThanOrEqualTo	query	decimal?	No
RealisedGainLossGreaterThan	query	decimal?	No
RealisedGainLossLessThan	query	decimal?	No
RealisedGainLossLessThanOrEqualTo	query	decimal?	No
RealisedGainLossNotEqualTo	query	decimal?	No
RealisedGainLossBetween	query	Nullable<Decimal>[]	No
RealisedGainLossIn	query	Nullable<Decimal>[]	No
UnRealisedGainLoss	query	decimal?	No
UnRealisedGainLossGreaterThanOrEqualTo	query	decimal?	No
UnRealisedGainLossGreaterThan	query	decimal?	No
UnRealisedGainLossLessThan	query	decimal?	No
UnRealisedGainLossLessThanOrEqualTo	query	decimal?	No
UnRealisedGainLossNotEqualTo	query	decimal?	No
UnRealisedGainLossBetween	query	Nullable<Decimal>[]	No
UnRealisedGainLossIn	query	Nullable<Decimal>[]	No
CurrencyID	query	string	No
CurrencyIDStartsWith	query	string	No
CurrencyIDEndsWith	query	string	No
CurrencyIDContains	query	string	No
CurrencyIDLike	query	string	No
CurrencyIDBetween	query	string[]	No
CurrencyIDIn	query	string[]	No
Cartage1Amount	query	decimal?	No
Cartage1AmountGreaterThanOrEqualTo	query	decimal?	No
Cartage1AmountGreaterThan	query	decimal?	No
Cartage1AmountLessThan	query	decimal?	No
Cartage1AmountLessThanOrEqualTo	query	decimal?	No
Cartage1AmountNotEqualTo	query	decimal?	No
Cartage1AmountBetween	query	Nullable<Decimal>[]	No
Cartage1AmountIn	query	Nullable<Decimal>[]	No
Cartage1TaxAmount	query	decimal?	No
Cartage1TaxAmountGreaterThanOrEqualTo	query	decimal?	No
Cartage1TaxAmountGreaterThan	query	decimal?	No
Cartage1TaxAmountLessThan	query	decimal?	No
Cartage1TaxAmountLessThanOrEqualTo	query	decimal?	No
Cartage1TaxAmountNotEqualTo	query	decimal?	No
Cartage1TaxAmountBetween	query	Nullable<Decimal>[]	No
Cartage1TaxAmountIn	query	Nullable<Decimal>[]	No
Cartage2Amount	query	decimal?	No
Cartage2AmountGreaterThanOrEqualTo	query	decimal?	No
Cartage2AmountGreaterThan	query	decimal?	No
Cartage2AmountLessThan	query	decimal?	No
Cartage2AmountLessThanOrEqualTo	query	decimal?	No
Cartage2AmountNotEqualTo	query	decimal?	No
Cartage2AmountBetween	query	Nullable<Decimal>[]	No
Cartage2AmountIn	query	Nullable<Decimal>[]	No
Cartage2TaxAmount	query	decimal?	No
Cartage2TaxAmountGreaterThanOrEqualTo	query	decimal?	No
Cartage2TaxAmountGreaterThan	query	decimal?	No
Cartage2TaxAmountLessThan	query	decimal?	No
Cartage2TaxAmountLessThanOrEqualTo	query	decimal?	No
Cartage2TaxAmountNotEqualTo	query	decimal?	No
Cartage2TaxAmountBetween	query	Nullable<Decimal>[]	No
Cartage2TaxAmountIn	query	Nullable<Decimal>[]	No
Cartage3Amount	query	decimal?	No
Cartage3AmountGreaterThanOrEqualTo	query	decimal?	No
Cartage3AmountGreaterThan	query	decimal?	No
Cartage3AmountLessThan	query	decimal?	No
Cartage3AmountLessThanOrEqualTo	query	decimal?	No
Cartage3AmountNotEqualTo	query	decimal?	No
Cartage3AmountBetween	query	Nullable<Decimal>[]	No
Cartage3AmountIn	query	Nullable<Decimal>[]	No
Cartage3TaxAmount	query	decimal?	No
Cartage3TaxAmountGreaterThanOrEqualTo	query	decimal?	No
Cartage3TaxAmountGreaterThan	query	decimal?	No
Cartage3TaxAmountLessThan	query	decimal?	No
Cartage3TaxAmountLessThanOrEqualTo	query	decimal?	No
Cartage3TaxAmountNotEqualTo	query	decimal?	No
Cartage3TaxAmountBetween	query	Nullable<Decimal>[]	No
Cartage3TaxAmountIn	query	Nullable<Decimal>[]	No
FXDecimalPlaces	query	short?	No
FXDecimalPlacesGreaterThanOrEqualTo	query	short?	No
FXDecimalPlacesGreaterThan	query	short?	No
FXDecimalPlacesLessThan	query	short?	No
FXDecimalPlacesLessThanOrEqualTo	query	short?	No
FXDecimalPlacesNotEqualTo	query	short?	No
FXDecimalPlacesBetween	query	Nullable<Int16>[]	No
FXDecimalPlacesIn	query	Nullable<Int16>[]	No
DecimalPlaces	query	short?	No
DecimalPlacesGreaterThanOrEqualTo	query	short?	No
DecimalPlacesGreaterThan	query	short?	No
DecimalPlacesLessThan	query	short?	No
DecimalPlacesLessThanOrEqualTo	query	short?	No
DecimalPlacesNotEqualTo	query	short?	No
DecimalPlacesBetween	query	Nullable<Int16>[]	No
DecimalPlacesIn	query	Nullable<Int16>[]	No
Note	query	string	No
NoteStartsWith	query	string	No
NoteEndsWith	query	string	No
NoteContains	query	string	No
NoteLike	query	string	No
NoteBetween	query	string[]	No
NoteIn	query	string[]	No

**QueryBase** Parameters:
Name	Parameter	Data Type	Required
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

**DB_Trans** Parameters:
Name	Parameter	Data Type	Required
TransID	form	string	No
DebtorID	form	string	No
DebitCredit	form	bool	No
Source	form	string	No
Ref	form	string	No
Remark	form	string	No
TranDate	form	DateTime?	No
InvRemitNo	form	string	No
Amount	form	decimal?	No
DiscountedAmount	form	decimal?	No
AgedOut	form	bool	No
SourceID	form	string	No
AllocatedAmount	form	decimal?	No
InitDateTime	form	DateTime?	No
LastSavedDateTime	form	DateTime?	No
SubType	form	short?	No
BatchNo	form	string	No
ChildDebtorID	form	string	No
GSTAmount	form	decimal?	No
DueDate	form	DateTime?	No
FXAmount	form	decimal?	No
FXAllocAmount	form	decimal?	No
CurrencyRateUsed	form	decimal?	No
RealisedGainLoss	form	decimal?	No
UnRealisedGainLoss	form	decimal?	No
CurrencyID	form	string	No
Cartage1Amount	form	decimal?	No
Cartage1TaxAmount	form	decimal?	No
Cartage2Amount	form	decimal?	No
Cartage2TaxAmount	form	decimal?	No
Cartage3Amount	form	decimal?	No
Cartage3TaxAmount	form	decimal?	No
FXDecimalPlaces	form	short?	No
DecimalPlaces	form	short?	No
Note	form	string	No

**QueryResponse<T>** Parameters:
Name	Parameter	Data Type	Required
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json

HTTP/1.1 200 OK
Content-Type: application/json
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"}}}