6.1. Extension v4

Interface

Extension to the standard interface.

If the ”ID's” columns are used then the corresponding columns for name or value would be ignored.

Actions can be done:

• list

• create, update, delete

  • print 

 Internal Use Inventory (Master and Details)

API Method

List headers and details:

URL:    https://api.socratecloud.com/webapi/rest/internal_use_inventory/full/list/{version}?startRow={0}&endRow={100}&accessToken={access_token}

Method: GET

Available filter parameters:

• Organization_ID

• Inventory_ID

  • BPartner_ID

  • Warehouse_ID

Return: JSON object with next format:

{

    "data": [

        {

            "Organization_ID": 1000001,

            "Organization": "Demo SRL",

            "Created": "2018-03-05 09:52:26+0000",

            "CreatedBy_ID": 1000002,

            "CreatedBy": "AdminTitular",

            "Updated": "2018-03-05 09:56:15+0000",

            "UpdatedBy_ID": 1000002,

            "UpdatedBy": "AdminTitular",

            "DocumentNo": "1027001",

            "DocType": "Internal Use Inventory",

            "Description": null,

            "MovementDate": "2018-03-05 00:00:00+0000",

            "BPartner_ID": 1000384,

            "BPartner": "E1",

            "BPartnerName": "Employee 1",

            "Warehouse_ID": 1000288,

            "Warehouse": "Depozit A",

            "TrxOrganization_ID": null,

            "TrxOrganization": null,

            "Activity_ID": null,

            "Activity": null,

            "Project_ID": null,

            "Project": null,

            "DocumentStatus": "Completed",

            "DocumentAction": "Close",

            "RegisterDocument": null,

            "ExtPartner_ID": null,

            "Inventory_ID": 1011814,

            "lines": [

                {

                    "Organization_ID": 1000001,

                    "Organization": "Demo SRL",

                    "Created": "2018-03-05 09:52:26+0000",

                    "CreatedBy_ID": 1000002,

                    "CreatedBy": "AdminTitular",

                    "Updated": "2018-03-05 09:52:26+0000",

                    "UpdatedBy_ID": 1000002,

                    "UpdatedBy": "AdminTitular",

                    "Line": 10,

                    "Product_ID": 1000053,

                    "Product": "Struguri RO",

                    "Locator_ID": 1000129,

                    "Locator": "Depozit A",

                    "ProductName": "Struguri RO",

                    "Description": null,

                    "QtyEntered": 1,

                    "UOM_ID": 100,

                    "UOM": "Each",

                    "Charge_ID": null,

                    "Charge": null,

                    "InventoryLine_ID": 1012676

                }

            ]

        }

    ],

    "totalRows": 1

}

Create header and details:

URL: https://api.socratecloud.com/webapi/rest/internal_use_inventory/full/create/{version}?accessToken={access_token}

Method: POST

Return: document no for success or error message (start with "ERROR: ")

Data format:

{

            "Organization_ID": 1000001,

            "Organization": "Demo SRL",

            "Created": "2018-03-05 08:21:07+0000",

            "CreatedBy_ID": 1000002,

            "CreatedBy": "AdminTitular",

            "Updated": "2018-03-05 08:23:49+0000",

            "UpdatedBy_ID": 1000002,

            "UpdatedBy": "AdminTitular",

            "DocumentNo": "1027003",

            "DocType": "Internal Use Inventory",

            "Description": "Test cu ID-uri",

            "MovementDate": "2018-03-05 00:00:00+0000",

            "BPartner_ID": 1000384,

            "BPartner": "E1",

            "BPartnerName": "Employee 1",

            "Warehouse_ID": 1000288,

            "Warehouse": "Depozit A",

            "TrxOrganization_ID": 1000001,

            "TrxOrganization": null,

            "Activity_ID": 1000116,

            "Activity": "Testare API",

            "Project_ID": 1000717,

            "Project": null,

            "DocumentStatus": "Completed",

            "DocumentAction": "Close",

            "RegisterDocument": null,

            "ExtPartner_ID": null,

            "Inventory_ID": 1011762,

            "lines": [

                {

                    "Organization_ID": 1000001,

                    "Organization": "Demo SRL",

                    "Created": "2018-03-05 08:23:43+0000",

                    "CreatedBy_ID": 1000002,

                    "CreatedBy": "AdminTitular",

                    "Updated": "2018-03-05 08:23:43+0000",

                    "UpdatedBy_ID": 1000002,

                    "UpdatedBy": "AdminTitular",

                    "Line": 10,

                    "Product_ID": 1000053,

                    "Product": "Struguri RO API",

                    "Locator_ID": 1000129,

                    "Locator": "Depozit A",

                    "ProductName": "Struguri RO",

                    "Description": null,

                    "QtyEntered": 1,

                    "UOM_ID": 100,

                    "UOM": "Each",

                    "Charge_ID": null,

                    "Charge": null,

                    "InventoryLine_ID": 1012625

                }

            ]

        }

