Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 | |
Name | query | string | No | |
NameStartsWith | query | string | No | |
NameEndsWith | query | string | No | |
NameContains | query | string | No | |
NameLike | query | string | No | |
NameBetween | query | string[] | No | |
NameIn | query | string[] | No | |
Company | query | string | No | |
CompanyStartsWith | query | string | No | |
CompanyEndsWith | query | string | No | |
CompanyContains | query | string | No | |
CompanyLike | query | string | No | |
CompanyBetween | query | string[] | No | |
CompanyIn | query | string[] | No | |
Address1 | query | string | No | |
Address1StartsWith | query | string | No | |
Address1EndsWith | query | string | No | |
Address1Contains | query | string | No | |
Address1Like | query | string | No | |
Address1Between | query | string[] | No | |
Address1In | query | string[] | No | |
Address2 | query | string | No | |
Address2StartsWith | query | string | No | |
Address2EndsWith | query | string | No | |
Address2Contains | query | string | No | |
Address2Like | query | string | No | |
Address2Between | query | string[] | No | |
Address2In | query | string[] | No | |
Address3 | query | string | No | |
Address3StartsWith | query | string | No | |
Address3EndsWith | query | string | No | |
Address3Contains | query | string | No | |
Address3Like | query | string | No | |
Address3Between | query | string[] | No | |
Address3In | query | string[] | No | |
Address4 | query | string | No | |
Address4StartsWith | query | string | No | |
Address4EndsWith | query | string | No | |
Address4Contains | query | string | No | |
Address4Like | query | string | No | |
Address4Between | query | string[] | No | |
Address4In | query | string[] | No | |
PostCode | query | string | No | |
PostCodeStartsWith | query | string | No | |
PostCodeEndsWith | query | string | No | |
PostCodeContains | query | string | No | |
PostCodeLike | query | string | No | |
PostCodeBetween | query | string[] | No | |
PostCodeIn | query | string[] | No | |
Phone | query | string | No | |
PhoneStartsWith | query | string | No | |
PhoneEndsWith | query | string | No | |
PhoneContains | query | string | No | |
PhoneLike | query | string | No | |
PhoneBetween | query | string[] | No | |
PhoneIn | query | string[] | No | |
Fax | query | string | No | |
FaxStartsWith | query | string | No | |
FaxEndsWith | query | string | No | |
FaxContains | query | string | No | |
FaxLike | query | string | No | |
FaxBetween | query | string[] | No | |
FaxIn | query | string[] | No | |
ContactName | query | string | No | |
ContactNameStartsWith | query | string | No | |
ContactNameEndsWith | query | string | No | |
ContactNameContains | query | string | No | |
ContactNameLike | query | string | No | |
ContactNameBetween | query | string[] | No | |
ContactNameIn | 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 |
---|---|---|---|---|
InvoiceID | form | string | No | |
Name | form | string | No | |
Company | form | string | No | |
Address1 | form | string | No | |
Address2 | form | string | No | |
Address3 | form | string | No | |
Address4 | form | string | No | |
PostCode | form | string | No | |
Phone | form | string | No | |
Fax | form | string | No | |
ContactName | 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /json/reply/SO_CashSaleQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: application/json
Content-Type: application/json
Content-Length: length
{"InvoiceID":"String","InvoiceIDStartsWith":"String","InvoiceIDEndsWith":"String","InvoiceIDContains":"String","InvoiceIDLike":"String","InvoiceIDBetween":["String"],"InvoiceIDIn":["String"],"Name":"String","NameStartsWith":"String","NameEndsWith":"String","NameContains":"String","NameLike":"String","NameBetween":["String"],"NameIn":["String"],"Company":"String","CompanyStartsWith":"String","CompanyEndsWith":"String","CompanyContains":"String","CompanyLike":"String","CompanyBetween":["String"],"CompanyIn":["String"],"Address1":"String","Address1StartsWith":"String","Address1EndsWith":"String","Address1Contains":"String","Address1Like":"String","Address1Between":["String"],"Address1In":["String"],"Address2":"String","Address2StartsWith":"String","Address2EndsWith":"String","Address2Contains":"String","Address2Like":"String","Address2Between":["String"],"Address2In":["String"],"Address3":"String","Address3StartsWith":"String","Address3EndsWith":"String","Address3Contains":"String","Address3Like":"String","Address3Between":["String"],"Address3In":["String"],"Address4":"String","Address4StartsWith":"String","Address4EndsWith":"String","Address4Contains":"String","Address4Like":"String","Address4Between":["String"],"Address4In":["String"],"PostCode":"String","PostCodeStartsWith":"String","PostCodeEndsWith":"String","PostCodeContains":"String","PostCodeLike":"String","PostCodeBetween":["String"],"PostCodeIn":["String"],"Phone":"String","PhoneStartsWith":"String","PhoneEndsWith":"String","PhoneContains":"String","PhoneLike":"String","PhoneBetween":["String"],"PhoneIn":["String"],"Fax":"String","FaxStartsWith":"String","FaxEndsWith":"String","FaxContains":"String","FaxLike":"String","FaxBetween":["String"],"FaxIn":["String"],"ContactName":"String","ContactNameStartsWith":"String","ContactNameEndsWith":"String","ContactNameContains":"String","ContactNameLike":"String","ContactNameBetween":["String"],"ContactNameIn":["String"],"Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"Results":[{"InvoiceID":"String","Name":"String","Company":"String","Address1":"String","Address2":"String","Address3":"String","Address4":"String","PostCode":"String","Phone":"String","Fax":"String","ContactName":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}