Stored Procedures
[e]suite offers a range of standard stored procedures to ease integration and provide increased functionality outside of standard endpoints.
They range from Account history and delivery information to a full paginated stock catalog.
Account Information
Introduction
The account stored procedures includes references to validate logins as well as return account related information or transaction history.
W_Acc_FullDet
This stored procedure returns all of the information in the T_Acc table for a single account.
endpoint: sp/W_Acc_FullDet
Required Parameters
| Field | Type | Example | Information |
|---|---|---|---|
| CompanyNo | int | 123456 | |
| AccountNo | int | 123456 |
{
"Count": "1",
"Result": [
{
"CompanyNo": "123456",
"AccountNo": "2",
"TransLedger": "S",
"AccountName": "Cash Customer",
"AccountStatus": "Y",
"AccountRefNo": "1",
"AccountRef": "CASH01",
"AccountAltRef": "",
"AccountCurrency": "",
"AccountPriceBand": "",
"DateCreated": "5/14/2013 3:53:32 PM",
"DateUpdated": "10/31/2018 2:26:05 PM",
"AccountOutstanding": "0",
"AccountHasOutstanding": "",
"AdjustmentIsPercent": "False",
"AdjustmentEntryAmt": "",
"AdjustmentMethod": "",
"AccountHasCreditLimit": "",
"AccountCreditLimit": "0",
"CompanyCode": "",
"MediaCode": "",
"CampaignCode": "",
"CostCentreCode": "",
"SegmentCode": "",
"CountryCode": "",
"AccountContactName": "Cash Customer",
"AccountContactTitle": "",
"AccountSalute": "",
"AccountFirstName": "Cash",
"AccountLastName": "Customer",
"AccountBusinessName": "",
"AccountDivisionName": "",
"AccountAddress1": ".",
"AccountAddress2": "",
"AccountAddress3": "",
"AccountAddress4": "",
"AccountSuburb": " ",
"AccountState": " ",
"AccountPostCode": " ",
"AccountSortCode": "",
"AccountDPID": "",
"AccountDPIDHouseno": "",
"AccountPhone1": "",
"AccountPhone2": "",
"AccountMobile": "0000000000",
"AccountFax": "",
"AccountEmail": "",
"AccountCode1": "",
"AccountCode2": "",
"AccountProfile": "{\\rtf }",
"AccountLastContact": "",
"DedupePrefix": "",
"DedupeCode": "",
"DedupeSuffix": "",
"IntroducedByAccountNo": "",
"NPM": "",
"IsAccountDlvAddress": "False",
"DefaultDlvAddressNo": "",
"AccountUserStr1": "",
"AccountUserStr2": "",
"AccountUserStr3": "",
"AccountUserStr4": "PAS",
"AccountUserStr5": "",
"AccountUserStr6": "",
"AccountUserAmt1": "",
"AccountUserAmt2": "",
"AccountUserNum1": "",
"AccountUserNum2": "",
"AccountUserDate1": "",
"AccountUserDate2": "",
"AccountBusinessNumber": "",
"AccountTermsType": "",
"AccountTerms": "0",
"AccountGSTType": "",
"AccountIncGST": "True",
"AccountPayType": "",
"AccountDrawer": "",
"AccountBank": "",
"AccountBranch": "",
"AccountBankAccount": "",
"AccountBankAuthorised": "False",
"AccountExpiry": "",
"AccountGLNo": "",
"AccountWebsite": "",
"AccountLogin": "",
"AccountPassword": "",
"AccountBankSecurityCode": "",
"OrderLeadDays": "",
"ReplicatedHistory": "",
"EDIInterface": "",
"EDILedgerCompanyNo": "",
"EDIAccountRef": "",
"EDIAccountCompanyNo": "",
"EDIAccountNo": "",
"PrimaryContactCompanyNo": "123456",
"PrimaryContactNo": "169",
"AccountRemoteOutstanding": "",
"AccountCRMStatus": "",
"AccountCRMDue": "",
"StatementSent": "",
"CreditStatus": "",
"CreditExceedAction": "",
"DebtLevel": "",
"DebtLevelLast": "",
"DebtLevelHighest": "",
"DebtLevelHighestDate": "",
"PaymentPlan": "False",
"PlanStartDate": "",
"PlanNextDue": "",
"PlanTotal": "",
"PlanInstall": "",
"PlanInstallQty": "",
"PlanFreqDuration": "",
"PlanFreq": "",
"PlanRetainCredit": "False",
"PlanCurrency": "",
"AccountCommPreference": "Phone",
"GroupCompanyNo": "",
"GroupAccountNo": "",
"GroupAccountRef": "",
"AccountPoints": "0",
"DefaultMsgNo": "",
"AccountRemotePoints": "",
"AccountMaxNumberOfInvoices": "",
"AccountTradingGLNo": "",
"CreatedUserNo": "12",
"ModifiedUserNo": "53"
}
]
}
W_Acc_FullDlvInfo
This stored procedure returns all of the information in the T_Acc table for a single account.
endpoint: sp/W_Acc_FullDlvInfo
Required Parameters
| Field | Type | Example | Information |
|---|---|---|---|
| CompanyNo | int | 123456 | |
| AccountNo | int | 123456 |
{
"Count": "1",
"Result": [
{
"CompanyNo": "123456",
"AccountNo": "761",
"AddressNo": "1",
"AddressDesc": "Delivery Address",
"TransLedger": "",
"AccountRef": "",
"DlvContactName": "Emily Osment",
"DlvTitle": "",
"DlvSalute": "",
"DlvFirstname": "Emily",
"DlvLastname": "Osment",
"DlvBusinessName": "",
"DlvDivisionName": "",
"DlvAddress1": "26B ABC Place",
"DlvAddress2": "",
"DlvAddress3": "",
"DlvAddress4": "",
"DlvSuburb": "AVALON",
"DlvState": "NSW",
"DlvPostcode": "2107",
"DlvCountry": "",
"DlvSortcode": "",
"DlvDPID": "",
"DlvDPIDHouseNo": "",
"DlvPhone": "",
"DlvEmail": "",
"AccDlvUserStr1": "",
"AccDlvUserStr2": ""
}
]
}
W_AccLogin
This stored procedure returns account minor account data when a match is found.
NOTE - if two accounts are found with the same data then an error is returned.
endpoint: sp/W_AccLogin
Required Parameters
| Field | Type | Example | Information |
|---|---|---|---|
| Login | varchar(50) | ABCDEFG | |
| Password | varchar(15) | ABCD#$#@$REV |
Optional Parameters
| Field | Type | Example | Information |
|---|---|---|---|
| Ledger | varchar(1) | S | Defaults to S - other Ledgers are P / I |
{
"Count": "1",
"Result": [
{
"CompanyNo": "123456",
"AccountNo": "1234567",
"AccountRef": "00000P04",
"AccountName": "Andy Tester",
"AccountBusinessName": "",
"AccountContactName": "Andy Tester",
"AccountFirstName": "Andy",
"AccountLastName": "Tester"
}
]
}
W_AccLogin_FullDet
This stored procedure returns account minor account data when a match is found.
NOTE - if two accounts are found with the same data then an error is returned.
endpoint: sp/W_AccLogin
Required Parameters
| Field | Type | Example | Information |
|---|---|---|---|
| Login | varchar(50) | ABCDEFG | |
| Password | varchar(15) | ABCD#$#@$REV |
Optional Parameters
| Field | Type | Example | Information |
|---|---|---|---|
| Ledger | varchar(1) | S | Defaults to S - other Ledgers are P / I |
{
"Count": "1",
"Result": [
{
"CompanyNo": "123456",
"AccountNo": "1234567",
"TransLedger": "S",
"AccountName": "Andy Tester",
"AccountStatus": "Y",
"AccountRefNo": "28772",
"AccountRef": "00000P04",
"AccountAltRef": "",
"AccountCurrency": "",
"AccountPriceBand": "",
"DateCreated": "5/17/2018 10:12:16 AM",
"DateUpdated": "10/9/2020 3:12:17 PM",
"AccountOutstanding": "0",
"AccountHasOutstanding": "",
"AdjustmentIsPercent": "False",
"AdjustmentEntryAmt": "",
"AdjustmentMethod": "",
"AccountHasCreditLimit": "N",
"AccountCreditLimit": "",
"CompanyCode": "",
"MediaCode": "",
"CampaignCode": "",
"CostCentreCode": "",
"SegmentCode": "PINE",
"CountryCode": "",
"AccountContactName": "Andy Tester",
"AccountContactTitle": "",
"AccountSalute": "",
"AccountFirstName": "Andy",
"AccountLastName": "Tester",
"AccountBusinessName": "",
"AccountDivisionName": "",
"AccountAddress1": "123 ABC Way",
"AccountAddress2": "",
"AccountAddress3": "",
"AccountAddress4": "",
"AccountSuburb": "ALBION PARK",
"AccountState": "NSW",
"AccountPostCode": "2176",
"AccountSortCode": "",
"AccountDPID": "",
"AccountDPIDHouseno": "",
"AccountPhone1": "",
"AccountPhone2": "",
"AccountMobile": "0410 000 000",
"AccountFax": "",
"AccountEmail": "emailaddress@domain.com",
"AccountCode1": "",
"AccountCode2": "",
"AccountProfile": "{\\rtf }",
"AccountLastContact": "",
"DedupePrefix": "",
"DedupeCode": "",
"DedupeSuffix": "",
"IntroducedByAccountNo": "",
"NPM": "",
"IsAccountDlvAddress": "False",
"DefaultDlvAddressNo": "",
"AccountUserStr1": "",
"AccountUserStr2": "",
"AccountUserStr3": "",
"AccountUserStr4": "CAT",
"AccountUserStr5": "",
"AccountUserStr6": "",
"AccountUserAmt1": "",
"AccountUserAmt2": "",
"AccountUserNum1": "",
"AccountUserNum2": "",
"AccountUserDate1": "",
"AccountUserDate2": "",
"AccountBusinessNumber": "",
"AccountTermsType": "U",
"AccountTerms": "0",
"AccountGSTType": "",
"AccountIncGST": "True",
"AccountPayType": "",
"AccountDrawer": "",
"AccountBank": "",
"AccountBranch": "",
"AccountBankAccount": "",
"AccountBankAuthorised": "False",
"AccountExpiry": "",
"AccountGLNo": "",
"AccountWebsite": "",
"AccountLogin": "abc",
"AccountPassword": "abcee",
"AccountBankSecurityCode": "",
"OrderLeadDays": "",
"ReplicatedHistory": "1234567",
"EDIInterface": "",
"EDILedgerCompanyNo": "",
"EDIAccountRef": "",
"EDIAccountCompanyNo": "",
"EDIAccountNo": "",
"PrimaryContactCompanyNo": "",
"PrimaryContactNo": "",
"AccountRemoteOutstanding": "",
"AccountCRMStatus": "",
"AccountCRMDue": "",
"StatementSent": "",
"CreditStatus": "",
"CreditExceedAction": "",
"DebtLevel": "",
"DebtLevelLast": "",
"DebtLevelHighest": "",
"DebtLevelHighestDate": "",
"PaymentPlan": "False",
"PlanStartDate": "",
"PlanNextDue": "",
"PlanTotal": "",
"PlanInstall": "",
"PlanInstallQty": "",
"PlanFreqDuration": "",
"PlanFreq": "",
"PlanRetainCredit": "False",
"PlanCurrency": "",
"AccountCommPreference": "Phone",
"GroupCompanyNo": "",
"GroupAccountNo": "",
"GroupAccountRef": "",
"AccountPoints": "0",
"DefaultMsgNo": "",
"AccountRemotePoints": "",
"AccountMaxNumberOfInvoices": "",
"AccountTradingGLNo": "",
"CreatedUserNo": "67",
"ModifiedUserNo": "53"
}
]
}
W_AccTransHistory
This stored procedure returns all of the transactions for a specific customer.
endpoint: sp/W_AccTransHistory
Required Parameters
| Field | Type | Example | Information |
|---|---|---|---|
| CompanyNo | int | 123456 | |
| AccountNo | int | 2 |
Optional Parameters
| Field | Type | Example | Information |
|---|---|---|---|
| TransType | varchar(3) | SOR | Defaults to SOR if left empty |
| Actioned | varchar(3) | Y | Defaults to Y - if N is passed then will return open orders. |
{
"Count": "1",
"Result": [
{
"CompanyNo": "123456",
"TransNo": "12345678",
"LedgerCompanyNo": "123456",
"LocationNo": "23",
"OriginCompanyNo": "123456",
"OriginLocationNo": "0",
"AccountCompanyNo": "123456",
"AccountNo": "1234567",
"AccountRef": "00000P03",
"BatchNo": "172353",
"BatchType": "SAR",
"BatchRefCode": "TSOR:2",
"TransRefCode": "TSOR-2",
"TransYourRef": "WEB-123456",
"TransComment": "",
"OrderNo": "2",
"InvoiceNo": "",
"TransLedger": "S",
"TransType": "SOR",
"TransRefNo": "2",
"TransDate": "10/1/2020",
"TransPeriod": "202104",
"TransDueDate": "",
"PaymentEntryAmt": "51.95",
"TransCurrency": "AUD",
"TransTotalExGST": "83.55",
"TransTotalGST": "8.35",
"TransTotalIncGST": "91.9",
"TransIncGST": "True",
"AccountAmt": "-51.95",
"AccountOutstanding": "-51.95",
"EDIInterface": ""
}
]
}
Stock Information
Introduction
These stored procedures are helpful in getting stock and pricing information.
W_StkSearch_Contains
This stored procedure returns all stock items that contain the specified keywords in the stockcode or description as required.
Will also return pricing data.
The Ext procedures are the only ones to use the StkCheck parameters at the end.
NOTE: The StkSearch procedures are specifically for stock items.
endpoint: sp/W_StkSearch_Contains
endpoint: sp/W_StkSearch_Contains_ByPage
endpoint: sp/W_StkSearch_ContainsExt
endpoint: sp/W_StkSearch_ContainsExt_ByPage
Required Parameters - ALL
| Field | Type | Example | Information |
|---|---|---|---|
| SearchTerm | varchar(512) | Search StockCode and StockDesc for this value |
Required Parameters - ByPage
| Field | Type | Example | Information |
|---|---|---|---|
| PageNo | int | 123456 | |
| PageSize | int | 123456 | Determines how many records are returned |
Optional Parameters - not all procedures feature all these parameters
| Field | Type | Example | Information |
|---|---|---|---|
| SortBy | varchar(30) | StockCode | Optional Sort By (StockCode/StockDesc/Rank) |
| CustCompanyno | int | Use with CustAccountNo to get Customer Specific pricing considered (if exists) | |
| CustAccountNo | int | ||
| PriceBand | varchar(10) | R | Leaving this blank will use company default priceband or customer priceband (if specified) |
| BrandFilter | varchar(30) | Any Stock Brand | |
| WebEnabled | bit | 1 | Defaults to 1 - Will only show Web Enabled items |
| ParentStockNo | int | Returns data under a specific Parent | |
| FromPrice | money | Specifies a minimum price for results | |
| ToPrice | money | Specifies a maximum price for results | |
| MaxResultCount | int | Specifies a maximum resultset for the query - 0 is all | |
| ImageNo | int | 1 | Returns the ImageFileName corresponding to the Image number passed in |
| ImageSizeNo | int | 1 | Returns specific image dimensions (customer specific) |
| CampaignCode | varchar(10) | Filters the resultset for the specific Campaign Code. | |
| StkCheck | varchar(1) | S | Defaults to S - Uses stock values from the specified source | S=Stk, L=StkLock, X=StkLocExt |
| StkCompare | varchar(2) | Defaults to '' - Returns a comparison Stock Qty value from the specified source | PM=Parent.StockMinQty, P1=Parent.StockUserNum1, SM=Stk.StockMinQty, S1=Stk.StockUserNum1 | |
| StkCompanyNo | int | 123456 | CompanyNo to look up StockOnHandQty |
| StockLocationNo | int | 123456 | LocationNo to look up StockOnHandQty |
| DefaultMinQty | float | 0.0 | MinQty if StkCompare is not used |
| DaysSinceCreatedFilter | float | 30 | Only returns items created within x days |
| AttField1 | varchar(20) | Returns data on the specific attribute field | |
| UseWebStatus | bit | ||
| WebStatus | varchar(1) | Used with the above setting - only returns data with the supplied web status. |
{
"Count": "1",
"Result": [
{
"StockNo": "123456",
"StockCode": "123456",
"StockDesc": "Alpha Concrete Coffee Table [Indoor & Outdoor] ***",
"LineType": "S",
"StockAltRef": "9001211",
"ParentStockNo": "28736",
"ParentStockCode": "Dining",
"QtyFrom2": "",
"QtyFrom3": "",
"QtyFrom4": "",
"QtyFrom5": "",
"CampaignCode": "",
"BasePrice": "99999",
"Price": "99999",
"Price2": "",
"Price3": "",
"Price4": "",
"Price5": "",
"StockQty": "19",
"StockOnHandQty": "19",
"StockPurchaseOrderQty": "0",
"StockUserStr1": "",
"StockUserStr2": "",
"StockUserStr3": "",
"StockUserStr4": "",
"StockUserStr5": "Alpha Concrete Coffee Table [Indoor & Outdoor]",
"StockUserStr6": "",
"StockUserAmt1": "",
"StockUserAmt2": "2",
"StockUserNum1": "",
"StockUserNum2": "",
"StockUserDate1": "",
"StockUserDate2": "",
"WebStatus": "",
"ShippingStatus": "",
"StockBrand": "",
"StockBrandDesc": "",
"ManufacturerCode": "",
"RecRetailPrice": "",
"StockUnit": "",
"SellUnit": "",
"SellSmallestUnit": "",
"SalesPackQty": "1",
"SalesPackInnerQty": "1",
"ImageFileName": "1_43141__400_400.jpg",
"VersionNo": "1",
"DiscountType": "",
"UnitDiscount": "",
"SearchRank": "64",
"CustFilter": ""
}
]
}
W_StkTreeNodes
This procedure returns stock information including best price for all items under a specified header.
There are a few offshoots of this one with more required fields to utilize.
FilterByPage uses both ByPage and Filter params.
The pricing information that it returns will take into account existing Campaigns / Auto Campaigns as well as B2B pricing.
It will also calculate any pricebands that work as a markup/margin etc based off a secondary price band.
endpoint: sp/W_StkTreeNodes
endpoint: sp/W_StkTreeNodes_ByPage
endpoint: sp/W_StkTreeNodesFilter
endpoint: sp/W_StkTreeNodesFilter_ByPage
Required Parameters - ALL
| Field | Type | Example | Information |
|---|---|---|---|
| ParentStockNo | int | 123456 | Set to 0 for all items |
Required Parameters - ByPage
| Field | Type | Example | Information |
|---|---|---|---|
| PageNo | int | 123456 | |
| PageSize | int | 123456 | Determines how many records are returned |
Required Parameters - Filter
| Field | Type | Example | Information |
|---|---|---|---|
| FilterField | varchar(20) | Specifies a lookup field on the stock table - User Fields / CostCentreCode / SegmentCode / StockAltRef / SupplierAccountRef | |
| FilterValue | varchar(50) | The value to filter on - % suffix implies a like when filtering on User String fields |
Optional Parameters
| Field | Type | Example | Information |
|---|---|---|---|
| SortBy | varchar(30) | StockCode | Optional Sort By (StockCode/StockDesc/Rank) |
| CustCompanyno | int | Use with CustAccountNo to get Customer Specific pricing considered (if exists) | |
| CustAccountNo | int | ||
| PriceBand | varchar(10) | R | Leaving this blank will use company default priceband or customer priceband (if specified) |
| BrandFilter | varchar(30) | Any Stock Brand | |
| WebEnabled | bit | 1 | Defaults to 1 - Will only show Web Enabled items |
| IncludeHeaders | bit | 1 | Defaults to 1 - Includes Headers in the resultset |
| IncludeStock | bit | 1 | Defaults to 1 - Includes stock in the resultset |
| IncludeNonStock | bit | 0 | Defaults to 0 - Includes descriptive items in the resultset |
| ImageNo | int | 1 | Returns the ImageFileName corresponding to the Image number passed in |
| ImageSizeNo | int | 1 | Returns specific image dimensions (customer specific) |
| TextNo1 | int | 1 | Returns data from the relevant StkText record |
| TextNo2 | int | 1 | Returns data from the relevant StkText record |
| TextNo3 | int | 1 | Returns data from the relevant StkText record |
| CampaignCode | varchar(10) | Filters the resultset for the specific Campaign Code. | |
| StkCheck | varchar(1) | S | Defaults to S - Uses stock values from the specified source | S=Stk, L=StkLock, X=StkLocExt |
| StkCompare | varchar(2) | Defaults to '' - Returns a comparison Stock Qty value from the specified source | PM=Parent.StockMinQty, P1=Parent.StockUserNum1, SM=Stk.StockMinQty, S1=Stk.StockUserNum1 | |
| StkCompanyNo | int | 123456 | CompanyNo to look up StockOnHandQty |
| StockLocationNo | int | 123456 | LocationNo to look up StockOnHandQty |
| DefaultMinQty | float | 0.0 | MinQty if StkCompare is not used |
| DaysSinceCreatedFilter | float | 30 | Only returns items created within x days |
| AttField1 | varchar(20) | Returns data on the specific attribute field | |
| UseWebStatus | bit | ||
| WebStatus | varchar(1) | Used with the above setting - only returns data with the supplied web status. |
{
"Count": "17",
"Result": [
{
"StockCode": "123456",
"StockNo": "38777",
"StockDesc": "Item ***",
"LineType": "P",
"StockAltRef": "STK123456",
"ParentStockNo": "1234",
"ParentStockCode": "PL2",
"StockBarCode": "02##########123456c",
"StockAltBarCode": "",
"StockBrand": "",
"StockBrandDesc": "",
"QtyFrom2": "",
"QtyFrom3": "",
"QtyFrom4": "",
"QtyFrom5": "",
"CampaignCode": "",
"BasePrice": "1599",
"Price": "1599",
"Price2": "",
"Price3": "",
"Price4": "",
"Price5": "",
"StockQty": "5",
"StockOnHandQty": "4",
"StockPurchaseOrderQty": "",
"StockUserStr1": "",
"StockUserStr2": "",
"StockUserStr3": "",
"StockUserStr4": "",
"StockUserStr5": "",
"StockUserStr6": "",
"StockUserAmt1": "",
"StockUserAmt2": "2",
"StockUserNum1": "",
"StockUserNum2": "",
"StockUserDate1": "",
"StockUserDate2": "",
"WebStatus": "",
"ShippingStatus": "",
"ManufacturerCode": "",
"RecRetailPrice": "",
"StockUnit": "",
"SellUnit": "",
"SellSmallestUnit": "",
"SalesPackQty": "1",
"SalesPackInnerQty": "1",
"StockTreeSort": "",
"LineTypeSort": "1",
"ImageFileName": "1_38777_400_400.jpg",
"VersionNo": "0",
"MatrixColumn": "",
"MatrixRowOne": "",
"MatrixRowTwo": "",
"MatrixRowThree": "",
"MatrixColumnDesc": "",
"MatrixRowOneDesc": "",
"MatrixRowTwoDesc": "",
"MatrixRowThreeDesc": "",
"DiscountType": "",
"UnitDiscount": "",
"Text1": "",
"Text2": "",
"Text3": "",
"AttValue1": "",
"ParStockUserStr1": "PUSTR1",
"ParStockUserStr2": "",
"ParStockUserNum1": "",
"ParStockUserNum2": "",
"ExtStockQty": "5",
"ExtStockOnHandQty": "4",
"ExtPurchaseOrderQty": "",
"ExtReservedQty": "",
"ExtMinQty": "0",
"ExtCanAddToCart": "True",
"CustFilter": "",
"GSTType": "GST",
"StockWeight": "",
"StockHeight": "750",
"StockWidth": "1800",
"StockDepth": "1000"
},
...
}
}
W_StkDetails_AllData
The procedure returns detailed information about a stock code - including the options to include pricing with pricing precidence.
Required Parameters
| Field | Type | Example | Information |
|---|---|---|---|
| StockNo | int | To enable stockcode search set this to 0 |
Optional Parameters
| Field | Type | Example | Information |
|---|---|---|---|
| StockCode | varchar(30) | ||
| CustCompanyno | int | Use with CustAccountNo to get Customer Specific pricing considered (if exists) | |
| CustAccountNo | int | ||
| PriceBand | varchar(10) | R | Leaving this blank will use company default priceband or customer priceband (if specified) |
| ImageNo | int | 1 | Returns the ImageFileName corresponding to the Image number passed in |
| ImageSizeNo | int | 1 | Returns specific image dimensions (customer specific) |
| TextNo1 | int | 1 | Returns data from the relevant StkText record |
| TextNo2 | int | 1 | Returns data from the relevant StkText record |
| TextNo3 | int | 1 | Returns data from the relevant StkText record |
| CampaignCode | varchar(10) | Filters the resultset for the specific Campaign Code. | |
| StkCheck | varchar(1) | S | Defaults to S - Uses stock values from the specified source | S=Stk, L=StkLock, X=StkLocExt |
| StkCompare | varchar(2) | Defaults to '' - Returns a comparison Stock Qty value from the specified source | PM=Parent.StockMinQty, P1=Parent.StockUserNum1, SM=Stk.StockMinQty, S1=Stk.StockUserNum1 | |
| StkCompanyNo | int | 123456 | CompanyNo to look up StockOnHandQty |
| StockLocationNo | int | 123456 | LocationNo to look up StockOnHandQty |
| DefaultMinQty | float | 0.0 | MinQty if StkCompare is not used |
| AttField1 | varchar(20) | Returns data on the specific attribute field | |
| InclDiscontinued | bit | Allows you to find the stock code if it is discontinued. |
{
"Count": "1",
"Result": [
{
"StockCode": "123456",
"StockNo": "123456",
"StockDesc": "This is an item description",
"StockAltRef": "",
"StockBarCode": "02##########000049",
"Discontinued": "False",
"FastFind": "False",
"LineType": "S",
"LineCostType": "A",
"ParentStockNo": "35314",
"ParentStockCode": "SP",
"UseParentPrice": "False",
"PurchaseGSTType": "NIL",
"UnitCostCurrency": "",
"UnitCostExGST": "",
"StockValueExGST": "0",
"StockQty": "9",
"StockPostedQty": "",
"StockSalesPickedQty": "0",
"StockSalesOrderQty": "0",
"StockOnHandQty": "9",
"StockCostQty": "9",
"StockPurchaseOrderQty": "0",
"StockReOrderQty": "",
"StockBuyThis": "True",
"StockSellThis": "False",
"DiscountType": "P",
"QtyFrom2": "",
"QtyFrom3": "",
"QtyFrom4": "",
"QtyFrom5": "",
"SalesGLNo": "348",
"COSGLNo": "347",
"StockGLNo": "16",
"ShrinkageGLNo": "347",
"BOMGLNo": "0",
"CampaignCode": "",
"CostCentreCode": "",
"SegmentCode": "",
"StockUserStr1": "",
"StockUserStr2": "",
"StockUserStr3": "",
"StockUserStr4": "",
"StockUserAmt1": "",
"StockUserAmt2": "2",
"StockUserNum1": "",
"StockUserNum2": "",
"StockWeight": "",
"StockHeight": "",
"StockWidth": "",
"StockDepth": "",
"StockVolume": "",
"SalesPackQty": "1",
"SalesPackInnerQty": "1",
"PurchasePackQty": "1",
"PurchasePackInnerQty": "1",
"TouchPage": "",
"TouchPos": "",
"QtyMode": "1",
"WebStatus": "",
"ShippingStatus": "",
"StockBrand": "",
"ManufacturerCode": "",
"RecRetailPrice": "",
"LastCostExGST": "",
"SupplierCompanyNo": "36015",
"SupplierAccountNo": "5",
"SupplierAccountRef": "SHAN",
"LastPurchaseDate": "",
"LastOrderCostExGST": "",
"StockSalesDeliveryQty": "0",
"StockPurchaseDeliveryQty": "0",
"StockMinQty": "",
"StockMaxQty": "",
"StockModified": "10/28/2020 2:47:54 PM",
"WebEnabled": "False",
"StockQtyModified": "11/1/2018 11:43:45 AM",
"StockTreeSort": "",
"LastCostCompanyNo": "",
"LastCostTransNo": "",
"StockAltBarCode": "",
"StockCreated": "2/18/2015 2:07:36 PM",
"BOMSalesKit": "F",
"BOMPurchaseKit": "H",
"BOMPriceBy": "K",
"BOMJustInTime": "False",
"StockReserveQty": "",
"StockCoverLimit": "",
"StockReOrderMultQty": "",
"StockReOrderRule": "",
"OTBGroupCode": "",
"RestockFrom": "",
"RestockCompanyNo": "",
"RestockLocationNo": "",
"RestockLeadTime": "",
"StockUserStr5": "",
"StockUserStr6": "",
"StockUserDate1": "",
"StockUserDate2": "",
"LastLandedCostExGST": "0",
"LineDlvMode": "TBA",
"POSEnabled": "False",
"StockInfoStr1": "",
"StockInfoStr2": "",
"StockUnit": "",
"SellUnit": "",
"SellSmallestUnit": "",
"BuyUnit": "",
"BuySmallestUnit": "",
"StockStatus": "A",
"PriceGroup": "",
"StockReservedQty": "0",
"StockBinSize": "",
"StockBinStdCapacity": "",
"StockBinCode": "",
"StockSerialMode": "A",
"SupplierQty": "",
"CtnBarCode": "",
"CreatedUserNo": "",
"ModifiedUserNo": "",
"StockUserNum3": "",
"StockUserNum4": "",
"StockSerialFormat": "",
"StockNo_1": "35367",
"ParStockUserStr1": "",
"ParStockUserStr2": "",
"ParStockUserNum1": "",
"ParStockUserNum2": "",
"LineType_1": "S",
"ExtStockQty": "9",
"ExtStockOnHandQty": "9",
"ExtPurchaseOrderQty": "0",
"ExtReservedQty": "0",
"ExtMinQty": "0",
"ExtCanAddToCart": "True",
"QtyFrom2_1": "",
"QtyFrom3_1": "",
"QtyFrom4_1": "",
"QtyFrom5_1": "",
"DiscCampaignCode": "",
"BasePrice": "",
"Price": "",
"Price2": "",
"Price3": "",
"Price4": "",
"Price5": "",
"ImageFileName": "",
"VersionNo": "",
"DiscountType_1": "",
"UnitDiscount": "",
"CustFilter": "",
"Text1": "",
"Text2": "",
"Text3": "",
"AttValue1": "",
"StockBrandDesc": "",
"GSTType": "GST"
}
]
}