JiwaAPI

<back to all web services

GL_DistributionQuery

Requires Authentication
GL_DistributionQuery Parameters:
NameParameterData TypeRequiredDescription
GLDistIDquerystringNo
GLDistIDStartsWithquerystringNo
GLDistIDEndsWithquerystringNo
GLDistIDContainsquerystringNo
GLDistIDLikequerystringNo
GLDistIDBetweenquerystring[]No
GLDistIDInquerystring[]No
GLLedgerIDquerystringNo
GLLedgerIDStartsWithquerystringNo
GLLedgerIDEndsWithquerystringNo
GLLedgerIDContainsquerystringNo
GLLedgerIDLikequerystringNo
GLLedgerIDBetweenquerystring[]No
GLLedgerIDInquerystring[]No
GLDistLedgerIDquerystringNo
GLDistLedgerIDStartsWithquerystringNo
GLDistLedgerIDEndsWithquerystringNo
GLDistLedgerIDContainsquerystringNo
GLDistLedgerIDLikequerystringNo
GLDistLedgerIDBetweenquerystring[]No
GLDistLedgerIDInquerystring[]No
DistAmountquerydecimal?No
DistAmountGreaterThanOrEqualToquerydecimal?No
DistAmountGreaterThanquerydecimal?No
DistAmountLessThanquerydecimal?No
DistAmountLessThanOrEqualToquerydecimal?No
DistAmountNotEqualToquerydecimal?No
DistAmountBetweenqueryNullable<Decimal>[]No
DistAmountInqueryNullable<Decimal>[]No
LineNumqueryint?No
LineNumGreaterThanOrEqualToqueryint?No
LineNumGreaterThanqueryint?No
LineNumLessThanqueryint?No
LineNumLessThanOrEqualToqueryint?No
LineNumNotEqualToqueryint?No
LineNumBetweenqueryNullable<Int32>[]No
LineNumInqueryNullable<Int32>[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
GL_Distribution Parameters:
NameParameterData TypeRequiredDescription
GLDistIDformstringNo
GLLedgerIDformstringNo
GLDistLedgerIDformstringNo
DistAmountformdecimal?No
LineNumformint?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/GL_DistributionQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"GLDistID":"String","GLDistIDStartsWith":"String","GLDistIDEndsWith":"String","GLDistIDContains":"String","GLDistIDLike":"String","GLDistIDBetween":["String"],"GLDistIDIn":["String"],"GLLedgerID":"String","GLLedgerIDStartsWith":"String","GLLedgerIDEndsWith":"String","GLLedgerIDContains":"String","GLLedgerIDLike":"String","GLLedgerIDBetween":["String"],"GLLedgerIDIn":["String"],"GLDistLedgerID":"String","GLDistLedgerIDStartsWith":"String","GLDistLedgerIDEndsWith":"String","GLDistLedgerIDContains":"String","GLDistLedgerIDLike":"String","GLDistLedgerIDBetween":["String"],"GLDistLedgerIDIn":["String"],"DistAmount":0,"DistAmountGreaterThanOrEqualTo":0,"DistAmountGreaterThan":0,"DistAmountLessThan":0,"DistAmountLessThanOrEqualTo":0,"DistAmountNotEqualTo":0,"DistAmountBetween":[0],"DistAmountIn":[0],"LineNum":0,"LineNumGreaterThanOrEqualTo":0,"LineNumGreaterThan":0,"LineNumLessThan":0,"LineNumLessThanOrEqualTo":0,"LineNumNotEqualTo":0,"LineNumBetween":[0],"LineNumIn":[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":[{"GLDistID":"String","GLLedgerID":"String","GLDistLedgerID":"String","DistAmount":0,"LineNum":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}