JiwaAPI

<back to all web services

CR_TransAllocQuery

Requires Authentication
CR_TransAllocQuery Parameters:
NameParameterData TypeRequiredDescription
AllocIDquerystringNo
AllocIDStartsWithquerystringNo
AllocIDEndsWithquerystringNo
AllocIDContainsquerystringNo
AllocIDLikequerystringNo
AllocIDBetweenquerystring[]No
AllocIDInquerystring[]No
CreditorIDquerystringNo
CreditorIDStartsWithquerystringNo
CreditorIDEndsWithquerystringNo
CreditorIDContainsquerystringNo
CreditorIDLikequerystringNo
CreditorIDBetweenquerystring[]No
CreditorIDInquerystring[]No
DebitTransIDquerystringNo
DebitTransIDStartsWithquerystringNo
DebitTransIDEndsWithquerystringNo
DebitTransIDContainsquerystringNo
DebitTransIDLikequerystringNo
DebitTransIDBetweenquerystring[]No
DebitTransIDInquerystring[]No
CreditTransIDquerystringNo
CreditTransIDStartsWithquerystringNo
CreditTransIDEndsWithquerystringNo
CreditTransIDContainsquerystringNo
CreditTransIDLikequerystringNo
CreditTransIDBetweenquerystring[]No
CreditTransIDInquerystring[]No
FXAmountquerydecimal?No
FXAmountGreaterThanOrEqualToquerydecimal?No
FXAmountGreaterThanquerydecimal?No
FXAmountLessThanquerydecimal?No
FXAmountLessThanOrEqualToquerydecimal?No
FXAmountNotEqualToquerydecimal?No
FXAmountBetweenqueryNullable<Decimal>[]No
FXAmountInqueryNullable<Decimal>[]No
DebitAmountquerydecimal?No
DebitAmountGreaterThanOrEqualToquerydecimal?No
DebitAmountGreaterThanquerydecimal?No
DebitAmountLessThanquerydecimal?No
DebitAmountLessThanOrEqualToquerydecimal?No
DebitAmountNotEqualToquerydecimal?No
DebitAmountBetweenqueryNullable<Decimal>[]No
DebitAmountInqueryNullable<Decimal>[]No
CreditAmountquerydecimal?No
CreditAmountGreaterThanOrEqualToquerydecimal?No
CreditAmountGreaterThanquerydecimal?No
CreditAmountLessThanquerydecimal?No
CreditAmountLessThanOrEqualToquerydecimal?No
CreditAmountNotEqualToquerydecimal?No
CreditAmountBetweenqueryNullable<Decimal>[]No
CreditAmountInqueryNullable<Decimal>[]No
DebitAgedquerybool?No
CreditAgedquerybool?No
DateAllocqueryDateTime?No
DateAllocGreaterThanOrEqualToqueryDateTime?No
DateAllocGreaterThanqueryDateTime?No
DateAllocLessThanqueryDateTime?No
DateAllocLessThanOrEqualToqueryDateTime?No
DateAllocNotEqualToqueryDateTime?No
DateAllocBetweenqueryDateTime[]No
DateAllocInqueryDateTime[]No
Versionqueryint?No
VersionGreaterThanOrEqualToqueryint?No
VersionGreaterThanqueryint?No
VersionLessThanqueryint?No
VersionLessThanOrEqualToqueryint?No
VersionNotEqualToqueryint?No
VersionBetweenqueryNullable<Int32>[]No
VersionInqueryNullable<Int32>[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
CR_TransAlloc Parameters:
NameParameterData TypeRequiredDescription
AllocIDformstringNo
CreditorIDformstringNo
DebitTransIDformstringNo
CreditTransIDformstringNo
FXAmountformdecimal?No
DebitAmountformdecimal?No
CreditAmountformdecimal?No
DebitAgedformbool?No
CreditAgedformbool?No
DateAllocformDateTimeNo
Versionformint?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/CR_TransAllocQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CR_TransAllocQuery 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>
  <AllocID>String</AllocID>
  <AllocIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AllocIDBetween>
  <AllocIDContains>String</AllocIDContains>
  <AllocIDEndsWith>String</AllocIDEndsWith>
  <AllocIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AllocIDIn>
  <AllocIDLike>String</AllocIDLike>
  <AllocIDStartsWith>String</AllocIDStartsWith>
  <CreditAged>false</CreditAged>
  <CreditAmount>0</CreditAmount>
  <CreditAmountBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </CreditAmountBetween>
  <CreditAmountGreaterThan>0</CreditAmountGreaterThan>
  <CreditAmountGreaterThanOrEqualTo>0</CreditAmountGreaterThanOrEqualTo>
  <CreditAmountIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </CreditAmountIn>
  <CreditAmountLessThan>0</CreditAmountLessThan>
  <CreditAmountLessThanOrEqualTo>0</CreditAmountLessThanOrEqualTo>
  <CreditAmountNotEqualTo>0</CreditAmountNotEqualTo>
  <CreditTransID>String</CreditTransID>
  <CreditTransIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CreditTransIDBetween>
  <CreditTransIDContains>String</CreditTransIDContains>
  <CreditTransIDEndsWith>String</CreditTransIDEndsWith>
  <CreditTransIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CreditTransIDIn>
  <CreditTransIDLike>String</CreditTransIDLike>
  <CreditTransIDStartsWith>String</CreditTransIDStartsWith>
  <CreditorID>String</CreditorID>
  <CreditorIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CreditorIDBetween>
  <CreditorIDContains>String</CreditorIDContains>
  <CreditorIDEndsWith>String</CreditorIDEndsWith>
  <CreditorIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CreditorIDIn>
  <CreditorIDLike>String</CreditorIDLike>
  <CreditorIDStartsWith>String</CreditorIDStartsWith>
  <DateAlloc>0001-01-01T00:00:00</DateAlloc>
  <DateAllocBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </DateAllocBetween>
  <DateAllocGreaterThan>0001-01-01T00:00:00</DateAllocGreaterThan>
  <DateAllocGreaterThanOrEqualTo>0001-01-01T00:00:00</DateAllocGreaterThanOrEqualTo>
  <DateAllocIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </DateAllocIn>
  <DateAllocLessThan>0001-01-01T00:00:00</DateAllocLessThan>
  <DateAllocLessThanOrEqualTo>0001-01-01T00:00:00</DateAllocLessThanOrEqualTo>
  <DateAllocNotEqualTo>0001-01-01T00:00:00</DateAllocNotEqualTo>
  <DebitAged>false</DebitAged>
  <DebitAmount>0</DebitAmount>
  <DebitAmountBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </DebitAmountBetween>
  <DebitAmountGreaterThan>0</DebitAmountGreaterThan>
  <DebitAmountGreaterThanOrEqualTo>0</DebitAmountGreaterThanOrEqualTo>
  <DebitAmountIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </DebitAmountIn>
  <DebitAmountLessThan>0</DebitAmountLessThan>
  <DebitAmountLessThanOrEqualTo>0</DebitAmountLessThanOrEqualTo>
  <DebitAmountNotEqualTo>0</DebitAmountNotEqualTo>
  <DebitTransID>String</DebitTransID>
  <DebitTransIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DebitTransIDBetween>
  <DebitTransIDContains>String</DebitTransIDContains>
  <DebitTransIDEndsWith>String</DebitTransIDEndsWith>
  <DebitTransIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DebitTransIDIn>
  <DebitTransIDLike>String</DebitTransIDLike>
  <DebitTransIDStartsWith>String</DebitTransIDStartsWith>
  <FXAmount>0</FXAmount>
  <FXAmountBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </FXAmountBetween>
  <FXAmountGreaterThan>0</FXAmountGreaterThan>
  <FXAmountGreaterThanOrEqualTo>0</FXAmountGreaterThanOrEqualTo>
  <FXAmountIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </FXAmountIn>
  <FXAmountLessThan>0</FXAmountLessThan>
  <FXAmountLessThanOrEqualTo>0</FXAmountLessThanOrEqualTo>
  <FXAmountNotEqualTo>0</FXAmountNotEqualTo>
  <Version>0</Version>
  <VersionBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:int>0</d2p1:int>
  </VersionBetween>
  <VersionGreaterThan>0</VersionGreaterThan>
  <VersionGreaterThanOrEqualTo>0</VersionGreaterThanOrEqualTo>
  <VersionIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:int>0</d2p1:int>
  </VersionIn>
  <VersionLessThan>0</VersionLessThan>
  <VersionLessThanOrEqualTo>0</VersionLessThanOrEqualTo>
  <VersionNotEqualTo>0</VersionNotEqualTo>
</CR_TransAllocQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfCR_TransAlloc7kRqkrSv 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:CR_TransAlloc>
      <d2p1:_x003C_AllocID_x003E_k__BackingField>String</d2p1:_x003C_AllocID_x003E_k__BackingField>
      <d2p1:_x003C_CreditAged_x003E_k__BackingField>false</d2p1:_x003C_CreditAged_x003E_k__BackingField>
      <d2p1:_x003C_CreditAmount_x003E_k__BackingField>0</d2p1:_x003C_CreditAmount_x003E_k__BackingField>
      <d2p1:_x003C_CreditTransID_x003E_k__BackingField>String</d2p1:_x003C_CreditTransID_x003E_k__BackingField>
      <d2p1:_x003C_CreditorID_x003E_k__BackingField>String</d2p1:_x003C_CreditorID_x003E_k__BackingField>
      <d2p1:_x003C_DateAlloc_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_DateAlloc_x003E_k__BackingField>
      <d2p1:_x003C_DebitAged_x003E_k__BackingField>false</d2p1:_x003C_DebitAged_x003E_k__BackingField>
      <d2p1:_x003C_DebitAmount_x003E_k__BackingField>0</d2p1:_x003C_DebitAmount_x003E_k__BackingField>
      <d2p1:_x003C_DebitTransID_x003E_k__BackingField>String</d2p1:_x003C_DebitTransID_x003E_k__BackingField>
      <d2p1:_x003C_FXAmount_x003E_k__BackingField>0</d2p1:_x003C_FXAmount_x003E_k__BackingField>
      <d2p1:_x003C_Version_x003E_k__BackingField>0</d2p1:_x003C_Version_x003E_k__BackingField>
    </d2p1:CR_TransAlloc>
  </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>
</QueryResponseOfCR_TransAlloc7kRqkrSv>