JiwaAPI

<back to all web services

v_Oscar_DebtorsQuery

Requires Authentication
The following routes are available for this service:
GET/Queries/OscarDebtorsQueryable list of debtors with default delivery address and contact name for Oscar
v_Oscar_DebtorsQuery Parameters:
NameParameterData TypeRequiredDescription
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
AltAccountNoquerystringNo
AltAccountNoStartsWithquerystringNo
AltAccountNoEndsWithquerystringNo
AltAccountNoContainsquerystringNo
AltAccountNoLikequerystringNo
AltAccountNoBetweenquerystring[]No
AltAccountNoInquerystring[]No
MailingAddress1querystringNo
MailingAddress1StartsWithquerystringNo
MailingAddress1EndsWithquerystringNo
MailingAddress1ContainsquerystringNo
MailingAddress1LikequerystringNo
MailingAddress1Betweenquerystring[]No
MailingAddress1Inquerystring[]No
MailingAddress2querystringNo
MailingAddress2StartsWithquerystringNo
MailingAddress2EndsWithquerystringNo
MailingAddress2ContainsquerystringNo
MailingAddress2LikequerystringNo
MailingAddress2Betweenquerystring[]No
MailingAddress2Inquerystring[]No
MailingAddress3querystringNo
MailingAddress3StartsWithquerystringNo
MailingAddress3EndsWithquerystringNo
MailingAddress3ContainsquerystringNo
MailingAddress3LikequerystringNo
MailingAddress3Betweenquerystring[]No
MailingAddress3Inquerystring[]No
MailingAddress4querystringNo
MailingAddress4StartsWithquerystringNo
MailingAddress4EndsWithquerystringNo
MailingAddress4ContainsquerystringNo
MailingAddress4LikequerystringNo
MailingAddress4Betweenquerystring[]No
MailingAddress4Inquerystring[]No
MailingAddressPostcodequerystringNo
MailingAddressPostcodeStartsWithquerystringNo
MailingAddressPostcodeEndsWithquerystringNo
MailingAddressPostcodeContainsquerystringNo
MailingAddressPostcodeLikequerystringNo
MailingAddressPostcodeBetweenquerystring[]No
MailingAddressPostcodeInquerystring[]No
MailingAddressCountryquerystringNo
MailingAddressCountryStartsWithquerystringNo
MailingAddressCountryEndsWithquerystringNo
MailingAddressCountryContainsquerystringNo
MailingAddressCountryLikequerystringNo
MailingAddressCountryBetweenquerystring[]No
MailingAddressCountryInquerystring[]No
MailingAddressPhonequerystringNo
MailingAddressPhoneStartsWithquerystringNo
MailingAddressPhoneEndsWithquerystringNo
MailingAddressPhoneContainsquerystringNo
MailingAddressPhoneLikequerystringNo
MailingAddressPhoneBetweenquerystring[]No
MailingAddressPhoneInquerystring[]No
DeliveryAddressNamequerystringNo
DeliveryAddressNameStartsWithquerystringNo
DeliveryAddressNameEndsWithquerystringNo
DeliveryAddressNameContainsquerystringNo
DeliveryAddressNameLikequerystringNo
DeliveryAddressNameBetweenquerystring[]No
DeliveryAddressNameInquerystring[]No
DeliveryAddressCodequerystringNo
DeliveryAddressCodeStartsWithquerystringNo
DeliveryAddressCodeEndsWithquerystringNo
DeliveryAddressCodeContainsquerystringNo
DeliveryAddressCodeLikequerystringNo
DeliveryAddressCodeBetweenquerystring[]No
DeliveryAddressCodeInquerystring[]No
DeliveryAddress1querystringNo
DeliveryAddress1StartsWithquerystringNo
DeliveryAddress1EndsWithquerystringNo
DeliveryAddress1ContainsquerystringNo
DeliveryAddress1LikequerystringNo
DeliveryAddress1Betweenquerystring[]No
DeliveryAddress1Inquerystring[]No
DeliveryAddress2querystringNo
DeliveryAddress2StartsWithquerystringNo
DeliveryAddress2EndsWithquerystringNo
DeliveryAddress2ContainsquerystringNo
DeliveryAddress2LikequerystringNo
DeliveryAddress2Betweenquerystring[]No
DeliveryAddress2Inquerystring[]No
DeliveryAddress3querystringNo
DeliveryAddress3StartsWithquerystringNo
DeliveryAddress3EndsWithquerystringNo
DeliveryAddress3ContainsquerystringNo
DeliveryAddress3LikequerystringNo
DeliveryAddress3Betweenquerystring[]No
DeliveryAddress3Inquerystring[]No
DeliveryAddress4querystringNo
DeliveryAddress4StartsWithquerystringNo
DeliveryAddress4EndsWithquerystringNo
DeliveryAddress4ContainsquerystringNo
DeliveryAddress4LikequerystringNo
DeliveryAddress4Betweenquerystring[]No
DeliveryAddress4Inquerystring[]No
DeliveryAddressPostcodequerystringNo
DeliveryAddressPostcodeStartsWithquerystringNo
DeliveryAddressPostcodeEndsWithquerystringNo
DeliveryAddressPostcodeContainsquerystringNo
DeliveryAddressPostcodeLikequerystringNo
DeliveryAddressPostcodeBetweenquerystring[]No
DeliveryAddressPostcodeInquerystring[]No
DeliveryAddressCountryquerystringNo
DeliveryAddressCountryStartsWithquerystringNo
DeliveryAddressCountryEndsWithquerystringNo
DeliveryAddressCountryContainsquerystringNo
DeliveryAddressCountryLikequerystringNo
DeliveryAddressCountryBetweenquerystring[]No
DeliveryAddressCountryInquerystring[]No
AccountOnHoldquerybool?No
EmailAddressquerystringNo
EmailAddressStartsWithquerystringNo
EmailAddressEndsWithquerystringNo
EmailAddressContainsquerystringNo
EmailAddressLikequerystringNo
EmailAddressBetweenquerystring[]No
EmailAddressInquerystring[]No
CurrentBalancequerydecimal?No
CurrentBalanceGreaterThanOrEqualToquerydecimal?No
CurrentBalanceGreaterThanquerydecimal?No
CurrentBalanceLessThanquerydecimal?No
CurrentBalanceLessThanOrEqualToquerydecimal?No
CurrentBalanceNotEqualToquerydecimal?No
CurrentBalanceBetweenqueryNullable<Decimal>[]No
CurrentBalanceInqueryNullable<Decimal>[]No
WebAccessquerybool?No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryNullable<DateTime>[]No
LastSavedDateTimeInqueryNullable<DateTime>[]No
TradingStatusquerybyte?No
TradingStatusGreaterThanOrEqualToquerybyte?No
TradingStatusGreaterThanquerybyte?No
TradingStatusLessThanquerybyte?No
TradingStatusLessThanOrEqualToquerybyte?No
TradingStatusNotEqualToquerybyte?No
TradingStatusBetweenqueryNullable<Byte>[]No
TradingStatusInqueryNullable<Byte>[]No
DebtorClassificationIDquerystringNo
DebtorClassificationIDStartsWithquerystringNo
DebtorClassificationIDEndsWithquerystringNo
DebtorClassificationIDContainsquerystringNo
DebtorClassificationIDLikequerystringNo
DebtorClassificationIDBetweenquerystring[]No
DebtorClassificationIDInquerystring[]No
ClassificationDescriptionquerystringNo
ClassificationDescriptionStartsWithquerystringNo
ClassificationDescriptionEndsWithquerystringNo
ClassificationDescriptionContainsquerystringNo
ClassificationDescriptionLikequerystringNo
ClassificationDescriptionBetweenquerystring[]No
ClassificationDescriptionInquerystring[]No
Category1IDquerystringNo
Category1IDStartsWithquerystringNo
Category1IDEndsWithquerystringNo
Category1IDContainsquerystringNo
Category1IDLikequerystringNo
Category1IDBetweenquerystring[]No
Category1IDInquerystring[]No
Category1DescriptionquerystringNo
Category1DescriptionStartsWithquerystringNo
Category1DescriptionEndsWithquerystringNo
Category1DescriptionContainsquerystringNo
Category1DescriptionLikequerystringNo
Category1DescriptionBetweenquerystring[]No
Category1DescriptionInquerystring[]No
Category2IDquerystringNo
Category2IDStartsWithquerystringNo
Category2IDEndsWithquerystringNo
Category2IDContainsquerystringNo
Category2IDLikequerystringNo
Category2IDBetweenquerystring[]No
Category2IDInquerystring[]No
Category2DescriptionquerystringNo
Category2DescriptionStartsWithquerystringNo
Category2DescriptionEndsWithquerystringNo
Category2DescriptionContainsquerystringNo
Category2DescriptionLikequerystringNo
Category2DescriptionBetweenquerystring[]No
Category2DescriptionInquerystring[]No
Category3IDquerystringNo
Category3IDStartsWithquerystringNo
Category3IDEndsWithquerystringNo
Category3IDContainsquerystringNo
Category3IDLikequerystringNo
Category3IDBetweenquerystring[]No
Category3IDInquerystring[]No
Category3DescriptionquerystringNo
Category3DescriptionStartsWithquerystringNo
Category3DescriptionEndsWithquerystringNo
Category3DescriptionContainsquerystringNo
Category3DescriptionLikequerystringNo
Category3DescriptionBetweenquerystring[]No
Category3DescriptionInquerystring[]No
Category4IDquerystringNo
Category4IDStartsWithquerystringNo
Category4IDEndsWithquerystringNo
Category4IDContainsquerystringNo
Category4IDLikequerystringNo
Category4IDBetweenquerystring[]No
Category4IDInquerystring[]No
Category4DescriptionquerystringNo
Category4DescriptionStartsWithquerystringNo
Category4DescriptionEndsWithquerystringNo
Category4DescriptionContainsquerystringNo
Category4DescriptionLikequerystringNo
Category4DescriptionBetweenquerystring[]No
Category4DescriptionInquerystring[]No
Category5IDquerystringNo
Category5IDStartsWithquerystringNo
Category5IDEndsWithquerystringNo
Category5IDContainsquerystringNo
Category5IDLikequerystringNo
Category5IDBetweenquerystring[]No
Category5IDInquerystring[]No
Category5DescriptionquerystringNo
Category5DescriptionStartsWithquerystringNo
Category5DescriptionEndsWithquerystringNo
Category5DescriptionContainsquerystringNo
Category5DescriptionLikequerystringNo
Category5DescriptionBetweenquerystring[]No
Category5DescriptionInquerystring[]No
PriceSchemeIDquerystringNo
PriceSchemeIDStartsWithquerystringNo
PriceSchemeIDEndsWithquerystringNo
PriceSchemeIDContainsquerystringNo
PriceSchemeIDLikequerystringNo
PriceSchemeIDBetweenquerystring[]No
PriceSchemeIDInquerystring[]No
PriceSchemeDescriptionquerystringNo
PriceSchemeDescriptionStartsWithquerystringNo
PriceSchemeDescriptionEndsWithquerystringNo
PriceSchemeDescriptionContainsquerystringNo
PriceSchemeDescriptionLikequerystringNo
PriceSchemeDescriptionBetweenquerystring[]No
PriceSchemeDescriptionInquerystring[]No
PricingGroupIDquerystringNo
PricingGroupIDStartsWithquerystringNo
PricingGroupIDEndsWithquerystringNo
PricingGroupIDContainsquerystringNo
PricingGroupIDLikequerystringNo
PricingGroupIDBetweenquerystring[]No
PricingGroupIDInquerystring[]No
PricingGroupDescriptionquerystringNo
PricingGroupDescriptionStartsWithquerystringNo
PricingGroupDescriptionEndsWithquerystringNo
PricingGroupDescriptionContainsquerystringNo
PricingGroupDescriptionLikequerystringNo
PricingGroupDescriptionBetweenquerystring[]No
PricingGroupDescriptionInquerystring[]No
ContactTitlequerystringNo
ContactTitleStartsWithquerystringNo
ContactTitleEndsWithquerystringNo
ContactTitleContainsquerystringNo
ContactTitleLikequerystringNo
ContactTitleBetweenquerystring[]No
ContactTitleInquerystring[]No
ContactFirstNamequerystringNo
ContactFirstNameStartsWithquerystringNo
ContactFirstNameEndsWithquerystringNo
ContactFirstNameContainsquerystringNo
ContactFirstNameLikequerystringNo
ContactFirstNameBetweenquerystring[]No
ContactFirstNameInquerystring[]No
ContactSurnamequerystringNo
ContactSurnameStartsWithquerystringNo
ContactSurnameEndsWithquerystringNo
ContactSurnameContainsquerystringNo
ContactSurnameLikequerystringNo
ContactSurnameBetweenquerystring[]No
ContactSurnameInquerystring[]No
ContactEmailAddressquerystringNo
ContactEmailAddressStartsWithquerystringNo
ContactEmailAddressEndsWithquerystringNo
ContactEmailAddressContainsquerystringNo
ContactEmailAddressLikequerystringNo
ContactEmailAddressBetweenquerystring[]No
ContactEmailAddressInquerystring[]No
ContactTelephonequerystringNo
ContactTelephoneStartsWithquerystringNo
ContactTelephoneEndsWithquerystringNo
ContactTelephoneContainsquerystringNo
ContactTelephoneLikequerystringNo
ContactTelephoneBetweenquerystring[]No
ContactTelephoneInquerystring[]No
ContactMobileTelephonequerystringNo
ContactMobileTelephoneStartsWithquerystringNo
ContactMobileTelephoneEndsWithquerystringNo
ContactMobileTelephoneContainsquerystringNo
ContactMobileTelephoneLikequerystringNo
ContactMobileTelephoneBetweenquerystring[]No
ContactMobileTelephoneInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
v_Oscar_Debtors Parameters:
NameParameterData TypeRequiredDescription
DebtorIDformstringNo
AccountNoformstringNo
NameformstringNo
AltAccountNoformstringNo
MailingAddress1formstringNo
MailingAddress2formstringNo
MailingAddress3formstringNo
MailingAddress4formstringNo
MailingAddressPostcodeformstringNo
MailingAddressCountryformstringNo
MailingAddressPhoneformstringNo
DeliveryAddressNameformstringNo
DeliveryAddressCodeformstringNo
DeliveryAddress1formstringNo
DeliveryAddress2formstringNo
DeliveryAddress3formstringNo
DeliveryAddress4formstringNo
DeliveryAddressPostcodeformstringNo
DeliveryAddressCountryformstringNo
AccountOnHoldformbool?No
EmailAddressformstringNo
CurrentBalanceformdecimal?No
WebAccessformboolNo
LastSavedDateTimeformDateTime?No
TradingStatusformbyte?No
DebtorClassificationIDformstringNo
ClassificationDescriptionformstringNo
Category1IDformstringNo
Category1DescriptionformstringNo
Category2IDformstringNo
Category2DescriptionformstringNo
Category3IDformstringNo
Category3DescriptionformstringNo
Category4IDformstringNo
Category4DescriptionformstringNo
Category5IDformstringNo
Category5DescriptionformstringNo
PriceSchemeIDformstringNo
PriceSchemeDescriptionformstringNo
PricingGroupIDformstringNo
PricingGroupDescriptionformstringNo
ContactTitleformstringNo
ContactFirstNameformstringNo
ContactSurnameformstringNo
ContactEmailAddressformstringNo
ContactTelephoneformstringNo
ContactMobileTelephoneformstringNo
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.

