| 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 | |
| Reference | query | string | No | |
| ReferenceStartsWith | query | string | No | |
| ReferenceEndsWith | query | string | No | |
| ReferenceContains | query | string | No | |
| ReferenceLike | query | string | No | |
| ReferenceBetween | query | string[] | No | |
| ReferenceIn | query | string[] | No | |
| SO_History_InvoiceHistoryID | query | string | No | |
| SO_History_InvoiceHistoryIDStartsWith | query | string | No | |
| SO_History_InvoiceHistoryIDEndsWith | query | string | No | |
| SO_History_InvoiceHistoryIDContains | query | string | No | |
| SO_History_InvoiceHistoryIDLike | query | string | No | |
| SO_History_InvoiceHistoryIDBetween | query | string[] | No | |
| SO_History_InvoiceHistoryIDIn | query | string[] | No | |
| FR_CarrierFreightDescriptions_RecID | query | string | No | |
| FR_CarrierFreightDescriptions_RecIDStartsWith | query | string | No | |
| FR_CarrierFreightDescriptions_RecIDEndsWith | query | string | No | |
| FR_CarrierFreightDescriptions_RecIDContains | query | string | No | |
| FR_CarrierFreightDescriptions_RecIDLike | query | string | No | |
| FR_CarrierFreightDescriptions_RecIDBetween | query | string[] | No | |
| FR_CarrierFreightDescriptions_RecIDIn | 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 | |
| NumberItems | query | decimal? | No | |
| NumberItemsGreaterThanOrEqualTo | query | decimal? | No | |
| NumberItemsGreaterThan | query | decimal? | No | |
| NumberItemsLessThan | query | decimal? | No | |
| NumberItemsLessThanOrEqualTo | query | decimal? | No | |
| NumberItemsNotEqualTo | query | decimal? | No | |
| NumberItemsBetween | query | decimal[] | No | |
| NumberItemsIn | query | decimal[] | No | |
| ItemWeight | query | decimal? | No | |
| ItemWeightGreaterThanOrEqualTo | query | decimal? | No | |
| ItemWeightGreaterThan | query | decimal? | No | |
| ItemWeightLessThan | query | decimal? | No | |
| ItemWeightLessThanOrEqualTo | query | decimal? | No | |
| ItemWeightNotEqualTo | query | decimal? | No | |
| ItemWeightBetween | query | decimal[] | No | |
| ItemWeightIn | query | decimal[] | No | |
| ItemCubic | query | decimal? | No | |
| ItemCubicGreaterThanOrEqualTo | query | decimal? | No | |
| ItemCubicGreaterThan | query | decimal? | No | |
| ItemCubicLessThan | query | decimal? | No | |
| ItemCubicLessThanOrEqualTo | query | decimal? | No | |
| ItemCubicNotEqualTo | query | decimal? | No | |
| ItemCubicBetween | query | decimal[] | No | |
| ItemCubicIn | query | decimal[] | No | |
| ItemLength | query | decimal? | No | |
| ItemLengthGreaterThanOrEqualTo | query | decimal? | No | |
| ItemLengthGreaterThan | query | decimal? | No | |
| ItemLengthLessThan | query | decimal? | No | |
| ItemLengthLessThanOrEqualTo | query | decimal? | No | |
| ItemLengthNotEqualTo | query | decimal? | No | |
| ItemLengthBetween | query | decimal[] | No | |
| ItemLengthIn | query | decimal[] | No | |
| ItemWidth | query | decimal? | No | |
| ItemWidthGreaterThanOrEqualTo | query | decimal? | No | |
| ItemWidthGreaterThan | query | decimal? | No | |
| ItemWidthLessThan | query | decimal? | No | |
| ItemWidthLessThanOrEqualTo | query | decimal? | No | |
| ItemWidthNotEqualTo | query | decimal? | No | |
| ItemWidthBetween | query | decimal[] | No | |
| ItemWidthIn | query | decimal[] | No | |
| ItemHeight | query | decimal? | No | |
| ItemHeightGreaterThanOrEqualTo | query | decimal? | No | |
| ItemHeightGreaterThan | query | decimal? | No | |
| ItemHeightLessThan | query | decimal? | No | |
| ItemHeightLessThanOrEqualTo | query | decimal? | No | |
| ItemHeightNotEqualTo | query | decimal? | No | |
| ItemHeightBetween | query | decimal[] | No | |
| ItemHeightIn | query | decimal[] | No | |
| SO_HistoryConsignmentNotes_RecID | query | string | No | |
| SO_HistoryConsignmentNotes_RecIDStartsWith | query | string | No | |
| SO_HistoryConsignmentNotes_RecIDEndsWith | query | string | No | |
| SO_HistoryConsignmentNotes_RecIDContains | query | string | No | |
| SO_HistoryConsignmentNotes_RecIDLike | query | string | No | |
| SO_HistoryConsignmentNotes_RecIDBetween | query | string[] | No | |
| SO_HistoryConsignmentNotes_RecIDIn | 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 |
|---|---|---|---|---|
| RecID | form | string | No | |
| Reference | form | string | No | |
| SO_History_InvoiceHistoryID | form | string | No | |
| FR_CarrierFreightDescriptions_RecID | form | string | No | |
| LastSavedDateTime | form | DateTime | No | |
| NumberItems | form | decimal | No | |
| ItemWeight | form | decimal | No | |
| ItemCubic | form | decimal | No | |
| ItemLength | form | decimal | No | |
| ItemWidth | form | decimal | No | |
| ItemHeight | form | decimal | No | |
| SO_HistoryConsignmentNotes_RecID | 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/SO_HistoryFreightItemsQuery 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"],"Reference":"String","ReferenceStartsWith":"String","ReferenceEndsWith":"String","ReferenceContains":"String","ReferenceLike":"String","ReferenceBetween":["String"],"ReferenceIn":["String"],"SO_History_InvoiceHistoryID":"String","SO_History_InvoiceHistoryIDStartsWith":"String","SO_History_InvoiceHistoryIDEndsWith":"String","SO_History_InvoiceHistoryIDContains":"String","SO_History_InvoiceHistoryIDLike":"String","SO_History_InvoiceHistoryIDBetween":["String"],"SO_History_InvoiceHistoryIDIn":["String"],"FR_CarrierFreightDescriptions_RecID":"String","FR_CarrierFreightDescriptions_RecIDStartsWith":"String","FR_CarrierFreightDescriptions_RecIDEndsWith":"String","FR_CarrierFreightDescriptions_RecIDContains":"String","FR_CarrierFreightDescriptions_RecIDLike":"String","FR_CarrierFreightDescriptions_RecIDBetween":["String"],"FR_CarrierFreightDescriptions_RecIDIn":["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"],"NumberItems":0,"NumberItemsGreaterThanOrEqualTo":0,"NumberItemsGreaterThan":0,"NumberItemsLessThan":0,"NumberItemsLessThanOrEqualTo":0,"NumberItemsNotEqualTo":0,"NumberItemsBetween":[0],"NumberItemsIn":[0],"ItemWeight":0,"ItemWeightGreaterThanOrEqualTo":0,"ItemWeightGreaterThan":0,"ItemWeightLessThan":0,"ItemWeightLessThanOrEqualTo":0,"ItemWeightNotEqualTo":0,"ItemWeightBetween":[0],"ItemWeightIn":[0],"ItemCubic":0,"ItemCubicGreaterThanOrEqualTo":0,"ItemCubicGreaterThan":0,"ItemCubicLessThan":0,"ItemCubicLessThanOrEqualTo":0,"ItemCubicNotEqualTo":0,"ItemCubicBetween":[0],"ItemCubicIn":[0],"ItemLength":0,"ItemLengthGreaterThanOrEqualTo":0,"ItemLengthGreaterThan":0,"ItemLengthLessThan":0,"ItemLengthLessThanOrEqualTo":0,"ItemLengthNotEqualTo":0,"ItemLengthBetween":[0],"ItemLengthIn":[0],"ItemWidth":0,"ItemWidthGreaterThanOrEqualTo":0,"ItemWidthGreaterThan":0,"ItemWidthLessThan":0,"ItemWidthLessThanOrEqualTo":0,"ItemWidthNotEqualTo":0,"ItemWidthBetween":[0],"ItemWidthIn":[0],"ItemHeight":0,"ItemHeightGreaterThanOrEqualTo":0,"ItemHeightGreaterThan":0,"ItemHeightLessThan":0,"ItemHeightLessThanOrEqualTo":0,"ItemHeightNotEqualTo":0,"ItemHeightBetween":[0],"ItemHeightIn":[0],"SO_HistoryConsignmentNotes_RecID":"String","SO_HistoryConsignmentNotes_RecIDStartsWith":"String","SO_HistoryConsignmentNotes_RecIDEndsWith":"String","SO_HistoryConsignmentNotes_RecIDContains":"String","SO_HistoryConsignmentNotes_RecIDLike":"String","SO_HistoryConsignmentNotes_RecIDBetween":["String"],"SO_HistoryConsignmentNotes_RecIDIn":["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":[{"RecID":"String","Reference":"String","SO_History_InvoiceHistoryID":"String","FR_CarrierFreightDescriptions_RecID":"String","SO_HistoryConsignmentNotes_RecID":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}