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 .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_DistributionQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GL_DistributionQuery 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>
  <DistAmount>0</DistAmount>
  <DistAmountBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </DistAmountBetween>
  <DistAmountGreaterThan>0</DistAmountGreaterThan>
  <DistAmountGreaterThanOrEqualTo>0</DistAmountGreaterThanOrEqualTo>
  <DistAmountIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </DistAmountIn>
  <DistAmountLessThan>0</DistAmountLessThan>
  <DistAmountLessThanOrEqualTo>0</DistAmountLessThanOrEqualTo>
  <DistAmountNotEqualTo>0</DistAmountNotEqualTo>
  <GLDistID>String</GLDistID>
  <GLDistIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </GLDistIDBetween>
  <GLDistIDContains>String</GLDistIDContains>
  <GLDistIDEndsWith>String</GLDistIDEndsWith>
  <GLDistIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </GLDistIDIn>
  <GLDistIDLike>String</GLDistIDLike>
  <GLDistIDStartsWith>String</GLDistIDStartsWith>
  <GLDistLedgerID>String</GLDistLedgerID>
  <GLDistLedgerIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </GLDistLedgerIDBetween>
  <GLDistLedgerIDContains>String</GLDistLedgerIDContains>
  <GLDistLedgerIDEndsWith>String</GLDistLedgerIDEndsWith>
  <GLDistLedgerIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </GLDistLedgerIDIn>
  <GLDistLedgerIDLike>String</GLDistLedgerIDLike>
  <GLDistLedgerIDStartsWith>String</GLDistLedgerIDStartsWith>
  <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>
  <LineNum>0</LineNum>
  <LineNumBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:int>0</d2p1:int>
  </LineNumBetween>
  <LineNumGreaterThan>0</LineNumGreaterThan>
  <LineNumGreaterThanOrEqualTo>0</LineNumGreaterThanOrEqualTo>
  <LineNumIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:int>0</d2p1:int>
  </LineNumIn>
  <LineNumLessThan>0</LineNumLessThan>
  <LineNumLessThanOrEqualTo>0</LineNumLessThanOrEqualTo>
  <LineNumNotEqualTo>0</LineNumNotEqualTo>
</GL_DistributionQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfGL_Distribution7kRqkrSv 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_Distribution>
      <d2p1:_x003C_DistAmount_x003E_k__BackingField>0</d2p1:_x003C_DistAmount_x003E_k__BackingField>
      <d2p1:_x003C_GLDistID_x003E_k__BackingField>String</d2p1:_x003C_GLDistID_x003E_k__BackingField>
      <d2p1:_x003C_GLDistLedgerID_x003E_k__BackingField>String</d2p1:_x003C_GLDistLedgerID_x003E_k__BackingField>
      <d2p1:_x003C_GLLedgerID_x003E_k__BackingField>String</d2p1:_x003C_GLLedgerID_x003E_k__BackingField>
      <d2p1:_x003C_LineNum_x003E_k__BackingField>0</d2p1:_x003C_LineNum_x003E_k__BackingField>
    </d2p1:GL_Distribution>
  </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_Distribution7kRqkrSv>