Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 | |
BulkCreditNoteBatchID | query | string | No | |
BulkCreditNoteBatchIDStartsWith | query | string | No | |
BulkCreditNoteBatchIDEndsWith | query | string | No | |
BulkCreditNoteBatchIDContains | query | string | No | |
BulkCreditNoteBatchIDLike | query | string | No | |
BulkCreditNoteBatchIDBetween | query | string[] | No | |
BulkCreditNoteBatchIDIn | query | string[] | No | |
LineNumber | query | int? | No | |
LineNumberGreaterThanOrEqualTo | query | int? | No | |
LineNumberGreaterThan | query | int? | No | |
LineNumberLessThan | query | int? | No | |
LineNumberLessThanOrEqualTo | query | int? | No | |
LineNumberNotEqualTo | query | int? | No | |
LineNumberBetween | query | int[] | No | |
LineNumberIn | query | int[] | No | |
InvoiceHistoryID | query | string | No | |
InvoiceHistoryIDStartsWith | query | string | No | |
InvoiceHistoryIDEndsWith | query | string | No | |
InvoiceHistoryIDContains | query | string | No | |
InvoiceHistoryIDLike | query | string | No | |
InvoiceHistoryIDBetween | query | string[] | No | |
InvoiceHistoryIDIn | 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 | |
InvoiceNo | query | string | No | |
InvoiceNoStartsWith | query | string | No | |
InvoiceNoEndsWith | query | string | No | |
InvoiceNoContains | query | string | No | |
InvoiceNoLike | query | string | No | |
InvoiceNoBetween | query | string[] | No | |
InvoiceNoIn | query | string[] | No | |
DebtorID | query | string | No | |
DebtorIDStartsWith | query | string | No | |
DebtorIDEndsWith | query | string | No | |
DebtorIDContains | query | string | No | |
DebtorIDLike | query | string | No | |
DebtorIDBetween | query | string[] | No | |
DebtorIDIn | query | string[] | No | |
DebtorAccountNo | query | string | No | |
DebtorAccountNoStartsWith | query | string | No | |
DebtorAccountNoEndsWith | query | string | No | |
DebtorAccountNoContains | query | string | No | |
DebtorAccountNoLike | query | string | No | |
DebtorAccountNoBetween | query | string[] | No | |
DebtorAccountNoIn | query | string[] | No | |
DebtorName | query | string | No | |
DebtorNameStartsWith | query | string | No | |
DebtorNameEndsWith | query | string | No | |
DebtorNameContains | query | string | No | |
DebtorNameLike | query | string | No | |
DebtorNameBetween | query | string[] | No | |
DebtorNameIn | query | string[] | No | |
CreditNoteInvoiceID | query | string | No | |
CreditNoteInvoiceIDStartsWith | query | string | No | |
CreditNoteInvoiceIDEndsWith | query | string | No | |
CreditNoteInvoiceIDContains | query | string | No | |
CreditNoteInvoiceIDLike | query | string | No | |
CreditNoteInvoiceIDBetween | query | string[] | No | |
CreditNoteInvoiceIDIn | query | string[] | No | |
CreditNoteInvoiceNo | query | string | No | |
CreditNoteInvoiceNoStartsWith | query | string | No | |
CreditNoteInvoiceNoEndsWith | query | string | No | |
CreditNoteInvoiceNoContains | query | string | No | |
CreditNoteInvoiceNoLike | query | string | No | |
CreditNoteInvoiceNoBetween | query | string[] | No | |
CreditNoteInvoiceNoIn | query | string[] | No | |
CreditFlag | query | bool? | No | |
CreditFailed | query | bool? | No | |
FailReason | query | string | No | |
FailReasonStartsWith | query | string | No | |
FailReasonEndsWith | query | string | No | |
FailReasonContains | query | string | No | |
FailReasonLike | query | string | No | |
FailReasonBetween | query | string[] | No | |
FailReasonIn | query | string[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RecID | form | string | No | |
BulkCreditNoteBatchID | form | string | No | |
LineNumber | form | int | No | |
InvoiceHistoryID | form | string | No | |
InvoiceID | form | string | No | |
InvoiceNo | form | string | No | |
DebtorID | form | string | No | |
DebtorAccountNo | form | string | No | |
DebtorName | form | string | No | |
CreditNoteInvoiceID | form | string | No | |
CreditNoteInvoiceNo | form | string | No | |
CreditFlag | form | bool? | No | |
CreditFailed | form | bool? | No | |
FailReason | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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
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>