GET /Queries/OscarDebtors HTTP/1.1 
Host: 10.150.151.12 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Results":[{"DebtorID":"String","AccountNo":"String","Name":"String","AltAccountNo":"String","MailingAddress1":"String","MailingAddress2":"String","MailingAddress3":"String","MailingAddress4":"String","MailingAddressPostcode":"String","MailingAddressCountry":"String","MailingAddressPhone":"String","DeliveryAddressName":"String","DeliveryAddressCode":"String","DeliveryAddress1":"String","DeliveryAddress2":"String","DeliveryAddress3":"String","DeliveryAddress4":"String","DeliveryAddressPostcode":"String","DeliveryAddressCountry":"String","AccountOnHold":false,"EmailAddress":"String","CurrentBalance":0,"LastSavedDateTime":"0001-01-01T00:00:00.0000000","TradingStatus":0,"DebtorClassificationID":"String","ClassificationDescription":"String","Category1ID":"String","Category1Description":"String","Category2ID":"String","Category2Description":"String","Category3ID":"String","Category3Description":"String","Category4ID":"String","Category4Description":"String","Category5ID":"String","Category5Description":"String","PriceSchemeID":"String","PriceSchemeDescription":"String","PricingGroupID":"String","PricingGroupDescription":"String","ContactTitle":"String","ContactFirstName":"String","ContactSurname":"String","ContactEmailAddress":"String","ContactTelephone":"String","ContactMobileTelephone":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}