JiwaAPI

CR_BatchPaymentQuery

**CR_BatchPaymentQuery** Parameters:
Name	Parameter	Data Type	Required
CR_BatchPayID	query	string	No
CR_BatchPayIDStartsWith	query	string	No
CR_BatchPayIDEndsWith	query	string	No
CR_BatchPayIDContains	query	string	No
CR_BatchPayIDLike	query	string	No
CR_BatchPayIDBetween	query	string[]	No
CR_BatchPayIDIn	query	string[]	No
BatchNo	query	string	No
BatchNoStartsWith	query	string	No
BatchNoEndsWith	query	string	No
BatchNoContains	query	string	No
BatchNoLike	query	string	No
BatchNoBetween	query	string[]	No
BatchNoIn	query	string[]	No
CreationDate	query	DateTime?	No
CreationDateGreaterThanOrEqualTo	query	DateTime?	No
CreationDateGreaterThan	query	DateTime?	No
CreationDateLessThan	query	DateTime?	No
CreationDateLessThanOrEqualTo	query	DateTime?	No
CreationDateNotEqualTo	query	DateTime?	No
CreationDateBetween	query	Nullable<DateTime>[]	No
CreationDateIn	query	Nullable<DateTime>[]	No
ActivationDate	query	DateTime?	No
ActivationDateGreaterThanOrEqualTo	query	DateTime?	No
ActivationDateGreaterThan	query	DateTime?	No
ActivationDateLessThan	query	DateTime?	No
ActivationDateLessThanOrEqualTo	query	DateTime?	No
ActivationDateNotEqualTo	query	DateTime?	No
ActivationDateBetween	query	Nullable<DateTime>[]	No
ActivationDateIn	query	Nullable<DateTime>[]	No
LastSavedDateTime	query	DateTime?	No
LastSavedDateTimeGreaterThanOrEqualTo	query	DateTime?	No
LastSavedDateTimeGreaterThan	query	DateTime?	No
LastSavedDateTimeLessThan	query	DateTime?	No
LastSavedDateTimeLessThanOrEqualTo	query	DateTime?	No
LastSavedDateTimeNotEqualTo	query	DateTime?	No
LastSavedDateTimeBetween	query	Nullable<DateTime>[]	No
LastSavedDateTimeIn	query	Nullable<DateTime>[]	No
Status	query	short?	No
StatusGreaterThanOrEqualTo	query	short?	No
StatusGreaterThan	query	short?	No
StatusLessThan	query	short?	No
StatusLessThanOrEqualTo	query	short?	No
StatusNotEqualTo	query	short?	No
StatusBetween	query	Nullable<Int16>[]	No
StatusIn	query	Nullable<Int16>[]	No
GLBankID	query	string	No
GLBankIDStartsWith	query	string	No
GLBankIDEndsWith	query	string	No
GLBankIDContains	query	string	No
GLBankIDLike	query	string	No
GLBankIDBetween	query	string[]	No
GLBankIDIn	query	string[]	No
OneCheque	query	bool?	No
UseSelectedBank	query	bool?	No
TypeCheque	query	bool?	No
StartChequeNo	query	string	No
StartChequeNoStartsWith	query	string	No
StartChequeNoEndsWith	query	string	No
StartChequeNoContains	query	string	No
StartChequeNoLike	query	string	No
StartChequeNoBetween	query	string[]	No
StartChequeNoIn	query	string[]	No
CreatedBy_HR_Staff_RecID	query	string	No
CreatedBy_HR_Staff_RecIDStartsWith	query	string	No
CreatedBy_HR_Staff_RecIDEndsWith	query	string	No
CreatedBy_HR_Staff_RecIDContains	query	string	No
CreatedBy_HR_Staff_RecIDLike	query	string	No
CreatedBy_HR_Staff_RecIDBetween	query	string[]	No
CreatedBy_HR_Staff_RecIDIn	query	string[]	No

**QueryBase** Parameters:
Name	Parameter	Data Type	Required
Skip	form	int?	No
Take	form	int?	No
OrderBy	form	string	No
OrderByDesc	form	string	No
Include	form	string	No
Fields	form	string	No
Meta	form	Dictionary<string, string>	No

**CR_BatchPayment** Parameters:
Name	Parameter	Data Type	Required
CR_BatchPayID	form	string	No
BatchNo	form	string	No
CreationDate	form	DateTime?	No
ActivationDate	form	DateTime?	No
LastSavedDateTime	form	DateTime?	No
Status	form	short?	No
GLBankID	form	string	No
OneCheque	form	bool	No
UseSelectedBank	form	bool?	No
TypeCheque	form	bool?	No
StartChequeNo	form	string	No
CreatedBy_HR_Staff_RecID	form	string	No

**QueryResponse<T>** Parameters:
Name	Parameter	Data Type	Required
Offset	form	int	No
Total	form	int	No
Results	form	List<T>	No
Meta	form	Dictionary<string, string>	No
ResponseStatus	form	ResponseStatus	No

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

