Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RecID | query | string | No | |
RecIDStartsWith | query | string | No | |
RecIDEndsWith | query | string | No | |
RecIDContains | query | string | No | |
RecIDLike | query | string | No | |
RecIDBetween | query | string[] | No | |
RecIDIn | 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 | |
NextChequeNumber | query | string | No | |
NextChequeNumberStartsWith | query | string | No | |
NextChequeNumberEndsWith | query | string | No | |
NextChequeNumberContains | query | string | No | |
NextChequeNumberLike | query | string | No | |
NextChequeNumberBetween | query | string[] | No | |
NextChequeNumberIn | query | string[] | No | |
BankName | query | string | No | |
BankNameStartsWith | query | string | No | |
BankNameEndsWith | query | string | No | |
BankNameContains | query | string | No | |
BankNameLike | query | string | No | |
BankNameBetween | query | string[] | No | |
BankNameIn | query | string[] | No | |
BSBN | query | string | No | |
BSBNStartsWith | query | string | No | |
BSBNEndsWith | query | string | No | |
BSBNContains | query | string | No | |
BSBNLike | query | string | No | |
BSBNBetween | query | string[] | No | |
BSBNIn | query | string[] | No | |
AccountNumber | query | string | No | |
AccountNumberStartsWith | query | string | No | |
AccountNumberEndsWith | query | string | No | |
AccountNumberContains | query | string | No | |
AccountNumberLike | query | string | No | |
AccountNumberBetween | query | string[] | No | |
AccountNumberIn | query | string[] | No | |
AccountName | query | string | No | |
AccountNameStartsWith | query | string | No | |
AccountNameEndsWith | query | string | No | |
AccountNameContains | query | string | No | |
AccountNameLike | query | string | No | |
AccountNameBetween | query | string[] | No | |
AccountNameIn | query | string[] | No | |
DefaultBank | query | bool? | 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 | DateTime[] | No | |
LastSavedDateTimeIn | query | DateTime[] | No | |
FeesLedgerID | query | string | No | |
FeesLedgerIDStartsWith | query | string | No | |
FeesLedgerIDEndsWith | query | string | No | |
FeesLedgerIDContains | query | string | No | |
FeesLedgerIDLike | query | string | No | |
FeesLedgerIDBetween | query | string[] | No | |
FeesLedgerIDIn | query | string[] | No | |
EFTBankCode | query | string | No | |
EFTBankCodeStartsWith | query | string | No | |
EFTBankCodeEndsWith | query | string | No | |
EFTBankCodeContains | query | string | No | |
EFTBankCodeLike | query | string | No | |
EFTBankCodeBetween | query | string[] | No | |
EFTBankCodeIn | query | string[] | No | |
UserIdentificationNumber | query | string | No | |
UserIdentificationNumberStartsWith | query | string | No | |
UserIdentificationNumberEndsWith | query | string | No | |
UserIdentificationNumberContains | query | string | No | |
UserIdentificationNumberLike | query | string | No | |
UserIdentificationNumberBetween | query | string[] | No | |
UserIdentificationNumberIn | 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 |
---|---|---|---|---|
RecID | form | string | No | |
GLLedgerID | form | string | No | |
NextChequeNumber | form | string | No | |
BankName | form | string | No | |
BSBN | form | string | No | |
AccountNumber | form | string | No | |
AccountName | form | string | No | |
DefaultBank | form | bool? | No | |
LastSavedDateTime | form | DateTime | No | |
FeesLedgerID | form | string | No | |
EFTBankCode | form | string | No | |
UserIdentificationNumber | 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_BankDetailsQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"RecID":"String","RecIDStartsWith":"String","RecIDEndsWith":"String","RecIDContains":"String","RecIDLike":"String","RecIDBetween":["String"],"RecIDIn":["String"],"GLLedgerID":"String","GLLedgerIDStartsWith":"String","GLLedgerIDEndsWith":"String","GLLedgerIDContains":"String","GLLedgerIDLike":"String","GLLedgerIDBetween":["String"],"GLLedgerIDIn":["String"],"NextChequeNumber":"String","NextChequeNumberStartsWith":"String","NextChequeNumberEndsWith":"String","NextChequeNumberContains":"String","NextChequeNumberLike":"String","NextChequeNumberBetween":["String"],"NextChequeNumberIn":["String"],"BankName":"String","BankNameStartsWith":"String","BankNameEndsWith":"String","BankNameContains":"String","BankNameLike":"String","BankNameBetween":["String"],"BankNameIn":["String"],"BSBN":"String","BSBNStartsWith":"String","BSBNEndsWith":"String","BSBNContains":"String","BSBNLike":"String","BSBNBetween":["String"],"BSBNIn":["String"],"AccountNumber":"String","AccountNumberStartsWith":"String","AccountNumberEndsWith":"String","AccountNumberContains":"String","AccountNumberLike":"String","AccountNumberBetween":["String"],"AccountNumberIn":["String"],"AccountName":"String","AccountNameStartsWith":"String","AccountNameEndsWith":"String","AccountNameContains":"String","AccountNameLike":"String","AccountNameBetween":["String"],"AccountNameIn":["String"],"DefaultBank":false,"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"],"FeesLedgerID":"String","FeesLedgerIDStartsWith":"String","FeesLedgerIDEndsWith":"String","FeesLedgerIDContains":"String","FeesLedgerIDLike":"String","FeesLedgerIDBetween":["String"],"FeesLedgerIDIn":["String"],"EFTBankCode":"String","EFTBankCodeStartsWith":"String","EFTBankCodeEndsWith":"String","EFTBankCodeContains":"String","EFTBankCodeLike":"String","EFTBankCodeBetween":["String"],"EFTBankCodeIn":["String"],"UserIdentificationNumber":"String","UserIdentificationNumberStartsWith":"String","UserIdentificationNumberEndsWith":"String","UserIdentificationNumberContains":"String","UserIdentificationNumberLike":"String","UserIdentificationNumberBetween":["String"],"UserIdentificationNumberIn":["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":[{"RecID":"String","GLLedgerID":"String","NextChequeNumber":"String","BankName":"String","BSBN":"String","AccountNumber":"String","AccountName":"String","DefaultBank":false,"FeesLedgerID":"String","EFTBankCode":"String","UserIdentificationNumber":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}