JiwaAPI

<back to all web services

CR_BatchPaymentQuery

Requires Authentication
CR_BatchPaymentQuery Parameters:
NameParameterData TypeRequiredDescription
CR_BatchPayIDquerystringNo
CR_BatchPayIDStartsWithquerystringNo
CR_BatchPayIDEndsWithquerystringNo
CR_BatchPayIDContainsquerystringNo
CR_BatchPayIDLikequerystringNo
CR_BatchPayIDBetweenquerystring[]No
CR_BatchPayIDInquerystring[]No
BatchNoquerystringNo
BatchNoStartsWithquerystringNo
BatchNoEndsWithquerystringNo
BatchNoContainsquerystringNo
BatchNoLikequerystringNo
BatchNoBetweenquerystring[]No
BatchNoInquerystring[]No
CreationDatequeryDateTime?No
CreationDateGreaterThanOrEqualToqueryDateTime?No
CreationDateGreaterThanqueryDateTime?No
CreationDateLessThanqueryDateTime?No
CreationDateLessThanOrEqualToqueryDateTime?No
CreationDateNotEqualToqueryDateTime?No
CreationDateBetweenqueryNullable<DateTime>[]No
CreationDateInqueryNullable<DateTime>[]No
ActivationDatequeryDateTime?No
ActivationDateGreaterThanOrEqualToqueryDateTime?No
ActivationDateGreaterThanqueryDateTime?No
ActivationDateLessThanqueryDateTime?No
ActivationDateLessThanOrEqualToqueryDateTime?No
ActivationDateNotEqualToqueryDateTime?No
ActivationDateBetweenqueryNullable<DateTime>[]No
ActivationDateInqueryNullable<DateTime>[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryNullable<DateTime>[]No
LastSavedDateTimeInqueryNullable<DateTime>[]No
Statusqueryshort?No
StatusGreaterThanOrEqualToqueryshort?No
StatusGreaterThanqueryshort?No
StatusLessThanqueryshort?No
StatusLessThanOrEqualToqueryshort?No
StatusNotEqualToqueryshort?No
StatusBetweenqueryNullable<Int16>[]No
StatusInqueryNullable<Int16>[]No
GLBankIDquerystringNo
GLBankIDStartsWithquerystringNo
GLBankIDEndsWithquerystringNo
GLBankIDContainsquerystringNo
GLBankIDLikequerystringNo
GLBankIDBetweenquerystring[]No
GLBankIDInquerystring[]No
OneChequequerybool?No
UseSelectedBankquerybool?No
TypeChequequerybool?No
StartChequeNoquerystringNo
StartChequeNoStartsWithquerystringNo
StartChequeNoEndsWithquerystringNo
StartChequeNoContainsquerystringNo
StartChequeNoLikequerystringNo
StartChequeNoBetweenquerystring[]No
StartChequeNoInquerystring[]No
CreatedBy_HR_Staff_RecIDquerystringNo
CreatedBy_HR_Staff_RecIDStartsWithquerystringNo
CreatedBy_HR_Staff_RecIDEndsWithquerystringNo
CreatedBy_HR_Staff_RecIDContainsquerystringNo
CreatedBy_HR_Staff_RecIDLikequerystringNo
CreatedBy_HR_Staff_RecIDBetweenquerystring[]No
CreatedBy_HR_Staff_RecIDInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
CR_BatchPayment Parameters:
NameParameterData TypeRequiredDescription
CR_BatchPayIDformstringNo
BatchNoformstringNo
CreationDateformDateTime?No
ActivationDateformDateTime?No
LastSavedDateTimeformDateTime?No
Statusformshort?No
GLBankIDformstringNo
OneChequeformboolNo
UseSelectedBankformbool?No
TypeChequeformbool?No
StartChequeNoformstringNo
CreatedBy_HR_Staff_RecIDformstringNo
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_BatchPaymentQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"CR_BatchPayID":"String","CR_BatchPayIDStartsWith":"String","CR_BatchPayIDEndsWith":"String","CR_BatchPayIDContains":"String","CR_BatchPayIDLike":"String","CR_BatchPayIDBetween":["String"],"CR_BatchPayIDIn":["String"],"BatchNo":"String","BatchNoStartsWith":"String","BatchNoEndsWith":"String","BatchNoContains":"String","BatchNoLike":"String","BatchNoBetween":["String"],"BatchNoIn":["String"],"CreationDate":"0001-01-01T00:00:00.0000000","CreationDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","CreationDateGreaterThan":"0001-01-01T00:00:00.0000000","CreationDateLessThan":"0001-01-01T00:00:00.0000000","CreationDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","CreationDateNotEqualTo":"0001-01-01T00:00:00.0000000","CreationDateBetween":["0001-01-01T00:00:00.0000000"],"CreationDateIn":["0001-01-01T00:00:00.0000000"],"ActivationDate":"0001-01-01T00:00:00.0000000","ActivationDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","ActivationDateGreaterThan":"0001-01-01T00:00:00.0000000","ActivationDateLessThan":"0001-01-01T00:00:00.0000000","ActivationDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","ActivationDateNotEqualTo":"0001-01-01T00:00:00.0000000","ActivationDateBetween":["0001-01-01T00:00:00.0000000"],"ActivationDateIn":["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"],"Status":0,"StatusGreaterThanOrEqualTo":0,"StatusGreaterThan":0,"StatusLessThan":0,"StatusLessThanOrEqualTo":0,"StatusNotEqualTo":0,"StatusBetween":[0],"StatusIn":[0],"GLBankID":"String","GLBankIDStartsWith":"String","GLBankIDEndsWith":"String","GLBankIDContains":"String","GLBankIDLike":"String","GLBankIDBetween":["String"],"GLBankIDIn":["String"],"OneCheque":false,"UseSelectedBank":false,"TypeCheque":false,"StartChequeNo":"String","StartChequeNoStartsWith":"String","StartChequeNoEndsWith":"String","StartChequeNoContains":"String","StartChequeNoLike":"String","StartChequeNoBetween":["String"],"StartChequeNoIn":["String"],"CreatedBy_HR_Staff_RecID":"String","CreatedBy_HR_Staff_RecIDStartsWith":"String","CreatedBy_HR_Staff_RecIDEndsWith":"String","CreatedBy_HR_Staff_RecIDContains":"String","CreatedBy_HR_Staff_RecIDLike":"String","CreatedBy_HR_Staff_RecIDBetween":["String"],"CreatedBy_HR_Staff_RecIDIn":["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":[{"CR_BatchPayID":"String","BatchNo":"String","CreationDate":"0001-01-01T00:00:00.0000000","ActivationDate":"0001-01-01T00:00:00.0000000","LastSavedDateTime":"0001-01-01T00:00:00.0000000","Status":0,"GLBankID":"String","UseSelectedBank":false,"TypeCheque":false,"StartChequeNo":"String","CreatedBy_HR_Staff_RecID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}