JiwaAPI

<back to all web services

v_Jiwa_GL_PeriodsFromSO_SalesHistoryQuery

Requires Authentication
v_Jiwa_GL_PeriodsFromSO_SalesHistoryQuery Parameters:
NameParameterData TypeRequiredDescription
Year_Noqueryshort?No
Year_NoGreaterThanOrEqualToqueryshort?No
Year_NoGreaterThanqueryshort?No
Year_NoLessThanqueryshort?No
Year_NoLessThanOrEqualToqueryshort?No
Year_NoNotEqualToqueryshort?No
Year_NoBetweenqueryNullable<Int16>[]No
Year_NoInqueryNullable<Int16>[]No
Period_NamequerystringNo
Period_NameStartsWithquerystringNo
Period_NameEndsWithquerystringNo
Period_NameContainsquerystringNo
Period_NameLikequerystringNo
Period_NameBetweenquerystring[]No
Period_NameInquerystring[]No
Period_Start_DatequeryDateTime?No
Period_Start_DateGreaterThanOrEqualToqueryDateTime?No
Period_Start_DateGreaterThanqueryDateTime?No
Period_Start_DateLessThanqueryDateTime?No
Period_Start_DateLessThanOrEqualToqueryDateTime?No
Period_Start_DateNotEqualToqueryDateTime?No
Period_Start_DateBetweenqueryNullable<DateTime>[]No
Period_Start_DateInqueryNullable<DateTime>[]No
Period_End_DatequeryDateTime?No
Period_End_DateGreaterThanOrEqualToqueryDateTime?No
Period_End_DateGreaterThanqueryDateTime?No
Period_End_DateLessThanqueryDateTime?No
Period_End_DateLessThanOrEqualToqueryDateTime?No
Period_End_DateNotEqualToqueryDateTime?No
Period_End_DateBetweenqueryNullable<DateTime>[]No
Period_End_DateInqueryNullable<DateTime>[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
v_Jiwa_GL_PeriodsFromSO_SalesHistory Parameters:
NameParameterData TypeRequiredDescription
Year_Noformshort?No
Period_NameformstringNo
Period_Start_DateformDateTime?No
Period_End_DateformDateTime?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/v_Jiwa_GL_PeriodsFromSO_SalesHistoryQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Year_No":0,"Year_NoGreaterThanOrEqualTo":0,"Year_NoGreaterThan":0,"Year_NoLessThan":0,"Year_NoLessThanOrEqualTo":0,"Year_NoNotEqualTo":0,"Year_NoBetween":[0],"Year_NoIn":[0],"Period_Name":"String","Period_NameStartsWith":"String","Period_NameEndsWith":"String","Period_NameContains":"String","Period_NameLike":"String","Period_NameBetween":["String"],"Period_NameIn":["String"],"Period_Start_Date":"0001-01-01T00:00:00.0000000","Period_Start_DateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","Period_Start_DateGreaterThan":"0001-01-01T00:00:00.0000000","Period_Start_DateLessThan":"0001-01-01T00:00:00.0000000","Period_Start_DateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","Period_Start_DateNotEqualTo":"0001-01-01T00:00:00.0000000","Period_Start_DateBetween":["0001-01-01T00:00:00.0000000"],"Period_Start_DateIn":["0001-01-01T00:00:00.0000000"],"Period_End_Date":"0001-01-01T00:00:00.0000000","Period_End_DateGreaterThanOrEqualTo":"0001-01-01T00:00:00.0000000","Period_End_DateGreaterThan":"0001-01-01T00:00:00.0000000","Period_End_DateLessThan":"0001-01-01T00:00:00.0000000","Period_End_DateLessThanOrEqualTo":"0001-01-01T00:00:00.0000000","Period_End_DateNotEqualTo":"0001-01-01T00:00:00.0000000","Period_End_DateBetween":["0001-01-01T00:00:00.0000000"],"Period_End_DateIn":["0001-01-01T00:00:00.0000000"],"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":[{"Year_No":0,"Period_Name":"String","Period_Start_Date":"0001-01-01T00:00:00.0000000","Period_End_Date":"0001-01-01T00:00:00.0000000"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}