1.2 Sales Order Details

Interface

It allows you:

• to insert new lines (one by one)  into an existing  sales orders 

• to update, delete sales order lines (one by one)

• to view sales order lines

Prerequisites:

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

• • to have an open Sales Order (document status: Draft, In Progress)

• to have products active with all the mandatory fields

  • the products selected on Sales Order must have prices defined in the Price List selected on the Sales Order

Columns that can  be used as filters:

• • DocumentNo (OrderNo)

  • Line

  • Product

  • AssetValue

  • AssetSN

  • Employee

  • Project

  • ProjectPhase

  • ProjectTask

Mandatory Parameters when inserting order lines: 

• • OrderNo

Actions can be done:

• list

• insert

• update

• delete

Sales Order line fields

API Methods:

List:

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

Method: GET

Return: JSON object with next format:

{

    "data": [

        {

            "Organization": "Demo SRL",

            "Created": "2014-03-04 06:31:38",

            "CreatedBy": "SuperUser",

            "Updated": "2014-03-04 06:31:38",

            "UpdatedBy": "SuperUser",

            "IsActive": true,

            "Line": 10,

            "ID": 1000001,

            "Product": "some_product",

            "ProductName": "some_product",

            "Description": null,

            "QtyEntered": 1,

        "UOM_ID": 100,

            "UOM": "Each",

            "ListPrice": 150,

            "Discount": 0,

            "PriceEntered": 150,

            "LineNetAmt": 150,

            "IsTaxIncluded": true,

            "Tax": "24% ",

            "TrxOrganization": "Demo SRL",

            "Activity": null,

            "AssetValue": "9195",

            "AssetSN": null,

            "Employee": "Loredan",

            "Project" : null,

            "ProjectPhase": null,

          "ProjectTask": null,

            "BOMPrice": null,

            "SecondaryQty": null,

            "DropShip": false,

            "Status_ID": 1000081,

            "Status": "Creat",

            "Campaign_ID":null,

            "CampaignValue": "Campanie testare",

            "Campaign": "Campanie testare"

    "User1_ID": 1053396,

            "User1": "1068",

      "LineHelp": "test12"

            "OnInvoicePricePackage": 9,

            "OnInvoicePoint": 4, 

            "OnInvoiceVoucher": 6,

            "OnInvoicePriceDiscount1": 9,

            "OnInvoicePriceDiscount2": 9,

            "OnInvoicePriceDiscount3": 9,

            "OnInvoicePriceDiscount4": 9,

            "OnInvoicePriceDiscount5": 9,

            "OnInvoicePriceDiscount6": 9

  }

    ],

    "totalRows": 1

}

Create:

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

Method: POST

Return: line no & id for success or error message 

Data format:

{

    "Organization": "Demo SRL",

    "Active": true,

    "Product": "some_product",

    "Description": null,

    "QtyEntered": 1,

    "UOM_ID": 100,

    "UOM": "Each",

    "ListPrice": null,

    "Discount": null,

    "PriceEntered": null,

    "Tax": "24% ",

    "TrxOrganization": "Demo SRL",

    "Activity": "Programare",

    "AssetValue": "9195",

    "AssetSN": null,

    "Employee": "Loredan",

    "Project" : null,

    "ProjectPhase": null,

    "ProjectTask": null,

    "BOMPrice": null,

    "SecondaryQty": null,

    "DropShip": false,

    "Status_ID": 1000081,

    "Status": "Creat",

    "Campaign_ID":null,

    "CampaignValue": "Campanie testare",

    "Campaign": "Campanie testare"

    "User1_ID": 1053396,

    "User1": "1068",

    "LineHelp": "test12"

      "OnInvoicePricePackage": 9,

      "OnInvoicePoint": 4,

      "OnInvoiceVoucher": 6,

      "OnInvoicePriceDiscount1": 9,

      "OnInvoicePriceDiscount2": 9,

      "OnInvoicePriceDiscount3": 9,

      "OnInvoicePriceDiscount4": 9,

      "OnInvoicePriceDiscount5": 9,

      "OnInvoicePriceDiscount6": 9

}

Update:

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

{

    "Organization": "Demo SRL",

    "Active": true,

    "Product": "some_product",

    "Description": null,

    "QtyEntered": 1,

    "ListPrice": null,

    "Discount": null,

    "PriceEntered": null,

    "Tax": "24% ",

    "TrxOrganization": "Demo SRL",

    "Activity": "Programare",

    "AssetValue": "9195",

    "AssetSN": null,

    "Employee": "Loredan",

    "Project" : null,

    "ProjectPhase": null,

    "ProjectTask": null,

    "BOMPrice": null,

    "DropShip": false,

    "Status_ID": 1000081,

    "Status": "Creat",

    "Campaign_ID":null,

    "CampaignValue": "Campanie testare",

    "Campaign": "Campanie testare",

    "User1_ID": 1053396,

    "User1": "1068",

    "LineHelp": "Test API 2",

      "OnInvoicePricePackage": 9,

      "OnInvoicePoint": 4,

      "OnInvoiceVoucher": 6,

      "OnInvoicePriceDiscount1": 9,

      "OnInvoicePriceDiscount2": 9,

      "OnInvoicePriceDiscount3": 9,

      "OnInvoicePriceDiscount4": 9,

      "OnInvoicePriceDiscount5": 9,

      "OnInvoicePriceDiscount6": 9

}

Delete:

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

Method: POST

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