JiwaAPI

<back to all web services

GL_TransactionsQuery

Requires Authentication
GL_TransactionsQuery Parameters:
NameParameterData TypeRequiredDescription
GLTransactionIDquerystringNo
GLTransactionIDStartsWithquerystringNo
GLTransactionIDEndsWithquerystringNo
GLTransactionIDContainsquerystringNo
GLTransactionIDLikequerystringNo
GLTransactionIDBetweenquerystring[]No
GLTransactionIDInquerystring[]No
GLSetIDquerystringNo
GLSetIDStartsWithquerystringNo
GLSetIDEndsWithquerystringNo
GLSetIDContainsquerystringNo
GLSetIDLikequerystringNo
GLSetIDBetweenquerystring[]No
GLSetIDInquerystring[]No
GLLedgerIDquerystringNo
GLLedgerIDStartsWithquerystringNo
GLLedgerIDEndsWithquerystringNo
GLLedgerIDContainsquerystringNo
GLLedgerIDLikequerystringNo
GLLedgerIDBetweenquerystring[]No
GLLedgerIDInquerystring[]No
DebitCreditquerybool?No
Amountquerydecimal?No
AmountGreaterThanOrEqualToquerydecimal?No
AmountGreaterThanquerydecimal?No
AmountLessThanquerydecimal?No
AmountLessThanOrEqualToquerydecimal?No
AmountNotEqualToquerydecimal?No
AmountBetweenqueryNullable<Decimal>[]No
AmountInqueryNullable<Decimal>[]No
RefquerystringNo
RefStartsWithquerystringNo
RefEndsWithquerystringNo
RefContainsquerystringNo
RefLikequerystringNo
RefBetweenquerystring[]No
RefInquerystring[]No
RemarkquerystringNo
RemarkStartsWithquerystringNo
RemarkEndsWithquerystringNo
RemarkContainsquerystringNo
RemarkLikequerystringNo
RemarkBetweenquerystring[]No
RemarkInquerystring[]No
LineNumqueryint?No
LineNumGreaterThanOrEqualToqueryint?No
LineNumGreaterThanqueryint?No
LineNumLessThanqueryint?No
LineNumLessThanOrEqualToqueryint?No
LineNumNotEqualToqueryint?No
LineNumBetweenqueryint[]No
LineNumInqueryint[]No
TransCode1IDquerystringNo
TransCode1IDStartsWithquerystringNo
TransCode1IDEndsWithquerystringNo
TransCode1IDContainsquerystringNo
TransCode1IDLikequerystringNo
TransCode1IDBetweenquerystring[]No
TransCode1IDInquerystring[]No
TransCode2IDquerystringNo
TransCode2IDStartsWithquerystringNo
TransCode2IDEndsWithquerystringNo
TransCode2IDContainsquerystringNo
TransCode2IDLikequerystringNo
TransCode2IDBetweenquerystring[]No
TransCode2IDInquerystring[]No
TransCode3IDquerystringNo
TransCode3IDStartsWithquerystringNo
TransCode3IDEndsWithquerystringNo
TransCode3IDContainsquerystringNo
TransCode3IDLikequerystringNo
TransCode3IDBetweenquerystring[]No
TransCode3IDInquerystring[]No
StaffIDquerystringNo
StaffIDStartsWithquerystringNo
StaffIDEndsWithquerystringNo
StaffIDContainsquerystringNo
StaffIDLikequerystringNo
StaffIDBetweenquerystring[]No
StaffIDInquerystring[]No
Reconciledquerybool?No
Clearedquerybool?No
TransPostDateTimequeryDateTime?No
TransPostDateTimeGreaterThanOrEqualToqueryDateTime?No
TransPostDateTimeGreaterThanqueryDateTime?No
TransPostDateTimeLessThanqueryDateTime?No
TransPostDateTimeLessThanOrEqualToqueryDateTime?No
TransPostDateTimeNotEqualToqueryDateTime?No
TransPostDateTimeBetweenqueryNullable<DateTime>[]No
TransPostDateTimeInqueryNullable<DateTime>[]No
JB_JobStages_RecIDquerystringNo
JB_JobStages_RecIDStartsWithquerystringNo
JB_JobStages_RecIDEndsWithquerystringNo
JB_JobStages_RecIDContainsquerystringNo
JB_JobStages_RecIDLikequerystringNo
JB_JobStages_RecIDBetweenquerystring[]No
JB_JobStages_RecIDInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
GL_Transactions Parameters:
NameParameterData TypeRequiredDescription
GLTransactionIDformstringNo
GLSetIDformstringNo
GLLedgerIDformstringNo
DebitCreditformbool?No
Amountformdecimal?No
RefformstringNo
RemarkformstringNo
LineNumformintNo
TransCode1IDformstringNo
TransCode2IDformstringNo
TransCode3IDformstringNo
StaffIDformstringNo
Reconciledformbool?No
Clearedformbool?No
TransPostDateTimeformDateTime?No
JB_JobStages_RecIDformstringNo
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.

