JiwaAPI

<back to all web services

BR_MainQuery

Requires Authentication
BR_MainQuery Parameters:
NameParameterData TypeRequiredDescription
BankRecIDquerystringNo
BankRecIDStartsWithquerystringNo
BankRecIDEndsWithquerystringNo
BankRecIDContainsquerystringNo
BankRecIDLikequerystringNo
BankRecIDBetweenquerystring[]No
BankRecIDInquerystring[]No
BankRecNoquerystringNo
BankRecNoStartsWithquerystringNo
BankRecNoEndsWithquerystringNo
BankRecNoContainsquerystringNo
BankRecNoLikequerystringNo
BankRecNoBetweenquerystring[]No
BankRecNoInquerystring[]No
ReferencequerystringNo
ReferenceStartsWithquerystringNo
ReferenceEndsWithquerystringNo
ReferenceContainsquerystringNo
ReferenceLikequerystringNo
ReferenceBetweenquerystring[]No
ReferenceInquerystring[]No
BankAccountLedgerIDquerystringNo
BankAccountLedgerIDStartsWithquerystringNo
BankAccountLedgerIDEndsWithquerystringNo
BankAccountLedgerIDContainsquerystringNo
BankAccountLedgerIDLikequerystringNo
BankAccountLedgerIDBetweenquerystring[]No
BankAccountLedgerIDInquerystring[]No
BankStatementDatequeryDateTime?No
BankStatementDateGreaterThanOrEqualToqueryDateTime?No
BankStatementDateGreaterThanqueryDateTime?No
BankStatementDateLessThanqueryDateTime?No
BankStatementDateLessThanOrEqualToqueryDateTime?No
BankStatementDateNotEqualToqueryDateTime?No
BankStatementDateBetweenqueryNullable<DateTime>[]No
BankStatementDateInqueryNullable<DateTime>[]No
Statusqueryint?No
StatusGreaterThanOrEqualToqueryint?No
StatusGreaterThanqueryint?No
StatusLessThanqueryint?No
StatusLessThanOrEqualToqueryint?No
StatusNotEqualToqueryint?No
StatusBetweenqueryNullable<Int32>[]No
StatusInqueryNullable<Int32>[]No
CreatedByStaffIDquerystringNo
CreatedByStaffIDStartsWithquerystringNo
CreatedByStaffIDEndsWithquerystringNo
CreatedByStaffIDContainsquerystringNo
CreatedByStaffIDLikequerystringNo
CreatedByStaffIDBetweenquerystring[]No
CreatedByStaffIDInquerystring[]No
CreatedDateTimequeryDateTime?No
CreatedDateTimeGreaterThanOrEqualToqueryDateTime?No
CreatedDateTimeGreaterThanqueryDateTime?No
CreatedDateTimeLessThanqueryDateTime?No
CreatedDateTimeLessThanOrEqualToqueryDateTime?No
CreatedDateTimeNotEqualToqueryDateTime?No
CreatedDateTimeBetweenqueryNullable<DateTime>[]No
CreatedDateTimeInqueryNullable<DateTime>[]No
LastSavedByStaffIDquerystringNo
LastSavedByStaffIDStartsWithquerystringNo
LastSavedByStaffIDEndsWithquerystringNo
LastSavedByStaffIDContainsquerystringNo
LastSavedByStaffIDLikequerystringNo
LastSavedByStaffIDBetweenquerystring[]No
LastSavedByStaffIDInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryNullable<DateTime>[]No
LastSavedDateTimeInqueryNullable<DateTime>[]No
BankStatementOpeningBalancequerydecimal?No
BankStatementOpeningBalanceGreaterThanOrEqualToquerydecimal?No
BankStatementOpeningBalanceGreaterThanquerydecimal?No
BankStatementOpeningBalanceLessThanquerydecimal?No
BankStatementOpeningBalanceLessThanOrEqualToquerydecimal?No
BankStatementOpeningBalanceNotEqualToquerydecimal?No
BankStatementOpeningBalanceBetweenqueryNullable<Decimal>[]No
BankStatementOpeningBalanceInqueryNullable<Decimal>[]No
BankAccountLedgerCurrentBalancequerydecimal?No
BankAccountLedgerCurrentBalanceGreaterThanOrEqualToquerydecimal?No
BankAccountLedgerCurrentBalanceGreaterThanquerydecimal?No
BankAccountLedgerCurrentBalanceLessThanquerydecimal?No
BankAccountLedgerCurrentBalanceLessThanOrEqualToquerydecimal?No
BankAccountLedgerCurrentBalanceNotEqualToquerydecimal?No
BankAccountLedgerCurrentBalanceBetweenqueryNullable<Decimal>[]No
BankAccountLedgerCurrentBalanceInqueryNullable<Decimal>[]No
BankStatementClosingBalancequerydecimal?No
BankStatementClosingBalanceGreaterThanOrEqualToquerydecimal?No
BankStatementClosingBalanceGreaterThanquerydecimal?No
BankStatementClosingBalanceLessThanquerydecimal?No
BankStatementClosingBalanceLessThanOrEqualToquerydecimal?No
BankStatementClosingBalanceNotEqualToquerydecimal?No
BankStatementClosingBalanceBetweenqueryNullable<Decimal>[]No
BankStatementClosingBalanceInqueryNullable<Decimal>[]No
BankAccountLedgerBalanceBroughtForwardquerydecimal?No
BankAccountLedgerBalanceBroughtForwardGreaterThanOrEqualToquerydecimal?No
BankAccountLedgerBalanceBroughtForwardGreaterThanquerydecimal?No
BankAccountLedgerBalanceBroughtForwardLessThanquerydecimal?No
BankAccountLedgerBalanceBroughtForwardLessThanOrEqualToquerydecimal?No
BankAccountLedgerBalanceBroughtForwardNotEqualToquerydecimal?No
BankAccountLedgerBalanceBroughtForwardBetweenqueryNullable<Decimal>[]No
BankAccountLedgerBalanceBroughtForwardInqueryNullable<Decimal>[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
BR_Main Parameters:
NameParameterData TypeRequiredDescription
BankRecIDformstringNo
BankRecNoformstringNo
ReferenceformstringNo
BankAccountLedgerIDformstringNo
BankStatementDateformDateTime?No
Statusformint?No
CreatedByStaffIDformstringNo
CreatedDateTimeformDateTime?No
LastSavedByStaffIDformstringNo
LastSavedDateTimeformDateTime?No
BankStatementOpeningBalanceformdecimal?No
BankAccountLedgerCurrentBalanceformdecimal?No
BankStatementClosingBalanceformdecimal?No
BankAccountLedgerBalanceBroughtForwardformdecimal?No
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/BR_MainQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"BankRecID":"String","BankRecIDStartsWith":"String","BankRecIDEndsWith":"String","BankRecIDContains":"String","BankRecIDLike":"String","BankRecIDBetween":["String"],"BankRecIDIn":["String"],"BankRecNo":"String","BankRecNoStartsWith":"String","BankRecNoEndsWith":"String","BankRecNoContains":"String","BankRecNoLike":"String","BankRecNoBetween":["String"],"BankRecNoIn":["String"],"Reference":"String","ReferenceStartsWith":"String","ReferenceEndsWith":"String","ReferenceContains":"String","ReferenceLike":"String","ReferenceBetween":["String"],"ReferenceIn":["String"],"BankAccountLedgerID":"String","BankAccountLedgerIDStartsWith":"String","BankAccountLedgerIDEndsWith":"String","BankAccountLedgerIDContains":"String","BankAccountLedgerIDLike":"String","BankAccountLedgerIDBetween":["String"],"BankAccountLedgerIDIn":["String"],"BankStatementDate":"0001-01-01T00:00:00.0000000","BankStatementDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","BankStatementDateGreaterThan":"0001-01-01T00:00:00.0000000","BankStatementDateLessThan":"0001-01-01T00:00:00.0000000","BankStatementDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","BankStatementDateNotEqualTo":"0001-01-01T00:00:00.0000000","BankStatementDateBetween":["0001-01-01T00:00:00.0000000"],"BankStatementDateIn":["0001-01-01T00:00:00.0000000"],"Status":0,"StatusGreaterThanOrEqualTo":0,"StatusGreaterThan":0,"StatusLessThan":0,"StatusLessThanOrEqualTo":0,"StatusNotEqualTo":0,"StatusBetween":[0],"StatusIn":[0],"CreatedByStaffID":"String","CreatedByStaffIDStartsWith":"String","CreatedByStaffIDEndsWith":"String","CreatedByStaffIDContains":"String","CreatedByStaffIDLike":"String","CreatedByStaffIDBetween":["String"],"CreatedByStaffIDIn":["String"],"CreatedDateTime":"0001-01-01T00:00:00.0000000","CreatedDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","CreatedDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","CreatedDateTimeLessThan":"0001-01-01T00:00:00.0000000","CreatedDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","CreatedDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","CreatedDateTimeBetween":["0001-01-01T00:00:00.0000000"],"CreatedDateTimeIn":["0001-01-01T00:00:00.0000000"],"LastSavedByStaffID":"String","LastSavedByStaffIDStartsWith":"String","LastSavedByStaffIDEndsWith":"String","LastSavedByStaffIDContains":"String","LastSavedByStaffIDLike":"String","LastSavedByStaffIDBetween":["String"],"LastSavedByStaffIDIn":["String"],"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"],"BankStatementOpeningBalance":0,"BankStatementOpeningBalanceGreaterThanOrEqualTo":0,"BankStatementOpeningBalanceGreaterThan":0,"BankStatementOpeningBalanceLessThan":0,"BankStatementOpeningBalanceLessThanOrEqualTo":0,"BankStatementOpeningBalanceNotEqualTo":0,"BankStatementOpeningBalanceBetween":[0],"BankStatementOpeningBalanceIn":[0],"BankAccountLedgerCurrentBalance":0,"BankAccountLedgerCurrentBalanceGreaterThanOrEqualTo":0,"BankAccountLedgerCurrentBalanceGreaterThan":0,"BankAccountLedgerCurrentBalanceLessThan":0,"BankAccountLedgerCurrentBalanceLessThanOrEqualTo":0,"BankAccountLedgerCurrentBalanceNotEqualTo":0,"BankAccountLedgerCurrentBalanceBetween":[0],"BankAccountLedgerCurrentBalanceIn":[0],"BankStatementClosingBalance":0,"BankStatementClosingBalanceGreaterThanOrEqualTo":0,"BankStatementClosingBalanceGreaterThan":0,"BankStatementClosingBalanceLessThan":0,"BankStatementClosingBalanceLessThanOrEqualTo":0,"BankStatementClosingBalanceNotEqualTo":0,"BankStatementClosingBalanceBetween":[0],"BankStatementClosingBalanceIn":[0],"BankAccountLedgerBalanceBroughtForward":0,"BankAccountLedgerBalanceBroughtForwardGreaterThanOrEqualTo":0,"BankAccountLedgerBalanceBroughtForwardGreaterThan":0,"BankAccountLedgerBalanceBroughtForwardLessThan":0,"BankAccountLedgerBalanceBroughtForwardLessThanOrEqualTo":0,"BankAccountLedgerBalanceBroughtForwardNotEqualTo":0,"BankAccountLedgerBalanceBroughtForwardBetween":[0],"BankAccountLedgerBalanceBroughtForwardIn":[0],"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":[{"BankRecID":"String","BankRecNo":"String","Reference":"String","BankAccountLedgerID":"String","BankStatementDate":"0001-01-01T00:00:00.0000000","Status":0,"CreatedByStaffID":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","LastSavedByStaffID":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","BankStatementOpeningBalance":0,"BankAccountLedgerCurrentBalance":0,"BankStatementClosingBalance":0,"BankAccountLedgerBalanceBroughtForward":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}