JiwaAPI

sh_SalesOrderQuery

The following routes are available for this service:
GET	/Queries/sh_SalesOrders	Retrieves a list of sh sales orders

**sh_SalesOrderQuery** Parameters:
Name	Parameter	Data Type	Required
InvoiceID	query	string	No
InvoiceIDStartsWith	query	string	No
InvoiceIDEndsWith	query	string	No
InvoiceIDContains	query	string	No
InvoiceIDLike	query	string	No
InvoiceIDBetween	query	string[]	No
InvoiceIDIn	query	string[]	No
Source	query	string	No
DocType	query	int	No
DebtorID	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

**sh_SalesOrder** Parameters:
Name	Parameter	Data Type	Required
InvoiceID	form	string	No
LastSavedDateTime	form	DateTime	No
DebtorID	form	string	No
StaffID	form	string	No
InvoiceNo	form	string	No
InvoiceInitDate	form	DateTime	No
InvoiceLastDate	form	DateTime	No
OrderNo	form	string	No
TaxExemptNo	form	string	No
InvoiceTotal	form	decimal?	No
CurrentHistoryNo	form	short?	No
Status	form	int?	No
BillWhenComplete	form	short	No
CreditNote	form	bool	No
InvoiceType	form	short?	No
GroupSupplierID	form	string	No
IN_LogicalID	form	string	No
BranchID	form	string	No
SOReference	form	string	No
ParentDebtorID	form	string	No
BackOrderMode	form	short	No
DocType	form	int	No
GSTInvoice	form	bool	No
ExpectedDeliveryDate	form	DateTime?	No
SourceQuoteID	form	string	No
PriceSchemeID	form	string	No
LastModifiedBy	form	string	No
InvoiceHistoryID	form	string	No
RecordDate	form	DateTime	No
Ref	form	string	No
HistoryNo	form	short?	No
HistoryTotal	form	decimal?	No
DelAddress1	form	string	No
DelAddress2	form	string	No
DelAddress3	form	string	No
DelAddress4	form	string	No
HistoryPostCode	form	string	No
Notes	form	string	No
CourierDetails	form	string	No
PaymentTypeID	form	string	No
PaymentRef	form	string	No
AmountPaid	form	decimal?	No
RunNo	form	string	No
DelContactName	form	string	No
Delivered	form	bool	No
DeliveredDate	form	DateTime?	No
FreightForwardAddress1	form	string	No
FreightForwardAddress2	form	string	No
FreightForwardAddress3	form	string	No
FreightForwardAddress4	form	string	No
FreightForwardNotes	form	string	No
HistoryStatus	form	byte?	No
EmailAddress	form	string	No
ConsignmentNote	form	string	No
DateCreated	form	DateTime?	No
DateLastSaved	form	DateTime?	No
DatePosted	form	DateTime?	No
DateProcessed	form	DateTime?	No
DropShipment	form	bool	No
DeliveryAddressee	form	string	No
DeliveryAddressCountry	form	string	No
FreightForwardAddressCountry	form	string	No
OrderedByID	form	string	No
DeliveryContactID	form	string	No
CostCenter	form	string	No
ExpressedInterestInInsurance	form	bool	No
PrimaryOrderID	form	string	No
InsuranceOrderID	form	string	No
HasWarrantyUplift	form	bool	No
HasLicensing	form	bool	No
WarrantyUpliftDocumentCount	form	int	No
LicenseDocumentCount	form	int	No
Source	form	string	No
DispatchedOn	form	DateTime	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_SalesOrders HTTP/1.1 
Host: localhost 
Accept: application/xml

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

