JiwaAPI

<back to all web services

CR_TransAllocQuery

Requires Authentication
CR_TransAllocQuery Parameters:
NameParameterData TypeRequiredDescription
AllocIDquerystringNo
AllocIDStartsWithquerystringNo
AllocIDEndsWithquerystringNo
AllocIDContainsquerystringNo
AllocIDLikequerystringNo
AllocIDBetweenquerystring[]No
AllocIDInquerystring[]No
CreditorIDquerystringNo
CreditorIDStartsWithquerystringNo
CreditorIDEndsWithquerystringNo
CreditorIDContainsquerystringNo
CreditorIDLikequerystringNo
CreditorIDBetweenquerystring[]No
CreditorIDInquerystring[]No
DebitTransIDquerystringNo
DebitTransIDStartsWithquerystringNo
DebitTransIDEndsWithquerystringNo
DebitTransIDContainsquerystringNo
DebitTransIDLikequerystringNo
DebitTransIDBetweenquerystring[]No
DebitTransIDInquerystring[]No
CreditTransIDquerystringNo
CreditTransIDStartsWithquerystringNo
CreditTransIDEndsWithquerystringNo
CreditTransIDContainsquerystringNo
CreditTransIDLikequerystringNo
CreditTransIDBetweenquerystring[]No
CreditTransIDInquerystring[]No
FXAmountquerydecimal?No
FXAmountGreaterThanOrEqualToquerydecimal?No
FXAmountGreaterThanquerydecimal?No
FXAmountLessThanquerydecimal?No
FXAmountLessThanOrEqualToquerydecimal?No
FXAmountNotEqualToquerydecimal?No
FXAmountBetweenqueryNullable<Decimal>[]No
FXAmountInqueryNullable<Decimal>[]No
DebitAmountquerydecimal?No
DebitAmountGreaterThanOrEqualToquerydecimal?No
DebitAmountGreaterThanquerydecimal?No
DebitAmountLessThanquerydecimal?No
DebitAmountLessThanOrEqualToquerydecimal?No
DebitAmountNotEqualToquerydecimal?No
DebitAmountBetweenqueryNullable<Decimal>[]No
DebitAmountInqueryNullable<Decimal>[]No
CreditAmountquerydecimal?No
CreditAmountGreaterThanOrEqualToquerydecimal?No
CreditAmountGreaterThanquerydecimal?No
CreditAmountLessThanquerydecimal?No
CreditAmountLessThanOrEqualToquerydecimal?No
CreditAmountNotEqualToquerydecimal?No
CreditAmountBetweenqueryNullable<Decimal>[]No
CreditAmountInqueryNullable<Decimal>[]No
DebitAgedquerybool?No
CreditAgedquerybool?No
DateAllocqueryDateTime?No
DateAllocGreaterThanOrEqualToqueryDateTime?No
DateAllocGreaterThanqueryDateTime?No
DateAllocLessThanqueryDateTime?No
DateAllocLessThanOrEqualToqueryDateTime?No
DateAllocNotEqualToqueryDateTime?No
DateAllocBetweenqueryDateTime[]No
DateAllocInqueryDateTime[]No
Versionqueryint?No
VersionGreaterThanOrEqualToqueryint?No
VersionGreaterThanqueryint?No
VersionLessThanqueryint?No
VersionLessThanOrEqualToqueryint?No
VersionNotEqualToqueryint?No
VersionBetweenqueryNullable<Int32>[]No
VersionInqueryNullable<Int32>[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
CR_TransAlloc Parameters:
NameParameterData TypeRequiredDescription
AllocIDformstringNo
CreditorIDformstringNo
DebitTransIDformstringNo
CreditTransIDformstringNo
FXAmountformdecimal?No
DebitAmountformdecimal?No
CreditAmountformdecimal?No
DebitAgedformbool?No
CreditAgedformbool?No
DateAllocformDateTimeNo
Versionformint?No
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_TransAllocQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"AllocID":"String","AllocIDStartsWith":"String","AllocIDEndsWith":"String","AllocIDContains":"String","AllocIDLike":"String","AllocIDBetween":["String"],"AllocIDIn":["String"],"CreditorID":"String","CreditorIDStartsWith":"String","CreditorIDEndsWith":"String","CreditorIDContains":"String","CreditorIDLike":"String","CreditorIDBetween":["String"],"CreditorIDIn":["String"],"DebitTransID":"String","DebitTransIDStartsWith":"String","DebitTransIDEndsWith":"String","DebitTransIDContains":"String","DebitTransIDLike":"String","DebitTransIDBetween":["String"],"DebitTransIDIn":["String"],"CreditTransID":"String","CreditTransIDStartsWith":"String","CreditTransIDEndsWith":"String","CreditTransIDContains":"String","CreditTransIDLike":"String","CreditTransIDBetween":["String"],"CreditTransIDIn":["String"],"FXAmount":0,"FXAmountGreaterThanOrEqualTo":0,"FXAmountGreaterThan":0,"FXAmountLessThan":0,"FXAmountLessThanOrEqualTo":0,"FXAmountNotEqualTo":0,"FXAmountBetween":[0],"FXAmountIn":[0],"DebitAmount":0,"DebitAmountGreaterThanOrEqualTo":0,"DebitAmountGreaterThan":0,"DebitAmountLessThan":0,"DebitAmountLessThanOrEqualTo":0,"DebitAmountNotEqualTo":0,"DebitAmountBetween":[0],"DebitAmountIn":[0],"CreditAmount":0,"CreditAmountGreaterThanOrEqualTo":0,"CreditAmountGreaterThan":0,"CreditAmountLessThan":0,"CreditAmountLessThanOrEqualTo":0,"CreditAmountNotEqualTo":0,"CreditAmountBetween":[0],"CreditAmountIn":[0],"DebitAged":false,"CreditAged":false,"DateAlloc":"0001-01-01T00:00:00.0000000","DateAllocGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","DateAllocGreaterThan":"0001-01-01T00:00:00.0000000","DateAllocLessThan":"0001-01-01T00:00:00.0000000","DateAllocLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","DateAllocNotEqualTo":"0001-01-01T00:00:00.0000000","DateAllocBetween":["0001-01-01T00:00:00.0000000"],"DateAllocIn":["0001-01-01T00:00:00.0000000"],"Version":0,"VersionGreaterThanOrEqualTo":0,"VersionGreaterThan":0,"VersionLessThan":0,"VersionLessThanOrEqualTo":0,"VersionNotEqualTo":0,"VersionBetween":[0],"VersionIn":[0],"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":[{"AllocID":"String","CreditorID":"String","DebitTransID":"String","CreditTransID":"String","FXAmount":0,"DebitAmount":0,"CreditAmount":0,"DebitAged":false,"CreditAged":false,"Version":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}