<CR_BatchPaymentQuery 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>
  <ActivationDate>0001-01-01T00:00:00</ActivationDate>
  <ActivationDateBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </ActivationDateBetween>
  <ActivationDateGreaterThan>0001-01-01T00:00:00</ActivationDateGreaterThan>
  <ActivationDateGreaterThanOrEqualTo>0001-01-01T00:00:00</ActivationDateGreaterThanOrEqualTo>
  <ActivationDateIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </ActivationDateIn>
  <ActivationDateLessThan>0001-01-01T00:00:00</ActivationDateLessThan>
  <ActivationDateLessThanOrEqualTo>0001-01-01T00:00:00</ActivationDateLessThanOrEqualTo>
  <ActivationDateNotEqualTo>0001-01-01T00:00:00</ActivationDateNotEqualTo>
  <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>
  <CR_BatchPayID>String</CR_BatchPayID>
  <CR_BatchPayIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CR_BatchPayIDBetween>
  <CR_BatchPayIDContains>String</CR_BatchPayIDContains>
  <CR_BatchPayIDEndsWith>String</CR_BatchPayIDEndsWith>
  <CR_BatchPayIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CR_BatchPayIDIn>
  <CR_BatchPayIDLike>String</CR_BatchPayIDLike>
  <CR_BatchPayIDStartsWith>String</CR_BatchPayIDStartsWith>
  <CreatedBy_HR_Staff_RecID>String</CreatedBy_HR_Staff_RecID>
  <CreatedBy_HR_Staff_RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CreatedBy_HR_Staff_RecIDBetween>
  <CreatedBy_HR_Staff_RecIDContains>String</CreatedBy_HR_Staff_RecIDContains>
  <CreatedBy_HR_Staff_RecIDEndsWith>String</CreatedBy_HR_Staff_RecIDEndsWith>
  <CreatedBy_HR_Staff_RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CreatedBy_HR_Staff_RecIDIn>
  <CreatedBy_HR_Staff_RecIDLike>String</CreatedBy_HR_Staff_RecIDLike>
  <CreatedBy_HR_Staff_RecIDStartsWith>String</CreatedBy_HR_Staff_RecIDStartsWith>
  <CreationDate>0001-01-01T00:00:00</CreationDate>
  <CreationDateBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </CreationDateBetween>
  <CreationDateGreaterThan>0001-01-01T00:00:00</CreationDateGreaterThan>
  <CreationDateGreaterThanOrEqualTo>0001-01-01T00:00:00</CreationDateGreaterThanOrEqualTo>
  <CreationDateIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </CreationDateIn>
  <CreationDateLessThan>0001-01-01T00:00:00</CreationDateLessThan>
  <CreationDateLessThanOrEqualTo>0001-01-01T00:00:00</CreationDateLessThanOrEqualTo>
  <CreationDateNotEqualTo>0001-01-01T00:00:00</CreationDateNotEqualTo>
  <GLBankID>String</GLBankID>
  <GLBankIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </GLBankIDBetween>
  <GLBankIDContains>String</GLBankIDContains>
  <GLBankIDEndsWith>String</GLBankIDEndsWith>
  <GLBankIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </GLBankIDIn>
  <GLBankIDLike>String</GLBankIDLike>
  <GLBankIDStartsWith>String</GLBankIDStartsWith>
  <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>
  <OneCheque>false</OneCheque>
  <StartChequeNo>String</StartChequeNo>
  <StartChequeNoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </StartChequeNoBetween>
  <StartChequeNoContains>String</StartChequeNoContains>
  <StartChequeNoEndsWith>String</StartChequeNoEndsWith>
  <StartChequeNoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </StartChequeNoIn>
  <StartChequeNoLike>String</StartChequeNoLike>
  <StartChequeNoStartsWith>String</StartChequeNoStartsWith>
  <Status>0</Status>
  <StatusBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:short>0</d2p1:short>
  </StatusBetween>
  <StatusGreaterThan>0</StatusGreaterThan>
  <StatusGreaterThanOrEqualTo>0</StatusGreaterThanOrEqualTo>
  <StatusIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:short>0</d2p1:short>
  </StatusIn>
  <StatusLessThan>0</StatusLessThan>
  <StatusLessThanOrEqualTo>0</StatusLessThanOrEqualTo>
  <StatusNotEqualTo>0</StatusNotEqualTo>
  <TypeCheque>false</TypeCheque>
  <UseSelectedBank>false</UseSelectedBank>
</CR_BatchPaymentQuery>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfCR_BatchPayment7kRqkrSv 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_BatchPayment>
      <d2p1:_x003C_ActivationDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_ActivationDate_x003E_k__BackingField>
      <d2p1:_x003C_BatchNo_x003E_k__BackingField>String</d2p1:_x003C_BatchNo_x003E_k__BackingField>
      <d2p1:_x003C_CR_BatchPayID_x003E_k__BackingField>String</d2p1:_x003C_CR_BatchPayID_x003E_k__BackingField>
      <d2p1:_x003C_CreatedBy_HR_Staff_RecID_x003E_k__BackingField>String</d2p1:_x003C_CreatedBy_HR_Staff_RecID_x003E_k__BackingField>
      <d2p1:_x003C_CreationDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_CreationDate_x003E_k__BackingField>
      <d2p1:_x003C_GLBankID_x003E_k__BackingField>String</d2p1:_x003C_GLBankID_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_OneCheque_x003E_k__BackingField>false</d2p1:_x003C_OneCheque_x003E_k__BackingField>
      <d2p1:_x003C_StartChequeNo_x003E_k__BackingField>String</d2p1:_x003C_StartChequeNo_x003E_k__BackingField>
      <d2p1:_x003C_Status_x003E_k__BackingField>0</d2p1:_x003C_Status_x003E_k__BackingField>
      <d2p1:_x003C_TypeCheque_x003E_k__BackingField>false</d2p1:_x003C_TypeCheque_x003E_k__BackingField>
      <d2p1:_x003C_UseSelectedBank_x003E_k__BackingField>false</d2p1:_x003C_UseSelectedBank_x003E_k__BackingField>
    </d2p1:CR_BatchPayment>
  </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_BatchPayment7kRqkrSv>