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 .xml suffix or ?format=xml

HTTP + 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>