JiwaAPI

<back to all web services

sh_DebtorQuery

Requires Authentication
The following routes are available for this service:
GET/Queries/sh_DebtorsRetrieves a list of sh debtors
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
sh_Debtor Parameters:
NameParameterData TypeRequiredDescription
DebtorIDformstringNo
LastSavedDateTimeformDateTimeNo
AccountNoformstringNo
NameformstringNo
Address1formstringNo
Address2formstringNo
Address3formstringNo
Address4formstringNo
PostCodeformstringNo
PhoneformstringNo
FaxformstringNo
BSBNformstringNo
AccountNameformstringNo
TaxExemptNoformstringNo
CreditLimitformdecimal?No
ClassificationIDformstringNo
ClassificationformstringNo
AccountOnHoldformbool?No
EmailAddressformstringNo
CurrentBalanceformdecimal?No
AltAccountNoformstringNo
NotifyRequiredformboolNo
NotifyAddressformstringNo
CommenceDateformDateTime?No
WebAccessformboolNo
ParentDebtorIDformstringNo
AllocLastSavedDateTimeformDateTime?No
PriceSchemeIDformstringNo
AustPostDPIDformstringNo
AustPostBCSPformstringNo
TradingNameformstringNo
CompanyNameformstringNo
ACNformstringNo
ProprietorsNameformstringNo
PeriodTypeformshort?No
TermsDaysformshort?No
TermsTypeformshort?No
ABNformstringNo
BPayReferenceformstringNo
TradingStatusformbyte?No
IndustryIDformstringNo
IndustryNameformstringNo
AccountSizeIDformstringNo
AccountSizeNameformstringNo
Category3IDformstringNo
Category4IDformstringNo
Category5IDformstringNo
BO_Priorities_RecIDformstringNo
PricingGroupIDformstringNo
BudgetedGPPercentageformdecimal?No
CountryformstringNo
FR_Carriers_RecIDformstringNo
FR_CarrierServices_RecIDformstringNo
CarrierAccountNoformstringNo
ChargeToformbyteNo
IsCashOnlyformboolNo
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/sh_Debtors HTTP/1.1 
Host: localhost 
Accept: text/csv

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

{"Results":[{"DebtorID":"String","AccountNo":"String","Name":"String","Address1":"String","Address2":"String","Address3":"String","Address4":"String","PostCode":"String","Phone":"String","Fax":"String","BSBN":"String","AccountName":"String","TaxExemptNo":"String","CreditLimit":0,"ClassificationID":"String","Classification":"String","AccountOnHold":false,"EmailAddress":"String","CurrentBalance":0,"AltAccountNo":"String","NotifyAddress":"String","CommenceDate":"0001-01-01T00:00:00.0000000","ParentDebtorID":"String","AllocLastSavedDateTime":"0001-01-01T00:00:00.0000000","PriceSchemeID":"String","AustPostDPID":"String","AustPostBCSP":"String","TradingName":"String","CompanyName":"String","ACN":"String","ProprietorsName":"String","PeriodType":0,"TermsDays":0,"TermsType":0,"ABN":"String","BPayReference":"String","TradingStatus":0,"IndustryID":"String","IndustryName":"String","AccountSizeID":"String","AccountSizeName":"String","Category3ID":"String","Category4ID":"String","Category5ID":"String","BO_Priorities_RecID":"String","PricingGroupID":"String","BudgetedGPPercentage":0,"Country":"String","FR_Carriers_RecID":"String","FR_CarrierServices_RecID":"String","CarrierAccountNo":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}