List header only:

URL:    https://api.socratecloud.com/webapi/rest/internal_use_inventory/list/{version}?startRow={0}&endRow={100}&accessToken={access_token}

Method: GET

Available filter parameters:

• Organization_ID

• Inventory_ID

  • BPartner_ID

  • Warehouse_ID

Return: JSON object with next format:

{

    "data": [

        {

            "Organization_ID": 1000001,

            "Organization": "Demo SRL",

            "Created": "2014-01-14 09:54:03+0000",

            "CreatedBy_ID": 1000008,

            "CreatedBy": "Dana Boarti",

            "Updated": "2014-01-14 09:54:51+0000",

            "UpdatedBy_ID": 1000008,

            "UpdatedBy": "Dana Boarti",

            "DocumentNo": "1000901",

            "DocType": "Internal Use Inventory",

            "Description": "(1000901^<-)",

            "MovementDate": "2014-01-13 00:00:00+0000",

            "BPartner_ID": null,

            "BPartner": null,

            "BPartnerName": null,

            "Warehouse_ID": 1000009,

            "Warehouse": "Gest PAS 2celule",

            "TrxOrganization_ID": null,

            "TrxOrganization": null,

            "Activity_ID": null,

            "Activity": null,

            "Project_ID": null,

            "Project": null,

            "DocumentStatus": "Voided",

            "DocumentAction": "<None>",

            "RegisterDocument": null,

            "ExtPartner_ID": null,

            "Inventory_ID": 1000013

        }

    ],

}

Create header only:

URL: https://api.socratecloud.com/webapi/rest/internal_use_inventory/create/{version}?accessToken={access_token}

Method: POST

Return: document no for success or error message (start with "ERROR: ")

Data format:

{

            "Organization_ID": 1000001,

            "Organization": "Demo SRL",

            "Created": "2018-03-05 08:21:07+0000",

            "CreatedBy_ID": 1000002,

            "CreatedBy": "AdminTitular",

            "Updated": "2018-03-05 08:23:49+0000",

            "UpdatedBy_ID": 1000002,

            "UpdatedBy": "AdminTitular",

            "DocumentNo": "1027003",

            "DocType": "Internal Use Inventory",

            "Description": "Test cu ID-uri",

            "MovementDate": "2018-03-05 00:00:00+0000",

            "BPartner_ID": 1000384,

            "BPartner": "E1",

            "BPartnerName": "Employee 1",

            "Warehouse_ID": 1000288,

            "Warehouse": "Depozit A",

            "TrxOrganization_ID": 1000001,

            "TrxOrganization": null,

            "Activity_ID": 1000116,

            "Activity": "Testare API",

            "Project_ID": 1000717,

            "Project": null,

            "DocumentStatus": "Completed",

            "DocumentAction": "Close",

            "RegisterDocument": null,

            "ExtPartner_ID": null,

            "Inventory_ID": 1011762

}

Update header only:

URL:     https://api.socratecloud.com/webapi/rest/internal_use_inventory/update/{version}?accessToken={access_token}&DocumentNo={document_no}

