Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RecID | query | string | No | |
RecIDStartsWith | query | string | No | |
RecIDEndsWith | query | string | No | |
RecIDContains | query | string | No | |
RecIDLike | query | string | No | |
RecIDBetween | query | string[] | No | |
RecIDIn | query | string[] | No | |
JobEntryID | query | string | No | |
JobEntryIDStartsWith | query | string | No | |
JobEntryIDEndsWith | query | string | No | |
JobEntryIDContains | query | string | No | |
JobEntryIDLike | query | string | No | |
JobEntryIDBetween | query | string[] | No | |
JobEntryIDIn | query | string[] | No | |
JobCode | query | string | No | |
JobCodeStartsWith | query | string | No | |
JobCodeEndsWith | query | string | No | |
JobCodeContains | query | string | No | |
JobCodeLike | query | string | No | |
JobCodeBetween | query | string[] | No | |
JobCodeIn | query | string[] | No | |
JobID | query | string | No | |
JobIDStartsWith | query | string | No | |
JobIDEndsWith | query | string | No | |
JobIDContains | query | string | No | |
JobIDLike | query | string | No | |
JobIDBetween | query | string[] | No | |
JobIDIn | query | string[] | No | |
CostCentreID | query | string | No | |
CostCentreIDStartsWith | query | string | No | |
CostCentreIDEndsWith | query | string | No | |
CostCentreIDContains | query | string | No | |
CostCentreIDLike | query | string | No | |
CostCentreIDBetween | query | string[] | No | |
CostCentreIDIn | query | string[] | No | |
StageID | query | string | No | |
StageIDStartsWith | query | string | No | |
StageIDEndsWith | query | string | No | |
StageIDContains | query | string | No | |
StageIDLike | query | string | No | |
StageIDBetween | query | string[] | No | |
StageIDIn | query | string[] | No | |
Qty | query | decimal? | No | |
QtyGreaterThanOrEqualTo | query | decimal? | No | |
QtyGreaterThan | query | decimal? | No | |
QtyLessThan | query | decimal? | No | |
QtyLessThanOrEqualTo | query | decimal? | No | |
QtyNotEqualTo | query | decimal? | No | |
QtyBetween | query | decimal[] | No | |
QtyIn | query | decimal[] | No | |
UnitCost | query | decimal? | No | |
UnitCostGreaterThanOrEqualTo | query | decimal? | No | |
UnitCostGreaterThan | query | decimal? | No | |
UnitCostLessThan | query | decimal? | No | |
UnitCostLessThanOrEqualTo | query | decimal? | No | |
UnitCostNotEqualTo | query | decimal? | No | |
UnitCostBetween | query | decimal[] | No | |
UnitCostIn | query | decimal[] | No | |
UnitCharge | query | decimal? | No | |
UnitChargeGreaterThanOrEqualTo | query | decimal? | No | |
UnitChargeGreaterThan | query | decimal? | No | |
UnitChargeLessThan | query | decimal? | No | |
UnitChargeLessThanOrEqualTo | query | decimal? | No | |
UnitChargeNotEqualTo | query | decimal? | No | |
UnitChargeBetween | query | decimal[] | No | |
UnitChargeIn | query | decimal[] | No | |
MarkUp | query | decimal? | No | |
MarkUpGreaterThanOrEqualTo | query | decimal? | No | |
MarkUpGreaterThan | query | decimal? | No | |
MarkUpLessThan | query | decimal? | No | |
MarkUpLessThanOrEqualTo | query | decimal? | No | |
MarkUpNotEqualTo | query | decimal? | No | |
MarkUpBetween | query | Nullable<Decimal>[] | No | |
MarkUpIn | query | Nullable<Decimal>[] | No | |
ComponentID | query | string | No | |
ComponentIDStartsWith | query | string | No | |
ComponentIDEndsWith | query | string | No | |
ComponentIDContains | query | string | No | |
ComponentIDLike | query | string | No | |
ComponentIDBetween | query | string[] | No | |
ComponentIDIn | query | string[] | No | |
ComponentNo | query | string | No | |
ComponentNoStartsWith | query | string | No | |
ComponentNoEndsWith | query | string | No | |
ComponentNoContains | query | string | No | |
ComponentNoLike | query | string | No | |
ComponentNoBetween | query | string[] | No | |
ComponentNoIn | query | string[] | No | |
ComponentDesc | query | string | No | |
ComponentDescStartsWith | query | string | No | |
ComponentDescEndsWith | query | string | No | |
ComponentDescContains | query | string | No | |
ComponentDescLike | query | string | No | |
ComponentDescBetween | query | string[] | No | |
ComponentDescIn | query | string[] | No | |
ComponentType | query | short? | No | |
ComponentTypeGreaterThanOrEqualTo | query | short? | No | |
ComponentTypeGreaterThan | query | short? | No | |
ComponentTypeLessThan | query | short? | No | |
ComponentTypeLessThanOrEqualTo | query | short? | No | |
ComponentTypeNotEqualTo | query | short? | No | |
ComponentTypeBetween | query | Nullable<Int16>[] | No | |
ComponentTypeIn | query | Nullable<Int16>[] | No | |
InvoiceNo | query | string | No | |
InvoiceNoStartsWith | query | string | No | |
InvoiceNoEndsWith | query | string | No | |
InvoiceNoContains | query | string | No | |
InvoiceNoLike | query | string | No | |
InvoiceNoBetween | query | string[] | No | |
InvoiceNoIn | query | string[] | No | |
TranType | query | short? | No | |
TranTypeGreaterThanOrEqualTo | query | short? | No | |
TranTypeGreaterThan | query | short? | No | |
TranTypeLessThan | query | short? | No | |
TranTypeLessThanOrEqualTo | query | short? | No | |
TranTypeNotEqualTo | query | short? | No | |
TranTypeBetween | query | Nullable<Int16>[] | No | |
TranTypeIn | query | Nullable<Int16>[] | No | |
TaxID | query | string | No | |
TaxIDStartsWith | query | string | No | |
TaxIDEndsWith | query | string | No | |
TaxIDContains | query | string | No | |
TaxIDLike | query | string | No | |
TaxIDBetween | query | string[] | No | |
TaxIDIn | query | string[] | No | |
Status | query | short? | No | |
StatusGreaterThanOrEqualTo | query | short? | No | |
StatusGreaterThan | query | short? | No | |
StatusLessThan | query | short? | No | |
StatusLessThanOrEqualTo | query | short? | No | |
StatusNotEqualTo | query | short? | No | |
StatusBetween | query | Nullable<Int16>[] | No | |
StatusIn | query | Nullable<Int16>[] | No | |
LinkID | query | string | No | |
LinkIDStartsWith | query | string | No | |
LinkIDEndsWith | query | string | No | |
LinkIDContains | query | string | No | |
LinkIDLike | query | string | No | |
LinkIDBetween | query | string[] | No | |
LinkIDIn | query | string[] | No | |
LastSavedDateTime | query | DateTime? | No | |
LastSavedDateTimeGreaterThanOrEqualTo | query | DateTime? | No | |
LastSavedDateTimeGreaterThan | query | DateTime? | No | |
LastSavedDateTimeLessThan | query | DateTime? | No | |
LastSavedDateTimeLessThanOrEqualTo | query | DateTime? | No | |
LastSavedDateTimeNotEqualTo | query | DateTime? | No | |
LastSavedDateTimeBetween | query | DateTime[] | No | |
LastSavedDateTimeIn | query | DateTime[] | No | |
TranDate | query | DateTime? | No | |
TranDateGreaterThanOrEqualTo | query | DateTime? | No | |
TranDateGreaterThan | query | DateTime? | No | |
TranDateLessThan | query | DateTime? | No | |
TranDateLessThanOrEqualTo | query | DateTime? | No | |
TranDateNotEqualTo | query | DateTime? | No | |
TranDateBetween | query | DateTime[] | No | |
TranDateIn | query | DateTime[] | No | |
InvoicedAmount | query | decimal? | No | |
InvoicedAmountGreaterThanOrEqualTo | query | decimal? | No | |
InvoicedAmountGreaterThan | query | decimal? | No | |
InvoicedAmountLessThan | query | decimal? | No | |
InvoicedAmountLessThanOrEqualTo | query | decimal? | No | |
InvoicedAmountNotEqualTo | query | decimal? | No | |
InvoicedAmountBetween | query | Nullable<Decimal>[] | No | |
InvoicedAmountIn | query | Nullable<Decimal>[] | No | |
Unit | query | string | No | |
UnitStartsWith | query | string | No | |
UnitEndsWith | query | string | No | |
UnitContains | query | string | No | |
UnitLike | query | string | No | |
UnitBetween | query | string[] | No | |
UnitIn | query | string[] | No | |
Remark | query | string | No | |
RemarkStartsWith | query | string | No | |
RemarkEndsWith | query | string | No | |
RemarkContains | query | string | No | |
RemarkLike | query | string | No | |
RemarkBetween | query | string[] | No | |
RemarkIn | query | string[] | No | |
ServiceNo | query | string | No | |
ServiceNoStartsWith | query | string | No | |
ServiceNoEndsWith | query | string | No | |
ServiceNoContains | query | string | No | |
ServiceNoLike | query | string | No | |
ServiceNoBetween | query | string[] | No | |
ServiceNoIn | query | string[] | No | |
BackOrderQty | query | decimal? | No | |
BackOrderQtyGreaterThanOrEqualTo | query | decimal? | No | |
BackOrderQtyGreaterThan | query | decimal? | No | |
BackOrderQtyLessThan | query | decimal? | No | |
BackOrderQtyLessThanOrEqualTo | query | decimal? | No | |
BackOrderQtyNotEqualTo | query | decimal? | No | |
BackOrderQtyBetween | query | Nullable<Decimal>[] | No | |
BackOrderQtyIn | query | Nullable<Decimal>[] | No | |
QtyDelivered | query | decimal? | No | |
QtyDeliveredGreaterThanOrEqualTo | query | decimal? | No | |
QtyDeliveredGreaterThan | query | decimal? | No | |
QtyDeliveredLessThan | query | decimal? | No | |
QtyDeliveredLessThanOrEqualTo | query | decimal? | No | |
QtyDeliveredNotEqualTo | query | decimal? | No | |
QtyDeliveredBetween | query | Nullable<Decimal>[] | No | |
QtyDeliveredIn | query | Nullable<Decimal>[] | No | |
QtyDecimalPlaces | query | short? | No | |
QtyDecimalPlacesGreaterThanOrEqualTo | query | short? | No | |
QtyDecimalPlacesGreaterThan | query | short? | No | |
QtyDecimalPlacesLessThan | query | short? | No | |
QtyDecimalPlacesLessThanOrEqualTo | query | short? | No | |
QtyDecimalPlacesNotEqualTo | query | short? | No | |
QtyDecimalPlacesBetween | query | Nullable<Int16>[] | No | |
QtyDecimalPlacesIn | query | Nullable<Int16>[] | 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 |
---|---|---|---|---|
RecID | form | string | No | |
JobEntryID | form | string | No | |
JobCode | form | string | No | |
JobID | form | string | No | |
CostCentreID | form | string | No | |
StageID | form | string | No | |
Qty | form | decimal | No | |
UnitCost | form | decimal | No | |
UnitCharge | form | decimal | No | |
MarkUp | form | decimal? | No | |
ComponentID | form | string | No | |
ComponentNo | form | string | No | |
ComponentDesc | form | string | No | |
ComponentType | form | short? | No | |
InvoiceNo | form | string | No | |
TranType | form | short? | No | |
TaxID | form | string | No | |
Status | form | short? | No | |
LinkID | form | string | No | |
LastSavedDateTime | form | DateTime | No | |
TranDate | form | DateTime | No | |
InvoicedAmount | form | decimal? | No | |
Unit | form | string | No | |
Remark | form | string | No | |
ServiceNo | form | string | No | |
BackOrderQty | form | decimal? | No | |
QtyDelivered | form | decimal? | No | |
QtyDecimalPlaces | form | short? | 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 .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /csv/reply/JB_CostEntryLinesQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"RecID":"String","RecIDStartsWith":"String","RecIDEndsWith":"String","RecIDContains":"String","RecIDLike":"String","RecIDBetween":["String"],"RecIDIn":["String"],"JobEntryID":"String","JobEntryIDStartsWith":"String","JobEntryIDEndsWith":"String","JobEntryIDContains":"String","JobEntryIDLike":"String","JobEntryIDBetween":["String"],"JobEntryIDIn":["String"],"JobCode":"String","JobCodeStartsWith":"String","JobCodeEndsWith":"String","JobCodeContains":"String","JobCodeLike":"String","JobCodeBetween":["String"],"JobCodeIn":["String"],"JobID":"String","JobIDStartsWith":"String","JobIDEndsWith":"String","JobIDContains":"String","JobIDLike":"String","JobIDBetween":["String"],"JobIDIn":["String"],"CostCentreID":"String","CostCentreIDStartsWith":"String","CostCentreIDEndsWith":"String","CostCentreIDContains":"String","CostCentreIDLike":"String","CostCentreIDBetween":["String"],"CostCentreIDIn":["String"],"StageID":"String","StageIDStartsWith":"String","StageIDEndsWith":"String","StageIDContains":"String","StageIDLike":"String","StageIDBetween":["String"],"StageIDIn":["String"],"Qty":0,"QtyGreaterThanOrEqualTo":0,"QtyGreaterThan":0,"QtyLessThan":0,"QtyLessThanOrEqualTo":0,"QtyNotEqualTo":0,"QtyBetween":[0],"QtyIn":[0],"UnitCost":0,"UnitCostGreaterThanOrEqualTo":0,"UnitCostGreaterThan":0,"UnitCostLessThan":0,"UnitCostLessThanOrEqualTo":0,"UnitCostNotEqualTo":0,"UnitCostBetween":[0],"UnitCostIn":[0],"UnitCharge":0,"UnitChargeGreaterThanOrEqualTo":0,"UnitChargeGreaterThan":0,"UnitChargeLessThan":0,"UnitChargeLessThanOrEqualTo":0,"UnitChargeNotEqualTo":0,"UnitChargeBetween":[0],"UnitChargeIn":[0],"MarkUp":0,"MarkUpGreaterThanOrEqualTo":0,"MarkUpGreaterThan":0,"MarkUpLessThan":0,"MarkUpLessThanOrEqualTo":0,"MarkUpNotEqualTo":0,"MarkUpBetween":[0],"MarkUpIn":[0],"ComponentID":"String","ComponentIDStartsWith":"String","ComponentIDEndsWith":"String","ComponentIDContains":"String","ComponentIDLike":"String","ComponentIDBetween":["String"],"ComponentIDIn":["String"],"ComponentNo":"String","ComponentNoStartsWith":"String","ComponentNoEndsWith":"String","ComponentNoContains":"String","ComponentNoLike":"String","ComponentNoBetween":["String"],"ComponentNoIn":["String"],"ComponentDesc":"String","ComponentDescStartsWith":"String","ComponentDescEndsWith":"String","ComponentDescContains":"String","ComponentDescLike":"String","ComponentDescBetween":["String"],"ComponentDescIn":["String"],"ComponentType":0,"ComponentTypeGreaterThanOrEqualTo":0,"ComponentTypeGreaterThan":0,"ComponentTypeLessThan":0,"ComponentTypeLessThanOrEqualTo":0,"ComponentTypeNotEqualTo":0,"ComponentTypeBetween":[0],"ComponentTypeIn":[0],"InvoiceNo":"String","InvoiceNoStartsWith":"String","InvoiceNoEndsWith":"String","InvoiceNoContains":"String","InvoiceNoLike":"String","InvoiceNoBetween":["String"],"InvoiceNoIn":["String"],"TranType":0,"TranTypeGreaterThanOrEqualTo":0,"TranTypeGreaterThan":0,"TranTypeLessThan":0,"TranTypeLessThanOrEqualTo":0,"TranTypeNotEqualTo":0,"TranTypeBetween":[0],"TranTypeIn":[0],"TaxID":"String","TaxIDStartsWith":"String","TaxIDEndsWith":"String","TaxIDContains":"String","TaxIDLike":"String","TaxIDBetween":["String"],"TaxIDIn":["String"],"Status":0,"StatusGreaterThanOrEqualTo":0,"StatusGreaterThan":0,"StatusLessThan":0,"StatusLessThanOrEqualTo":0,"StatusNotEqualTo":0,"StatusBetween":[0],"StatusIn":[0],"LinkID":"String","LinkIDStartsWith":"String","LinkIDEndsWith":"String","LinkIDContains":"String","LinkIDLike":"String","LinkIDBetween":["String"],"LinkIDIn":["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"],"TranDate":"0001-01-01T00:00:00.0000000","TranDateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","TranDateGreaterThan":"0001-01-01T00:00:00.0000000","TranDateLessThan":"0001-01-01T00:00:00.0000000","TranDateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","TranDateNotEqualTo":"0001-01-01T00:00:00.0000000","TranDateBetween":["0001-01-01T00:00:00.0000000"],"TranDateIn":["0001-01-01T00:00:00.0000000"],"InvoicedAmount":0,"InvoicedAmountGreaterThanOrEqualTo":0,"InvoicedAmountGreaterThan":0,"InvoicedAmountLessThan":0,"InvoicedAmountLessThanOrEqualTo":0,"InvoicedAmountNotEqualTo":0,"InvoicedAmountBetween":[0],"InvoicedAmountIn":[0],"Unit":"String","UnitStartsWith":"String","UnitEndsWith":"String","UnitContains":"String","UnitLike":"String","UnitBetween":["String"],"UnitIn":["String"],"Remark":"String","RemarkStartsWith":"String","RemarkEndsWith":"String","RemarkContains":"String","RemarkLike":"String","RemarkBetween":["String"],"RemarkIn":["String"],"ServiceNo":"String","ServiceNoStartsWith":"String","ServiceNoEndsWith":"String","ServiceNoContains":"String","ServiceNoLike":"String","ServiceNoBetween":["String"],"ServiceNoIn":["String"],"BackOrderQty":0,"BackOrderQtyGreaterThanOrEqualTo":0,"BackOrderQtyGreaterThan":0,"BackOrderQtyLessThan":0,"BackOrderQtyLessThanOrEqualTo":0,"BackOrderQtyNotEqualTo":0,"BackOrderQtyBetween":[0],"BackOrderQtyIn":[0],"QtyDelivered":0,"QtyDeliveredGreaterThanOrEqualTo":0,"QtyDeliveredGreaterThan":0,"QtyDeliveredLessThan":0,"QtyDeliveredLessThanOrEqualTo":0,"QtyDeliveredNotEqualTo":0,"QtyDeliveredBetween":[0],"QtyDeliveredIn":[0],"QtyDecimalPlaces":0,"QtyDecimalPlacesGreaterThanOrEqualTo":0,"QtyDecimalPlacesGreaterThan":0,"QtyDecimalPlacesLessThan":0,"QtyDecimalPlacesLessThanOrEqualTo":0,"QtyDecimalPlacesNotEqualTo":0,"QtyDecimalPlacesBetween":[0],"QtyDecimalPlacesIn":[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":[{"RecID":"String","JobEntryID":"String","JobCode":"String","JobID":"String","CostCentreID":"String","StageID":"String","MarkUp":0,"ComponentID":"String","ComponentNo":"String","ComponentDesc":"String","ComponentType":0,"InvoiceNo":"String","TranType":0,"TaxID":"String","Status":0,"LinkID":"String","InvoicedAmount":0,"Unit":"String","Remark":"String","ServiceNo":"String","BackOrderQty":0,"QtyDelivered":0,"QtyDecimalPlaces":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}