JiwaAPI

JB_PaymentDetailsQuery

**JB_PaymentDetailsQuery** Parameters:
Name	Parameter	Data Type	Required
RecID	query	string	No
RecIDStartsWith	query	string	No
RecIDEndsWith	query	string	No
RecIDContains	query	string	No
RecIDLike	query	string	No
RecIDBetween	query	string[]	No
RecIDIn	query	string[]	No
JobNo	query	string	No
JobNoStartsWith	query	string	No
JobNoEndsWith	query	string	No
JobNoContains	query	string	No
JobNoLike	query	string	No
JobNoBetween	query	string[]	No
JobNoIn	query	string[]	No
InvoiceID	query	string	No
InvoiceIDStartsWith	query	string	No
InvoiceIDEndsWith	query	string	No
InvoiceIDContains	query	string	No
InvoiceIDLike	query	string	No
InvoiceIDBetween	query	string[]	No
InvoiceIDIn	query	string[]	No
CostEntryLineID	query	string	No
CostEntryLineIDStartsWith	query	string	No
CostEntryLineIDEndsWith	query	string	No
CostEntryLineIDContains	query	string	No
CostEntryLineIDLike	query	string	No
CostEntryLineIDBetween	query	string[]	No
CostEntryLineIDIn	query	string[]	No
InvoiceType	query	short?	No
InvoiceTypeGreaterThanOrEqualTo	query	short?	No
InvoiceTypeGreaterThan	query	short?	No
InvoiceTypeLessThan	query	short?	No
InvoiceTypeLessThanOrEqualTo	query	short?	No
InvoiceTypeNotEqualTo	query	short?	No
InvoiceTypeBetween	query	short[]	No
InvoiceTypeIn	query	short[]	No
BillAmount	query	decimal?	No
BillAmountGreaterThanOrEqualTo	query	decimal?	No
BillAmountGreaterThan	query	decimal?	No
BillAmountLessThan	query	decimal?	No
BillAmountLessThanOrEqualTo	query	decimal?	No
BillAmountNotEqualTo	query	decimal?	No
BillAmountBetween	query	decimal[]	No
BillAmountIn	query	decimal[]	No
CostAmount	query	decimal?	No
CostAmountGreaterThanOrEqualTo	query	decimal?	No
CostAmountGreaterThan	query	decimal?	No
CostAmountLessThan	query	decimal?	No
CostAmountLessThanOrEqualTo	query	decimal?	No
CostAmountNotEqualTo	query	decimal?	No
CostAmountBetween	query	decimal[]	No
CostAmountIn	query	decimal[]	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	short[]	No
StatusIn	query	short[]	No
WriteBill	query	decimal?	No
WriteBillGreaterThanOrEqualTo	query	decimal?	No
WriteBillGreaterThan	query	decimal?	No
WriteBillLessThan	query	decimal?	No
WriteBillLessThanOrEqualTo	query	decimal?	No
WriteBillNotEqualTo	query	decimal?	No
WriteBillBetween	query	decimal[]	No
WriteBillIn	query	decimal[]	No
WriteCost	query	decimal?	No
WriteCostGreaterThanOrEqualTo	query	decimal?	No
WriteCostGreaterThan	query	decimal?	No
WriteCostLessThan	query	decimal?	No
WriteCostLessThanOrEqualTo	query	decimal?	No
WriteCostNotEqualTo	query	decimal?	No
WriteCostBetween	query	decimal[]	No
WriteCostIn	query	decimal[]	No
LinkLineID	query	string	No
LinkLineIDStartsWith	query	string	No
LinkLineIDEndsWith	query	string	No
LinkLineIDContains	query	string	No
LinkLineIDLike	query	string	No
LinkLineIDBetween	query	string[]	No
LinkLineIDIn	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

