| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SourceType | query | string | No | |
| SourceTypeStartsWith | query | string | No | |
| SourceTypeEndsWith | query | string | No | |
| SourceTypeContains | query | string | No | |
| SourceTypeLike | query | string | No | |
| SourceTypeBetween | query | string[] | No | |
| SourceTypeIn | query | string[] | No | |
| BatchNo | query | string | No | |
| BatchNoStartsWith | query | string | No | |
| BatchNoEndsWith | query | string | No | |
| BatchNoContains | query | string | No | |
| BatchNoLike | query | string | No | |
| BatchNoBetween | query | string[] | No | |
| BatchNoIn | query | string[] | No | |
| JobCostStage | query | string | No | |
| JobCostStageStartsWith | query | string | No | |
| JobCostStageEndsWith | query | string | No | |
| JobCostStageContains | query | string | No | |
| JobCostStageLike | query | string | No | |
| JobCostStageBetween | query | string[] | No | |
| JobCostStageIn | query | string[] | No | |
| Item | query | string | No | |
| ItemStartsWith | query | string | No | |
| ItemEndsWith | query | string | No | |
| ItemContains | query | string | No | |
| ItemLike | query | string | No | |
| ItemBetween | query | string[] | No | |
| ItemIn | query | string[] | No | |
| Description | query | string | No | |
| DescriptionStartsWith | query | string | No | |
| DescriptionEndsWith | query | string | No | |
| DescriptionContains | query | string | No | |
| DescriptionLike | query | string | No | |
| DescriptionBetween | query | string[] | No | |
| DescriptionIn | query | string[] | 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 | |
| Qty | query | string | No | |
| QtyStartsWith | query | string | No | |
| QtyEndsWith | query | string | No | |
| QtyContains | query | string | No | |
| QtyLike | query | string | No | |
| QtyBetween | query | string[] | No | |
| QtyIn | query | string[] | No | |
| TotalCost | query | decimal? | No | |
| TotalCostGreaterThanOrEqualTo | query | decimal? | No | |
| TotalCostGreaterThan | query | decimal? | No | |
| TotalCostLessThan | query | decimal? | No | |
| TotalCostLessThanOrEqualTo | query | decimal? | No | |
| TotalCostNotEqualTo | query | decimal? | No | |
| TotalCostBetween | query | Nullable<Decimal>[] | No | |
| TotalCostIn | query | Nullable<Decimal>[] | No | |
| TotalCharge | query | decimal? | No | |
| TotalChargeGreaterThanOrEqualTo | query | decimal? | No | |
| TotalChargeGreaterThan | query | decimal? | No | |
| TotalChargeLessThan | query | decimal? | No | |
| TotalChargeLessThanOrEqualTo | query | decimal? | No | |
| TotalChargeNotEqualTo | query | decimal? | No | |
| TotalChargeBetween | query | Nullable<Decimal>[] | No | |
| TotalChargeIn | query | Nullable<Decimal>[] | 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 | |
| JobNo | query | string | No | |
| JobNoStartsWith | query | string | No | |
| JobNoEndsWith | query | string | No | |
| JobNoContains | query | string | No | |
| JobNoLike | query | string | No | |
| JobNoBetween | query | string[] | No | |
| JobNoIn | query | string[] | 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 |
|---|---|---|---|---|
| SourceType | form | string | No | |
| BatchNo | form | string | No | |
| JobCostStage | form | string | No | |
| Item | form | string | No | |
| Description | form | string | No | |
| TranDate | form | DateTime | No | |
| Qty | form | string | No | |
| TotalCost | form | decimal? | No | |
| TotalCharge | form | decimal? | No | |
| Remark | form | string | No | |
| JobNo | form | string | 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/v_JB_CreditNotesQuery HTTP/1.1
Host: api.jiwa.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"SourceType":"String","SourceTypeStartsWith":"String","SourceTypeEndsWith":"String","SourceTypeContains":"String","SourceTypeLike":"String","SourceTypeBetween":["String"],"SourceTypeIn":["String"],"BatchNo":"String","BatchNoStartsWith":"String","BatchNoEndsWith":"String","BatchNoContains":"String","BatchNoLike":"String","BatchNoBetween":["String"],"BatchNoIn":["String"],"JobCostStage":"String","JobCostStageStartsWith":"String","JobCostStageEndsWith":"String","JobCostStageContains":"String","JobCostStageLike":"String","JobCostStageBetween":["String"],"JobCostStageIn":["String"],"Item":"String","ItemStartsWith":"String","ItemEndsWith":"String","ItemContains":"String","ItemLike":"String","ItemBetween":["String"],"ItemIn":["String"],"Description":"String","DescriptionStartsWith":"String","DescriptionEndsWith":"String","DescriptionContains":"String","DescriptionLike":"String","DescriptionBetween":["String"],"DescriptionIn":["String"],"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"],"Qty":"String","QtyStartsWith":"String","QtyEndsWith":"String","QtyContains":"String","QtyLike":"String","QtyBetween":["String"],"QtyIn":["String"],"TotalCost":0,"TotalCostGreaterThanOrEqualTo":0,"TotalCostGreaterThan":0,"TotalCostLessThan":0,"TotalCostLessThanOrEqualTo":0,"TotalCostNotEqualTo":0,"TotalCostBetween":[0],"TotalCostIn":[0],"TotalCharge":0,"TotalChargeGreaterThanOrEqualTo":0,"TotalChargeGreaterThan":0,"TotalChargeLessThan":0,"TotalChargeLessThanOrEqualTo":0,"TotalChargeNotEqualTo":0,"TotalChargeBetween":[0],"TotalChargeIn":[0],"Remark":"String","RemarkStartsWith":"String","RemarkEndsWith":"String","RemarkContains":"String","RemarkLike":"String","RemarkBetween":["String"],"RemarkIn":["String"],"JobNo":"String","JobNoStartsWith":"String","JobNoEndsWith":"String","JobNoContains":"String","JobNoLike":"String","JobNoBetween":["String"],"JobNoIn":["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":[{"SourceType":"String","BatchNo":"String","JobCostStage":"String","Item":"String","Description":"String","Qty":"String","TotalCost":0,"TotalCharge":0,"Remark":"String","JobNo":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}