JiwaAPI

BR_DirectCreditorPaymentAllocationsQuery

**BR_DirectCreditorPaymentAllocationsQuery** Parameters:
Name	Parameter	Data Type	Required
DirectCreditorPaymentAllocationID	query	string	No
DirectCreditorPaymentAllocationIDStartsWith	query	string	No
DirectCreditorPaymentAllocationIDEndsWith	query	string	No
DirectCreditorPaymentAllocationIDContains	query	string	No
DirectCreditorPaymentAllocationIDLike	query	string	No
DirectCreditorPaymentAllocationIDBetween	query	string[]	No
DirectCreditorPaymentAllocationIDIn	query	string[]	No
DirectCreditorPaymentID	query	string	No
DirectCreditorPaymentIDStartsWith	query	string	No
DirectCreditorPaymentIDEndsWith	query	string	No
DirectCreditorPaymentIDContains	query	string	No
DirectCreditorPaymentIDLike	query	string	No
DirectCreditorPaymentIDBetween	query	string[]	No
DirectCreditorPaymentIDIn	query	string[]	No
AmountAllocated	query	decimal?	No
AmountAllocatedGreaterThanOrEqualTo	query	decimal?	No
AmountAllocatedGreaterThan	query	decimal?	No
AmountAllocatedLessThan	query	decimal?	No
AmountAllocatedLessThanOrEqualTo	query	decimal?	No
AmountAllocatedNotEqualTo	query	decimal?	No
AmountAllocatedBetween	query	Nullable<Decimal>[]	No
AmountAllocatedIn	query	Nullable<Decimal>[]	No
TransID	query	string	No
TransIDStartsWith	query	string	No
TransIDEndsWith	query	string	No
TransIDContains	query	string	No
TransIDLike	query	string	No
TransIDBetween	query	string[]	No
TransIDIn	query	string[]	No
LastSavedByStaffID	query	string	No
LastSavedByStaffIDStartsWith	query	string	No
LastSavedByStaffIDEndsWith	query	string	No
LastSavedByStaffIDContains	query	string	No
LastSavedByStaffIDLike	query	string	No
LastSavedByStaffIDBetween	query	string[]	No
LastSavedByStaffIDIn	query	string[]	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
DiscountAmountAllocated	query	decimal?	No
DiscountAmountAllocatedGreaterThanOrEqualTo	query	decimal?	No
DiscountAmountAllocatedGreaterThan	query	decimal?	No
DiscountAmountAllocatedLessThan	query	decimal?	No
DiscountAmountAllocatedLessThanOrEqualTo	query	decimal?	No
DiscountAmountAllocatedNotEqualTo	query	decimal?	No
DiscountAmountAllocatedBetween	query	Nullable<Decimal>[]	No
DiscountAmountAllocatedIn	query	Nullable<Decimal>[]	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

