Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ID | query | string | No | |
IDStartsWith | query | string | No | |
IDEndsWith | query | string | No | |
IDContains | query | string | No | |
IDLike | query | string | No | |
IDBetween | query | string[] | No | |
IDIn | query | string[] | No | |
Accountno | query | string | No | |
AccountnoStartsWith | query | string | No | |
AccountnoEndsWith | query | string | No | |
AccountnoContains | query | string | No | |
AccountnoLike | query | string | No | |
AccountnoBetween | query | string[] | No | |
AccountnoIn | query | string[] | 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 | |
TransDate | query | DateTime? | No | |
TransDateGreaterThanOrEqualTo | query | DateTime? | No | |
TransDateGreaterThan | query | DateTime? | No | |
TransDateLessThan | query | DateTime? | No | |
TransDateLessThanOrEqualTo | query | DateTime? | No | |
TransDateNotEqualTo | query | DateTime? | No | |
TransDateBetween | query | Nullable<DateTime>[] | No | |
TransDateIn | query | Nullable<DateTime>[] | No | |
SourceText | query | string | No | |
SourceTextStartsWith | query | string | No | |
SourceTextEndsWith | query | string | No | |
SourceTextContains | query | string | No | |
SourceTextLike | query | string | No | |
SourceTextBetween | query | string[] | No | |
SourceTextIn | query | string[] | No | |
SourceID | query | string | No | |
SourceIDStartsWith | query | string | No | |
SourceIDEndsWith | query | string | No | |
SourceIDContains | query | string | No | |
SourceIDLike | query | string | No | |
SourceIDBetween | query | string[] | No | |
SourceIDIn | query | string[] | No | |
SourceNum | query | int? | No | |
SourceNumGreaterThanOrEqualTo | query | int? | No | |
SourceNumGreaterThan | query | int? | No | |
SourceNumLessThan | query | int? | No | |
SourceNumLessThanOrEqualTo | query | int? | No | |
SourceNumNotEqualTo | query | int? | No | |
SourceNumBetween | query | Nullable<Int32>[] | No | |
SourceNumIn | query | Nullable<Int32>[] | No | |
SubTypeNum | query | int? | No | |
SubTypeNumGreaterThanOrEqualTo | query | int? | No | |
SubTypeNumGreaterThan | query | int? | No | |
SubTypeNumLessThan | query | int? | No | |
SubTypeNumLessThanOrEqualTo | query | int? | No | |
SubTypeNumNotEqualTo | query | int? | No | |
SubTypeNumBetween | query | Nullable<Int32>[] | No | |
SubTypeNumIn | query | Nullable<Int32>[] | No | |
Value | query | decimal? | No | |
ValueGreaterThanOrEqualTo | query | decimal? | No | |
ValueGreaterThan | query | decimal? | No | |
ValueLessThan | query | decimal? | No | |
ValueLessThanOrEqualTo | query | decimal? | No | |
ValueNotEqualTo | query | decimal? | No | |
ValueBetween | query | Nullable<Decimal>[] | No | |
ValueIn | query | Nullable<Decimal>[] | No | |
DebitCredit | query | bool? | No | |
ReportType | query | string | No | |
ReportTypeStartsWith | query | string | No | |
ReportTypeEndsWith | query | string | No | |
ReportTypeContains | query | string | No | |
ReportTypeLike | query | string | No | |
ReportTypeBetween | query | string[] | No | |
ReportTypeIn | 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 |
---|---|---|---|---|
ID | form | string | No | |
Accountno | form | string | No | |
Description | form | string | No | |
TransDate | form | DateTime? | No | |
SourceText | form | string | No | |
SourceID | form | string | No | |
SourceNum | form | int? | No | |
SubTypeNum | form | int? | No | |
Value | form | decimal? | No | |
DebitCredit | form | bool? | No | |
ReportType | 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/V_DBGL_ReconciliationQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"ID":"String","IDStartsWith":"String","IDEndsWith":"String","IDContains":"String","IDLike":"String","IDBetween":["String"],"IDIn":["String"],"Accountno":"String","AccountnoStartsWith":"String","AccountnoEndsWith":"String","AccountnoContains":"String","AccountnoLike":"String","AccountnoBetween":["String"],"AccountnoIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"TransDate":"0001-01-01T00:00:00.0000000","TransDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","TransDateGreaterThan":"0001-01-01T00:00:00.0000000","TransDateLessThan":"0001-01-01T00:00:00.0000000","TransDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","TransDateNotEqualTo":"0001-01-01T00:00:00.0000000","TransDateBetween":["0001-01-01T00:00:00.0000000"],"TransDateIn":["0001-01-01T00:00:00.0000000"],"SourceText":"String","SourceTextStartsWith":"String","SourceTextEndsWith":"String","SourceTextContains":"String","SourceTextLike":"String","SourceTextBetween":["String"],"SourceTextIn":["String"],"SourceID":"String","SourceIDStartsWith":"String","SourceIDEndsWith":"String","SourceIDContains":"String","SourceIDLike":"String","SourceIDBetween":["String"],"SourceIDIn":["String"],"SourceNum":0,"SourceNumGreaterThanOrEqualTo":0,"SourceNumGreaterThan":0,"SourceNumLessThan":0,"SourceNumLessThanOrEqualTo":0,"SourceNumNotEqualTo":0,"SourceNumBetween":[0],"SourceNumIn":[0],"SubTypeNum":0,"SubTypeNumGreaterThanOrEqualTo":0,"SubTypeNumGreaterThan":0,"SubTypeNumLessThan":0,"SubTypeNumLessThanOrEqualTo":0,"SubTypeNumNotEqualTo":0,"SubTypeNumBetween":[0],"SubTypeNumIn":[0],"Value":0,"ValueGreaterThanOrEqualTo":0,"ValueGreaterThan":0,"ValueLessThan":0,"ValueLessThanOrEqualTo":0,"ValueNotEqualTo":0,"ValueBetween":[0],"ValueIn":[0],"DebitCredit":false,"ReportType":"String","ReportTypeStartsWith":"String","ReportTypeEndsWith":"String","ReportTypeContains":"String","ReportTypeLike":"String","ReportTypeBetween":["String"],"ReportTypeIn":["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":[{"ID":"String","Accountno":"String","Description":"String","TransDate":"0001-01-01T00:00:00.0000000","SourceText":"String","SourceID":"String","SourceNum":0,"SubTypeNum":0,"Value":0,"DebitCredit":false,"ReportType":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}