GET | /Queries/GL_Category | Retrieves a list of general ledger categories. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
GLCategoryID | query | string | No | |
GLCategoryIDStartsWith | query | string | No | |
GLCategoryIDEndsWith | query | string | No | |
GLCategoryIDContains | query | string | No | |
GLCategoryIDLike | query | string | No | |
GLCategoryIDBetween | query | string[] | No | |
GLCategoryIDIn | query | string[] | 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 | Nullable<DateTime>[] | No | |
LastSavedDateTimeIn | query | Nullable<DateTime>[] | No | |
Description | query | string | No | |
DescriptionStartsWith | query | string | No | |
DescriptionEndsWith | query | string | No | |
DescriptionContains | query | string | No | |
DescriptionLike | query | string | No | |
DescriptionBetween | query | string[] | No | |
DescriptionIn | query | string[] | No | |
ExpSign | query | byte? | No | |
ExpSignGreaterThanOrEqualTo | query | byte? | No | |
ExpSignGreaterThan | query | byte? | No | |
ExpSignLessThan | query | byte? | No | |
ExpSignLessThanOrEqualTo | query | byte? | No | |
ExpSignNotEqualTo | query | byte? | No | |
ExpSignBetween | query | Nullable<Byte>[] | No | |
ExpSignIn | query | Nullable<Byte>[] | No | |
AccType | query | byte? | No | |
AccTypeGreaterThanOrEqualTo | query | byte? | No | |
AccTypeGreaterThan | query | byte? | No | |
AccTypeLessThan | query | byte? | No | |
AccTypeLessThanOrEqualTo | query | byte? | No | |
AccTypeNotEqualTo | query | byte? | No | |
AccTypeBetween | query | Nullable<Byte>[] | No | |
AccTypeIn | query | Nullable<Byte>[] | No | |
Group1 | query | string | No | |
Group1StartsWith | query | string | No | |
Group1EndsWith | query | string | No | |
Group1Contains | query | string | No | |
Group1Like | query | string | No | |
Group1Between | query | string[] | No | |
Group1In | query | string[] | No | |
Group2 | query | string | No | |
Group2StartsWith | query | string | No | |
Group2EndsWith | query | string | No | |
Group2Contains | query | string | No | |
Group2Like | query | string | No | |
Group2Between | query | string[] | No | |
Group2In | query | string[] | No | |
Group2DisplayOrder | query | int? | No | |
Group2DisplayOrderGreaterThanOrEqualTo | query | int? | No | |
Group2DisplayOrderGreaterThan | query | int? | No | |
Group2DisplayOrderLessThan | query | int? | No | |
Group2DisplayOrderLessThanOrEqualTo | query | int? | No | |
Group2DisplayOrderNotEqualTo | query | int? | No | |
Group2DisplayOrderBetween | query | Nullable<Int32>[] | No | |
Group2DisplayOrderIn | query | Nullable<Int32>[] | No | |
Group1DisplayOrder | query | int? | No | |
Group1DisplayOrderGreaterThanOrEqualTo | query | int? | No | |
Group1DisplayOrderGreaterThan | query | int? | No | |
Group1DisplayOrderLessThan | query | int? | No | |
Group1DisplayOrderLessThanOrEqualTo | query | int? | No | |
Group1DisplayOrderNotEqualTo | query | int? | No | |
Group1DisplayOrderBetween | query | Nullable<Int32>[] | No | |
Group1DisplayOrderIn | query | Nullable<Int32>[] | 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 |
---|---|---|---|---|
GLCategoryID | form | string | No | |
LastSavedDateTime | form | DateTime? | No | |
Description | form | string | No | |
ExpSign | form | byte? | No | |
AccType | form | byte? | No | |
Group1 | form | string | No | |
Group2 | form | string | No | |
Group2DisplayOrder | form | int? | No | |
Group1DisplayOrder | form | int? | 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 .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <QueryResponseOfGL_Category7kRqkrSv xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types"> <Offset>0</Offset> <Total>0</Total> <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Tables"> <d2p1:GL_Category> <d2p1:_x003C_AccType_x003E_k__BackingField>0</d2p1:_x003C_AccType_x003E_k__BackingField> <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField> <d2p1:_x003C_ExpSign_x003E_k__BackingField>0</d2p1:_x003C_ExpSign_x003E_k__BackingField> <d2p1:_x003C_GLCategoryID_x003E_k__BackingField>String</d2p1:_x003C_GLCategoryID_x003E_k__BackingField> <d2p1:_x003C_Group1DisplayOrder_x003E_k__BackingField>0</d2p1:_x003C_Group1DisplayOrder_x003E_k__BackingField> <d2p1:_x003C_Group1_x003E_k__BackingField>String</d2p1:_x003C_Group1_x003E_k__BackingField> <d2p1:_x003C_Group2DisplayOrder_x003E_k__BackingField>0</d2p1:_x003C_Group2DisplayOrder_x003E_k__BackingField> <d2p1:_x003C_Group2_x003E_k__BackingField>String</d2p1:_x003C_Group2_x003E_k__BackingField> <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField> </d2p1:GL_Category> </Results> <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringstring> <d2p1:Key>String</d2p1:Key> <d2p1:Value>String</d2p1:Value> </d2p1:KeyValueOfstringstring> </Meta> <ResponseStatus> <ErrorCode>String</ErrorCode> <Message>String</Message> <StackTrace>String</StackTrace> <Errors> <ResponseError> <ErrorCode>String</ErrorCode> <FieldName>String</FieldName> <Message>String</Message> <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </Meta> </ResponseError> </Errors> <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </Meta> </ResponseStatus> </QueryResponseOfGL_Category7kRqkrSv>