Method: POST

Return: document no for success or error message (start with "ERROR: ")

Data format:

{

    "Organization": "Organization F.O",

    "DocumentNo": "1000500",

    "DocType": "Internal Use Inventory",

    "Description": "Test Case - 005 (check costs with LC on FIFO+ORG)",

    "MovementDate": "2013-03-08 00:00:00+0200",

    "BPartner": null,

    "Warehouse": "Warehouse-2 F.O",

    "TrxOrganization": null,

    "Activity": null,

    "Project": "ABC",

    "DocumentAction": "Complete"

}

Delete header (automatically deletes also details):

URL:     https://api.socratecloud.com/webapi/rest/internal_use_inventory/delete/{version}?accessToken={access_token}&DocumentNo={document_no}

Method: POST

Return: 'Deleted' for success or error message (start with "ERROR: ")

             ID: null

Process header:

URL:     https://api.socratecloud.com/webapi/rest/internal_use_inventory/process/{version}?accessToken={access_token}&DocumentNo={document_no}&DocumentAction={document_action}

Method: POST

Return: Document status for success or error message (start with "ERROR: ")

             ID: null

List details:

URL:    https://api.socratecloud.com/webapi/rest/internal_use_inventory/line/list/{version}?startRow={0}&endRow={100}&accessToken={access_token}&DocumentNo={document_no}

Method: GET

Available filter parameters:

• InventoryLine_ID

  • Product_ID

Return: JSON object with next format:

{

    "data": [

        {

            "Organization_ID": 1000001,

            "Organization": "Demo SRL",

            "Created": "2018-03-05 10:14:41+0000",

            "CreatedBy_ID": 1000002,

            "CreatedBy": "AdminTitular",

            "Updated": "2018-03-05 10:14:41+0000",

            "UpdatedBy_ID": 1000002,

            "UpdatedBy": "AdminTitular",

            "Line": 10,

            "Product_ID": 1000053,

            "Product": "Struguri RO",

            "Locator_ID": 1000129,

            "Locator": "Depozit A",

            "ProductName": "Struguri RO",

            "Description": null,

            "QtyEntered": 1,

            "UOM_ID": 100,

            "UOM": "Each",

            "Charge_ID": null,

            "Charge": null,

            "InventoryLine_ID": 1012677

        }

    ],

    "totalRows": 1

}

Create detail:

URL: https://api.socratecloud.com/webapi/rest/internal_use_inventory/line/create/{version}?accessToken={access_token}&DocumentNo={document_no}&Line={Line}

Method: POST

Return: line no and inventory line ID and inventory line ID for success or error message (start with "ERROR: ")

Data format:

{

   "Product_ID": 1010591,

   "Product": "Struguri RO",

   "Description": "Test linie API",

   "QtyEntered": 2,

   "Charge_ID": 1000001,

   "Charge": null,

}

Note: Locator or Locator_ID is ignored if they are used.

Update detail:

URL: https://api.socratecloud.com/webapi/rest/internal_use_inventory/line/update/{version}?accessToken={access_token}&DocumentNo={document_no}&Line={line_no}

Method: POST

Return: line no for success or error message (start with "ERROR: ")

Data format:

{

            "Product_ID": 1006595,

            "Description": "Test linie API - fara linie",

            "QtyEntered": 8,

            "Charge_ID": 1000001

}

Note: Locator or Locator_ID is ignored if they are used.

Delete detail:

URL:     https://api.socratecloud.com/webapi/rest/internal_use_inventory/line/delete/{version}?accessToken={access_token}&DocumentNo={document_no}&Line={line_no}

Method: POST

Return: 'Deleted' and inventory line ID = null for success or error message (start with "ERROR: ")

Print:

URL:     https://api.socratecloud.com/webapi/rest/internal_use_inventory/print/{version}?accessToken={access_token}&DocumentNo={document_no}

Method: GET

Return: PDF file

Filter: Inventory_ID