POST /xml/reply/GL_TransactionsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GL_TransactionsQuery xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Tables">
  <Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
  <Include xmlns="http://schemas.servicestack.net/types">String</Include>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
  <OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
  <Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
  <Take xmlns="http://schemas.servicestack.net/types">0</Take>
  <Amount>0</Amount>
  <AmountBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </AmountBetween>
  <AmountGreaterThan>0</AmountGreaterThan>
  <AmountGreaterThanOrEqualTo>0</AmountGreaterThanOrEqualTo>
  <AmountIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </AmountIn>
  <AmountLessThan>0</AmountLessThan>
  <AmountLessThanOrEqualTo>0</AmountLessThanOrEqualTo>
  <AmountNotEqualTo>0</AmountNotEqualTo>
  <Cleared>false</Cleared>
  <DebitCredit>false</DebitCredit>
  <GLLedgerID>String</GLLedgerID>
  <GLLedgerIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </GLLedgerIDBetween>
  <GLLedgerIDContains>String</GLLedgerIDContains>
  <GLLedgerIDEndsWith>String</GLLedgerIDEndsWith>
  <GLLedgerIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </GLLedgerIDIn>
  <GLLedgerIDLike>String</GLLedgerIDLike>
  <GLLedgerIDStartsWith>String</GLLedgerIDStartsWith>
  <GLSetID>String</GLSetID>
  <GLSetIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </GLSetIDBetween>
  <GLSetIDContains>String</GLSetIDContains>
  <GLSetIDEndsWith>String</GLSetIDEndsWith>
  <GLSetIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </GLSetIDIn>
  <GLSetIDLike>String</GLSetIDLike>
  <GLSetIDStartsWith>String</GLSetIDStartsWith>
  <GLTransactionID>String</GLTransactionID>
  <GLTransactionIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </GLTransactionIDBetween>
  <GLTransactionIDContains>String</GLTransactionIDContains>
  <GLTransactionIDEndsWith>String</GLTransactionIDEndsWith>
  <GLTransactionIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </GLTransactionIDIn>
  <GLTransactionIDLike>String</GLTransactionIDLike>
  <GLTransactionIDStartsWith>String</GLTransactionIDStartsWith>
  <JB_JobStages_RecID>String</JB_JobStages_RecID>
  <JB_JobStages_RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </JB_JobStages_RecIDBetween>
  <JB_JobStages_RecIDContains>String</JB_JobStages_RecIDContains>
  <JB_JobStages_RecIDEndsWith>String</JB_JobStages_RecIDEndsWith>
  <JB_JobStages_RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </JB_JobStages_RecIDIn>
  <JB_JobStages_RecIDLike>String</JB_JobStages_RecIDLike>
  <JB_JobStages_RecIDStartsWith>String</JB_JobStages_RecIDStartsWith>
  <LineNum>0</LineNum>
  <LineNumBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </LineNumBetween>
  <LineNumGreaterThan>0</LineNumGreaterThan>
  <LineNumGreaterThanOrEqualTo>0</LineNumGreaterThanOrEqualTo>
  <LineNumIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </LineNumIn>
  <LineNumLessThan>0</LineNumLessThan>
  <LineNumLessThanOrEqualTo>0</LineNumLessThanOrEqualTo>
  <LineNumNotEqualTo>0</LineNumNotEqualTo>
  <Reconciled>false</Reconciled>
  <Ref>String</Ref>
  <RefBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RefBetween>
  <RefContains>String</RefContains>
  <RefEndsWith>String</RefEndsWith>
  <RefIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RefIn>
  <RefLike>String</RefLike>
  <RefStartsWith>String</RefStartsWith>
  <Remark>String</Remark>
  <RemarkBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RemarkBetween>
  <RemarkContains>String</RemarkContains>
  <RemarkEndsWith>String</RemarkEndsWith>
  <RemarkIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RemarkIn>
  <RemarkLike>String</RemarkLike>
  <RemarkStartsWith>String</RemarkStartsWith>
  <StaffID>String</StaffID>
  <StaffIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </StaffIDBetween>
  <StaffIDContains>String</StaffIDContains>
  <StaffIDEndsWith>String</StaffIDEndsWith>
  <StaffIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </StaffIDIn>
  <StaffIDLike>String</StaffIDLike>
  <StaffIDStartsWith>String</StaffIDStartsWith>
  <TransCode1ID>String</TransCode1ID>
  <TransCode1IDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </TransCode1IDBetween>
  <TransCode1IDContains>String</TransCode1IDContains>
  <TransCode1IDEndsWith>String</TransCode1IDEndsWith>
  <TransCode1IDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </TransCode1IDIn>
  <TransCode1IDLike>String</TransCode1IDLike>
  <TransCode1IDStartsWith>String</TransCode1IDStartsWith>
  <TransCode2ID>String</TransCode2ID>
  <TransCode2IDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </TransCode2IDBetween>
  <TransCode2IDContains>String</TransCode2IDContains>
  <TransCode2IDEndsWith>String</TransCode2IDEndsWith>
  <TransCode2IDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </TransCode2IDIn>
  <TransCode2IDLike>String</TransCode2IDLike>
  <TransCode2IDStartsWith>String</TransCode2IDStartsWith>
  <TransCode3ID>String</TransCode3ID>
  <TransCode3IDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </TransCode3IDBetween>
  <TransCode3IDContains>String</TransCode3IDContains>
  <TransCode3IDEndsWith>String</TransCode3IDEndsWith>
  <TransCode3IDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </TransCode3IDIn>
  <TransCode3IDLike>String</TransCode3IDLike>
  <TransCode3IDStartsWith>String</TransCode3IDStartsWith>
  <TransPostDateTime>0001-01-01T00:00:00</TransPostDateTime>
  <TransPostDateTimeBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </TransPostDateTimeBetween>
  <TransPostDateTimeGreaterThan>0001-01-01T00:00:00</TransPostDateTimeGreaterThan>
  <TransPostDateTimeGreaterThanOrEqualTo>0001-01-01T00:00:00</TransPostDateTimeGreaterThanOrEqualTo>
  <TransPostDateTimeIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </TransPostDateTimeIn>
  <TransPostDateTimeLessThan>0001-01-01T00:00:00</TransPostDateTimeLessThan>
  <TransPostDateTimeLessThanOrEqualTo>0001-01-01T00:00:00</TransPostDateTimeLessThanOrEqualTo>
  <TransPostDateTimeNotEqualTo>0001-01-01T00:00:00</TransPostDateTimeNotEqualTo>
