JiwaAPI

<back to all web services

SO_ViewInvoicedQuery

Requires Authentication
SO_ViewInvoicedQuery Parameters:
NameParameterData TypeRequiredDescription
InvoiceIDquerystringNo
InvoiceIDStartsWithquerystringNo
InvoiceIDEndsWithquerystringNo
InvoiceIDContainsquerystringNo
InvoiceIDLikequerystringNo
InvoiceIDBetweenquerystring[]No
InvoiceIDInquerystring[]No
InvoiceNoquerystringNo
InvoiceNoStartsWithquerystringNo
InvoiceNoEndsWithquerystringNo
InvoiceNoContainsquerystringNo
InvoiceNoLikequerystringNo
InvoiceNoBetweenquerystring[]No
InvoiceNoInquerystring[]No
BillWhenCompletequeryshort?No
BillWhenCompleteGreaterThanOrEqualToqueryshort?No
BillWhenCompleteGreaterThanqueryshort?No
BillWhenCompleteLessThanqueryshort?No
BillWhenCompleteLessThanOrEqualToqueryshort?No
BillWhenCompleteNotEqualToqueryshort?No
BillWhenCompleteBetweenqueryshort[]No
BillWhenCompleteInqueryshort[]No
OrderNoquerystringNo
OrderNoStartsWithquerystringNo
OrderNoEndsWithquerystringNo
OrderNoContainsquerystringNo
OrderNoLikequerystringNo
OrderNoBetweenquerystring[]No
OrderNoInquerystring[]No
CreditNotequerybool?No
WholeSaleInvoicequerybool?No
TaxExemptNoquerystringNo
TaxExemptNoStartsWithquerystringNo
TaxExemptNoEndsWithquerystringNo
TaxExemptNoContainsquerystringNo
TaxExemptNoLikequerystringNo
TaxExemptNoBetweenquerystring[]No
TaxExemptNoInquerystring[]No
Statusqueryshort?No
StatusGreaterThanOrEqualToqueryshort?No
StatusGreaterThanqueryshort?No
StatusLessThanqueryshort?No
StatusLessThanOrEqualToqueryshort?No
StatusNotEqualToqueryshort?No
StatusBetweenqueryNullable<Int16>[]No
StatusInqueryNullable<Int16>[]No
StaffIDquerystringNo
StaffIDStartsWithquerystringNo
StaffIDEndsWithquerystringNo
StaffIDContainsquerystringNo
StaffIDLikequerystringNo
StaffIDBetweenquerystring[]No
StaffIDInquerystring[]No
InvoiceHistoryIDquerystringNo
InvoiceHistoryIDStartsWithquerystringNo
InvoiceHistoryIDEndsWithquerystringNo
InvoiceHistoryIDContainsquerystringNo
InvoiceHistoryIDLikequerystringNo
InvoiceHistoryIDBetweenquerystring[]No
InvoiceHistoryIDInquerystring[]No
Frieghtquerydecimal?No
FrieghtGreaterThanOrEqualToquerydecimal?No
FrieghtGreaterThanquerydecimal?No
FrieghtLessThanquerydecimal?No
FrieghtLessThanOrEqualToquerydecimal?No
FrieghtNotEqualToquerydecimal?No
FrieghtBetweenqueryNullable<Decimal>[]No
FrieghtInqueryNullable<Decimal>[]No
ProcessedHistoryNoqueryshort?No
ProcessedHistoryNoGreaterThanOrEqualToqueryshort?No
ProcessedHistoryNoGreaterThanqueryshort?No
ProcessedHistoryNoLessThanqueryshort?No
ProcessedHistoryNoLessThanOrEqualToqueryshort?No
ProcessedHistoryNoNotEqualToqueryshort?No
ProcessedHistoryNoBetweenqueryNullable<Int16>[]No
ProcessedHistoryNoInqueryNullable<Int16>[]No
InvoicedHistoryNoqueryshort?No
InvoicedHistoryNoGreaterThanOrEqualToqueryshort?No
InvoicedHistoryNoGreaterThanqueryshort?No
InvoicedHistoryNoLessThanqueryshort?No
InvoicedHistoryNoLessThanOrEqualToqueryshort?No
InvoicedHistoryNoNotEqualToqueryshort?No
InvoicedHistoryNoBetweenqueryNullable<Int16>[]No
InvoicedHistoryNoInqueryNullable<Int16>[]No
ProcessedOnRunNoquerystringNo
ProcessedOnRunNoStartsWithquerystringNo
ProcessedOnRunNoEndsWithquerystringNo
ProcessedOnRunNoContainsquerystringNo
ProcessedOnRunNoLikequerystringNo
ProcessedOnRunNoBetweenquerystring[]No
ProcessedOnRunNoInquerystring[]No
InvoicedOnRunNoquerystringNo
InvoicedOnRunNoStartsWithquerystringNo
InvoicedOnRunNoEndsWithquerystringNo
InvoicedOnRunNoContainsquerystringNo
InvoicedOnRunNoLikequerystringNo
InvoicedOnRunNoBetweenquerystring[]No
InvoicedOnRunNoInquerystring[]No
ProcessedDatequeryDateTime?No
ProcessedDateGreaterThanOrEqualToqueryDateTime?No
ProcessedDateGreaterThanqueryDateTime?No
ProcessedDateLessThanqueryDateTime?No
ProcessedDateLessThanOrEqualToqueryDateTime?No
ProcessedDateNotEqualToqueryDateTime?No
ProcessedDateBetweenqueryDateTime[]No
ProcessedDateInqueryDateTime[]No
InvoicedDatequeryDateTime?No
InvoicedDateGreaterThanOrEqualToqueryDateTime?No
InvoicedDateGreaterThanqueryDateTime?No
InvoicedDateLessThanqueryDateTime?No
InvoicedDateLessThanOrEqualToqueryDateTime?No
InvoicedDateNotEqualToqueryDateTime?No
InvoicedDateBetweenqueryDateTime[]No
InvoicedDateInqueryDateTime[]No
InvoiceLineIDquerystringNo
InvoiceLineIDStartsWithquerystringNo
InvoiceLineIDEndsWithquerystringNo
InvoiceLineIDContainsquerystringNo
InvoiceLineIDLikequerystringNo
InvoiceLineIDBetweenquerystring[]No
InvoiceLineIDInquerystring[]No
PartNoquerystringNo
PartNoStartsWithquerystringNo
PartNoEndsWithquerystringNo
PartNoContainsquerystringNo
PartNoLikequerystringNo
PartNoBetweenquerystring[]No
PartNoInquerystring[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
CostInquerydecimal?No
CostInGreaterThanOrEqualToquerydecimal?No
CostInGreaterThanquerydecimal?No
CostInLessThanquerydecimal?No
CostInLessThanOrEqualToquerydecimal?No
CostInNotEqualToquerydecimal?No
CostInBetweenqueryNullable<Decimal>[]No
CostInInqueryNullable<Decimal>[]No
QuantityThisDelquerydecimal?No
QuantityThisDelGreaterThanOrEqualToquerydecimal?No
QuantityThisDelGreaterThanquerydecimal?No
QuantityThisDelLessThanquerydecimal?No
QuantityThisDelLessThanOrEqualToquerydecimal?No
QuantityThisDelNotEqualToquerydecimal?No
QuantityThisDelBetweenqueryNullable<Decimal>[]No
QuantityThisDelInqueryNullable<Decimal>[]No
CurrentLineTotalquerydecimal?No
CurrentLineTotalGreaterThanOrEqualToquerydecimal?No
CurrentLineTotalGreaterThanquerydecimal?No
CurrentLineTotalLessThanquerydecimal?No
CurrentLineTotalLessThanOrEqualToquerydecimal?No
CurrentLineTotalNotEqualToquerydecimal?No
CurrentLineTotalBetweenqueryNullable<Decimal>[]No
CurrentLineTotalInqueryNullable<Decimal>[]No
TaxToChargequerydecimal?No
TaxToChargeGreaterThanOrEqualToquerydecimal?No
TaxToChargeGreaterThanquerydecimal?No
TaxToChargeLessThanquerydecimal?No
TaxToChargeLessThanOrEqualToquerydecimal?No
TaxToChargeNotEqualToquerydecimal?No
TaxToChargeBetweenqueryNullable<Decimal>[]No
TaxToChargeInqueryNullable<Decimal>[]No
TaxPaidquerydecimal?No
TaxPaidGreaterThanOrEqualToquerydecimal?No
TaxPaidGreaterThanquerydecimal?No
TaxPaidLessThanquerydecimal?No
TaxPaidLessThanOrEqualToquerydecimal?No
TaxPaidNotEqualToquerydecimal?No
TaxPaidBetweenqueryNullable<Decimal>[]No
TaxPaidInqueryNullable<Decimal>[]No
DecimalPlacesqueryshort?No
DecimalPlacesGreaterThanOrEqualToqueryshort?No
DecimalPlacesGreaterThanqueryshort?No
DecimalPlacesLessThanqueryshort?No
DecimalPlacesLessThanOrEqualToqueryshort?No
DecimalPlacesNotEqualToqueryshort?No
DecimalPlacesBetweenqueryNullable<Int16>[]No
DecimalPlacesInqueryNullable<Int16>[]No
TaxIDquerystringNo
TaxIDStartsWithquerystringNo
TaxIDEndsWithquerystringNo
TaxIDContainsquerystringNo
TaxIDLikequerystringNo
TaxIDBetweenquerystring[]No
TaxIDInquerystring[]No
PhysicalItemqueryshort?No
PhysicalItemGreaterThanOrEqualToqueryshort?No
PhysicalItemGreaterThanqueryshort?No
PhysicalItemLessThanqueryshort?No
PhysicalItemLessThanOrEqualToqueryshort?No
PhysicalItemNotEqualToqueryshort?No
PhysicalItemBetweenqueryNullable<Int16>[]No
PhysicalItemInqueryNullable<Int16>[]No
NonStockquerybool?No
DebtorIDquerystringNo
DebtorIDStartsWithquerystringNo
DebtorIDEndsWithquerystringNo
DebtorIDContainsquerystringNo
DebtorIDLikequerystringNo
DebtorIDBetweenquerystring[]No
DebtorIDInquerystring[]No
AccountNoquerystringNo
AccountNoStartsWithquerystringNo
AccountNoEndsWithquerystringNo
AccountNoContainsquerystringNo
AccountNoLikequerystringNo
AccountNoBetweenquerystring[]No
AccountNoInquerystring[]No
NamequerystringNo
NameStartsWithquerystringNo
NameEndsWithquerystringNo
NameContainsquerystringNo
NameLikequerystringNo
NameBetweenquerystring[]No
NameInquerystring[]No
InventoryClassificationIDquerystringNo
InventoryClassificationIDStartsWithquerystringNo
InventoryClassificationIDEndsWithquerystringNo
InventoryClassificationIDContainsquerystringNo
InventoryClassificationIDLikequerystringNo
InventoryClassificationIDBetweenquerystring[]No
InventoryClassificationIDInquerystring[]No
ClassDescriptionquerystringNo
ClassDescriptionStartsWithquerystringNo
ClassDescriptionEndsWithquerystringNo
ClassDescriptionContainsquerystringNo
ClassDescriptionLikequerystringNo
ClassDescriptionBetweenquerystring[]No
ClassDescriptionInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SO_ViewInvoiced Parameters:
NameParameterData TypeRequiredDescription
InvoiceIDformstringNo
InvoiceNoformstringNo
BillWhenCompleteformshortNo
OrderNoformstringNo
CreditNoteformboolNo
WholeSaleInvoiceformboolNo
TaxExemptNoformstringNo
Statusformshort?No
StaffIDformstringNo
InvoiceHistoryIDformstringNo
Frieghtformdecimal?No
ProcessedHistoryNoformshort?No
InvoicedHistoryNoformshort?No
ProcessedOnRunNoformstringNo
InvoicedOnRunNoformstringNo
ProcessedDateformDateTimeNo
InvoicedDateformDateTimeNo
InvoiceLineIDformstringNo
PartNoformstringNo
DescriptionformstringNo
CostInformdecimal?No
QuantityThisDelformdecimal?No
CurrentLineTotalformdecimal?No
TaxToChargeformdecimal?No
TaxPaidformdecimal?No
DecimalPlacesformshort?No
TaxIDformstringNo
PhysicalItemformshort?No
NonStockformbool?No
DebtorIDformstringNo
AccountNoformstringNo
NameformstringNo
InventoryClassificationIDformstringNo
ClassDescriptionformstringNo
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_ViewInvoicedQuery 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"],"InvoiceNo":"String","InvoiceNoStartsWith":"String","InvoiceNoEndsWith":"String","InvoiceNoContains":"String","InvoiceNoLike":"String","InvoiceNoBetween":["String"],"InvoiceNoIn":["String"],"BillWhenComplete":0,"BillWhenCompleteGreaterThanOrEqualTo":0,"BillWhenCompleteGreaterThan":0,"BillWhenCompleteLessThan":0,"BillWhenCompleteLessThanOrEqualTo":0,"BillWhenCompleteNotEqualTo":0,"BillWhenCompleteBetween":[0],"BillWhenCompleteIn":[0],"OrderNo":"String","OrderNoStartsWith":"String","OrderNoEndsWith":"String","OrderNoContains":"String","OrderNoLike":"String","OrderNoBetween":["String"],"OrderNoIn":["String"],"CreditNote":false,"WholeSaleInvoice":false,"TaxExemptNo":"String","TaxExemptNoStartsWith":"String","TaxExemptNoEndsWith":"String","TaxExemptNoContains":"String","TaxExemptNoLike":"String","TaxExemptNoBetween":["String"],"TaxExemptNoIn":["String"],"Status":0,"StatusGreaterThanOrEqualTo":0,"StatusGreaterThan":0,"StatusLessThan":0,"StatusLessThanOrEqualTo":0,"StatusNotEqualTo":0,"StatusBetween":[0],"StatusIn":[0],"StaffID":"String","StaffIDStartsWith":"String","StaffIDEndsWith":"String","StaffIDContains":"String","StaffIDLike":"String","StaffIDBetween":["String"],"StaffIDIn":["String"],"InvoiceHistoryID":"String","InvoiceHistoryIDStartsWith":"String","InvoiceHistoryIDEndsWith":"String","InvoiceHistoryIDContains":"String","InvoiceHistoryIDLike":"String","InvoiceHistoryIDBetween":["String"],"InvoiceHistoryIDIn":["String"],"Frieght":0,"FrieghtGreaterThanOrEqualTo":0,"FrieghtGreaterThan":0,"FrieghtLessThan":0,"FrieghtLessThanOrEqualTo":0,"FrieghtNotEqualTo":0,"FrieghtBetween":[0],"FrieghtIn":[0],"ProcessedHistoryNo":0,"ProcessedHistoryNoGreaterThanOrEqualTo":0,"ProcessedHistoryNoGreaterThan":0,"ProcessedHistoryNoLessThan":0,"ProcessedHistoryNoLessThanOrEqualTo":0,"ProcessedHistoryNoNotEqualTo":0,"ProcessedHistoryNoBetween":[0],"ProcessedHistoryNoIn":[0],"InvoicedHistoryNo":0,"InvoicedHistoryNoGreaterThanOrEqualTo":0,"InvoicedHistoryNoGreaterThan":0,"InvoicedHistoryNoLessThan":0,"InvoicedHistoryNoLessThanOrEqualTo":0,"InvoicedHistoryNoNotEqualTo":0,"InvoicedHistoryNoBetween":[0],"InvoicedHistoryNoIn":[0],"ProcessedOnRunNo":"String","ProcessedOnRunNoStartsWith":"String","ProcessedOnRunNoEndsWith":"String","ProcessedOnRunNoContains":"String","ProcessedOnRunNoLike":"String","ProcessedOnRunNoBetween":["String"],"ProcessedOnRunNoIn":["String"],"InvoicedOnRunNo":"String","InvoicedOnRunNoStartsWith":"String","InvoicedOnRunNoEndsWith":"String","InvoicedOnRunNoContains":"String","InvoicedOnRunNoLike":"String","InvoicedOnRunNoBetween":["String"],"InvoicedOnRunNoIn":["String"],"ProcessedDate":"0001-01-01T00:00:00.0000000","ProcessedDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","ProcessedDateGreaterThan":"0001-01-01T00:00:00.0000000","ProcessedDateLessThan":"0001-01-01T00:00:00.0000000","ProcessedDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","ProcessedDateNotEqualTo":"0001-01-01T00:00:00.0000000","ProcessedDateBetween":["0001-01-01T00:00:00.0000000"],"ProcessedDateIn":["0001-01-01T00:00:00.0000000"],"InvoicedDate":"0001-01-01T00:00:00.0000000","InvoicedDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","InvoicedDateGreaterThan":"0001-01-01T00:00:00.0000000","InvoicedDateLessThan":"0001-01-01T00:00:00.0000000","InvoicedDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","InvoicedDateNotEqualTo":"0001-01-01T00:00:00.0000000","InvoicedDateBetween":["0001-01-01T00:00:00.0000000"],"InvoicedDateIn":["0001-01-01T00:00:00.0000000"],"InvoiceLineID":"String","InvoiceLineIDStartsWith":"String","InvoiceLineIDEndsWith":"String","InvoiceLineIDContains":"String","InvoiceLineIDLike":"String","InvoiceLineIDBetween":["String"],"InvoiceLineIDIn":["String"],"PartNo":"String","PartNoStartsWith":"String","PartNoEndsWith":"String","PartNoContains":"String","PartNoLike":"String","PartNoBetween":["String"],"PartNoIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"CostIn":0,"CostInGreaterThanOrEqualTo":0,"CostInGreaterThan":0,"CostInLessThan":0,"CostInLessThanOrEqualTo":0,"CostInNotEqualTo":0,"CostInBetween":[0],"CostInIn":[0],"QuantityThisDel":0,"QuantityThisDelGreaterThanOrEqualTo":0,"QuantityThisDelGreaterThan":0,"QuantityThisDelLessThan":0,"QuantityThisDelLessThanOrEqualTo":0,"QuantityThisDelNotEqualTo":0,"QuantityThisDelBetween":[0],"QuantityThisDelIn":[0],"CurrentLineTotal":0,"CurrentLineTotalGreaterThanOrEqualTo":0,"CurrentLineTotalGreaterThan":0,"CurrentLineTotalLessThan":0,"CurrentLineTotalLessThanOrEqualTo":0,"CurrentLineTotalNotEqualTo":0,"CurrentLineTotalBetween":[0],"CurrentLineTotalIn":[0],"TaxToCharge":0,"TaxToChargeGreaterThanOrEqualTo":0,"TaxToChargeGreaterThan":0,"TaxToChargeLessThan":0,"TaxToChargeLessThanOrEqualTo":0,"TaxToChargeNotEqualTo":0,"TaxToChargeBetween":[0],"TaxToChargeIn":[0],"TaxPaid":0,"TaxPaidGreaterThanOrEqualTo":0,"TaxPaidGreaterThan":0,"TaxPaidLessThan":0,"TaxPaidLessThanOrEqualTo":0,"TaxPaidNotEqualTo":0,"TaxPaidBetween":[0],"TaxPaidIn":[0],"DecimalPlaces":0,"DecimalPlacesGreaterThanOrEqualTo":0,"DecimalPlacesGreaterThan":0,"DecimalPlacesLessThan":0,"DecimalPlacesLessThanOrEqualTo":0,"DecimalPlacesNotEqualTo":0,"DecimalPlacesBetween":[0],"DecimalPlacesIn":[0],"TaxID":"String","TaxIDStartsWith":"String","TaxIDEndsWith":"String","TaxIDContains":"String","TaxIDLike":"String","TaxIDBetween":["String"],"TaxIDIn":["String"],"PhysicalItem":0,"PhysicalItemGreaterThanOrEqualTo":0,"PhysicalItemGreaterThan":0,"PhysicalItemLessThan":0,"PhysicalItemLessThanOrEqualTo":0,"PhysicalItemNotEqualTo":0,"PhysicalItemBetween":[0],"PhysicalItemIn":[0],"NonStock":false,"DebtorID":"String","DebtorIDStartsWith":"String","DebtorIDEndsWith":"String","DebtorIDContains":"String","DebtorIDLike":"String","DebtorIDBetween":["String"],"DebtorIDIn":["String"],"AccountNo":"String","AccountNoStartsWith":"String","AccountNoEndsWith":"String","AccountNoContains":"String","AccountNoLike":"String","AccountNoBetween":["String"],"AccountNoIn":["String"],"Name":"String","NameStartsWith":"String","NameEndsWith":"String","NameContains":"String","NameLike":"String","NameBetween":["String"],"NameIn":["String"],"InventoryClassificationID":"String","InventoryClassificationIDStartsWith":"String","InventoryClassificationIDEndsWith":"String","InventoryClassificationIDContains":"String","InventoryClassificationIDLike":"String","InventoryClassificationIDBetween":["String"],"InventoryClassificationIDIn":["String"],"ClassDescription":"String","ClassDescriptionStartsWith":"String","ClassDescriptionEndsWith":"String","ClassDescriptionContains":"String","ClassDescriptionLike":"String","ClassDescriptionBetween":["String"],"ClassDescriptionIn":["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":[{"InvoiceID":"String","InvoiceNo":"String","OrderNo":"String","TaxExemptNo":"String","Status":0,"StaffID":"String","InvoiceHistoryID":"String","Frieght":0,"ProcessedHistoryNo":0,"InvoicedHistoryNo":0,"ProcessedOnRunNo":"String","InvoicedOnRunNo":"String","InvoiceLineID":"String","PartNo":"String","Description":"String","CostIn":0,"QuantityThisDel":0,"CurrentLineTotal":0,"TaxToCharge":0,"TaxPaid":0,"DecimalPlaces":0,"TaxID":"String","PhysicalItem":0,"NonStock":false,"DebtorID":"String","AccountNo":"String","Name":"String","InventoryClassificationID":"String","ClassDescription":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}