Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
GLTransactionID | query | string | No | |
GLTransactionIDStartsWith | query | string | No | |
GLTransactionIDEndsWith | query | string | No | |
GLTransactionIDContains | query | string | No | |
GLTransactionIDLike | query | string | No | |
GLTransactionIDBetween | query | string[] | No | |
GLTransactionIDIn | query | string[] | No | |
GLSetID | query | string | No | |
GLSetIDStartsWith | query | string | No | |
GLSetIDEndsWith | query | string | No | |
GLSetIDContains | query | string | No | |
GLSetIDLike | query | string | No | |
GLSetIDBetween | query | string[] | No | |
GLSetIDIn | query | string[] | No | |
GLLedgerID | query | string | No | |
GLLedgerIDStartsWith | query | string | No | |
GLLedgerIDEndsWith | query | string | No | |
GLLedgerIDContains | query | string | No | |
GLLedgerIDLike | query | string | No | |
GLLedgerIDBetween | query | string[] | No | |
GLLedgerIDIn | query | string[] | No | |
DebitCredit | query | bool? | No | |
Amount | query | decimal? | No | |
AmountGreaterThanOrEqualTo | query | decimal? | No | |
AmountGreaterThan | query | decimal? | No | |
AmountLessThan | query | decimal? | No | |
AmountLessThanOrEqualTo | query | decimal? | No | |
AmountNotEqualTo | query | decimal? | No | |
AmountBetween | query | Nullable<Decimal>[] | No | |
AmountIn | query | Nullable<Decimal>[] | No | |
Ref | query | string | No | |
RefStartsWith | query | string | No | |
RefEndsWith | query | string | No | |
RefContains | query | string | No | |
RefLike | query | string | No | |
RefBetween | query | string[] | No | |
RefIn | query | string[] | No | |
Remark | query | string | No | |
RemarkStartsWith | query | string | No | |
RemarkEndsWith | query | string | No | |
RemarkContains | query | string | No | |
RemarkLike | query | string | No | |
RemarkBetween | query | string[] | No | |
RemarkIn | query | string[] | No | |
LineNum | query | int? | No | |
LineNumGreaterThanOrEqualTo | query | int? | No | |
LineNumGreaterThan | query | int? | No | |
LineNumLessThan | query | int? | No | |
LineNumLessThanOrEqualTo | query | int? | No | |
LineNumNotEqualTo | query | int? | No | |
LineNumBetween | query | int[] | No | |
LineNumIn | query | int[] | No | |
TransCode1ID | query | string | No | |
TransCode1IDStartsWith | query | string | No | |
TransCode1IDEndsWith | query | string | No | |
TransCode1IDContains | query | string | No | |
TransCode1IDLike | query | string | No | |
TransCode1IDBetween | query | string[] | No | |
TransCode1IDIn | query | string[] | No | |
TransCode2ID | query | string | No | |
TransCode2IDStartsWith | query | string | No | |
TransCode2IDEndsWith | query | string | No | |
TransCode2IDContains | query | string | No | |
TransCode2IDLike | query | string | No | |
TransCode2IDBetween | query | string[] | No | |
TransCode2IDIn | query | string[] | No | |
TransCode3ID | query | string | No | |
TransCode3IDStartsWith | query | string | No | |
TransCode3IDEndsWith | query | string | No | |
TransCode3IDContains | query | string | No | |
TransCode3IDLike | query | string | No | |
TransCode3IDBetween | query | string[] | No | |
TransCode3IDIn | query | string[] | No | |
StaffID | query | string | No | |
StaffIDStartsWith | query | string | No | |
StaffIDEndsWith | query | string | No | |
StaffIDContains | query | string | No | |
StaffIDLike | query | string | No | |
StaffIDBetween | query | string[] | No | |
StaffIDIn | query | string[] | No | |
Reconciled | query | bool? | No | |
Cleared | query | bool? | No | |
TransPostDateTime | query | DateTime? | No | |
TransPostDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
TransPostDateTimeGreaterThan | query | DateTime? | No | |
TransPostDateTimeLessThan | query | DateTime? | No | |
TransPostDateTimeLessThanOrEqualTo | query | DateTime? | No | |
TransPostDateTimeNotEqualTo | query | DateTime? | No | |
TransPostDateTimeBetween | query | Nullable<DateTime>[] | No | |
TransPostDateTimeIn | query | Nullable<DateTime>[] | No | |
JB_JobStages_RecID | query | string | No | |
JB_JobStages_RecIDStartsWith | query | string | No | |
JB_JobStages_RecIDEndsWith | query | string | No | |
JB_JobStages_RecIDContains | query | string | No | |
JB_JobStages_RecIDLike | query | string | No | |
JB_JobStages_RecIDBetween | query | string[] | No | |
JB_JobStages_RecIDIn | 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 |
---|---|---|---|---|
GLTransactionID | form | string | No | |
GLSetID | form | string | No | |
GLLedgerID | form | string | No | |
DebitCredit | form | bool? | No | |
Amount | form | decimal? | No | |
Ref | form | string | No | |
Remark | form | string | No | |
LineNum | form | int | No | |
TransCode1ID | form | string | No | |
TransCode2ID | form | string | No | |
TransCode3ID | form | string | No | |
StaffID | form | string | No | |
Reconciled | form | bool? | No | |
Cleared | form | bool? | No | |
TransPostDateTime | form | DateTime? | No | |
JB_JobStages_RecID | 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/GL_TransactionsQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"GLTransactionID":"String","GLTransactionIDStartsWith":"String","GLTransactionIDEndsWith":"String","GLTransactionIDContains":"String","GLTransactionIDLike":"String","GLTransactionIDBetween":["String"],"GLTransactionIDIn":["String"],"GLSetID":"String","GLSetIDStartsWith":"String","GLSetIDEndsWith":"String","GLSetIDContains":"String","GLSetIDLike":"String","GLSetIDBetween":["String"],"GLSetIDIn":["String"],"GLLedgerID":"String","GLLedgerIDStartsWith":"String","GLLedgerIDEndsWith":"String","GLLedgerIDContains":"String","GLLedgerIDLike":"String","GLLedgerIDBetween":["String"],"GLLedgerIDIn":["String"],"DebitCredit":false,"Amount":0,"AmountGreaterThanOrEqualTo":0,"AmountGreaterThan":0,"AmountLessThan":0,"AmountLessThanOrEqualTo":0,"AmountNotEqualTo":0,"AmountBetween":[0],"AmountIn":[0],"Ref":"String","RefStartsWith":"String","RefEndsWith":"String","RefContains":"String","RefLike":"String","RefBetween":["String"],"RefIn":["String"],"Remark":"String","RemarkStartsWith":"String","RemarkEndsWith":"String","RemarkContains":"String","RemarkLike":"String","RemarkBetween":["String"],"RemarkIn":["String"],"LineNum":0,"LineNumGreaterThanOrEqualTo":0,"LineNumGreaterThan":0,"LineNumLessThan":0,"LineNumLessThanOrEqualTo":0,"LineNumNotEqualTo":0,"LineNumBetween":[0],"LineNumIn":[0],"TransCode1ID":"String","TransCode1IDStartsWith":"String","TransCode1IDEndsWith":"String","TransCode1IDContains":"String","TransCode1IDLike":"String","TransCode1IDBetween":["String"],"TransCode1IDIn":["String"],"TransCode2ID":"String","TransCode2IDStartsWith":"String","TransCode2IDEndsWith":"String","TransCode2IDContains":"String","TransCode2IDLike":"String","TransCode2IDBetween":["String"],"TransCode2IDIn":["String"],"TransCode3ID":"String","TransCode3IDStartsWith":"String","TransCode3IDEndsWith":"String","TransCode3IDContains":"String","TransCode3IDLike":"String","TransCode3IDBetween":["String"],"TransCode3IDIn":["String"],"StaffID":"String","StaffIDStartsWith":"String","StaffIDEndsWith":"String","StaffIDContains":"String","StaffIDLike":"String","StaffIDBetween":["String"],"StaffIDIn":["String"],"Reconciled":false,"Cleared":false,"TransPostDateTime":"0001-01-01T00:00:00.0000000","TransPostDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","TransPostDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","TransPostDateTimeLessThan":"0001-01-01T00:00:00.0000000","TransPostDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","TransPostDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","TransPostDateTimeBetween":["0001-01-01T00:00:00.0000000"],"TransPostDateTimeIn":["0001-01-01T00:00:00.0000000"],"JB_JobStages_RecID":"String","JB_JobStages_RecIDStartsWith":"String","JB_JobStages_RecIDEndsWith":"String","JB_JobStages_RecIDContains":"String","JB_JobStages_RecIDLike":"String","JB_JobStages_RecIDBetween":["String"],"JB_JobStages_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":[{"GLTransactionID":"String","GLSetID":"String","GLLedgerID":"String","DebitCredit":false,"Amount":0,"Ref":"String","Remark":"String","TransCode1ID":"String","TransCode2ID":"String","TransCode3ID":"String","StaffID":"String","Reconciled":false,"Cleared":false,"TransPostDateTime":"0001-01-01T00:00:00.0000000","JB_JobStages_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"}}}