JiwaAPI

v_Jiwa_Debtor_ListQuery

The following routes are available for this service:
GET	/Queries/DebtorList	Retrieves a list of debtors

**v_Jiwa_Debtor_ListQuery** Parameters:
Name	Parameter	Data Type	Required
DebtorID	query	string	No
DebtorIDStartsWith	query	string	No
DebtorIDEndsWith	query	string	No
DebtorIDContains	query	string	No
DebtorIDLike	query	string	No
DebtorIDBetween	query	string[]	No
DebtorIDIn	query	string[]	No
AccountNo	query	string	No
AccountNoStartsWith	query	string	No
AccountNoEndsWith	query	string	No
AccountNoContains	query	string	No
AccountNoLike	query	string	No
AccountNoBetween	query	string[]	No
AccountNoIn	query	string[]	No
Name	query	string	No
NameStartsWith	query	string	No
NameEndsWith	query	string	No
NameContains	query	string	No
NameLike	query	string	No
NameBetween	query	string[]	No
NameIn	query	string[]	No
AltAccountNo	query	string	No
AltAccountNoStartsWith	query	string	No
AltAccountNoEndsWith	query	string	No
AltAccountNoContains	query	string	No
AltAccountNoLike	query	string	No
AltAccountNoBetween	query	string[]	No
AltAccountNoIn	query	string[]	No
Address1	query	string	No
Address1StartsWith	query	string	No
Address1EndsWith	query	string	No
Address1Contains	query	string	No
Address1Like	query	string	No
Address1Between	query	string[]	No
Address1In	query	string[]	No
Address2	query	string	No
Address2StartsWith	query	string	No
Address2EndsWith	query	string	No
Address2Contains	query	string	No
Address2Like	query	string	No
Address2Between	query	string[]	No
Address2In	query	string[]	No
Address3	query	string	No
Address3StartsWith	query	string	No
Address3EndsWith	query	string	No
Address3Contains	query	string	No
Address3Like	query	string	No
Address3Between	query	string[]	No
Address3In	query	string[]	No
Address4	query	string	No
Address4StartsWith	query	string	No
Address4EndsWith	query	string	No
Address4Contains	query	string	No
Address4Like	query	string	No
Address4Between	query	string[]	No
Address4In	query	string[]	No
PostCode	query	string	No
PostCodeStartsWith	query	string	No
PostCodeEndsWith	query	string	No
PostCodeContains	query	string	No
PostCodeLike	query	string	No
PostCodeBetween	query	string[]	No
PostCodeIn	query	string[]	No
Country	query	string	No
CountryStartsWith	query	string	No
CountryEndsWith	query	string	No
CountryContains	query	string	No
CountryLike	query	string	No
CountryBetween	query	string[]	No
CountryIn	query	string[]	No
Phone	query	string	No
PhoneStartsWith	query	string	No
PhoneEndsWith	query	string	No
PhoneContains	query	string	No
PhoneLike	query	string	No
PhoneBetween	query	string[]	No
PhoneIn	query	string[]	No
AccountOnHold	query	bool?	No
EmailAddress	query	string	No
EmailAddressStartsWith	query	string	No
EmailAddressEndsWith	query	string	No
EmailAddressContains	query	string	No
EmailAddressLike	query	string	No
EmailAddressBetween	query	string[]	No
EmailAddressIn	query	string[]	No
CurrentBalance	query	decimal?	No
CurrentBalanceGreaterThanOrEqualTo	query	decimal?	No
CurrentBalanceGreaterThan	query	decimal?	No
CurrentBalanceLessThan	query	decimal?	No
CurrentBalanceLessThanOrEqualTo	query	decimal?	No
CurrentBalanceNotEqualTo	query	decimal?	No
CurrentBalanceBetween	query	Nullable<Decimal>[]	No
CurrentBalanceIn	query	Nullable<Decimal>[]	No
WebAccess	query	bool?	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	Nullable<DateTime>[]	No
LastSavedDateTimeIn	query	Nullable<DateTime>[]	No
TradingStatus	query	byte?	No
TradingStatusGreaterThanOrEqualTo	query	byte?	No
TradingStatusGreaterThan	query	byte?	No
TradingStatusLessThan	query	byte?	No
TradingStatusLessThanOrEqualTo	query	byte?	No
TradingStatusNotEqualTo	query	byte?	No
TradingStatusBetween	query	Nullable<Byte>[]	No
TradingStatusIn	query	Nullable<Byte>[]	No
DebtorClassificationID	query	string	No
DebtorClassificationIDStartsWith	query	string	No
DebtorClassificationIDEndsWith	query	string	No
DebtorClassificationIDContains	query	string	No
DebtorClassificationIDLike	query	string	No
DebtorClassificationIDBetween	query	string[]	No
DebtorClassificationIDIn	query	string[]	No
ClassificationDescription	query	string	No
ClassificationDescriptionStartsWith	query	string	No
ClassificationDescriptionEndsWith	query	string	No
ClassificationDescriptionContains	query	string	No
ClassificationDescriptionLike	query	string	No
ClassificationDescriptionBetween	query	string[]	No
ClassificationDescriptionIn	query	string[]	No
Category1ID	query	string	No
Category1IDStartsWith	query	string	No
Category1IDEndsWith	query	string	No
Category1IDContains	query	string	No
Category1IDLike	query	string	No
Category1IDBetween	query	string[]	No
Category1IDIn	query	string[]	No
Category1Description	query	string	No
Category1DescriptionStartsWith	query	string	No
Category1DescriptionEndsWith	query	string	No
Category1DescriptionContains	query	string	No
Category1DescriptionLike	query	string	No
Category1DescriptionBetween	query	string[]	No
Category1DescriptionIn	query	string[]	No
Category2ID	query	string	No
Category2IDStartsWith	query	string	No
Category2IDEndsWith	query	string	No
Category2IDContains	query	string	No
Category2IDLike	query	string	No
Category2IDBetween	query	string[]	No
Category2IDIn	query	string[]	No
Category2Description	query	string	No
Category2DescriptionStartsWith	query	string	No
Category2DescriptionEndsWith	query	string	No
Category2DescriptionContains	query	string	No
Category2DescriptionLike	query	string	No
Category2DescriptionBetween	query	string[]	No
Category2DescriptionIn	query	string[]	No
Category3ID	query	string	No
Category3IDStartsWith	query	string	No
Category3IDEndsWith	query	string	No
Category3IDContains	query	string	No
Category3IDLike	query	string	No
Category3IDBetween	query	string[]	No
Category3IDIn	query	string[]	No
Category3Description	query	string	No
Category3DescriptionStartsWith	query	string	No
Category3DescriptionEndsWith	query	string	No
Category3DescriptionContains	query	string	No
Category3DescriptionLike	query	string	No
Category3DescriptionBetween	query	string[]	No
Category3DescriptionIn	query	string[]	No
Category4ID	query	string	No
Category4IDStartsWith	query	string	No
Category4IDEndsWith	query	string	No
Category4IDContains	query	string	No
Category4IDLike	query	string	No
Category4IDBetween	query	string[]	No
Category4IDIn	query	string[]	No
Category4Description	query	string	No
Category4DescriptionStartsWith	query	string	No
Category4DescriptionEndsWith	query	string	No
Category4DescriptionContains	query	string	No
Category4DescriptionLike	query	string	No
Category4DescriptionBetween	query	string[]	No
Category4DescriptionIn	query	string[]	No
Category5ID	query	string	No
Category5IDStartsWith	query	string	No
Category5IDEndsWith	query	string	No
Category5IDContains	query	string	No
Category5IDLike	query	string	No
Category5IDBetween	query	string[]	No
Category5IDIn	query	string[]	No
Category5Description	query	string	No
Category5DescriptionStartsWith	query	string	No
Category5DescriptionEndsWith	query	string	No
Category5DescriptionContains	query	string	No
Category5DescriptionLike	query	string	No
Category5DescriptionBetween	query	string[]	No
Category5DescriptionIn	query	string[]	No
PriceSchemeID	query	string	No
PriceSchemeIDStartsWith	query	string	No
PriceSchemeIDEndsWith	query	string	No
PriceSchemeIDContains	query	string	No
PriceSchemeIDLike	query	string	No
PriceSchemeIDBetween	query	string[]	No
PriceSchemeIDIn	query	string[]	No
PriceSchemeDescription	query	string	No
PriceSchemeDescriptionStartsWith	query	string	No
PriceSchemeDescriptionEndsWith	query	string	No
PriceSchemeDescriptionContains	query	string	No
PriceSchemeDescriptionLike	query	string	No
PriceSchemeDescriptionBetween	query	string[]	No
PriceSchemeDescriptionIn	query	string[]	No
PricingGroupDescription	query	string	No
PricingGroupDescriptionStartsWith	query	string	No
PricingGroupDescriptionEndsWith	query	string	No
PricingGroupDescriptionContains	query	string	No
PricingGroupDescriptionLike	query	string	No
PricingGroupDescriptionBetween	query	string[]	No
PricingGroupDescriptionIn	query	string[]	No