<QueryResponseOfsh_SalesOrder4i7vAI15 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_SalesOrder>
      <d2p1:AmountPaid>0</d2p1:AmountPaid>
      <d2p1:BackOrderMode>0</d2p1:BackOrderMode>
      <d2p1:BillWhenComplete>0</d2p1:BillWhenComplete>
      <d2p1:BranchID>String</d2p1:BranchID>
      <d2p1:ConsignmentNote>String</d2p1:ConsignmentNote>
      <d2p1:CostCenter>String</d2p1:CostCenter>
      <d2p1:CourierDetails>String</d2p1:CourierDetails>
      <d2p1:CreditNote>false</d2p1:CreditNote>
      <d2p1:CurrentHistoryNo>0</d2p1:CurrentHistoryNo>
      <d2p1:DateCreated>0001-01-01T00:00:00</d2p1:DateCreated>
      <d2p1:DateLastSaved>0001-01-01T00:00:00</d2p1:DateLastSaved>
      <d2p1:DatePosted>0001-01-01T00:00:00</d2p1:DatePosted>
      <d2p1:DateProcessed>0001-01-01T00:00:00</d2p1:DateProcessed>
      <d2p1:DebtorID>String</d2p1:DebtorID>
      <d2p1:DelAddress1>String</d2p1:DelAddress1>
      <d2p1:DelAddress2>String</d2p1:DelAddress2>
      <d2p1:DelAddress3>String</d2p1:DelAddress3>
      <d2p1:DelAddress4>String</d2p1:DelAddress4>
      <d2p1:DelContactName>String</d2p1:DelContactName>
      <d2p1:Delivered>false</d2p1:Delivered>
      <d2p1:DeliveredDate>0001-01-01T00:00:00</d2p1:DeliveredDate>
      <d2p1:DeliveryAddressCountry>String</d2p1:DeliveryAddressCountry>
      <d2p1:DeliveryAddressee>String</d2p1:DeliveryAddressee>
      <d2p1:DeliveryContactID>String</d2p1:DeliveryContactID>
      <d2p1:DispatchedOn>0001-01-01T00:00:00</d2p1:DispatchedOn>
      <d2p1:DocType>0</d2p1:DocType>
      <d2p1:DropShipment>false</d2p1:DropShipment>
      <d2p1:EmailAddress>String</d2p1:EmailAddress>
      <d2p1:ExpectedDeliveryDate>0001-01-01T00:00:00</d2p1:ExpectedDeliveryDate>
      <d2p1:ExpressedInterestInInsurance>false</d2p1:ExpressedInterestInInsurance>
      <d2p1:FreightForwardAddress1>String</d2p1:FreightForwardAddress1>
      <d2p1:FreightForwardAddress2>String</d2p1:FreightForwardAddress2>
      <d2p1:FreightForwardAddress3>String</d2p1:FreightForwardAddress3>
      <d2p1:FreightForwardAddress4>String</d2p1:FreightForwardAddress4>
      <d2p1:FreightForwardAddressCountry>String</d2p1:FreightForwardAddressCountry>
      <d2p1:FreightForwardNotes>String</d2p1:FreightForwardNotes>
      <d2p1:GSTInvoice>false</d2p1:GSTInvoice>
      <d2p1:GroupSupplierID>String</d2p1:GroupSupplierID>
      <d2p1:HasLicensing>false</d2p1:HasLicensing>
      <d2p1:HasWarrantyUplift>false</d2p1:HasWarrantyUplift>
      <d2p1:HistoryNo>0</d2p1:HistoryNo>
      <d2p1:HistoryPostCode>String</d2p1:HistoryPostCode>
      <d2p1:HistoryStatus>0</d2p1:HistoryStatus>
      <d2p1:HistoryTotal>0</d2p1:HistoryTotal>
      <d2p1:IN_LogicalID>String</d2p1:IN_LogicalID>
      <d2p1:InsuranceOrderID>String</d2p1:InsuranceOrderID>
      <d2p1:InvoiceHistoryID>String</d2p1:InvoiceHistoryID>
      <d2p1:InvoiceID>String</d2p1:InvoiceID>
      <d2p1:InvoiceInitDate>0001-01-01T00:00:00</d2p1:InvoiceInitDate>
      <d2p1:InvoiceLastDate>0001-01-01T00:00:00</d2p1:InvoiceLastDate>
      <d2p1:InvoiceNo>String</d2p1:InvoiceNo>
      <d2p1:InvoiceTotal>0</d2p1:InvoiceTotal>
      <d2p1:InvoiceType>0</d2p1:InvoiceType>
      <d2p1:LastModifiedBy>String</d2p1:LastModifiedBy>
      <d2p1:LastSavedDateTime>0001-01-01T00:00:00</d2p1:LastSavedDateTime>
      <d2p1:LicenseDocumentCount>0</d2p1:LicenseDocumentCount>
      <d2p1:Notes>String</d2p1:Notes>
      <d2p1:OrderNo>String</d2p1:OrderNo>
      <d2p1:OrderedByID>String</d2p1:OrderedByID>
      <d2p1:ParentDebtorID>String</d2p1:ParentDebtorID>
      <d2p1:PaymentRef>String</d2p1:PaymentRef>
      <d2p1:PaymentTypeID>String</d2p1:PaymentTypeID>
      <d2p1:PriceSchemeID>String</d2p1:PriceSchemeID>
      <d2p1:PrimaryOrderID>String</d2p1:PrimaryOrderID>
      <d2p1:RecordDate>0001-01-01T00:00:00</d2p1:RecordDate>
      <d2p1:Ref>String</d2p1:Ref>
      <d2p1:RunNo>String</d2p1:RunNo>
      <d2p1:SOReference>String</d2p1:SOReference>
      <d2p1:Source>String</d2p1:Source>
      <d2p1:SourceQuoteID>String</d2p1:SourceQuoteID>
      <d2p1:StaffID>String</d2p1:StaffID>
      <d2p1:Status>0</d2p1:Status>
      <d2p1:TaxExemptNo>String</d2p1:TaxExemptNo>
      <d2p1:WarrantyUpliftDocumentCount>0</d2p1:WarrantyUpliftDocumentCount>
    </d2p1:sh_SalesOrder>
  </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_SalesOrder4i7vAI15>