**JB_PaymentDetails** Parameters:
Name	Parameter	Data Type	Required
RecID	form	string	No
JobNo	form	string	No
InvoiceID	form	string	No
CostEntryLineID	form	string	No
InvoiceType	form	short	No
BillAmount	form	decimal	No
CostAmount	form	decimal	No
Status	form	short	No
WriteBill	form	decimal	No
WriteCost	form	decimal	No
LinkLineID	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/JB_PaymentDetailsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<JB_PaymentDetailsQuery 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>
  <BillAmount>0</BillAmount>
  <BillAmountBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>0</d2p1:decimal>
  </BillAmountBetween>
  <BillAmountGreaterThan>0</BillAmountGreaterThan>
  <BillAmountGreaterThanOrEqualTo>0</BillAmountGreaterThanOrEqualTo>
  <BillAmountIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>0</d2p1:decimal>
  </BillAmountIn>
  <BillAmountLessThan>0</BillAmountLessThan>
  <BillAmountLessThanOrEqualTo>0</BillAmountLessThanOrEqualTo>
  <BillAmountNotEqualTo>0</BillAmountNotEqualTo>
  <CostAmount>0</CostAmount>
  <CostAmountBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>0</d2p1:decimal>
  </CostAmountBetween>
  <CostAmountGreaterThan>0</CostAmountGreaterThan>
  <CostAmountGreaterThanOrEqualTo>0</CostAmountGreaterThanOrEqualTo>
  <CostAmountIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>0</d2p1:decimal>
  </CostAmountIn>
  <CostAmountLessThan>0</CostAmountLessThan>
  <CostAmountLessThanOrEqualTo>0</CostAmountLessThanOrEqualTo>
  <CostAmountNotEqualTo>0</CostAmountNotEqualTo>
  <CostEntryLineID>String</CostEntryLineID>
  <CostEntryLineIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CostEntryLineIDBetween>
  <CostEntryLineIDContains>String</CostEntryLineIDContains>
  <CostEntryLineIDEndsWith>String</CostEntryLineIDEndsWith>
  <CostEntryLineIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CostEntryLineIDIn>
  <CostEntryLineIDLike>String</CostEntryLineIDLike>
  <CostEntryLineIDStartsWith>String</CostEntryLineIDStartsWith>
  <InvoiceID>String</InvoiceID>
  <InvoiceIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </InvoiceIDBetween>
  <InvoiceIDContains>String</InvoiceIDContains>
  <InvoiceIDEndsWith>String</InvoiceIDEndsWith>
  <InvoiceIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </InvoiceIDIn>
  <InvoiceIDLike>String</InvoiceIDLike>
  <InvoiceIDStartsWith>String</InvoiceIDStartsWith>
  <InvoiceType>0</InvoiceType>
  <InvoiceTypeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:short>0</d2p1:short>
  </InvoiceTypeBetween>
  <InvoiceTypeGreaterThan>0</InvoiceTypeGreaterThan>
  <InvoiceTypeGreaterThanOrEqualTo>0</InvoiceTypeGreaterThanOrEqualTo>
  <InvoiceTypeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:short>0</d2p1:short>
  </InvoiceTypeIn>
  <InvoiceTypeLessThan>0</InvoiceTypeLessThan>
  <InvoiceTypeLessThanOrEqualTo>0</InvoiceTypeLessThanOrEqualTo>
  <InvoiceTypeNotEqualTo>0</InvoiceTypeNotEqualTo>
  <JobNo>String</JobNo>
  <JobNoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </JobNoBetween>
  <JobNoContains>String</JobNoContains>
  <JobNoEndsWith>String</JobNoEndsWith>
  <JobNoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </JobNoIn>
  <JobNoLike>String</JobNoLike>
  <JobNoStartsWith>String</JobNoStartsWith>
  <LinkLineID>String</LinkLineID>
  <LinkLineIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </LinkLineIDBetween>
  <LinkLineIDContains>String</LinkLineIDContains>
  <LinkLineIDEndsWith>String</LinkLineIDEndsWith>
  <LinkLineIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </LinkLineIDIn>
  <LinkLineIDLike>String</LinkLineIDLike>
  <LinkLineIDStartsWith>String</LinkLineIDStartsWith>
  <RecID>String</RecID>
  <RecIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RecIDBetween>
  <RecIDContains>String</RecIDContains>
  <RecIDEndsWith>String</RecIDEndsWith>
  <RecIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RecIDIn>
  <RecIDLike>String</RecIDLike>
  <RecIDStartsWith>String</RecIDStartsWith>
  <Status>0</Status>
  <StatusBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:short>0</d2p1:short>
  </StatusBetween>
  <StatusGreaterThan>0</StatusGreaterThan>
  <StatusGreaterThanOrEqualTo>0</StatusGreaterThanOrEqualTo>
  <StatusIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:short>0</d2p1:short>
  </StatusIn>
  <StatusLessThan>0</StatusLessThan>
  <StatusLessThanOrEqualTo>0</StatusLessThanOrEqualTo>
  <StatusNotEqualTo>0</StatusNotEqualTo>
  <WriteBill>0</WriteBill>
  <WriteBillBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>0</d2p1:decimal>
  </WriteBillBetween>
  <WriteBillGreaterThan>0</WriteBillGreaterThan>
  <WriteBillGreaterThanOrEqualTo>0</WriteBillGreaterThanOrEqualTo>
  <WriteBillIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>0</d2p1:decimal>
  </WriteBillIn>
  <WriteBillLessThan>0</WriteBillLessThan>
  <WriteBillLessThanOrEqualTo>0</WriteBillLessThanOrEqualTo>
  <WriteBillNotEqualTo>0</WriteBillNotEqualTo>
  <WriteCost>0</WriteCost>
  <WriteCostBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>0</d2p1:decimal>
  </WriteCostBetween>
  <WriteCostGreaterThan>0</WriteCostGreaterThan>
  <WriteCostGreaterThanOrEqualTo>0</WriteCostGreaterThanOrEqualTo>
  <WriteCostIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>0</d2p1:decimal>
  </WriteCostIn>
  <WriteCostLessThan>0</WriteCostLessThan>
  <WriteCostLessThanOrEqualTo>0</WriteCostLessThanOrEqualTo>
  <WriteCostNotEqualTo>0</WriteCostNotEqualTo>