**QueryBase** Parameters:
Name	Parameter	Data Type	Required
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

**v_Jiwa_Debtor_List** Parameters:
Name	Parameter	Data Type	Required
DebtorID	form	string	No
AccountNo	form	string	No
Name	form	string	No
AltAccountNo	form	string	No
Address1	form	string	No
Address2	form	string	No
Address3	form	string	No
Address4	form	string	No
PostCode	form	string	No
Country	form	string	No
Phone	form	string	No
AccountOnHold	form	bool?	No
EmailAddress	form	string	No
CurrentBalance	form	decimal?	No
WebAccess	form	bool	No
LastSavedDateTime	form	DateTime?	No
TradingStatus	form	byte?	No
DebtorClassificationID	form	string	No
ClassificationDescription	form	string	No
Category1ID	form	string	No
Category1Description	form	string	No
Category2ID	form	string	No
Category2Description	form	string	No
Category3ID	form	string	No
Category3Description	form	string	No
Category4ID	form	string	No
Category4Description	form	string	No
Category5ID	form	string	No
Category5Description	form	string	No
PriceSchemeID	form	string	No
PriceSchemeDescription	form	string	No
PricingGroupDescription	form	string	No

**QueryResponse<T>** Parameters:
Name	Parameter	Data Type	Required
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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Queries/DebtorList HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Results":[{"DebtorID":"String","AccountNo":"String","Name":"String","AltAccountNo":"String","Address1":"String","Address2":"String","Address3":"String","Address4":"String","PostCode":"String","Country":"String","Phone":"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","PricingGroupDescription":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}