JiwaAPI

<back to all web services

SO_TotalsQuery

Requires Authentication
SO_TotalsQuery Parameters:
NameParameterData TypeRequiredDescription
InvoiceIDquerystringNo
InvoiceIDStartsWithquerystringNo
InvoiceIDEndsWithquerystringNo
InvoiceIDContainsquerystringNo
InvoiceIDLikequerystringNo
InvoiceIDBetweenquerystring[]No
InvoiceIDInquerystring[]No
InvoiceTotalquerydecimal?No
InvoiceTotalGreaterThanOrEqualToquerydecimal?No
InvoiceTotalGreaterThanquerydecimal?No
InvoiceTotalLessThanquerydecimal?No
InvoiceTotalLessThanOrEqualToquerydecimal?No
InvoiceTotalNotEqualToquerydecimal?No
InvoiceTotalBetweenqueryNullable<Decimal>[]No
InvoiceTotalInqueryNullable<Decimal>[]No
Cartage1Totalquerydecimal?No
Cartage1TotalGreaterThanOrEqualToquerydecimal?No
Cartage1TotalGreaterThanquerydecimal?No
Cartage1TotalLessThanquerydecimal?No
Cartage1TotalLessThanOrEqualToquerydecimal?No
Cartage1TotalNotEqualToquerydecimal?No
Cartage1TotalBetweenqueryNullable<Decimal>[]No
Cartage1TotalInqueryNullable<Decimal>[]No
Cartage1TaxTotalquerydecimal?No
Cartage1TaxTotalGreaterThanOrEqualToquerydecimal?No
Cartage1TaxTotalGreaterThanquerydecimal?No
Cartage1TaxTotalLessThanquerydecimal?No
Cartage1TaxTotalLessThanOrEqualToquerydecimal?No
Cartage1TaxTotalNotEqualToquerydecimal?No
Cartage1TaxTotalBetweenqueryNullable<Decimal>[]No
Cartage1TaxTotalInqueryNullable<Decimal>[]No
Cartage2Totalquerydecimal?No
Cartage2TotalGreaterThanOrEqualToquerydecimal?No
Cartage2TotalGreaterThanquerydecimal?No
Cartage2TotalLessThanquerydecimal?No
Cartage2TotalLessThanOrEqualToquerydecimal?No
Cartage2TotalNotEqualToquerydecimal?No
Cartage2TotalBetweenqueryNullable<Decimal>[]No
Cartage2TotalInqueryNullable<Decimal>[]No
Cartage2TaxTotalquerydecimal?No
Cartage2TaxTotalGreaterThanOrEqualToquerydecimal?No
Cartage2TaxTotalGreaterThanquerydecimal?No
Cartage2TaxTotalLessThanquerydecimal?No
Cartage2TaxTotalLessThanOrEqualToquerydecimal?No
Cartage2TaxTotalNotEqualToquerydecimal?No
Cartage2TaxTotalBetweenqueryNullable<Decimal>[]No
Cartage2TaxTotalInqueryNullable<Decimal>[]No
Cartage3Totalquerydecimal?No
Cartage3TotalGreaterThanOrEqualToquerydecimal?No
Cartage3TotalGreaterThanquerydecimal?No
Cartage3TotalLessThanquerydecimal?No
Cartage3TotalLessThanOrEqualToquerydecimal?No
Cartage3TotalNotEqualToquerydecimal?No
Cartage3TotalBetweenqueryNullable<Decimal>[]No
Cartage3TotalInqueryNullable<Decimal>[]No
Cartage3TaxTotalquerydecimal?No
Cartage3TaxTotalGreaterThanOrEqualToquerydecimal?No
Cartage3TaxTotalGreaterThanquerydecimal?No
Cartage3TaxTotalLessThanquerydecimal?No
Cartage3TaxTotalLessThanOrEqualToquerydecimal?No
Cartage3TaxTotalNotEqualToquerydecimal?No
Cartage3TaxTotalBetweenqueryNullable<Decimal>[]No
Cartage3TaxTotalInqueryNullable<Decimal>[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SO_Totals Parameters:
NameParameterData TypeRequiredDescription
InvoiceIDformstringNo
InvoiceTotalformdecimal?No
Cartage1Totalformdecimal?No
Cartage1TaxTotalformdecimal?No
Cartage2Totalformdecimal?No
Cartage2TaxTotalformdecimal?No
Cartage3Totalformdecimal?No
Cartage3TaxTotalformdecimal?No
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/SO_TotalsQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"InvoiceID":"String","InvoiceIDStartsWith":"String","InvoiceIDEndsWith":"String","InvoiceIDContains":"String","InvoiceIDLike":"String","InvoiceIDBetween":["String"],"InvoiceIDIn":["String"],"InvoiceTotal":0,"InvoiceTotalGreaterThanOrEqualTo":0,"InvoiceTotalGreaterThan":0,"InvoiceTotalLessThan":0,"InvoiceTotalLessThanOrEqualTo":0,"InvoiceTotalNotEqualTo":0,"InvoiceTotalBetween":[0],"InvoiceTotalIn":[0],"Cartage1Total":0,"Cartage1TotalGreaterThanOrEqualTo":0,"Cartage1TotalGreaterThan":0,"Cartage1TotalLessThan":0,"Cartage1TotalLessThanOrEqualTo":0,"Cartage1TotalNotEqualTo":0,"Cartage1TotalBetween":[0],"Cartage1TotalIn":[0],"Cartage1TaxTotal":0,"Cartage1TaxTotalGreaterThanOrEqualTo":0,"Cartage1TaxTotalGreaterThan":0,"Cartage1TaxTotalLessThan":0,"Cartage1TaxTotalLessThanOrEqualTo":0,"Cartage1TaxTotalNotEqualTo":0,"Cartage1TaxTotalBetween":[0],"Cartage1TaxTotalIn":[0],"Cartage2Total":0,"Cartage2TotalGreaterThanOrEqualTo":0,"Cartage2TotalGreaterThan":0,"Cartage2TotalLessThan":0,"Cartage2TotalLessThanOrEqualTo":0,"Cartage2TotalNotEqualTo":0,"Cartage2TotalBetween":[0],"Cartage2TotalIn":[0],"Cartage2TaxTotal":0,"Cartage2TaxTotalGreaterThanOrEqualTo":0,"Cartage2TaxTotalGreaterThan":0,"Cartage2TaxTotalLessThan":0,"Cartage2TaxTotalLessThanOrEqualTo":0,"Cartage2TaxTotalNotEqualTo":0,"Cartage2TaxTotalBetween":[0],"Cartage2TaxTotalIn":[0],"Cartage3Total":0,"Cartage3TotalGreaterThanOrEqualTo":0,"Cartage3TotalGreaterThan":0,"Cartage3TotalLessThan":0,"Cartage3TotalLessThanOrEqualTo":0,"Cartage3TotalNotEqualTo":0,"Cartage3TotalBetween":[0],"Cartage3TotalIn":[0],"Cartage3TaxTotal":0,"Cartage3TaxTotalGreaterThanOrEqualTo":0,"Cartage3TaxTotalGreaterThan":0,"Cartage3TaxTotalLessThan":0,"Cartage3TaxTotalLessThanOrEqualTo":0,"Cartage3TaxTotalNotEqualTo":0,"Cartage3TaxTotalBetween":[0],"Cartage3TaxTotalIn":[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":[{"InvoiceID":"String","InvoiceTotal":0,"Cartage1Total":0,"Cartage1TaxTotal":0,"Cartage2Total":0,"Cartage2TaxTotal":0,"Cartage3Total":0,"Cartage3TaxTotal":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}