**BR_DirectCreditorPaymentAllocations** Parameters:
Name	Parameter	Data Type	Required
DirectCreditorPaymentAllocationID	form	string	No
DirectCreditorPaymentID	form	string	No
AmountAllocated	form	decimal?	No
TransID	form	string	No
LastSavedByStaffID	form	string	No
LastSavedDateTime	form	DateTime?	No
DiscountAmountAllocated	form	decimal?	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/BR_DirectCreditorPaymentAllocationsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BR_DirectCreditorPaymentAllocationsQuery 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>
  <AmountAllocated>0</AmountAllocated>
  <AmountAllocatedBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </AmountAllocatedBetween>
  <AmountAllocatedGreaterThan>0</AmountAllocatedGreaterThan>
  <AmountAllocatedGreaterThanOrEqualTo>0</AmountAllocatedGreaterThanOrEqualTo>
  <AmountAllocatedIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </AmountAllocatedIn>
  <AmountAllocatedLessThan>0</AmountAllocatedLessThan>
  <AmountAllocatedLessThanOrEqualTo>0</AmountAllocatedLessThanOrEqualTo>
  <AmountAllocatedNotEqualTo>0</AmountAllocatedNotEqualTo>
  <DirectCreditorPaymentAllocationID>String</DirectCreditorPaymentAllocationID>
  <DirectCreditorPaymentAllocationIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DirectCreditorPaymentAllocationIDBetween>
  <DirectCreditorPaymentAllocationIDContains>String</DirectCreditorPaymentAllocationIDContains>
  <DirectCreditorPaymentAllocationIDEndsWith>String</DirectCreditorPaymentAllocationIDEndsWith>
  <DirectCreditorPaymentAllocationIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DirectCreditorPaymentAllocationIDIn>
  <DirectCreditorPaymentAllocationIDLike>String</DirectCreditorPaymentAllocationIDLike>
  <DirectCreditorPaymentAllocationIDStartsWith>String</DirectCreditorPaymentAllocationIDStartsWith>
  <DirectCreditorPaymentID>String</DirectCreditorPaymentID>
  <DirectCreditorPaymentIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DirectCreditorPaymentIDBetween>
  <DirectCreditorPaymentIDContains>String</DirectCreditorPaymentIDContains>
  <DirectCreditorPaymentIDEndsWith>String</DirectCreditorPaymentIDEndsWith>
  <DirectCreditorPaymentIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DirectCreditorPaymentIDIn>
  <DirectCreditorPaymentIDLike>String</DirectCreditorPaymentIDLike>
  <DirectCreditorPaymentIDStartsWith>String</DirectCreditorPaymentIDStartsWith>
  <DiscountAmountAllocated>0</DiscountAmountAllocated>
  <DiscountAmountAllocatedBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </DiscountAmountAllocatedBetween>
  <DiscountAmountAllocatedGreaterThan>0</DiscountAmountAllocatedGreaterThan>
  <DiscountAmountAllocatedGreaterThanOrEqualTo>0</DiscountAmountAllocatedGreaterThanOrEqualTo>
  <DiscountAmountAllocatedIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </DiscountAmountAllocatedIn>
  <DiscountAmountAllocatedLessThan>0</DiscountAmountAllocatedLessThan>
  <DiscountAmountAllocatedLessThanOrEqualTo>0</DiscountAmountAllocatedLessThanOrEqualTo>
  <DiscountAmountAllocatedNotEqualTo>0</DiscountAmountAllocatedNotEqualTo>
  <LastSavedByStaffID>String</LastSavedByStaffID>
  <LastSavedByStaffIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </LastSavedByStaffIDBetween>
  <LastSavedByStaffIDContains>String</LastSavedByStaffIDContains>
  <LastSavedByStaffIDEndsWith>String</LastSavedByStaffIDEndsWith>
  <LastSavedByStaffIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </LastSavedByStaffIDIn>
  <LastSavedByStaffIDLike>String</LastSavedByStaffIDLike>
  <LastSavedByStaffIDStartsWith>String</LastSavedByStaffIDStartsWith>
  <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>
  <TransID>String</TransID>
  <TransIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </TransIDBetween>
  <TransIDContains>String</TransIDContains>
  <TransIDEndsWith>String</TransIDEndsWith>
  <TransIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </TransIDIn>
  <TransIDLike>String</TransIDLike>
  <TransIDStartsWith>String</TransIDStartsWith>
</BR_DirectCreditorPaymentAllocationsQuery>

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

<QueryResponseOfBR_DirectCreditorPaymentAllocations7kRqkrSv 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:BR_DirectCreditorPaymentAllocations>
      <d2p1:_x003C_AmountAllocated_x003E_k__BackingField>0</d2p1:_x003C_AmountAllocated_x003E_k__BackingField>
      <d2p1:_x003C_DirectCreditorPaymentAllocationID_x003E_k__BackingField>String</d2p1:_x003C_DirectCreditorPaymentAllocationID_x003E_k__BackingField>
      <d2p1:_x003C_DirectCreditorPaymentID_x003E_k__BackingField>String</d2p1:_x003C_DirectCreditorPaymentID_x003E_k__BackingField>
      <d2p1:_x003C_DiscountAmountAllocated_x003E_k__BackingField>0</d2p1:_x003C_DiscountAmountAllocated_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedByStaffID_x003E_k__BackingField>String</d2p1:_x003C_LastSavedByStaffID_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_TransID_x003E_k__BackingField>String</d2p1:_x003C_TransID_x003E_k__BackingField>
    </d2p1:BR_DirectCreditorPaymentAllocations>
  </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>
</QueryResponseOfBR_DirectCreditorPaymentAllocations7kRqkrSv>