JiwaAPI

<back to all web services

v_DebtorBalanceInformationQuery

Requires Authentication
v_DebtorBalanceInformationQuery Parameters:
NameParameterData TypeRequiredDescription
DebtorIDquerystringNo
DebtorIDStartsWithquerystringNo
DebtorIDEndsWithquerystringNo
DebtorIDContainsquerystringNo
DebtorIDLikequerystringNo
DebtorIDBetweenquerystring[]No
DebtorIDInquerystring[]No
DueDatequeryDateTime?No
DueDateGreaterThanOrEqualToqueryDateTime?No
DueDateGreaterThanqueryDateTime?No
DueDateLessThanqueryDateTime?No
DueDateLessThanOrEqualToqueryDateTime?No
DueDateNotEqualToqueryDateTime?No
DueDateBetweenqueryNullable<DateTime>[]No
DueDateInqueryNullable<DateTime>[]No
Balancequerydecimal?No
BalanceGreaterThanOrEqualToquerydecimal?No
BalanceGreaterThanquerydecimal?No
BalanceLessThanquerydecimal?No
BalanceLessThanOrEqualToquerydecimal?No
BalanceNotEqualToquerydecimal?No
BalanceBetweenqueryNullable<Decimal>[]No
BalanceInqueryNullable<Decimal>[]No
SourcequerystringNo
SourceStartsWithquerystringNo
SourceEndsWithquerystringNo
SourceContainsquerystringNo
SourceLikequerystringNo
SourceBetweenquerystring[]No
SourceInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
v_DebtorBalanceInformation Parameters:
NameParameterData TypeRequiredDescription
DebtorIDformstringNo
DueDateformDateTime?No
Balanceformdecimal?No
SourceformstringNo
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/v_DebtorBalanceInformationQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<v_DebtorBalanceInformationQuery 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>
  <Balance>0</Balance>
  <BalanceBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </BalanceBetween>
  <BalanceGreaterThan>0</BalanceGreaterThan>
  <BalanceGreaterThanOrEqualTo>0</BalanceGreaterThanOrEqualTo>
  <BalanceIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:decimal>0</d2p1:decimal>
  </BalanceIn>
  <BalanceLessThan>0</BalanceLessThan>
  <BalanceLessThanOrEqualTo>0</BalanceLessThanOrEqualTo>
  <BalanceNotEqualTo>0</BalanceNotEqualTo>
  <DebtorID>String</DebtorID>
  <DebtorIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DebtorIDBetween>
  <DebtorIDContains>String</DebtorIDContains>
  <DebtorIDEndsWith>String</DebtorIDEndsWith>
  <DebtorIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DebtorIDIn>
  <DebtorIDLike>String</DebtorIDLike>
  <DebtorIDStartsWith>String</DebtorIDStartsWith>
  <DueDate>0001-01-01T00:00:00</DueDate>
  <DueDateBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </DueDateBetween>
  <DueDateGreaterThan>0001-01-01T00:00:00</DueDateGreaterThan>
  <DueDateGreaterThanOrEqualTo>0001-01-01T00:00:00</DueDateGreaterThanOrEqualTo>
  <DueDateIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </DueDateIn>
  <DueDateLessThan>0001-01-01T00:00:00</DueDateLessThan>
  <DueDateLessThanOrEqualTo>0001-01-01T00:00:00</DueDateLessThanOrEqualTo>
  <DueDateNotEqualTo>0001-01-01T00:00:00</DueDateNotEqualTo>
  <Source>String</Source>
  <SourceBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SourceBetween>
  <SourceContains>String</SourceContains>
  <SourceEndsWith>String</SourceEndsWith>
  <SourceIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SourceIn>
  <SourceLike>String</SourceLike>
  <SourceStartsWith>String</SourceStartsWith>
</v_DebtorBalanceInformationQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfv_DebtorBalanceInformation7kRqkrSv 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:v_DebtorBalanceInformation>
      <d2p1:_x003C_Balance_x003E_k__BackingField>0</d2p1:_x003C_Balance_x003E_k__BackingField>
      <d2p1:_x003C_DebtorID_x003E_k__BackingField>String</d2p1:_x003C_DebtorID_x003E_k__BackingField>
      <d2p1:_x003C_DueDate_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_DueDate_x003E_k__BackingField>
      <d2p1:_x003C_Source_x003E_k__BackingField>String</d2p1:_x003C_Source_x003E_k__BackingField>
    </d2p1:v_DebtorBalanceInformation>
  </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>
</QueryResponseOfv_DebtorBalanceInformation7kRqkrSv>