Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ReceiptID | query | string | No | |
ReceiptIDStartsWith | query | string | No | |
ReceiptIDEndsWith | query | string | No | |
ReceiptIDContains | query | string | No | |
ReceiptIDLike | query | string | No | |
ReceiptIDBetween | query | string[] | No | |
ReceiptIDIn | query | string[] | No | |
LastSavedDateTime | query | DateTime? | No | |
LastSavedDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
LastSavedDateTimeGreaterThan | query | DateTime? | No | |
LastSavedDateTimeLessThan | query | DateTime? | No | |
LastSavedDateTimeLessThanOrEqualTo | query | DateTime? | No | |
LastSavedDateTimeNotEqualTo | query | DateTime? | No | |
LastSavedDateTimeBetween | query | Nullable<DateTime>[] | No | |
LastSavedDateTimeIn | query | Nullable<DateTime>[] | No | |
JiwaUser | query | string | No | |
JiwaUserStartsWith | query | string | No | |
JiwaUserEndsWith | query | string | No | |
JiwaUserContains | query | string | No | |
JiwaUserLike | query | string | No | |
JiwaUserBetween | query | string[] | No | |
JiwaUserIn | query | string[] | No | |
ReceiptDate | query | DateTime? | No | |
ReceiptDateGreaterThanOrEqualTo | query | DateTime? | No | |
ReceiptDateGreaterThan | query | DateTime? | No | |
ReceiptDateLessThan | query | DateTime? | No | |
ReceiptDateLessThanOrEqualTo | query | DateTime? | No | |
ReceiptDateNotEqualTo | query | DateTime? | No | |
ReceiptDateBetween | query | Nullable<DateTime>[] | No | |
ReceiptDateIn | query | Nullable<DateTime>[] | No | |
BatchNum | query | string | No | |
BatchNumStartsWith | query | string | No | |
BatchNumEndsWith | query | string | No | |
BatchNumContains | query | string | No | |
BatchNumLike | query | string | No | |
BatchNumBetween | query | string[] | No | |
BatchNumIn | query | string[] | No | |
ReceiptType | query | short? | No | |
ReceiptTypeGreaterThanOrEqualTo | query | short? | No | |
ReceiptTypeGreaterThan | query | short? | No | |
ReceiptTypeLessThan | query | short? | No | |
ReceiptTypeLessThanOrEqualTo | query | short? | No | |
ReceiptTypeNotEqualTo | query | short? | No | |
ReceiptTypeBetween | query | Nullable<Int16>[] | No | |
ReceiptTypeIn | query | Nullable<Int16>[] | No | |
ReceiptStatus | query | short? | No | |
ReceiptStatusGreaterThanOrEqualTo | query | short? | No | |
ReceiptStatusGreaterThan | query | short? | No | |
ReceiptStatusLessThan | query | short? | No | |
ReceiptStatusLessThanOrEqualTo | query | short? | No | |
ReceiptStatusNotEqualTo | query | short? | No | |
ReceiptStatusBetween | query | Nullable<Int16>[] | No | |
ReceiptStatusIn | query | Nullable<Int16>[] | No | |
BatchType | query | short? | No | |
BatchTypeGreaterThanOrEqualTo | query | short? | No | |
BatchTypeGreaterThan | query | short? | No | |
BatchTypeLessThan | query | short? | No | |
BatchTypeLessThanOrEqualTo | query | short? | No | |
BatchTypeNotEqualTo | query | short? | No | |
BatchTypeBetween | query | short[] | No | |
BatchTypeIn | query | short[] | No | |
RepeatingType | query | short? | No | |
RepeatingTypeGreaterThanOrEqualTo | query | short? | No | |
RepeatingTypeGreaterThan | query | short? | No | |
RepeatingTypeLessThan | query | short? | No | |
RepeatingTypeLessThanOrEqualTo | query | short? | No | |
RepeatingTypeNotEqualTo | query | short? | No | |
RepeatingTypeBetween | query | short[] | No | |
RepeatingTypeIn | query | short[] | No | |
RepeatingUnits | query | short? | No | |
RepeatingUnitsGreaterThanOrEqualTo | query | short? | No | |
RepeatingUnitsGreaterThan | query | short? | No | |
RepeatingUnitsLessThan | query | short? | No | |
RepeatingUnitsLessThanOrEqualTo | query | short? | No | |
RepeatingUnitsNotEqualTo | query | short? | No | |
RepeatingUnitsBetween | query | short[] | No | |
RepeatingUnitsIn | query | short[] | No | |
NextRepeatingDate | query | DateTime? | No | |
NextRepeatingDateGreaterThanOrEqualTo | query | DateTime? | No | |
NextRepeatingDateGreaterThan | query | DateTime? | No | |
NextRepeatingDateLessThan | query | DateTime? | No | |
NextRepeatingDateLessThanOrEqualTo | query | DateTime? | No | |
NextRepeatingDateNotEqualTo | query | DateTime? | No | |
NextRepeatingDateBetween | query | Nullable<DateTime>[] | No | |
NextRepeatingDateIn | query | Nullable<DateTime>[] | No | |
RepeatingWillEnd | query | bool? | No | |
RepeatingEndDate | query | DateTime? | No | |
RepeatingEndDateGreaterThanOrEqualTo | query | DateTime? | No | |
RepeatingEndDateGreaterThan | query | DateTime? | No | |
RepeatingEndDateLessThan | query | DateTime? | No | |
RepeatingEndDateLessThanOrEqualTo | query | DateTime? | No | |
RepeatingEndDateNotEqualTo | query | DateTime? | No | |
RepeatingEndDateBetween | query | Nullable<DateTime>[] | No | |
RepeatingEndDateIn | query | Nullable<DateTime>[] | No | |
Description | query | string | No | |
DescriptionStartsWith | query | string | No | |
DescriptionEndsWith | query | string | No | |
DescriptionContains | query | string | No | |
DescriptionLike | query | string | No | |
DescriptionBetween | query | string[] | No | |
DescriptionIn | query | string[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | int? | No | |
Take | form | int? | No | |
OrderBy | form | string | No | |
OrderByDesc | form | string | No | |
Include | form | string | No | |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ReceiptID | form | string | No | |
LastSavedDateTime | form | DateTime? | No | |
JiwaUser | form | string | No | |
ReceiptDate | form | DateTime? | No | |
BatchNum | form | string | No | |
ReceiptType | form | short? | No | |
ReceiptStatus | form | short? | No | |
BatchType | form | short | No | |
RepeatingType | form | short | No | |
RepeatingUnits | form | short | No | |
NextRepeatingDate | form | DateTime? | No | |
RepeatingWillEnd | form | bool | No | |
RepeatingEndDate | form | DateTime? | No | |
Description | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<T> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=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"}}}