-
Notifications
You must be signed in to change notification settings - Fork 2
Get Data Documentation Item
liqian-simit edited this page Sep 2, 2019
·
18 revisions
| Required field for calling API | ||||
|---|---|---|---|---|
| No | Field Name | Data Type (Size) | Required | Description |
| 1 | item_id | varchar(50) | Y | Backend ID for the item (* will pick either one between item_id and item_code, item_id will be the first priority) |
| 2 | item_code | varchar(255) | Y | Item Code (* will pick either one between item_id and item_code, item_id will be the first priority) |
| 3 | item_barcode | varchar(255) | Item's Barcode | |
| 4 | category_code | varchar(50) | Item's Category Code | |
| 5 | type_code | varchar(50) | Item's Type Code | |
| 6 | brand_code | varchar(50) | Item's Brand Code | |
| Item Header Data | ||||
| No | Field Name | Data Type (Size) | Required | Description |
| 1 | Item ID | varchar(50) | Y | Backend ID for the item (* will pick either one between item_id and item_code, item_id will be the first priority) |
| 2 | Item Code | varchar(255) | Y | Item Code (* will pick either one between item_id and item_code, item_id will be the first priority) |
| 3 | Item Name | varchar(255) | Y | Item's name |
| 4 | Alternate Name | varchar(255) | Item's Alternate Name | |
| 5 | Barcode | varchar(255) | Item's Barcode | |
| 6 | Category | varchar(50) | Item's Category | |
| 7 | Type | varchar(50) | Item's Type | |
| 8 | Brand | varchar(50) | Item's Brand | |
| 9 | Is Get Point | smallint(1) | Item is available for point? | |
| 10 | Is Redeem | smallint(1) | Item is redeemable? | |
| 11 | Max Quantity | int(11) | ||
| 12 | Min Quantity | int(11) | ||
| 13 | Is Use Account ID | varchar(50) | ||
| 14 | Prefix 1 | varchar(50) NULL | ||
| 15 | Prefix 2 | varchar(50) NULL | ||
| 16 | Prefix 3 | varchar(50) NULL | ||
| 17 | Prefix Number | varchar(50) NULL | ||
| 18 | Attachment URL | varchar(255) | ||
| 19 | Filename | varchar(255) | ||
| 20 | Width | decimal(14,4) | Item's width | |
| 21 | Thickness | decimal(14,4) | Item's Thickness | |
| 22 | Length | decimal(14,4) | Item's Length | |
| 23 | Weight | decimal(14,4) | Item's Weight | |
| 24 | Size | decimal(14,4) | Item's Size | |
| 25 | Schedule | varchar(255) | ||
| 26 | Country | varchar(50) | ||
| 27 | Capacity | double | ||
| 28 | Tool Tips | varchar(255) | ||
| 29 | Description | text | Item's Description | |
| 30 | Document Note | text | ||
| 31 | Serial Text Area | text | Item's Serial No | |
| 32 | Batch Text Area | text | Item's Batch No | |
| 33 | Lot Text Area | text | Item's Lot No | |
| 34 | POS Point Method | varchar(20) | Item's point given method (POS) | |
| 35 | POS Required Point | int(11) | Is the item required point to redeem? (yes/no) (POS) | |
| 36 | POS Given Point Per Unit | decimal(10,4) | Item's given point per unit (POS) | |
| 37 | POS Allow Top Up | int(11) | Is the item allow top up (yes/no) (POS) | |
| 38 | POS Value Amount | decimal(10,2) | Item's value amount (POS) | |
| 39 | POS Com Fix Amount | decimal(10,2) | Item's fix commission amount (POS) | |
| 40 | POS Com Allow Change | int(11) | Is the item's commission allow for modify? (yes/no) (POS) | |
| 41 | POS Service Duration | int(11) | Item's service duration (POS) | |
| 42 | POS Allow Buy Product | int(11) | Is the customer allow to buy product? (yes/no) (POS) | |
| 43 | Seq No | smallint(6) [10] | Sequence Number | |
| 44 | Is Active | smallint(1) [1] | Active / Non Active | |
| 45 | Created | datetime | Item's created date in the system | |
| 46 | Created By | varchar(50) | Item's creator | |
| 47 | Updated | datetime | Item's last updated date | |
| 48 | Updated By | varchar(50) | Item's last updated user | |
| 49 | Organization | int(11) | Item was created under which organization | |
| 50 | Branch | int(11) | Item details was created under which branch | |
| 51 | Image | text NULL | Item's image path | |
| 52 | HS Code | varchar(50) | Item's HS Code | |
| 53 | POS Given Point Per Quantity | decimal(10,4) | Item's given point per unit (POS) | |
| 54 | POS Given Point Per Amount | decimal(10,4) | Item's given point per amount (POS) | |
| Item Line Data | ||||
| No | Field Name | Data Type (Size) | Required | Description |
| 1 | Item Line ID | varchar(255) | Y | Item's line ID |
| 2 | Base UOM | varchar(255) | Item's Base UOM | |
| 3 | Sales UOM | varchar(255) | Item's Sales UOM | |
| 4 | Purchase UOM | varchar(255) | Item's Purchase UOM | |
| 5 | Costing Method | varchar(50) | Item's Costing Method | |
| 6 | Fix Cost | decimal(24,4) | Item's Fix Cost | |
| 7 | Sell Price | decimal(24,4) | Item's Sell Price | |
| 8 | Purchase Price | decimal(24,4) | Item's Purchase Price | |
| 9 | Is BOM | int(11) | Item's is BOM | |
| 10 | Is Stock | int(11) | Item's is Stock | |
| 11 | Is Purchase | int(11) | Item's is Purchase | |
| 12 | Is Sold | int(11) | Item's is Sold | |
| 13 | Is Package | int(11) | Item's is Package | |
| 14 | Is Inclusive | int(11) | Item's is Inclusive | |
| 15 | Is Allow Discount | int(11) | Item's Allow Discount | |
| 16 | Is Allow Price | int(11) | Item's Allow Price | |
| 17 | Purchase Account ID | varchar(255) | Item's Purchase Account | |
| 18 | Purchase Account Code | varchar(50) | Item's Purchase Account Code | |
| 19 | Purchase Account | varchar(200) | Item's Purchase Account Name | |
| 20 | Credit Sales Account ID | varchar(255) | Item's Credit Sales Account | |
| 21 | Credit Sales Account Code | varchar(50) | Item's Credit Sales Account Code | |
| 22 | Credit Sales Account | varchar(200) | Item's Credit Sales Account Name | |
| 23 | Cash Sales Account ID | varchar(255) | Item's Cash Sales Account | |
| 24 | Cash Sales Account Code | varchar(50) | Item's Cash Sales Account Code | |
| 25 | Cash Sales Account | varchar(200) | Item's Cash Sales Account Name | |
| 26 | Stock Adjust Account ID | varchar(255) | Item's Stock Adjust Account | |
| 27 | Stock Adjust Account Code | varchar(50) | Item's Stock Adjust Account Code | |
| 28 | Stock Adjust Account | varchar(200) | Item's Stock Adjust Account Name | |
| 29 | Expenses Account ID | varchar(255) | Item's Expenses Account | |
| 30 | Expenses Account Code | varchar(50) | Item's Expenses Account Code | |
| 31 | Expenses Account | varchar(200) | Item's Expenses Account Name | |
| 32 | Output Tax | varchar(255) | Item's Output Tax | |
| 33 | Input Tax | varchar(255) | Item's Input Tax | |
| 34 | MSIC Name | varchar(255) | Item's MSIC Code | |
| 35 | Location | varchar(255) | ||
| 36 | GRNDR Account | varchar(255) | ||
| 37 | GRNDR Account Code | varchar(50) | ||
| 38 | GRNDR Account Name | varchar(200) | ||
| 39 | SIDR Account | varchar(255) | ||
| 40 | SIDR Account Code | varchar(50) | ||
| 41 | SIDR Account Name | varchar(200) | ||
| 42 | GRNCR Account | varchar(255) | ||
| 43 | GRNCR Account Code | varchar(50) | ||
| 44 | GRNCR Account Name | varchar(200) | ||
| 45 | DODR Account | varchar(255) | ||
| 46 | DODR Account Code | varchar(50) | ||
| 47 | DODR Account Name | varchar(200) | ||
| 48 | DOCR Account | varchar(255) | ||
| 49 | DOCR Account Code | varchar(50) | ||
| 50 | DOCR Account Name | varchar(200) | ||
| 51 | PIDR Account | varchar(255) | ||
| 52 | PIDR Account Code | varchar(50) | ||
| 53 | PIDR Account Name | varchar(200) | ||
| 54 | SICR Account | varchar(255) | ||
| 55 | SICR Account Code | varchar(50) | ||
| 56 | SICR Account Name | varchar(200) | ||
| 57 | Batch Setting | varchar(255) | Not Applicable / Compulsory / Optional | |
| 58 | Serial Setting | varchar(255) | Not Applicable / Compulsory / Optional | |
| 59 | Lot Setting | varchar(255) | Not Applicable / Compulsory / Optional | |
| 60 | Serial Allow Direct Key | varchar(255) | Yes / No | |
| 61 | Lot Allow Direct Key | varchar(255) | Yes / No | |
| 62 | Batch Allow Direct Key | varchar(255) | Yes / No | |
| 63 | Is Serial | smallint(1) [0] | Yes / No | |
| 64 | Created | datetime | Item details's created date in the system | |
| 65 | Created By | varchar(255) | Item details's creator | |
| 66 | Updated | datetime | Item details's last updated date | |
| 67 | Updated By | varchar(255) | Item details's last updated user | |
| 68 | Auto SICR | varchar(255) | ||
| 69 | Auto SIDR | varchar(255) | ||
| 70 | Track 1 | varchar(50) | Item's Tracking 1 | |
| 71 | Track 2 | varchar(50) | Item's Tracking 2 | |
| 72 | Track 3 | varchar(50) | Item's Tracking 3 | |
| 73 | Track 4 | varchar(50) | Item's Tracking 4 | |
| 74 | Track 5 | varchar(50) | Item's Tracking 5 | |
| 75 | Purchase Return | varchar(255) | Item's Purchase return account | |
| 76 | Sales Return | varchar(255) | Item's Sales return account | |
| 77 | Sell Price Label | varchar(100) | ||
| 78 | Purchase Price Label | varchar(100) | ||
| Item Price List Data | ||||
| No | Field Name | Data Type (Size) | Required | Description |
| 1 | Price List ID | varchar(50) | Y | Item's Price List ID |
| 2 | Price List Type | varchar(2) | S : Sell; P : Purchase; | |
| 3 | UOM | varchar(50) | Item's price list UOM | |
| 4 | Price List Tag | varchar(50) | Item's price list tag | |
| 5 | Bpartner No | varchar(50) | Item's price list business partner no | |
| 6 | Bpartner Name | varchar(50) | Item's price list business partner name | |
| 7 | Currency Code | varchar(10) | Item's price list currency code | |
| 8 | Quantity | decimal(24,4) | Item's price list minimum order quantity | |
| 9 | Unit Price | decimal(24,4) | Item's price list unit price | |
| 10 | Discount | varchar(255) | Item's price list discount | |
| 11 | Date From | date | Item's price list start effective date | |
| 12 | Date To | date | Item's price list end effective date | |
| 13 | Lead Time | int(11) | ||
| 14 | Is Active | smallint(6) | Active / Non Active | |
| 15 | Is Default | int(1) | Default / Non Default | |
| 16 | Created | datetime | Item pricelist's created date in the system | |
| 17 | Created By | varchar(50) | Item pricelist's creator | |
| 18 | Updated | datetime | Item pricelist's last updated date | |
| 19 | Updated By | varchar(50) | Item pricelist's last updated user | |
| 20 | Document No | varchar(50) | Item's price list document no | |
| 21 | Document Type | varchar(50) | Item's price list type | |
| 22 | Document Format | varchar(255) NULL | Item's price list document format | |
| 23 | Price List Name | varchar(50) | Item's price list name | |
| 24 | Is Promotion | smallint(2) NULL | ||
| 25 | Is Overwrite Quantity | smallint(1) NULL | ||
| 26 | Is Overwrite Bpartner | smallint(1) NULL | ||
| 27 | Price Tag | varchar(50) | ||
| 28 | Description | text NULL | ||
| Item Price List Line ID | ||||
| No | Field Name | Data Type (Size) | Required | Description |
| 1 | Price List Line ID | varchar(50) | Y | Item's Price List line ID |
| 2 | Quantity | decimal(24,4) | Item's quantity in the price list | |
| 3 | Lead Time | int(11) | ||
| 4 | UOM | varchar(50) | Item's UOM in the price list | |
| 5 | Unit Price | decimal(24,4) | Item's unit price in the price list | |
| 6 | List Price | decimal(24,4) | Item's list price in the price list | |
| 7 | Discount | varchar(50) | Item's discount in the price list | |
| 8 | Description | text | Item's price list details's description | |
| 9 | Price List Version | int(11) | Price list's version | |
| 10 | Created | datetime | Item pricelist details's created date in the system | |
| 11 | Created By | varchar(50) | Item pricelist details's creator | |
| 12 | Updated | datetime | Item pricelist details's last updated date | |
| 13 | Updated By | varchar(50) | Item pricelist details's last updated user | |
| Item Price List Version ID | ||||
| No | Field Name | Data Type (Size) | Required | Description |
| 1 | Version ID | varchar(50) | Y | Item price list's version ID |
| 2 | Version No | int(11) | Item price list's version no | |
| 3 | Version Name | varchar(255) | Item price list's version name | |
| 4 | Date From | date | Item price list's version effective start date | |
| 5 | Date To | date | Item price list's version effective end date | |
| 6 | Created | datetime | Item pricelist version's created date in the system | |
| 7 | Created By | varchar(50) | Item pricelist version's creator | |
| 8 | Updated | datetime | Item pricelist version's last updated date | |
| 9 | Updated By | varchar(50) | Item pricelist version's last updated user |
[getStockItemData] => Array ( [status] => OK [msg] => OK [data] => Array ( [0] => Array ( [Header] => Array ( [Item ID] => 1-1-208 [Item Code] => IT SOFTWARE 001 [Item Name] => IT SOFTWARE [Alternate Name] => [Barcode] => [Category] => Services [Type] => [Brand] => [Is Get Point] => 0 [Is Redeem] => 0 [Max Quantity] => 0 [Min Quantity] => 0 [Is Use Account ID] => [Prefix 1] => [Prefix 2] => [Prefix 3] => [Prefix Number] => [Attachment URL] => [Filename] => [Width] => 0.0000 [Thickness] => 0.0000 [Length] => 0.0000 [Weight] => 0.0000 [Size] => 0.0000 [Schedule] => [Country] => [Capacity] => 0 [Tool Tips] => [Description] => [Document Note] => [Serial Text Area] => [Batch Text Area] => [Lot Text Area] => [POS Point Method] => [POS Required Point] => 0 [POS Given Point Per Unit] => 0.0000 [POS Allow Top Up] => 0 [POS Value Amount] => 0.00 [POS Com Fix Amount] => 0.00 [POS Com Allow Change] => 0 [POS Service Duration] => 0 [POS Allow Buy Product] => 0 [Seq No] => 10 [Is Active] => 1 [Created] => 2019-01-16 12:02:22 [Created By] => admin [Updated] => 2019-01-16 12:02:22 [Updated By] => admin [Organization] => SIMIT SDN BHD [Branch] => HQ [Image] => [HS Code] => [POS Given Point Per Quantity] => 0.0000 [POS Given Point Per Amount] => 0.0000 )
[Line Details] => Array
(
[Item Line ID] => 1-1-208-1547611342787
[Base UOM] => Unit(s)
[Sales UOM] => Unit(s)
[Purchase UOM] => Unit(s)
[Costing Method] =>
[Fix Cost] => 0.0000
[Sell Price] => 0.0000
[Purchase Price] => 0.0000
[Is BOM] => 0
[Is Stock] => 0
[Is Purchase] => 1
[Is Sold] => 1
[Is Package] => 0
[Is Inclusive] => 0
[Is Allow Discount] => 0
[Is Allow Price] => 0
[Purchase Account ID] =>
[Purchase Account Code] =>
[Purchase Account] =>
[Credit Sales Account ID] => 1-1-540
[Credit Sales Account Code] => 7006/019
[Credit Sales Account] => SALES - 001
[Cash Sales Account ID] =>
[Cash Sales Account Code] =>
[Cash Sales Account] =>
[Stock Adjust Account ID] =>
[Stock Adjust Account Code] =>
[Stock Adjust Account] =>
[Expenses Account ID] =>
[Expenses Account Code] =>
[Expenses Account] =>
[Output Tax] =>
[Input Tax] =>
[MSIC Name] =>
[Location] =>
[GRNDR Account] =>
[GRNDR Account Code] =>
[GRNDR Account Name] =>
[SIDR Account] =>
[SIDR Account Code] =>
[SIDR Account Name] =>
[GRNCR Account] =>
[GRNCR Account Code] =>
[GRNCR Account Name] =>
[DODR Account] =>
[DODR Account Code] =>
[DODR Account Name] =>
[DOCR Account] =>
[DOCR Account Code] =>
[DOCR Account Name] =>
[PIDR Account] =>
[PIDR Account Code] =>
[PIDR Account Name] =>
[SICR Account] =>
[SICR Account Code] =>
[SICR Account Name] =>
[Batch Setting] =>
[Serial Setting] =>
[Lot Setting] =>
[Serial Allow Direct Key] =>
[Lot Allow Direct Key] =>
[Batch Allow Direct Key] =>
[Is Serial] =>
[Created] => 2019-01-16 12:02:22
[Created By] => admin
[Updated] => 2019-01-16 12:02:22
[Updated By] => admin
[Auto SICR] =>
[Auto SIDR] =>
[Track 1] =>
[Track 2] =>
[Track 3] =>
[Track 4] =>
[Track 5] =>
[Purchase Return] =>
[Sales Return] =>
[Sell Price Label] =>
[Purchase Price Label] =>
)
[Price List] => Array
(
[0] => Array
(
[Price List ID] => 1-1-P
[Price List Type] => P
[UOM] =>
[Price List Tag] =>
[Bpartner No] =>
[Bpartner Name] =>
[Currency Code] => MYR
[Quantity] => 0.0000
[Unit Price] => 0.0000
[Discount] =>
[Date From] => 0000-00-00
[Date To] => 0000-00-00
[Lead Time] => 0
[Is Active] => 1
[Is Default] => 0
[Created] => 2017-11-20 10:39:16
[Created By] =>
[Updated] => 2017-11-20 10:39:16
[Updated By] => admin
[Document No] =>
[Document Type] => PL
[Document Format] =>
[Price List Name] => Default Standard Purchase Price List
[Is Promotion] => 0
[Is Overwrite Quantity] => 0
[Is Overwrite Bpartner] => 0
[Price Tag] =>
[Description] =>
)
[1] => Array
(
[Price List ID] => 1-1-S
[Price List Type] => S
[UOM] =>
[Price List Tag] =>
[Bpartner No] =>
[Bpartner Name] =>
[Currency Code] => MYR
[Quantity] => 0.0000
[Unit Price] => 0.0000
[Discount] =>
[Date From] => 0000-00-00
[Date To] => 0000-00-00
[Lead Time] => 0
[Is Active] => 1
[Is Default] => 0
[Created] => 2017-11-20 10:39:17
[Created By] =>
[Updated] => 2017-11-20 10:39:17
[Updated By] => admin
[Document No] =>
[Document Type] => PL
[Document Format] =>
[Price List Name] => Default Standard Sales Price List
[Is Promotion] => 0
[Is Overwrite Quantity] => 0
[Is Overwrite Bpartner] => 0
[Price Tag] =>
[Description] =>
)
)
[Price List Line] => Array
(
[0] => Array
(
[Price List Line ID] => 1-1-P-1547611342798
[Quantity] => 0.0000
[Lead Time] => 0
[UOM] => Unit(s)
[Unit Price] => 0.0000
[List Price] => 0.0000
[Discount] =>
[Description] =>
[Price List Version] => 1
[Created] => 2019-01-16 12:02:22
[Created By] => admin
[Updated] => 2019-01-16 12:02:22
[Updated By] =>
)
[1] => Array ( [Price List Line ID] => 1-1-S-1547611342807 [Quantity] => 0.0000 [Lead Time] => 0 [UOM] => Unit(s) [Unit Price] => 0.0000 [List Price] => 0.0000 [Discount] => [Description] => [Price List Version] => 1 [Created] => 2019-01-16 12:02:22 [Created By] => admin [Updated] => 2019-01-16 12:02:22 [Updated By] => )
)
[Price List Version] => Array
(
[0] => Array
(
[Version ID] => 1-1-P-1511145556647
[Version No] => 1
[Version Name] => Default Standard Purchase Price List Ver.1
[Date From] => 2017-11-20
[Date To] => 0000-00-00
[Created] => 2017-11-20 10:39:16
[Created By] => admin
[Updated] => 2017-11-20 10:39:16
[Updated By] => admin
)
[1] => Array
(
[Version ID] => 1-1-S-1511145556653
[Version No] => 1
[Version Name] => Default Standard Purchase Sales List Ver.1
[Date From] => 2017-11-20
[Date To] => 0000-00-00
[Created] => 2017-11-20 10:39:17
[Created By] => admin
[Updated] => 2017-11-20 10:39:17
[Updated By] => admin
)
)
)
)
)