JiwaAPI

<back to all web services

v_Jiwa_Debtor_Transactions_ListQuery

Requires Authentication
v_Jiwa_Debtor_Transactions_ListQuery Parameters:
NameParameterData TypeRequiredDescription
TransIDquerystringNo
TransIDStartsWithquerystringNo
TransIDEndsWithquerystringNo
TransIDContainsquerystringNo
TransIDLikequerystringNo
TransIDBetweenquerystring[]No
TransIDInquerystring[]No
DebtorIDquerystringNo
DebtorIDStartsWithquerystringNo
DebtorIDEndsWithquerystringNo
DebtorIDContainsquerystringNo
DebtorIDLikequerystringNo
DebtorIDBetweenquerystring[]No
DebtorIDInquerystring[]No
AccountNoquerystringNo
AccountNoStartsWithquerystringNo
AccountNoEndsWithquerystringNo
AccountNoContainsquerystringNo
AccountNoLikequerystringNo
AccountNoBetweenquerystring[]No
AccountNoInquerystring[]No
NamequerystringNo
NameStartsWithquerystringNo
NameEndsWithquerystringNo
NameContainsquerystringNo
NameLikequerystringNo
NameBetweenquerystring[]No
NameInquerystring[]No
TranDatequeryDateTime?No
TranDateGreaterThanOrEqualToqueryDateTime?No
TranDateGreaterThanqueryDateTime?No
TranDateLessThanqueryDateTime?No
TranDateLessThanOrEqualToqueryDateTime?No
TranDateNotEqualToqueryDateTime?No
TranDateBetweenqueryNullable<DateTime>[]No
TranDateInqueryNullable<DateTime>[]No
DueDatequeryDateTime?No
DueDateGreaterThanOrEqualToqueryDateTime?No
DueDateGreaterThanqueryDateTime?No
DueDateLessThanqueryDateTime?No
DueDateLessThanOrEqualToqueryDateTime?No
DueDateNotEqualToqueryDateTime?No
DueDateBetweenqueryNullable<DateTime>[]No
DueDateInqueryNullable<DateTime>[]No
InvRemitNoquerystringNo
InvRemitNoStartsWithquerystringNo
InvRemitNoEndsWithquerystringNo
InvRemitNoContainsquerystringNo
InvRemitNoLikequerystringNo
InvRemitNoBetweenquerystring[]No
InvRemitNoInquerystring[]No
DebitCreditquerybool?No
Amountquerydecimal?No
AmountGreaterThanOrEqualToquerydecimal?No
AmountGreaterThanquerydecimal?No
AmountLessThanquerydecimal?No
AmountLessThanOrEqualToquerydecimal?No
AmountNotEqualToquerydecimal?No
AmountBetweenqueryNullable<Decimal>[]No
AmountInqueryNullable<Decimal>[]No
AllocatedAmountquerydecimal?No
AllocatedAmountGreaterThanOrEqualToquerydecimal?No
AllocatedAmountGreaterThanquerydecimal?No
AllocatedAmountLessThanquerydecimal?No
AllocatedAmountLessThanOrEqualToquerydecimal?No
AllocatedAmountNotEqualToquerydecimal?No
AllocatedAmountBetweenqueryNullable<Decimal>[]No
AllocatedAmountInqueryNullable<Decimal>[]No
GSTAmountquerydecimal?No
GSTAmountGreaterThanOrEqualToquerydecimal?No
GSTAmountGreaterThanquerydecimal?No
GSTAmountLessThanquerydecimal?No
GSTAmountLessThanOrEqualToquerydecimal?No
GSTAmountNotEqualToquerydecimal?No
GSTAmountBetweenqueryNullable<Decimal>[]No
GSTAmountInqueryNullable<Decimal>[]No
OutstandingAmountquerydecimal?No
OutstandingAmountGreaterThanOrEqualToquerydecimal?No
OutstandingAmountGreaterThanquerydecimal?No
OutstandingAmountLessThanquerydecimal?No
OutstandingAmountLessThanOrEqualToquerydecimal?No
OutstandingAmountNotEqualToquerydecimal?No
OutstandingAmountBetweenqueryNullable<Decimal>[]No
OutstandingAmountInqueryNullable<Decimal>[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
SourceIDquerystringNo
SourceIDStartsWithquerystringNo
SourceIDEndsWithquerystringNo
SourceIDContainsquerystringNo
SourceIDLikequerystringNo
SourceIDBetweenquerystring[]No
SourceIDInquerystring[]No
RefquerystringNo
RefStartsWithquerystringNo
RefEndsWithquerystringNo
RefContainsquerystringNo
RefLikequerystringNo
RefBetweenquerystring[]No
RefInquerystring[]No
RemarkquerystringNo
RemarkStartsWithquerystringNo
RemarkEndsWithquerystringNo
RemarkContainsquerystringNo
RemarkLikequerystringNo
RemarkBetweenquerystring[]No
RemarkInquerystring[]No
NotequerystringNo
NoteStartsWithquerystringNo
NoteEndsWithquerystringNo
NoteContainsquerystringNo
NoteLikequerystringNo
NoteBetweenquerystring[]No
NoteInquerystring[]No
AgedOutquerybool?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
v_Jiwa_Debtor_Transactions_List Parameters:
NameParameterData TypeRequiredDescription
TransIDformstringNo
DebtorIDformstringNo
AccountNoformstringNo
NameformstringNo
TranDateformDateTime?No
DueDateformDateTime?No
InvRemitNoformstringNo
DebitCreditformboolNo
Amountformdecimal?No
AllocatedAmountformdecimal?No
GSTAmountformdecimal?No
OutstandingAmountformdecimal?No
DescriptionformstringNo
SourceIDformstringNo
RefformstringNo
RemarkformstringNo
NoteformstringNo
AgedOutformboolNo
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/v_Jiwa_Debtor_Transactions_ListQuery 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"],"DebtorID":"String","DebtorIDStartsWith":"String","DebtorIDEndsWith":"String","DebtorIDContains":"String","DebtorIDLike":"String","DebtorIDBetween":["String"],"DebtorIDIn":["String"],"AccountNo":"String","AccountNoStartsWith":"String","AccountNoEndsWith":"String","AccountNoContains":"String","AccountNoLike":"String","AccountNoBetween":["String"],"AccountNoIn":["String"],"Name":"String","NameStartsWith":"String","NameEndsWith":"String","NameContains":"String","NameLike":"String","NameBetween":["String"],"NameIn":["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"],"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"],"InvRemitNo":"String","InvRemitNoStartsWith":"String","InvRemitNoEndsWith":"String","InvRemitNoContains":"String","InvRemitNoLike":"String","InvRemitNoBetween":["String"],"InvRemitNoIn":["String"],"DebitCredit":false,"Amount":0,"AmountGreaterThanOrEqualTo":0,"AmountGreaterThan":0,"AmountLessThan":0,"AmountLessThanOrEqualTo":0,"AmountNotEqualTo":0,"AmountBetween":[0],"AmountIn":[0],"AllocatedAmount":0,"AllocatedAmountGreaterThanOrEqualTo":0,"AllocatedAmountGreaterThan":0,"AllocatedAmountLessThan":0,"AllocatedAmountLessThanOrEqualTo":0,"AllocatedAmountNotEqualTo":0,"AllocatedAmountBetween":[0],"AllocatedAmountIn":[0],"GSTAmount":0,"GSTAmountGreaterThanOrEqualTo":0,"GSTAmountGreaterThan":0,"GSTAmountLessThan":0,"GSTAmountLessThanOrEqualTo":0,"GSTAmountNotEqualTo":0,"GSTAmountBetween":[0],"GSTAmountIn":[0],"OutstandingAmount":0,"OutstandingAmountGreaterThanOrEqualTo":0,"OutstandingAmountGreaterThan":0,"OutstandingAmountLessThan":0,"OutstandingAmountLessThanOrEqualTo":0,"OutstandingAmountNotEqualTo":0,"OutstandingAmountBetween":[0],"OutstandingAmountIn":[0],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"SourceID":"String","SourceIDStartsWith":"String","SourceIDEndsWith":"String","SourceIDContains":"String","SourceIDLike":"String","SourceIDBetween":["String"],"SourceIDIn":["String"],"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"],"Note":"String","NoteStartsWith":"String","NoteEndsWith":"String","NoteContains":"String","NoteLike":"String","NoteBetween":["String"],"NoteIn":["String"],"AgedOut":false,"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","DebtorID":"String","AccountNo":"String","Name":"String","TranDate":"0001-01-01T00:00:00.0000000","DueDate":"0001-01-01T00:00:00.0000000","InvRemitNo":"String","Amount":0,"AllocatedAmount":0,"GSTAmount":0,"OutstandingAmount":0,"Description":"String","SourceID":"String","Ref":"String","Remark":"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"}}}