JiwaAPI

<back to all web services

SO_ForwardOrderProcessBatchLinesQuery

Requires Authentication
SO_ForwardOrderProcessBatchLinesQuery Parameters:
NameParameterData TypeRequiredDescription
RecIDquerystringNo
RecIDStartsWithquerystringNo
RecIDEndsWithquerystringNo
RecIDContainsquerystringNo
RecIDLikequerystringNo
RecIDBetweenquerystring[]No
RecIDInquerystring[]No
ForwardOrderProcessBatchIDquerystringNo
ForwardOrderProcessBatchIDStartsWithquerystringNo
ForwardOrderProcessBatchIDEndsWithquerystringNo
ForwardOrderProcessBatchIDContainsquerystringNo
ForwardOrderProcessBatchIDLikequerystringNo
ForwardOrderProcessBatchIDBetweenquerystring[]No
ForwardOrderProcessBatchIDInquerystring[]No
LineNumberqueryint?No
LineNumberGreaterThanOrEqualToqueryint?No
LineNumberGreaterThanqueryint?No
LineNumberLessThanqueryint?No
LineNumberLessThanOrEqualToqueryint?No
LineNumberNotEqualToqueryint?No
LineNumberBetweenqueryint[]No
LineNumberInqueryint[]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
ConvertFlagquerybool?No
ConvertFailedquerybool?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_ForwardOrderProcessBatchLines Parameters:
NameParameterData TypeRequiredDescription
RecIDformstringNo
ForwardOrderProcessBatchIDformstringNo
LineNumberformintNo
InvoiceIDformstringNo
InvoiceNoformstringNo
DebtorIDformstringNo
DebtorAccountNoformstringNo
DebtorNameformstringNo
ConvertFlagformbool?No
ConvertFailedformbool?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 .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /csv/reply/SO_ForwardOrderProcessBatchLinesQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"RecID":"String","RecIDStartsWith":"String","RecIDEndsWith":"String","RecIDContains":"String","RecIDLike":"String","RecIDBetween":["String"],"RecIDIn":["String"],"ForwardOrderProcessBatchID":"String","ForwardOrderProcessBatchIDStartsWith":"String","ForwardOrderProcessBatchIDEndsWith":"String","ForwardOrderProcessBatchIDContains":"String","ForwardOrderProcessBatchIDLike":"String","ForwardOrderProcessBatchIDBetween":["String"],"ForwardOrderProcessBatchIDIn":["String"],"LineNumber":0,"LineNumberGreaterThanOrEqualTo":0,"LineNumberGreaterThan":0,"LineNumberLessThan":0,"LineNumberLessThanOrEqualTo":0,"LineNumberNotEqualTo":0,"LineNumberBetween":[0],"LineNumberIn":[0],"InvoiceID":"String","InvoiceIDStartsWith":"String","InvoiceIDEndsWith":"String","InvoiceIDContains":"String","InvoiceIDLike":"String","InvoiceIDBetween":["String"],"InvoiceIDIn":["String"],"InvoiceNo":"String","InvoiceNoStartsWith":"String","InvoiceNoEndsWith":"String","InvoiceNoContains":"String","InvoiceNoLike":"String","InvoiceNoBetween":["String"],"InvoiceNoIn":["String"],"DebtorID":"String","DebtorIDStartsWith":"String","DebtorIDEndsWith":"String","DebtorIDContains":"String","DebtorIDLike":"String","DebtorIDBetween":["String"],"DebtorIDIn":["String"],"DebtorAccountNo":"String","DebtorAccountNoStartsWith":"String","DebtorAccountNoEndsWith":"String","DebtorAccountNoContains":"String","DebtorAccountNoLike":"String","DebtorAccountNoBetween":["String"],"DebtorAccountNoIn":["String"],"DebtorName":"String","DebtorNameStartsWith":"String","DebtorNameEndsWith":"String","DebtorNameContains":"String","DebtorNameLike":"String","DebtorNameBetween":["String"],"DebtorNameIn":["String"],"ConvertFlag":false,"ConvertFailed":false,"FailReason":"String","FailReasonStartsWith":"String","FailReasonEndsWith":"String","FailReasonContains":"String","FailReasonLike":"String","FailReasonBetween":["String"],"FailReasonIn":["String"],"Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Results":[{"RecID":"String","ForwardOrderProcessBatchID":"String","InvoiceID":"String","InvoiceNo":"String","DebtorID":"String","DebtorAccountNo":"String","DebtorName":"String","ConvertFlag":false,"ConvertFailed":false,"FailReason":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}