JiwaAPI

<back to all web services

SY_NumbersQuery

Requires Authentication
SY_NumbersQuery Parameters:
NameParameterData TypeRequiredDescription
InvoiceNumberIDquerystringNo
InvoiceNumberIDStartsWithquerystringNo
InvoiceNumberIDEndsWithquerystringNo
InvoiceNumberIDContainsquerystringNo
InvoiceNumberIDLikequerystringNo
InvoiceNumberIDBetweenquerystring[]No
InvoiceNumberIDInquerystring[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
LastInvoiceNoquerystringNo
LastInvoiceNoStartsWithquerystringNo
LastInvoiceNoEndsWithquerystringNo
LastInvoiceNoContainsquerystringNo
LastInvoiceNoLikequerystringNo
LastInvoiceNoBetweenquerystring[]No
LastInvoiceNoInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SY_Numbers Parameters:
NameParameterData TypeRequiredDescription
InvoiceNumberIDformstringNo
DescriptionformstringNo
LastInvoiceNoformstringNo
LastSavedDateTimeformDateTimeNo
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /json/reply/SY_NumbersQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"InvoiceNumberID":"String","InvoiceNumberIDStartsWith":"String","InvoiceNumberIDEndsWith":"String","InvoiceNumberIDContains":"String","InvoiceNumberIDLike":"String","InvoiceNumberIDBetween":["String"],"InvoiceNumberIDIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"LastInvoiceNo":"String","LastInvoiceNoStartsWith":"String","LastInvoiceNoEndsWith":"String","LastInvoiceNoContains":"String","LastInvoiceNoLike":"String","LastInvoiceNoBetween":["String"],"LastInvoiceNoIn":["String"],"LastSavedDateTime":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeGreaterThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThan":"0001-01-01T00:00:00.0000000","LastSavedDateTimeLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeNotEqualTo":"0001-01-01T00:00:00.0000000","LastSavedDateTimeBetween":["0001-01-01T00:00:00.0000000"],"LastSavedDateTimeIn":["0001-01-01T00:00:00.0000000"],"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":[{"InvoiceNumberID":"String","Description":"String","LastInvoiceNo":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}