JiwaAPI

<back to all web services

SO_BulkCreditNoteBatchLinesQuery

Requires Authentication
SO_BulkCreditNoteBatchLinesQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
BulkCreditNoteBatchIDquerystringNo
BulkCreditNoteBatchIDStartsWithquerystringNo
BulkCreditNoteBatchIDEndsWithquerystringNo
BulkCreditNoteBatchIDContainsquerystringNo
BulkCreditNoteBatchIDLikequerystringNo
BulkCreditNoteBatchIDBetweenquerystring[]No
BulkCreditNoteBatchIDInquerystring[]No
LineNumberqueryint?No
LineNumberGreaterThanOrEqualToqueryint?No
LineNumberGreaterThanqueryint?No
LineNumberLessThanqueryint?No
LineNumberLessThanOrEqualToqueryint?No
LineNumberNotEqualToqueryint?No
LineNumberBetweenqueryint[]No
LineNumberInqueryint[]No
InvoiceHistoryIDquerystringNo
InvoiceHistoryIDStartsWithquerystringNo
InvoiceHistoryIDEndsWithquerystringNo
InvoiceHistoryIDContainsquerystringNo
InvoiceHistoryIDLikequerystringNo
InvoiceHistoryIDBetweenquerystring[]No
InvoiceHistoryIDInquerystring[]No
InvoiceIDquerystringNo
InvoiceIDStartsWithquerystringNo
InvoiceIDEndsWithquerystringNo
InvoiceIDContainsquerystringNo
InvoiceIDLikequerystringNo
InvoiceIDBetweenquerystring[]No
InvoiceIDInquerystring[]No
InvoiceNoquerystringNo
InvoiceNoStartsWithquerystringNo
InvoiceNoEndsWithquerystringNo
InvoiceNoContainsquerystringNo
InvoiceNoLikequerystringNo
InvoiceNoBetweenquerystring[]No
InvoiceNoInquerystring[]No
DebtorIDquerystringNo
DebtorIDStartsWithquerystringNo
DebtorIDEndsWithquerystringNo
DebtorIDContainsquerystringNo
DebtorIDLikequerystringNo
DebtorIDBetweenquerystring[]No
DebtorIDInquerystring[]No
DebtorAccountNoquerystringNo
DebtorAccountNoStartsWithquerystringNo
DebtorAccountNoEndsWithquerystringNo
DebtorAccountNoContainsquerystringNo
DebtorAccountNoLikequerystringNo
DebtorAccountNoBetweenquerystring[]No
DebtorAccountNoInquerystring[]No
DebtorNamequerystringNo
DebtorNameStartsWithquerystringNo
DebtorNameEndsWithquerystringNo
DebtorNameContainsquerystringNo
DebtorNameLikequerystringNo
DebtorNameBetweenquerystring[]No
DebtorNameInquerystring[]No
CreditNoteInvoiceIDquerystringNo
CreditNoteInvoiceIDStartsWithquerystringNo
CreditNoteInvoiceIDEndsWithquerystringNo
CreditNoteInvoiceIDContainsquerystringNo
CreditNoteInvoiceIDLikequerystringNo
CreditNoteInvoiceIDBetweenquerystring[]No
CreditNoteInvoiceIDInquerystring[]No
CreditNoteInvoiceNoquerystringNo
CreditNoteInvoiceNoStartsWithquerystringNo
CreditNoteInvoiceNoEndsWithquerystringNo
CreditNoteInvoiceNoContainsquerystringNo
CreditNoteInvoiceNoLikequerystringNo
CreditNoteInvoiceNoBetweenquerystring[]No
CreditNoteInvoiceNoInquerystring[]No
CreditFlagquerybool?No
CreditFailedquerybool?No
FailReasonquerystringNo
FailReasonStartsWithquerystringNo
FailReasonEndsWithquerystringNo
FailReasonContainsquerystringNo
FailReasonLikequerystringNo
FailReasonBetweenquerystring[]No
FailReasonInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SO_BulkCreditNoteBatchLines Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
BulkCreditNoteBatchIDformstringNo
LineNumberformintNo
InvoiceHistoryIDformstringNo
InvoiceIDformstringNo
InvoiceNoformstringNo
DebtorIDformstringNo
DebtorAccountNoformstringNo
DebtorNameformstringNo
CreditNoteInvoiceIDformstringNo
CreditNoteInvoiceNoformstringNo
CreditFlagformbool?No
CreditFailedformbool?No
FailReasonformstringNo
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/SO_BulkCreditNoteBatchLinesQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SO_BulkCreditNoteBatchLinesQuery 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>
  <BulkCreditNoteBatchID>String</BulkCreditNoteBatchID>
  <BulkCreditNoteBatchIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </BulkCreditNoteBatchIDBetween>
  <BulkCreditNoteBatchIDContains>String</BulkCreditNoteBatchIDContains>
  <BulkCreditNoteBatchIDEndsWith>String</BulkCreditNoteBatchIDEndsWith>
  <BulkCreditNoteBatchIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </BulkCreditNoteBatchIDIn>
  <BulkCreditNoteBatchIDLike>String</BulkCreditNoteBatchIDLike>
  <BulkCreditNoteBatchIDStartsWith>String</BulkCreditNoteBatchIDStartsWith>
  <CreditFailed>false</CreditFailed>
  <CreditFlag>false</CreditFlag>
  <CreditNoteInvoiceID>String</CreditNoteInvoiceID>
  <CreditNoteInvoiceIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CreditNoteInvoiceIDBetween>
  <CreditNoteInvoiceIDContains>String</CreditNoteInvoiceIDContains>
  <CreditNoteInvoiceIDEndsWith>String</CreditNoteInvoiceIDEndsWith>
  <CreditNoteInvoiceIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CreditNoteInvoiceIDIn>
  <CreditNoteInvoiceIDLike>String</CreditNoteInvoiceIDLike>
  <CreditNoteInvoiceIDStartsWith>String</CreditNoteInvoiceIDStartsWith>
  <CreditNoteInvoiceNo>String</CreditNoteInvoiceNo>
  <CreditNoteInvoiceNoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CreditNoteInvoiceNoBetween>
  <CreditNoteInvoiceNoContains>String</CreditNoteInvoiceNoContains>
  <CreditNoteInvoiceNoEndsWith>String</CreditNoteInvoiceNoEndsWith>
  <CreditNoteInvoiceNoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CreditNoteInvoiceNoIn>
  <CreditNoteInvoiceNoLike>String</CreditNoteInvoiceNoLike>
  <CreditNoteInvoiceNoStartsWith>String</CreditNoteInvoiceNoStartsWith>
  <DebtorAccountNo>String</DebtorAccountNo>
  <DebtorAccountNoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DebtorAccountNoBetween>
  <DebtorAccountNoContains>String</DebtorAccountNoContains>
  <DebtorAccountNoEndsWith>String</DebtorAccountNoEndsWith>
  <DebtorAccountNoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DebtorAccountNoIn>
  <DebtorAccountNoLike>String</DebtorAccountNoLike>
  <DebtorAccountNoStartsWith>String</DebtorAccountNoStartsWith>
  <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>
  <DebtorName>String</DebtorName>
  <DebtorNameBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DebtorNameBetween>
  <DebtorNameContains>String</DebtorNameContains>
  <DebtorNameEndsWith>String</DebtorNameEndsWith>
  <DebtorNameIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DebtorNameIn>
  <DebtorNameLike>String</DebtorNameLike>
  <DebtorNameStartsWith>String</DebtorNameStartsWith>
  <FailReason>String</FailReason>
  <FailReasonBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </FailReasonBetween>
  <FailReasonContains>String</FailReasonContains>
  <FailReasonEndsWith>String</FailReasonEndsWith>
  <FailReasonIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </FailReasonIn>
  <FailReasonLike>String</FailReasonLike>
  <FailReasonStartsWith>String</FailReasonStartsWith>
  <InvoiceHistoryID>String</InvoiceHistoryID>
  <InvoiceHistoryIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </InvoiceHistoryIDBetween>
  <InvoiceHistoryIDContains>String</InvoiceHistoryIDContains>
  <InvoiceHistoryIDEndsWith>String</InvoiceHistoryIDEndsWith>
  <InvoiceHistoryIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </InvoiceHistoryIDIn>
  <InvoiceHistoryIDLike>String</InvoiceHistoryIDLike>
  <InvoiceHistoryIDStartsWith>String</InvoiceHistoryIDStartsWith>
  <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>
  <InvoiceNo>String</InvoiceNo>
  <InvoiceNoBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </InvoiceNoBetween>
  <InvoiceNoContains>String</InvoiceNoContains>
  <InvoiceNoEndsWith>String</InvoiceNoEndsWith>
  <InvoiceNoIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </InvoiceNoIn>
  <InvoiceNoLike>String</InvoiceNoLike>
  <InvoiceNoStartsWith>String</InvoiceNoStartsWith>
  <LineNumber>0</LineNumber>
  <LineNumberBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </LineNumberBetween>
  <LineNumberGreaterThan>0</LineNumberGreaterThan>
  <LineNumberGreaterThanOrEqualTo>0</LineNumberGreaterThanOrEqualTo>
  <LineNumberIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </LineNumberIn>
  <LineNumberLessThan>0</LineNumberLessThan>
  <LineNumberLessThanOrEqualTo>0</LineNumberLessThanOrEqualTo>
  <LineNumberNotEqualTo>0</LineNumberNotEqualTo>
  <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>
</SO_BulkCreditNoteBatchLinesQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfSO_BulkCreditNoteBatchLines7kRqkrSv 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:SO_BulkCreditNoteBatchLines>
      <d2p1:_x003C_BulkCreditNoteBatchID_x003E_k__BackingField>String</d2p1:_x003C_BulkCreditNoteBatchID_x003E_k__BackingField>
      <d2p1:_x003C_CreditFailed_x003E_k__BackingField>false</d2p1:_x003C_CreditFailed_x003E_k__BackingField>
      <d2p1:_x003C_CreditFlag_x003E_k__BackingField>false</d2p1:_x003C_CreditFlag_x003E_k__BackingField>
      <d2p1:_x003C_CreditNoteInvoiceID_x003E_k__BackingField>String</d2p1:_x003C_CreditNoteInvoiceID_x003E_k__BackingField>
      <d2p1:_x003C_CreditNoteInvoiceNo_x003E_k__BackingField>String</d2p1:_x003C_CreditNoteInvoiceNo_x003E_k__BackingField>
      <d2p1:_x003C_DebtorAccountNo_x003E_k__BackingField>String</d2p1:_x003C_DebtorAccountNo_x003E_k__BackingField>
      <d2p1:_x003C_DebtorID_x003E_k__BackingField>String</d2p1:_x003C_DebtorID_x003E_k__BackingField>
      <d2p1:_x003C_DebtorName_x003E_k__BackingField>String</d2p1:_x003C_DebtorName_x003E_k__BackingField>
      <d2p1:_x003C_FailReason_x003E_k__BackingField>String</d2p1:_x003C_FailReason_x003E_k__BackingField>
      <d2p1:_x003C_InvoiceHistoryID_x003E_k__BackingField>String</d2p1:_x003C_InvoiceHistoryID_x003E_k__BackingField>
      <d2p1:_x003C_InvoiceID_x003E_k__BackingField>String</d2p1:_x003C_InvoiceID_x003E_k__BackingField>
      <d2p1:_x003C_InvoiceNo_x003E_k__BackingField>String</d2p1:_x003C_InvoiceNo_x003E_k__BackingField>
      <d2p1:_x003C_LineNumber_x003E_k__BackingField>0</d2p1:_x003C_LineNumber_x003E_k__BackingField>
      <d2p1:_x003C_RecID_x003E_k__BackingField>String</d2p1:_x003C_RecID_x003E_k__BackingField>
    </d2p1:SO_BulkCreditNoteBatchLines>
  </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>
</QueryResponseOfSO_BulkCreditNoteBatchLines7kRqkrSv>