JiwaAPI

<back to all web services

CR_BatchTransQuery

Requires Authentication
CR_BatchTransQuery Parameters:
NameParameterData TypeRequiredDescription
ReceiptIDquerystringNo
ReceiptIDStartsWithquerystringNo
ReceiptIDEndsWithquerystringNo
ReceiptIDContainsquerystringNo
ReceiptIDLikequerystringNo
ReceiptIDBetweenquerystring[]No
ReceiptIDInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryNullable<DateTime>[]No
LastSavedDateTimeInqueryNullable<DateTime>[]No
JiwaUserquerystringNo
JiwaUserStartsWithquerystringNo
JiwaUserEndsWithquerystringNo
JiwaUserContainsquerystringNo
JiwaUserLikequerystringNo
JiwaUserBetweenquerystring[]No
JiwaUserInquerystring[]No
ReceiptDatequeryDateTime?No
ReceiptDateGreaterThanOrEqualToqueryDateTime?No
ReceiptDateGreaterThanqueryDateTime?No
ReceiptDateLessThanqueryDateTime?No
ReceiptDateLessThanOrEqualToqueryDateTime?No
ReceiptDateNotEqualToqueryDateTime?No
ReceiptDateBetweenqueryNullable<DateTime>[]No
ReceiptDateInqueryNullable<DateTime>[]No
BatchNumquerystringNo
BatchNumStartsWithquerystringNo
BatchNumEndsWithquerystringNo
BatchNumContainsquerystringNo
BatchNumLikequerystringNo
BatchNumBetweenquerystring[]No
BatchNumInquerystring[]No
ReceiptTypequeryshort?No
ReceiptTypeGreaterThanOrEqualToqueryshort?No
ReceiptTypeGreaterThanqueryshort?No
ReceiptTypeLessThanqueryshort?No
ReceiptTypeLessThanOrEqualToqueryshort?No
ReceiptTypeNotEqualToqueryshort?No
ReceiptTypeBetweenqueryNullable<Int16>[]No
ReceiptTypeInqueryNullable<Int16>[]No
ReceiptStatusqueryshort?No
ReceiptStatusGreaterThanOrEqualToqueryshort?No
ReceiptStatusGreaterThanqueryshort?No
ReceiptStatusLessThanqueryshort?No
ReceiptStatusLessThanOrEqualToqueryshort?No
ReceiptStatusNotEqualToqueryshort?No
ReceiptStatusBetweenqueryNullable<Int16>[]No
ReceiptStatusInqueryNullable<Int16>[]No
BatchTypequeryshort?No
BatchTypeGreaterThanOrEqualToqueryshort?No
BatchTypeGreaterThanqueryshort?No
BatchTypeLessThanqueryshort?No
BatchTypeLessThanOrEqualToqueryshort?No
BatchTypeNotEqualToqueryshort?No
BatchTypeBetweenqueryshort[]No
BatchTypeInqueryshort[]No
RepeatingTypequeryshort?No
RepeatingTypeGreaterThanOrEqualToqueryshort?No
RepeatingTypeGreaterThanqueryshort?No
RepeatingTypeLessThanqueryshort?No
RepeatingTypeLessThanOrEqualToqueryshort?No
RepeatingTypeNotEqualToqueryshort?No
RepeatingTypeBetweenqueryshort[]No
RepeatingTypeInqueryshort[]No
RepeatingUnitsqueryshort?No
RepeatingUnitsGreaterThanOrEqualToqueryshort?No
RepeatingUnitsGreaterThanqueryshort?No
RepeatingUnitsLessThanqueryshort?No
RepeatingUnitsLessThanOrEqualToqueryshort?No
RepeatingUnitsNotEqualToqueryshort?No
RepeatingUnitsBetweenqueryshort[]No
RepeatingUnitsInqueryshort[]No
NextRepeatingDatequeryDateTime?No
NextRepeatingDateGreaterThanOrEqualToqueryDateTime?No
NextRepeatingDateGreaterThanqueryDateTime?No
NextRepeatingDateLessThanqueryDateTime?No
NextRepeatingDateLessThanOrEqualToqueryDateTime?No
NextRepeatingDateNotEqualToqueryDateTime?No
NextRepeatingDateBetweenqueryNullable<DateTime>[]No
NextRepeatingDateInqueryNullable<DateTime>[]No
RepeatingWillEndquerybool?No
RepeatingEndDatequeryDateTime?No
RepeatingEndDateGreaterThanOrEqualToqueryDateTime?No
RepeatingEndDateGreaterThanqueryDateTime?No
RepeatingEndDateLessThanqueryDateTime?No
RepeatingEndDateLessThanOrEqualToqueryDateTime?No
RepeatingEndDateNotEqualToqueryDateTime?No
RepeatingEndDateBetweenqueryNullable<DateTime>[]No
RepeatingEndDateInqueryNullable<DateTime>[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
CR_BatchTrans Parameters:
NameParameterData TypeRequiredDescription
ReceiptIDformstringNo
LastSavedDateTimeformDateTime?No
JiwaUserformstringNo
ReceiptDateformDateTime?No
BatchNumformstringNo
ReceiptTypeformshort?No
ReceiptStatusformshort?No
BatchTypeformshortNo
RepeatingTypeformshortNo
RepeatingUnitsformshortNo
NextRepeatingDateformDateTime?No
RepeatingWillEndformboolNo
RepeatingEndDateformDateTime?No
DescriptionformstringNo
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_BatchTransQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ReceiptID":"String","ReceiptIDStartsWith":"String","ReceiptIDEndsWith":"String","ReceiptIDContains":"String","ReceiptIDLike":"String","ReceiptIDBetween":["String"],"ReceiptIDIn":["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"],"JiwaUser":"String","JiwaUserStartsWith":"String","JiwaUserEndsWith":"String","JiwaUserContains":"String","JiwaUserLike":"String","JiwaUserBetween":["String"],"JiwaUserIn":["String"],"ReceiptDate":"0001-01-01T00:00:00.0000000","ReceiptDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","ReceiptDateGreaterThan":"0001-01-01T00:00:00.0000000","ReceiptDateLessThan":"0001-01-01T00:00:00.0000000","ReceiptDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","ReceiptDateNotEqualTo":"0001-01-01T00:00:00.0000000","ReceiptDateBetween":["0001-01-01T00:00:00.0000000"],"ReceiptDateIn":["0001-01-01T00:00:00.0000000"],"BatchNum":"String","BatchNumStartsWith":"String","BatchNumEndsWith":"String","BatchNumContains":"String","BatchNumLike":"String","BatchNumBetween":["String"],"BatchNumIn":["String"],"ReceiptType":0,"ReceiptTypeGreaterThanOrEqualTo":0,"ReceiptTypeGreaterThan":0,"ReceiptTypeLessThan":0,"ReceiptTypeLessThanOrEqualTo":0,"ReceiptTypeNotEqualTo":0,"ReceiptTypeBetween":[0],"ReceiptTypeIn":[0],"ReceiptStatus":0,"ReceiptStatusGreaterThanOrEqualTo":0,"ReceiptStatusGreaterThan":0,"ReceiptStatusLessThan":0,"ReceiptStatusLessThanOrEqualTo":0,"ReceiptStatusNotEqualTo":0,"ReceiptStatusBetween":[0],"ReceiptStatusIn":[0],"BatchType":0,"BatchTypeGreaterThanOrEqualTo":0,"BatchTypeGreaterThan":0,"BatchTypeLessThan":0,"BatchTypeLessThanOrEqualTo":0,"BatchTypeNotEqualTo":0,"BatchTypeBetween":[0],"BatchTypeIn":[0],"RepeatingType":0,"RepeatingTypeGreaterThanOrEqualTo":0,"RepeatingTypeGreaterThan":0,"RepeatingTypeLessThan":0,"RepeatingTypeLessThanOrEqualTo":0,"RepeatingTypeNotEqualTo":0,"RepeatingTypeBetween":[0],"RepeatingTypeIn":[0],"RepeatingUnits":0,"RepeatingUnitsGreaterThanOrEqualTo":0,"RepeatingUnitsGreaterThan":0,"RepeatingUnitsLessThan":0,"RepeatingUnitsLessThanOrEqualTo":0,"RepeatingUnitsNotEqualTo":0,"RepeatingUnitsBetween":[0],"RepeatingUnitsIn":[0],"NextRepeatingDate":"0001-01-01T00:00:00.0000000","NextRepeatingDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","NextRepeatingDateGreaterThan":"0001-01-01T00:00:00.0000000","NextRepeatingDateLessThan":"0001-01-01T00:00:00.0000000","NextRepeatingDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","NextRepeatingDateNotEqualTo":"0001-01-01T00:00:00.0000000","NextRepeatingDateBetween":["0001-01-01T00:00:00.0000000"],"NextRepeatingDateIn":["0001-01-01T00:00:00.0000000"],"RepeatingWillEnd":false,"RepeatingEndDate":"0001-01-01T00:00:00.0000000","RepeatingEndDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","RepeatingEndDateGreaterThan":"0001-01-01T00:00:00.0000000","RepeatingEndDateLessThan":"0001-01-01T00:00:00.0000000","RepeatingEndDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","RepeatingEndDateNotEqualTo":"0001-01-01T00:00:00.0000000","RepeatingEndDateBetween":["0001-01-01T00:00:00.0000000"],"RepeatingEndDateIn":["0001-01-01T00:00:00.0000000"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["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":[{"ReceiptID":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","JiwaUser":"String","ReceiptDate":"0001-01-01T00:00:00.0000000","BatchNum":"String","ReceiptType":0,"ReceiptStatus":0,"NextRepeatingDate":"0001-01-01T00:00:00.0000000","RepeatingEndDate":"0001-01-01T00:00:00.0000000","Description":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}