JiwaAPI

<back to all web services

CB_BatchTransQuery

Requires Authentication
CB_BatchTransQuery Parameters:
NameParameterData TypeRequiredDescription
CBBatchIDquerystringNo
CBBatchIDStartsWithquerystringNo
CBBatchIDEndsWithquerystringNo
CBBatchIDContainsquerystringNo
CBBatchIDLikequerystringNo
CBBatchIDBetweenquerystring[]No
CBBatchIDInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryNullable<DateTime>[]No
LastSavedDateTimeInqueryNullable<DateTime>[]No
StaffIDquerystringNo
StaffIDStartsWithquerystringNo
StaffIDEndsWithquerystringNo
StaffIDContainsquerystringNo
StaffIDLikequerystringNo
StaffIDBetweenquerystring[]No
StaffIDInquerystring[]No
BatchDatequeryDateTime?No
BatchDateGreaterThanOrEqualToqueryDateTime?No
BatchDateGreaterThanqueryDateTime?No
BatchDateLessThanqueryDateTime?No
BatchDateLessThanOrEqualToqueryDateTime?No
BatchDateNotEqualToqueryDateTime?No
BatchDateBetweenqueryNullable<DateTime>[]No
BatchDateInqueryNullable<DateTime>[]No
BatchNoquerystringNo
BatchNoStartsWithquerystringNo
BatchNoEndsWithquerystringNo
BatchNoContainsquerystringNo
BatchNoLikequerystringNo
BatchNoBetweenquerystring[]No
BatchNoInquerystring[]No
Activatedquerybool?No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
ReceiptPaymentquerybyte?No
ReceiptPaymentGreaterThanOrEqualToquerybyte?No
ReceiptPaymentGreaterThanquerybyte?No
ReceiptPaymentLessThanquerybyte?No
ReceiptPaymentLessThanOrEqualToquerybyte?No
ReceiptPaymentNotEqualToquerybyte?No
ReceiptPaymentBetweenqueryNullable<Byte>[]No
ReceiptPaymentInqueryNullable<Byte>[]No
BankLedgerIDquerystringNo
BankLedgerIDStartsWithquerystringNo
BankLedgerIDEndsWithquerystringNo
BankLedgerIDContainsquerystringNo
BankLedgerIDLikequerystringNo
BankLedgerIDBetweenquerystring[]No
BankLedgerIDInquerystring[]No
GroupJournalsquerybool?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
CB_BatchTrans Parameters:
NameParameterData TypeRequiredDescription
CBBatchIDformstringNo
LastSavedDateTimeformDateTime?No
StaffIDformstringNo
BatchDateformDateTime?No
BatchNoformstringNo
Activatedformbool?No
DescriptionformstringNo
ReceiptPaymentformbyte?No
BankLedgerIDformstringNo
GroupJournalsformboolNo
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/CB_BatchTransQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"CBBatchID":"String","CBBatchIDStartsWith":"String","CBBatchIDEndsWith":"String","CBBatchIDContains":"String","CBBatchIDLike":"String","CBBatchIDBetween":["String"],"CBBatchIDIn":["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"],"StaffID":"String","StaffIDStartsWith":"String","StaffIDEndsWith":"String","StaffIDContains":"String","StaffIDLike":"String","StaffIDBetween":["String"],"StaffIDIn":["String"],"BatchDate":"0001-01-01T00:00:00.0000000","BatchDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","BatchDateGreaterThan":"0001-01-01T00:00:00.0000000","BatchDateLessThan":"0001-01-01T00:00:00.0000000","BatchDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","BatchDateNotEqualTo":"0001-01-01T00:00:00.0000000","BatchDateBetween":["0001-01-01T00:00:00.0000000"],"BatchDateIn":["0001-01-01T00:00:00.0000000"],"BatchNo":"String","BatchNoStartsWith":"String","BatchNoEndsWith":"String","BatchNoContains":"String","BatchNoLike":"String","BatchNoBetween":["String"],"BatchNoIn":["String"],"Activated":false,"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"ReceiptPayment":0,"ReceiptPaymentGreaterThanOrEqualTo":0,"ReceiptPaymentGreaterThan":0,"ReceiptPaymentLessThan":0,"ReceiptPaymentLessThanOrEqualTo":0,"ReceiptPaymentNotEqualTo":0,"ReceiptPaymentBetween":[0],"ReceiptPaymentIn":[0],"BankLedgerID":"String","BankLedgerIDStartsWith":"String","BankLedgerIDEndsWith":"String","BankLedgerIDContains":"String","BankLedgerIDLike":"String","BankLedgerIDBetween":["String"],"BankLedgerIDIn":["String"],"GroupJournals":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":[{"CBBatchID":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","StaffID":"String","BatchDate":"0001-01-01T00:00:00.0000000","BatchNo":"String","Activated":false,"Description":"String","ReceiptPayment":0,"BankLedgerID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}