08. Physical Inventory

Interface

It allows you:

• to insert new documents (master&details in one json file)

  • to view and print inventory documents (master&details in one json file)

This document is used  to correlate OnHand quantity with Quantity book through inventory process.

Prerequisites:

In order to use this API Method for PUT there must be accomplished the following requirements in SocrateCloud:

• to have an Organization active

  • to have an Role active

Columns that can  be used as filters:

• • Organization

  • DocumentNo

  • MovementDate

  • Warehouse

  • BPartner

Actions can be done:

• list

• create, update, delete

  • print 

 Physical Inventory (Master and Details)

API Method

List headers and details:

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

Method: GET

Available filter parameters:

• Organization

  • DocumentNo

  • MovementDate

  • Warehouse

  • BPartner

Return: JSON object with next format:

{

    "data": [

        {

            "Organization": "Demo SRL",

            "Created": "2014-01-17 09:20:19+0200",

            "CreatedBy": "SuperUser",

            "Updated": "2014-03-14 10:31:58+0200",

            "UpdatedBy": "SuperUser",

            "DocumentNo": "620202",

            "DocType": "Inventar",

            "Description": "I 1000005 2014-01-15 00:00:00.0",

            "MovementDate": "2014-01-15 00:00:00+0200",

            "BPartner": null,

            "BPartnerName": null,

            "Warehouse": "Depozit central",

            "TrxOrganization": null,

            "Activity": null,

            "DocumentStatus": "Completed",

            "DocumentAction": "Close",

            "lines": [

                {

                    "Organization": "Demo SRL",

                    "Created": "2014-01-17 09:20:20+0200",

                    "CreatedBy": "SuperUser",

                    "Updated": "2014-01-17 09:20:20+0200",

                    "UpdatedBy": "SuperUser",

                    "Line": 10,

                    "Product": "Standard",

                    "Locator": "Crama",

                    "ProductName": "Standard",

                    "Description": null,

                    "QtyEntered": 0,

                    "QtyBook": 0,

                    "InventoryType": "Inventory Difference",

                    "UOM": "Each",

                    "Charge": null

                }

            ]

        }

    ],

    "totalRows": 1

}

Create header and details:

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

Method: POST

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

Data format:

{

    "Organization": "Demo SRL",

    "DocumentNo": null,

    "DocType": "Inventar",

    "Description": "I 1000005 2014-01-15 00:00:00.0",

    "MovementDate": "2014-01-15 00:00:00+0200",

    "BPartner": null,

    "Warehouse": "Depozit central",

    "TrxOrganization": null,

    "Activity": null,

    "DocumentAction": null,

    "lines": [

        {

            "Line": 10,

            "Product": "Standard",

            "Description": null,

            "QtyEntered": 10,

            "InventoryType": "Inventory Difference",

            "Charge": null

        }

    ]

}

List headers only:

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

Method: GET

Available filter parameters:

• Organization

  • DocumentNo

  • MovementDate

  • Warehouse

  • BPartner

Return: JSON object with next format:

{

    "data": [

        {

            "Organization": "Demo SRL",

            "Created": "2014-01-17 09:20:19+0200",

            "CreatedBy": "SuperUser",

            "Updated": "2014-03-14 10:31:58+0200",

            "UpdatedBy": "SuperUser",

            "DocumentNo": "620202",

            "DocType": "Inventar",

            "Description": "I 1000005 2014-01-15 00:00:00.0",

            "MovementDate": "2014-01-15 00:00:00+0200",

            "BPartner": null,

            "BPartnerName": null,

            "Warehouse": "Depozit central",

            "TrxOrganization": null,

            "Activity": null,

            "DocumentStatus": "Completed",

            "DocumentAction": "Close"

        }

    ],

    "totalRows": 1

}

Create header only:

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

Method: POST

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

Data format:

{

    "Organization": "Demo SRL",

    "DocumentNo": null,

    "DocType": "Inventar",

    "Description": "I 1000005 2014-01-15 00:00:00.0",

    "MovementDate": "2014-01-15 00:00:00+0200",

    "BPartner": null,

    "Warehouse": "Depozit central",

    "TrxOrganization": null,

    "Activity": null,

    "DocumentAction": null

}

Update header only:

URL:     https://api.socratecloud.com/webapi/rest/physical_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": "Demo SRL",

    "DocumentNo": null,

    "DocType": "Inventar",

    "Description": null,

    "MovementDate": "2014-01-15 00:00:00+0200",

    "BPartner": null,

    "Warehouse": "Depozit central",

    "TrxOrganization": null,

    "Activity": null,

    "DocumentAction": null

}

Delete header (automatically deletes also details):

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

Method: POST

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

Process header:

URL:     https://api.socratecloud.com/webapi/rest/physical_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: ")

List details:

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

Method: GET

Available filter parameters:

• Line

  • Product

Return: JSON object with next format:

{

    "data": [

        {

            "Organization": "Demo SRL",

            "Created": "2014-01-17 09:20:20+0200",

            "CreatedBy": "SuperUser",

            "Updated": "2014-01-17 09:20:20+0200",

            "UpdatedBy": "SuperUser",

            "Line": 10,

            "Product": "Standard",

            "Locator": "Crama",

            "ProductName": "Standard",

            "Description": null,

            "QtyEntered": 0,

            "QtyBook": 0,

            "InventoryType": "Inventory Difference",

            "UOM": "Each",

            "Charge": null

        }

    ],

    "totalRows": 1

}

Create detail:

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

Method: POST

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

Data format:

{

    "Line": 10,

    "Product": "Standard",

    "Description": null,

    "QtyEntered": 10,

    "InventoryType": "Inventory Difference",

    "Charge": null

}

Update detail:

URL:     https://api.socratecloud.com/webapi/rest/physical_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:

{

    "Line": 10,

    "Product": "Standard",

    "Description": null,

    "QtyEntered": 10,

    "InventoryType": "Inventory Difference",

    "Charge": null

}

Delete detail:

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

Method: POST

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

Print:

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

Method: GET

Return: PDF file