JiwaAPI

<back to all web services

sh_SalesOrderLineQuery

Requires Authentication
The following routes are available for this service:
GET/Queries/sh_SalesOrderLinesRetrieves a list of sh sales order lines
sh_SalesOrderLineQuery Parameters:
NameParameterData TypeRequiredDescription
InvoiceIDquerystringNo
InvoiceIDStartsWithquerystringNo
InvoiceIDEndsWithquerystringNo
InvoiceIDContainsquerystringNo
InvoiceIDLikequerystringNo
InvoiceIDBetweenquerystring[]No
InvoiceIDInquerystring[]No
UnitIncGSTqueryint?No
UnitIncGSTGreaterThanOrEqualToqueryint?No
UnitIncGSTGreaterThanqueryint?No
UnitIncGSTLessThanqueryint?No
UnitIncGSTLessThanOrEqualToqueryint?No
UnitIncGSTNotEqualToqueryint?No
UseSerialNoquerybool?No
PartNoquerystringNo
PartNoBetweenquerystring[]No
PartNoInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
sh_SalesOrderLine Parameters:
NameParameterData TypeRequiredDescription
InvoiceIDformstringNo
InvoiceLineIDformstringNo
InvoiceHistoryIDformstringNo
LineNumformshort?No
CommentLineformbool?No
PartNoformstringNo
DescriptionformstringNo
PhysicalItemformshort?No
UnitCostformdecimal?No
UnitExGSTformdecimal?No
TotalTaxformdecimal?No
TotalIncGSTformdecimal?No
QuantityOrderedformdecimal?No
QuantityPrevDelformdecimal?No
QuantityThisDelformdecimal?No
QuantityBackOrdformdecimal?No
HistoryText_CommentformstringNo
NonStockformbool?No
InventoryIDformstringNo
UseSerialNoformbool?No
UnitTaxformdecimal?No
BOMObjectformint?No
KitStyleformshort?No
LineCostformdecimal?No
OrigInvoiceNoformstringNo
UnitIncGSTformdecimal?No
TotalExGSTformdecimal?No
DemandQuantityformdecimal?No
QuantityPrevDemandformdecimal?No
UserDefinedFloat1formdecimal?No
ETAToSHEffectiveformDateTime?No
ETAToSHOverrideformDateTime?No
ETAToSupplierformDateTime?No
ETAToSupplierOffsetInDaysformint?No
PurchaseOrderIdformstringNo
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 .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_SalesOrderLines HTTP/1.1 
Host: localhost 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfsh_SalesOrderLine4i7vAI15 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_SalesOrderLine>
      <d2p1:BOMObject>0</d2p1:BOMObject>
      <d2p1:CommentLine>false</d2p1:CommentLine>
      <d2p1:DemandQuantity>0</d2p1:DemandQuantity>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:ETAToSHEffective>0001-01-01T00:00:00</d2p1:ETAToSHEffective>
      <d2p1:ETAToSHOverride>0001-01-01T00:00:00</d2p1:ETAToSHOverride>
      <d2p1:ETAToSupplier>0001-01-01T00:00:00</d2p1:ETAToSupplier>
      <d2p1:ETAToSupplierOffsetInDays>0</d2p1:ETAToSupplierOffsetInDays>
      <d2p1:HistoryText_Comment>String</d2p1:HistoryText_Comment>
      <d2p1:InventoryID>String</d2p1:InventoryID>
      <d2p1:InvoiceHistoryID>String</d2p1:InvoiceHistoryID>
      <d2p1:InvoiceID>String</d2p1:InvoiceID>
      <d2p1:InvoiceLineID>String</d2p1:InvoiceLineID>
      <d2p1:KitStyle>0</d2p1:KitStyle>
      <d2p1:LineCost>0</d2p1:LineCost>
      <d2p1:LineNum>0</d2p1:LineNum>
      <d2p1:NonStock>false</d2p1:NonStock>
      <d2p1:OrigInvoiceNo>String</d2p1:OrigInvoiceNo>
      <d2p1:PartNo>String</d2p1:PartNo>
      <d2p1:PhysicalItem>0</d2p1:PhysicalItem>
      <d2p1:PurchaseOrderId>String</d2p1:PurchaseOrderId>
      <d2p1:QuantityBackOrd>0</d2p1:QuantityBackOrd>
      <d2p1:QuantityOrdered>0</d2p1:QuantityOrdered>
      <d2p1:QuantityPrevDel>0</d2p1:QuantityPrevDel>
      <d2p1:QuantityPrevDemand>0</d2p1:QuantityPrevDemand>
      <d2p1:QuantityThisDel>0</d2p1:QuantityThisDel>
      <d2p1:TotalExGST>0</d2p1:TotalExGST>
      <d2p1:TotalIncGST>0</d2p1:TotalIncGST>
      <d2p1:TotalTax>0</d2p1:TotalTax>
      <d2p1:UnitCost>0</d2p1:UnitCost>
      <d2p1:UnitExGST>0</d2p1:UnitExGST>
      <d2p1:UnitIncGST>0</d2p1:UnitIncGST>
      <d2p1:UnitTax>0</d2p1:UnitTax>
      <d2p1:UseSerialNo>false</d2p1:UseSerialNo>
      <d2p1:UserDefinedFloat1>0</d2p1:UserDefinedFloat1>
    </d2p1:sh_SalesOrderLine>
  </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_SalesOrderLine4i7vAI15>