</JB_PaymentDetailsQuery>

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

<QueryResponseOfJB_PaymentDetails7kRqkrSv 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:JB_PaymentDetails>
      <d2p1:_x003C_BillAmount_x003E_k__BackingField>0</d2p1:_x003C_BillAmount_x003E_k__BackingField>
      <d2p1:_x003C_CostAmount_x003E_k__BackingField>0</d2p1:_x003C_CostAmount_x003E_k__BackingField>
      <d2p1:_x003C_CostEntryLineID_x003E_k__BackingField>String</d2p1:_x003C_CostEntryLineID_x003E_k__BackingField>
      <d2p1:_x003C_InvoiceID_x003E_k__BackingField>String</d2p1:_x003C_InvoiceID_x003E_k__BackingField>
      <d2p1:_x003C_InvoiceType_x003E_k__BackingField>0</d2p1:_x003C_InvoiceType_x003E_k__BackingField>
      <d2p1:_x003C_JobNo_x003E_k__BackingField>String</d2p1:_x003C_JobNo_x003E_k__BackingField>
      <d2p1:_x003C_LinkLineID_x003E_k__BackingField>String</d2p1:_x003C_LinkLineID_x003E_k__BackingField>
      <d2p1:_x003C_RecID_x003E_k__BackingField>String</d2p1:_x003C_RecID_x003E_k__BackingField>
      <d2p1:_x003C_Status_x003E_k__BackingField>0</d2p1:_x003C_Status_x003E_k__BackingField>
      <d2p1:_x003C_WriteBill_x003E_k__BackingField>0</d2p1:_x003C_WriteBill_x003E_k__BackingField>
      <d2p1:_x003C_WriteCost_x003E_k__BackingField>0</d2p1:_x003C_WriteCost_x003E_k__BackingField>
    </d2p1:JB_PaymentDetails>
  </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>
</QueryResponseOfJB_PaymentDetails7kRqkrSv>