| 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 | |
| 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 | |
| SourceInvoiceHistoryID | query | string | No | |
| SourceInvoiceHistoryIDStartsWith | query | string | No | |
| SourceInvoiceHistoryIDEndsWith | query | string | No | |
| SourceInvoiceHistoryIDContains | query | string | No | |
| SourceInvoiceHistoryIDLike | query | string | No | |
| SourceInvoiceHistoryIDBetween | query | string[] | No | |
| SourceInvoiceHistoryIDIn | 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 | |
| CreditNoteInvoiceID | form | string | No | |
| SourceInvoiceHistoryID | 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_CreditNoteInvoiceLinkQuery 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"],"CreditNoteInvoiceID":"String","CreditNoteInvoiceIDStartsWith":"String","CreditNoteInvoiceIDEndsWith":"String","CreditNoteInvoiceIDContains":"String","CreditNoteInvoiceIDLike":"String","CreditNoteInvoiceIDBetween":["String"],"CreditNoteInvoiceIDIn":["String"],"SourceInvoiceHistoryID":"String","SourceInvoiceHistoryIDStartsWith":"String","SourceInvoiceHistoryIDEndsWith":"String","SourceInvoiceHistoryIDContains":"String","SourceInvoiceHistoryIDLike":"String","SourceInvoiceHistoryIDBetween":["String"],"SourceInvoiceHistoryIDIn":["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","CreditNoteInvoiceID":"String","SourceInvoiceHistoryID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}