JiwaAPI

<back to all web services

CB_BatchTransQuery

Requires Authentication
CB_BatchTransQuery Parameters:
NameParameterData TypeRequiredDescription
CBBatchIDquerystringNo
CBBatchIDStartsWithquerystringNo
CBBatchIDEndsWithquerystringNo
CBBatchIDContainsquerystringNo
CBBatchIDLikequerystringNo
CBBatchIDBetweenquerystring[]No
CBBatchIDInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryNullable<DateTime>[]No
LastSavedDateTimeInqueryNullable<DateTime>[]No
StaffIDquerystringNo
StaffIDStartsWithquerystringNo
StaffIDEndsWithquerystringNo
StaffIDContainsquerystringNo
StaffIDLikequerystringNo
StaffIDBetweenquerystring[]No
StaffIDInquerystring[]No
BatchDatequeryDateTime?No
BatchDateGreaterThanOrEqualToqueryDateTime?No
BatchDateGreaterThanqueryDateTime?No
BatchDateLessThanqueryDateTime?No
BatchDateLessThanOrEqualToqueryDateTime?No
BatchDateNotEqualToqueryDateTime?No
BatchDateBetweenqueryNullable<DateTime>[]No
BatchDateInqueryNullable<DateTime>[]No
BatchNoquerystringNo
BatchNoStartsWithquerystringNo
BatchNoEndsWithquerystringNo
BatchNoContainsquerystringNo
BatchNoLikequerystringNo
BatchNoBetweenquerystring[]No
BatchNoInquerystring[]No
Activatedquerybool?No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
ReceiptPaymentquerybyte?No
ReceiptPaymentGreaterThanOrEqualToquerybyte?No
ReceiptPaymentGreaterThanquerybyte?No
ReceiptPaymentLessThanquerybyte?No
ReceiptPaymentLessThanOrEqualToquerybyte?No
ReceiptPaymentNotEqualToquerybyte?No
ReceiptPaymentBetweenqueryNullable<Byte>[]No
ReceiptPaymentInqueryNullable<Byte>[]No
BankLedgerIDquerystringNo
BankLedgerIDStartsWithquerystringNo
BankLedgerIDEndsWithquerystringNo
BankLedgerIDContainsquerystringNo
BankLedgerIDLikequerystringNo
BankLedgerIDBetweenquerystring[]No
BankLedgerIDInquerystring[]No
GroupJournalsquerybool?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
CB_BatchTrans Parameters:
NameParameterData TypeRequiredDescription
CBBatchIDformstringNo
LastSavedDateTimeformDateTime?No
StaffIDformstringNo
BatchDateformDateTime?No
BatchNoformstringNo
Activatedformbool?No
DescriptionformstringNo
ReceiptPaymentformbyte?No
BankLedgerIDformstringNo
GroupJournalsformboolNo
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/CB_BatchTransQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CB_BatchTransQuery 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>
  <Activated>false</Activated>
  <BankLedgerID>String</BankLedgerID>
  <BankLedgerIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </BankLedgerIDBetween>
  <BankLedgerIDContains>String</BankLedgerIDContains>
  <BankLedgerIDEndsWith>String</BankLedgerIDEndsWith>
  <BankLedgerIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </BankLedgerIDIn>
  <BankLedgerIDLike>String</BankLedgerIDLike>
  <BankLedgerIDStartsWith>String</BankLedgerIDStartsWith>
  <BatchDate>0001-01-01T00:00:00</BatchDate>
  <BatchDateBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </BatchDateBetween>
  <BatchDateGreaterThan>0001-01-01T00:00:00</BatchDateGreaterThan>
  <BatchDateGreaterThanOrEqualTo>0001-01-01T00:00:00</BatchDateGreaterThanOrEqualTo>
  <BatchDateIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </BatchDateIn>
  <BatchDateLessThan>0001-01-01T00:00:00</BatchDateLessThan>
  <BatchDateLessThanOrEqualTo>0001-01-01T00:00:00</BatchDateLessThanOrEqualTo>
  <BatchDateNotEqualTo>0001-01-01T00:00:00</BatchDateNotEqualTo>
  <BatchNo>String</BatchNo>
  <BatchNoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </BatchNoBetween>
  <BatchNoContains>String</BatchNoContains>
  <BatchNoEndsWith>String</BatchNoEndsWith>
  <BatchNoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </BatchNoIn>
  <BatchNoLike>String</BatchNoLike>
  <BatchNoStartsWith>String</BatchNoStartsWith>
  <CBBatchID>String</CBBatchID>
  <CBBatchIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CBBatchIDBetween>
  <CBBatchIDContains>String</CBBatchIDContains>
  <CBBatchIDEndsWith>String</CBBatchIDEndsWith>
  <CBBatchIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CBBatchIDIn>
  <CBBatchIDLike>String</CBBatchIDLike>
  <CBBatchIDStartsWith>String</CBBatchIDStartsWith>
  <Description>String</Description>
  <DescriptionBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DescriptionBetween>
  <DescriptionContains>String</DescriptionContains>
  <DescriptionEndsWith>String</DescriptionEndsWith>
  <DescriptionIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DescriptionIn>
  <DescriptionLike>String</DescriptionLike>
  <DescriptionStartsWith>String</DescriptionStartsWith>
  <GroupJournals>false</GroupJournals>
  <LastSavedDateTime>0001-01-01T00:00:00</LastSavedDateTime>
  <LastSavedDateTimeBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </LastSavedDateTimeBetween>
  <LastSavedDateTimeGreaterThan>0001-01-01T00:00:00</LastSavedDateTimeGreaterThan>
  <LastSavedDateTimeGreaterThanOrEqualTo>0001-01-01T00:00:00</LastSavedDateTimeGreaterThanOrEqualTo>
  <LastSavedDateTimeIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </LastSavedDateTimeIn>
  <LastSavedDateTimeLessThan>0001-01-01T00:00:00</LastSavedDateTimeLessThan>
  <LastSavedDateTimeLessThanOrEqualTo>0001-01-01T00:00:00</LastSavedDateTimeLessThanOrEqualTo>
  <LastSavedDateTimeNotEqualTo>0001-01-01T00:00:00</LastSavedDateTimeNotEqualTo>
  <ReceiptPayment>0</ReceiptPayment>
  <ReceiptPaymentBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:unsignedByte>0</d2p1:unsignedByte>
  </ReceiptPaymentBetween>
  <ReceiptPaymentGreaterThan>0</ReceiptPaymentGreaterThan>
  <ReceiptPaymentGreaterThanOrEqualTo>0</ReceiptPaymentGreaterThanOrEqualTo>
  <ReceiptPaymentIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:unsignedByte>0</d2p1:unsignedByte>
  </ReceiptPaymentIn>
  <ReceiptPaymentLessThan>0</ReceiptPaymentLessThan>
  <ReceiptPaymentLessThanOrEqualTo>0</ReceiptPaymentLessThanOrEqualTo>
  <ReceiptPaymentNotEqualTo>0</ReceiptPaymentNotEqualTo>
  <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>
