JiwaAPI

<back to all web services

SH_VotiQuery

Requires Authentication
SH_VotiQuery Parameters:
NameParameterData TypeRequiredDescription
VotiIDquerystringNo
VotiIDStartsWithquerystringNo
VotiIDEndsWithquerystringNo
VotiIDContainsquerystringNo
VotiIDLikequerystringNo
VotiIDBetweenquerystring[]No
VotiIDInquerystring[]No
ShipmentIDquerystringNo
ShipmentIDStartsWithquerystringNo
ShipmentIDEndsWithquerystringNo
ShipmentIDContainsquerystringNo
ShipmentIDLikequerystringNo
ShipmentIDBetweenquerystring[]No
ShipmentIDInquerystring[]No
CreditorIDquerystringNo
CreditorIDStartsWithquerystringNo
CreditorIDEndsWithquerystringNo
CreditorIDContainsquerystringNo
CreditorIDLikequerystringNo
CreditorIDBetweenquerystring[]No
CreditorIDInquerystring[]No
CreditorLedgerIDquerystringNo
CreditorLedgerIDStartsWithquerystringNo
CreditorLedgerIDEndsWithquerystringNo
CreditorLedgerIDContainsquerystringNo
CreditorLedgerIDLikequerystringNo
CreditorLedgerIDBetweenquerystring[]No
CreditorLedgerIDInquerystring[]No
GSTIDquerystringNo
GSTIDStartsWithquerystringNo
GSTIDEndsWithquerystringNo
GSTIDContainsquerystringNo
GSTIDLikequerystringNo
GSTIDBetweenquerystring[]No
GSTIDInquerystring[]No
LedgerIDquerystringNo
LedgerIDStartsWithquerystringNo
LedgerIDEndsWithquerystringNo
LedgerIDContainsquerystringNo
LedgerIDLikequerystringNo
LedgerIDBetweenquerystring[]No
LedgerIDInquerystring[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
InvoiceNoquerystringNo
InvoiceNoStartsWithquerystringNo
InvoiceNoEndsWithquerystringNo
InvoiceNoContainsquerystringNo
InvoiceNoLikequerystringNo
InvoiceNoBetweenquerystring[]No
InvoiceNoInquerystring[]No
ReferencequerystringNo
ReferenceStartsWithquerystringNo
ReferenceEndsWithquerystringNo
ReferenceContainsquerystringNo
ReferenceLikequerystringNo
ReferenceBetweenquerystring[]No
ReferenceInquerystring[]No
Amountquerydecimal?No
AmountGreaterThanOrEqualToquerydecimal?No
AmountGreaterThanquerydecimal?No
AmountLessThanquerydecimal?No
AmountLessThanOrEqualToquerydecimal?No
AmountNotEqualToquerydecimal?No
AmountBetweenqueryNullable<Decimal>[]No
AmountInqueryNullable<Decimal>[]No
GSTAmountquerydecimal?No
GSTAmountGreaterThanOrEqualToquerydecimal?No
GSTAmountGreaterThanquerydecimal?No
GSTAmountLessThanquerydecimal?No
GSTAmountLessThanOrEqualToquerydecimal?No
GSTAmountNotEqualToquerydecimal?No
GSTAmountBetweenqueryNullable<Decimal>[]No
GSTAmountInqueryNullable<Decimal>[]No
DueDatequeryDateTime?No
DueDateGreaterThanOrEqualToqueryDateTime?No
DueDateGreaterThanqueryDateTime?No
DueDateLessThanqueryDateTime?No
DueDateLessThanOrEqualToqueryDateTime?No
DueDateNotEqualToqueryDateTime?No
DueDateBetweenqueryNullable<DateTime>[]No
DueDateInqueryNullable<DateTime>[]No
Invoicedquerybool?No
CR_TransIDquerystringNo
CR_TransIDStartsWithquerystringNo
CR_TransIDEndsWithquerystringNo
CR_TransIDContainsquerystringNo
CR_TransIDLikequerystringNo
CR_TransIDBetweenquerystring[]No
CR_TransIDInquerystring[]No
UserField1querystringNo
UserField1StartsWithquerystringNo
UserField1EndsWithquerystringNo
UserField1ContainsquerystringNo
UserField1LikequerystringNo
UserField1Betweenquerystring[]No
UserField1Inquerystring[]No
UserField2querystringNo
UserField2StartsWithquerystringNo
UserField2EndsWithquerystringNo
UserField2ContainsquerystringNo
UserField2LikequerystringNo
UserField2Betweenquerystring[]No
UserField2Inquerystring[]No
UserField3querystringNo
UserField3StartsWithquerystringNo
UserField3EndsWithquerystringNo
UserField3ContainsquerystringNo
UserField3LikequerystringNo
UserField3Betweenquerystring[]No
UserField3Inquerystring[]No
UserField4querystringNo
UserField4StartsWithquerystringNo
UserField4EndsWithquerystringNo
UserField4ContainsquerystringNo
UserField4LikequerystringNo
UserField4Betweenquerystring[]No
UserField4Inquerystring[]No
UserField5querystringNo
UserField5StartsWithquerystringNo
UserField5EndsWithquerystringNo
UserField5ContainsquerystringNo
UserField5LikequerystringNo
UserField5Betweenquerystring[]No
UserField5Inquerystring[]No
UserField6querystringNo
UserField6StartsWithquerystringNo
UserField6EndsWithquerystringNo
UserField6ContainsquerystringNo
UserField6LikequerystringNo
UserField6Betweenquerystring[]No
UserField6Inquerystring[]No
UserField7querystringNo
UserField7StartsWithquerystringNo
UserField7EndsWithquerystringNo
UserField7ContainsquerystringNo
UserField7LikequerystringNo
UserField7Betweenquerystring[]No
UserField7Inquerystring[]No
UserField8querystringNo
UserField8StartsWithquerystringNo
UserField8EndsWithquerystringNo
UserField8ContainsquerystringNo
UserField8LikequerystringNo
UserField8Betweenquerystring[]No
UserField8Inquerystring[]No
UserField9querystringNo
UserField9StartsWithquerystringNo
UserField9EndsWithquerystringNo
UserField9ContainsquerystringNo
UserField9LikequerystringNo
UserField9Betweenquerystring[]No
UserField9Inquerystring[]No
UserField10querystringNo
UserField10StartsWithquerystringNo
UserField10EndsWithquerystringNo
UserField10ContainsquerystringNo
UserField10LikequerystringNo
UserField10Betweenquerystring[]No
UserField10Inquerystring[]No
DecimalPlacesqueryint?No
DecimalPlacesGreaterThanOrEqualToqueryint?No
DecimalPlacesGreaterThanqueryint?No
DecimalPlacesLessThanqueryint?No
DecimalPlacesLessThanOrEqualToqueryint?No
DecimalPlacesNotEqualToqueryint?No
DecimalPlacesBetweenqueryNullable<Int32>[]No
DecimalPlacesInqueryNullable<Int32>[]No
InvoiceDatequeryDateTime?No
InvoiceDateGreaterThanOrEqualToqueryDateTime?No
InvoiceDateGreaterThanqueryDateTime?No
InvoiceDateLessThanqueryDateTime?No
InvoiceDateLessThanOrEqualToqueryDateTime?No
InvoiceDateNotEqualToqueryDateTime?No
InvoiceDateBetweenqueryNullable<DateTime>[]No
InvoiceDateInqueryNullable<DateTime>[]No
RowHashquerybyte[]No
ItemNoqueryint?No
ItemNoGreaterThanOrEqualToqueryint?No
ItemNoGreaterThanqueryint?No
ItemNoLessThanqueryint?No
ItemNoLessThanOrEqualToqueryint?No
ItemNoNotEqualToqueryint?No
ItemNoBetweenqueryint[]No
ItemNoInqueryint[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SH_Voti Parameters:
NameParameterData TypeRequiredDescription
VotiIDformstringNo
ShipmentIDformstringNo
CreditorIDformstringNo
CreditorLedgerIDformstringNo
GSTIDformstringNo
LedgerIDformstringNo
DescriptionformstringNo
InvoiceNoformstringNo
ReferenceformstringNo
Amountformdecimal?No
GSTAmountformdecimal?No
DueDateformDateTime?No
InvoicedformboolNo
CR_TransIDformstringNo
UserField1formstringNo
UserField2formstringNo
UserField3formstringNo
UserField4formstringNo
UserField5formstringNo
UserField6formstringNo
UserField7formstringNo
UserField8formstringNo
UserField9formstringNo
UserField10formstringNo
DecimalPlacesformint?No
InvoiceDateformDateTime?No
RowHashformbyte[]No
ItemNoformintNo
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/SH_VotiQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"VotiID":"String","VotiIDStartsWith":"String","VotiIDEndsWith":"String","VotiIDContains":"String","VotiIDLike":"String","VotiIDBetween":["String"],"VotiIDIn":["String"],"ShipmentID":"String","ShipmentIDStartsWith":"String","ShipmentIDEndsWith":"String","ShipmentIDContains":"String","ShipmentIDLike":"String","ShipmentIDBetween":["String"],"ShipmentIDIn":["String"],"CreditorID":"String","CreditorIDStartsWith":"String","CreditorIDEndsWith":"String","CreditorIDContains":"String","CreditorIDLike":"String","CreditorIDBetween":["String"],"CreditorIDIn":["String"],"CreditorLedgerID":"String","CreditorLedgerIDStartsWith":"String","CreditorLedgerIDEndsWith":"String","CreditorLedgerIDContains":"String","CreditorLedgerIDLike":"String","CreditorLedgerIDBetween":["String"],"CreditorLedgerIDIn":["String"],"GSTID":"String","GSTIDStartsWith":"String","GSTIDEndsWith":"String","GSTIDContains":"String","GSTIDLike":"String","GSTIDBetween":["String"],"GSTIDIn":["String"],"LedgerID":"String","LedgerIDStartsWith":"String","LedgerIDEndsWith":"String","LedgerIDContains":"String","LedgerIDLike":"String","LedgerIDBetween":["String"],"LedgerIDIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"InvoiceNo":"String","InvoiceNoStartsWith":"String","InvoiceNoEndsWith":"String","InvoiceNoContains":"String","InvoiceNoLike":"String","InvoiceNoBetween":["String"],"InvoiceNoIn":["String"],"Reference":"String","ReferenceStartsWith":"String","ReferenceEndsWith":"String","ReferenceContains":"String","ReferenceLike":"String","ReferenceBetween":["String"],"ReferenceIn":["String"],"Amount":0,"AmountGreaterThanOrEqualTo":0,"AmountGreaterThan":0,"AmountLessThan":0,"AmountLessThanOrEqualTo":0,"AmountNotEqualTo":0,"AmountBetween":[0],"AmountIn":[0],"GSTAmount":0,"GSTAmountGreaterThanOrEqualTo":0,"GSTAmountGreaterThan":0,"GSTAmountLessThan":0,"GSTAmountLessThanOrEqualTo":0,"GSTAmountNotEqualTo":0,"GSTAmountBetween":[0],"GSTAmountIn":[0],"DueDate":"0001-01-01T00:00:00.0000000","DueDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","DueDateGreaterThan":"0001-01-01T00:00:00.0000000","DueDateLessThan":"0001-01-01T00:00:00.0000000","DueDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","DueDateNotEqualTo":"0001-01-01T00:00:00.0000000","DueDateBetween":["0001-01-01T00:00:00.0000000"],"DueDateIn":["0001-01-01T00:00:00.0000000"],"Invoiced":false,"CR_TransID":"String","CR_TransIDStartsWith":"String","CR_TransIDEndsWith":"String","CR_TransIDContains":"String","CR_TransIDLike":"String","CR_TransIDBetween":["String"],"CR_TransIDIn":["String"],"UserField1":"String","UserField1StartsWith":"String","UserField1EndsWith":"String","UserField1Contains":"String","UserField1Like":"String","UserField1Between":["String"],"UserField1In":["String"],"UserField2":"String","UserField2StartsWith":"String","UserField2EndsWith":"String","UserField2Contains":"String","UserField2Like":"String","UserField2Between":["String"],"UserField2In":["String"],"UserField3":"String","UserField3StartsWith":"String","UserField3EndsWith":"String","UserField3Contains":"String","UserField3Like":"String","UserField3Between":["String"],"UserField3In":["String"],"UserField4":"String","UserField4StartsWith":"String","UserField4EndsWith":"String","UserField4Contains":"String","UserField4Like":"String","UserField4Between":["String"],"UserField4In":["String"],"UserField5":"String","UserField5StartsWith":"String","UserField5EndsWith":"String","UserField5Contains":"String","UserField5Like":"String","UserField5Between":["String"],"UserField5In":["String"],"UserField6":"String","UserField6StartsWith":"String","UserField6EndsWith":"String","UserField6Contains":"String","UserField6Like":"String","UserField6Between":["String"],"UserField6In":["String"],"UserField7":"String","UserField7StartsWith":"String","UserField7EndsWith":"String","UserField7Contains":"String","UserField7Like":"String","UserField7Between":["String"],"UserField7In":["String"],"UserField8":"String","UserField8StartsWith":"String","UserField8EndsWith":"String","UserField8Contains":"String","UserField8Like":"String","UserField8Between":["String"],"UserField8In":["String"],"UserField9":"String","UserField9StartsWith":"String","UserField9EndsWith":"String","UserField9Contains":"String","UserField9Like":"String","UserField9Between":["String"],"UserField9In":["String"],"UserField10":"String","UserField10StartsWith":"String","UserField10EndsWith":"String","UserField10Contains":"String","UserField10Like":"String","UserField10Between":["String"],"UserField10In":["String"],"DecimalPlaces":0,"DecimalPlacesGreaterThanOrEqualTo":0,"DecimalPlacesGreaterThan":0,"DecimalPlacesLessThan":0,"DecimalPlacesLessThanOrEqualTo":0,"DecimalPlacesNotEqualTo":0,"DecimalPlacesBetween":[0],"DecimalPlacesIn":[0],"InvoiceDate":"0001-01-01T00:00:00.0000000","InvoiceDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","InvoiceDateGreaterThan":"0001-01-01T00:00:00.0000000","InvoiceDateLessThan":"0001-01-01T00:00:00.0000000","InvoiceDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","InvoiceDateNotEqualTo":"0001-01-01T00:00:00.0000000","InvoiceDateBetween":["0001-01-01T00:00:00.0000000"],"InvoiceDateIn":["0001-01-01T00:00:00.0000000"],"RowHash":"AA==","ItemNo":0,"ItemNoGreaterThanOrEqualTo":0,"ItemNoGreaterThan":0,"ItemNoLessThan":0,"ItemNoLessThanOrEqualTo":0,"ItemNoNotEqualTo":0,"ItemNoBetween":[0],"ItemNoIn":[0],"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":[{"VotiID":"String","ShipmentID":"String","CreditorID":"String","CreditorLedgerID":"String","GSTID":"String","LedgerID":"String","Description":"String","InvoiceNo":"String","Reference":"String","Amount":0,"GSTAmount":0,"DueDate":"0001-01-01T00:00:00.0000000","CR_TransID":"String","UserField1":"String","UserField2":"String","UserField3":"String","UserField4":"String","UserField5":"String","UserField6":"String","UserField7":"String","UserField8":"String","UserField9":"String","UserField10":"String","DecimalPlaces":0,"InvoiceDate":"0001-01-01T00:00:00.0000000","RowHash":"AA=="}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}