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 .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /csv/reply/SO_BulkCreditNoteBatchLinesQuery 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"],"BulkCreditNoteBatchID":"String","BulkCreditNoteBatchIDStartsWith":"String","BulkCreditNoteBatchIDEndsWith":"String","BulkCreditNoteBatchIDContains":"String","BulkCreditNoteBatchIDLike":"String","BulkCreditNoteBatchIDBetween":["String"],"BulkCreditNoteBatchIDIn":["String"],"LineNumber":0,"LineNumberGreaterThanOrEqualTo":0,"LineNumberGreaterThan":0,"LineNumberLessThan":0,"LineNumberLessThanOrEqualTo":0,"LineNumberNotEqualTo":0,"LineNumberBetween":[0],"LineNumberIn":[0],"InvoiceHistoryID":"String","InvoiceHistoryIDStartsWith":"String","InvoiceHistoryIDEndsWith":"String","InvoiceHistoryIDContains":"String","InvoiceHistoryIDLike":"String","InvoiceHistoryIDBetween":["String"],"InvoiceHistoryIDIn":["String"],"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"],"CreditNoteInvoiceID":"String","CreditNoteInvoiceIDStartsWith":"String","CreditNoteInvoiceIDEndsWith":"String","CreditNoteInvoiceIDContains":"String","CreditNoteInvoiceIDLike":"String","CreditNoteInvoiceIDBetween":["String"],"CreditNoteInvoiceIDIn":["String"],"CreditNoteInvoiceNo":"String","CreditNoteInvoiceNoStartsWith":"String","CreditNoteInvoiceNoEndsWith":"String","CreditNoteInvoiceNoContains":"String","CreditNoteInvoiceNoLike":"String","CreditNoteInvoiceNoBetween":["String"],"CreditNoteInvoiceNoIn":["String"],"CreditFlag":false,"CreditFailed":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","BulkCreditNoteBatchID":"String","InvoiceHistoryID":"String","InvoiceID":"String","InvoiceNo":"String","DebtorID":"String","DebtorAccountNo":"String","DebtorName":"String","CreditNoteInvoiceID":"String","CreditNoteInvoiceNo":"String","CreditFlag":false,"CreditFailed":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"}}}