</CB_BatchTransQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfCB_BatchTrans7kRqkrSv 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:CB_BatchTrans>
      <d2p1:_x003C_Activated_x003E_k__BackingField>false</d2p1:_x003C_Activated_x003E_k__BackingField>
      <d2p1:_x003C_BankLedgerID_x003E_k__BackingField>String</d2p1:_x003C_BankLedgerID_x003E_k__BackingField>
      <d2p1:_x003C_BatchDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_BatchDate_x003E_k__BackingField>
      <d2p1:_x003C_BatchNo_x003E_k__BackingField>String</d2p1:_x003C_BatchNo_x003E_k__BackingField>
      <d2p1:_x003C_CBBatchID_x003E_k__BackingField>String</d2p1:_x003C_CBBatchID_x003E_k__BackingField>
      <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
      <d2p1:_x003C_GroupJournals_x003E_k__BackingField>false</d2p1:_x003C_GroupJournals_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_ReceiptPayment_x003E_k__BackingField>0</d2p1:_x003C_ReceiptPayment_x003E_k__BackingField>
      <d2p1:_x003C_StaffID_x003E_k__BackingField>String</d2p1:_x003C_StaffID_x003E_k__BackingField>
    </d2p1:CB_BatchTrans>
  </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>
</QueryResponseOfCB_BatchTrans7kRqkrSv>