</GL_TransactionsQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfGL_Transactions7kRqkrSv 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_Transactions>
      <d2p1:_x003C_Amount_x003E_k__BackingField>0</d2p1:_x003C_Amount_x003E_k__BackingField>
      <d2p1:_x003C_Cleared_x003E_k__BackingField>false</d2p1:_x003C_Cleared_x003E_k__BackingField>
      <d2p1:_x003C_DebitCredit_x003E_k__BackingField>false</d2p1:_x003C_DebitCredit_x003E_k__BackingField>
      <d2p1:_x003C_GLLedgerID_x003E_k__BackingField>String</d2p1:_x003C_GLLedgerID_x003E_k__BackingField>
      <d2p1:_x003C_GLSetID_x003E_k__BackingField>String</d2p1:_x003C_GLSetID_x003E_k__BackingField>
      <d2p1:_x003C_GLTransactionID_x003E_k__BackingField>String</d2p1:_x003C_GLTransactionID_x003E_k__BackingField>
      <d2p1:_x003C_JB_JobStages_RecID_x003E_k__BackingField>String</d2p1:_x003C_JB_JobStages_RecID_x003E_k__BackingField>
      <d2p1:_x003C_LineNum_x003E_k__BackingField>0</d2p1:_x003C_LineNum_x003E_k__BackingField>
      <d2p1:_x003C_Reconciled_x003E_k__BackingField>false</d2p1:_x003C_Reconciled_x003E_k__BackingField>
      <d2p1:_x003C_Ref_x003E_k__BackingField>String</d2p1:_x003C_Ref_x003E_k__BackingField>
      <d2p1:_x003C_Remark_x003E_k__BackingField>String</d2p1:_x003C_Remark_x003E_k__BackingField>
      <d2p1:_x003C_StaffID_x003E_k__BackingField>String</d2p1:_x003C_StaffID_x003E_k__BackingField>
      <d2p1:_x003C_TransCode1ID_x003E_k__BackingField>String</d2p1:_x003C_TransCode1ID_x003E_k__BackingField>
      <d2p1:_x003C_TransCode2ID_x003E_k__BackingField>String</d2p1:_x003C_TransCode2ID_x003E_k__BackingField>
      <d2p1:_x003C_TransCode3ID_x003E_k__BackingField>String</d2p1:_x003C_TransCode3ID_x003E_k__BackingField>
      <d2p1:_x003C_TransPostDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_TransPostDateTime_x003E_k__BackingField>
    </d2p1:GL_Transactions>
  </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_Transactions7kRqkrSv>