JiwaAPI

sh_DebtorQuery

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

**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

**sh_Debtor** Parameters:
Name	Parameter	Data Type	Required
DebtorID	form	string	No
LastSavedDateTime	form	DateTime	No
AccountNo	form	string	No
Name	form	string	No
Address1	form	string	No
Address2	form	string	No
Address3	form	string	No
Address4	form	string	No
PostCode	form	string	No
Phone	form	string	No
Fax	form	string	No
BSBN	form	string	No
AccountName	form	string	No
TaxExemptNo	form	string	No
CreditLimit	form	decimal?	No
ClassificationID	form	string	No
Classification	form	string	No
AccountOnHold	form	bool?	No
EmailAddress	form	string	No
CurrentBalance	form	decimal?	No
AltAccountNo	form	string	No
NotifyRequired	form	bool	No
NotifyAddress	form	string	No
CommenceDate	form	DateTime?	No
WebAccess	form	bool	No
ParentDebtorID	form	string	No
AllocLastSavedDateTime	form	DateTime?	No
PriceSchemeID	form	string	No
AustPostDPID	form	string	No
AustPostBCSP	form	string	No
TradingName	form	string	No
CompanyName	form	string	No
ACN	form	string	No
ProprietorsName	form	string	No
PeriodType	form	short?	No
TermsDays	form	short?	No
TermsType	form	short?	No
ABN	form	string	No
BPayReference	form	string	No
TradingStatus	form	byte?	No
IndustryID	form	string	No
IndustryName	form	string	No
AccountSizeID	form	string	No
AccountSizeName	form	string	No
Category3ID	form	string	No
Category4ID	form	string	No
Category5ID	form	string	No
BO_Priorities_RecID	form	string	No
PricingGroupID	form	string	No
BudgetedGPPercentage	form	decimal?	No
Country	form	string	No
FR_Carriers_RecID	form	string	No
FR_CarrierServices_RecID	form	string	No
CarrierAccountNo	form	string	No
ChargeTo	form	byte	No
IsCashOnly	form	bool	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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfsh_Debtor4i7vAI15 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/StottHoare.Jiwa.CustomRoutes">
    <d2p1:sh_Debtor>
      <d2p1:ABN>String</d2p1:ABN>
      <d2p1:ACN>String</d2p1:ACN>
      <d2p1:AccountName>String</d2p1:AccountName>
      <d2p1:AccountNo>String</d2p1:AccountNo>
      <d2p1:AccountOnHold>false</d2p1:AccountOnHold>
      <d2p1:AccountSizeID>String</d2p1:AccountSizeID>
      <d2p1:AccountSizeName>String</d2p1:AccountSizeName>
      <d2p1:Address1>String</d2p1:Address1>
      <d2p1:Address2>String</d2p1:Address2>
      <d2p1:Address3>String</d2p1:Address3>
      <d2p1:Address4>String</d2p1:Address4>
      <d2p1:AllocLastSavedDateTime>0001-01-01T00:00:00</d2p1:AllocLastSavedDateTime>
      <d2p1:AltAccountNo>String</d2p1:AltAccountNo>
      <d2p1:AustPostBCSP>String</d2p1:AustPostBCSP>
      <d2p1:AustPostDPID>String</d2p1:AustPostDPID>
      <d2p1:BO_Priorities_RecID>String</d2p1:BO_Priorities_RecID>
      <d2p1:BPayReference>String</d2p1:BPayReference>
      <d2p1:BSBN>String</d2p1:BSBN>
      <d2p1:BudgetedGPPercentage>0</d2p1:BudgetedGPPercentage>
      <d2p1:CarrierAccountNo>String</d2p1:CarrierAccountNo>
      <d2p1:Category3ID>String</d2p1:Category3ID>
      <d2p1:Category4ID>String</d2p1:Category4ID>
      <d2p1:Category5ID>String</d2p1:Category5ID>
      <d2p1:ChargeTo>0</d2p1:ChargeTo>
      <d2p1:Classification>String</d2p1:Classification>
      <d2p1:ClassificationID>String</d2p1:ClassificationID>
      <d2p1:CommenceDate>0001-01-01T00:00:00</d2p1:CommenceDate>
      <d2p1:CompanyName>String</d2p1:CompanyName>
      <d2p1:Country>String</d2p1:Country>
      <d2p1:CreditLimit>0</d2p1:CreditLimit>
      <d2p1:CurrentBalance>0</d2p1:CurrentBalance>
      <d2p1:DebtorID>String</d2p1:DebtorID>
      <d2p1:EmailAddress>String</d2p1:EmailAddress>
      <d2p1:FR_CarrierServices_RecID>String</d2p1:FR_CarrierServices_RecID>
      <d2p1:FR_Carriers_RecID>String</d2p1:FR_Carriers_RecID>
      <d2p1:Fax>String</d2p1:Fax>
      <d2p1:IndustryID>String</d2p1:IndustryID>
      <d2p1:IndustryName>String</d2p1:IndustryName>
      <d2p1:IsCashOnly>false</d2p1:IsCashOnly>
      <d2p1:LastSavedDateTime>0001-01-01T00:00:00</d2p1:LastSavedDateTime>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:NotifyAddress>String</d2p1:NotifyAddress>
      <d2p1:NotifyRequired>false</d2p1:NotifyRequired>
      <d2p1:ParentDebtorID>String</d2p1:ParentDebtorID>
      <d2p1:PeriodType>0</d2p1:PeriodType>
      <d2p1:Phone>String</d2p1:Phone>
      <d2p1:PostCode>String</d2p1:PostCode>
      <d2p1:PriceSchemeID>String</d2p1:PriceSchemeID>
      <d2p1:PricingGroupID>String</d2p1:PricingGroupID>
      <d2p1:ProprietorsName>String</d2p1:ProprietorsName>
      <d2p1:TaxExemptNo>String</d2p1:TaxExemptNo>
      <d2p1:TermsDays>0</d2p1:TermsDays>
      <d2p1:TermsType>0</d2p1:TermsType>
      <d2p1:TradingName>String</d2p1:TradingName>
      <d2p1:TradingStatus>0</d2p1:TradingStatus>
      <d2p1:WebAccess>false</d2p1:WebAccess>
    </d2p1:sh_Debtor>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfsh_Debtor4i7vAI15>