JiwaAPI

<back to all web services

GL_CategoryQuery

Requires Authentication
The following routes are available for this service:
GET/Queries/GL_CategoryRetrieves a list of general ledger categories.
GL_CategoryQuery Parameters:
NameParameterData TypeRequiredDescription
GLCategoryIDquerystringNo
GLCategoryIDStartsWithquerystringNo
GLCategoryIDEndsWithquerystringNo
GLCategoryIDContainsquerystringNo
GLCategoryIDLikequerystringNo
GLCategoryIDBetweenquerystring[]No
GLCategoryIDInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryNullable<DateTime>[]No
LastSavedDateTimeInqueryNullable<DateTime>[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
ExpSignquerybyte?No
ExpSignGreaterThanOrEqualToquerybyte?No
ExpSignGreaterThanquerybyte?No
ExpSignLessThanquerybyte?No
ExpSignLessThanOrEqualToquerybyte?No
ExpSignNotEqualToquerybyte?No
ExpSignBetweenqueryNullable<Byte>[]No
ExpSignInqueryNullable<Byte>[]No
AccTypequerybyte?No
AccTypeGreaterThanOrEqualToquerybyte?No
AccTypeGreaterThanquerybyte?No
AccTypeLessThanquerybyte?No
AccTypeLessThanOrEqualToquerybyte?No
AccTypeNotEqualToquerybyte?No
AccTypeBetweenqueryNullable<Byte>[]No
AccTypeInqueryNullable<Byte>[]No
Group1querystringNo
Group1StartsWithquerystringNo
Group1EndsWithquerystringNo
Group1ContainsquerystringNo
Group1LikequerystringNo
Group1Betweenquerystring[]No
Group1Inquerystring[]No
Group2querystringNo
Group2StartsWithquerystringNo
Group2EndsWithquerystringNo
Group2ContainsquerystringNo
Group2LikequerystringNo
Group2Betweenquerystring[]No
Group2Inquerystring[]No
Group2DisplayOrderqueryint?No
Group2DisplayOrderGreaterThanOrEqualToqueryint?No
Group2DisplayOrderGreaterThanqueryint?No
Group2DisplayOrderLessThanqueryint?No
Group2DisplayOrderLessThanOrEqualToqueryint?No
Group2DisplayOrderNotEqualToqueryint?No
Group2DisplayOrderBetweenqueryNullable<Int32>[]No
Group2DisplayOrderInqueryNullable<Int32>[]No
Group1DisplayOrderqueryint?No
Group1DisplayOrderGreaterThanOrEqualToqueryint?No
Group1DisplayOrderGreaterThanqueryint?No
Group1DisplayOrderLessThanqueryint?No
Group1DisplayOrderLessThanOrEqualToqueryint?No
Group1DisplayOrderNotEqualToqueryint?No
Group1DisplayOrderBetweenqueryNullable<Int32>[]No
Group1DisplayOrderInqueryNullable<Int32>[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
GL_Category Parameters:
NameParameterData TypeRequiredDescription
GLCategoryIDformstringNo
LastSavedDateTimeformDateTime?No
DescriptionformstringNo
ExpSignformbyte?No
AccTypeformbyte?No
Group1formstringNo
Group2formstringNo
Group2DisplayOrderformint?No
Group1DisplayOrderformint?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.

GET /Queries/GL_Category HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Results":[{"GLCategoryID":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","Description":"String","ExpSign":0,"AccType":0,"Group1":"String","Group2":"String","Group2DisplayOrder":0,"Group1DisplayOrder":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}