GET api/Pricelist

Retrieve pricelists from ESOFT that were modified after the given date. Not providing itemcode returns every item. Not providing code returns every used pricelist code Retrieve data that were modified after given LastSyncDate. Stopped items and items with disallowed levels are excluded. Setting "validate" field to true return only the currently active pricelists

Request Information

URI Parameters

None.

Body Parameters

PricelistReq
NameDescriptionTypeAdditional information
Company

The company name

string

Required

LastSyncDate

Retrieve pricelists that were modified since LastSyncDate

date

Required

Code

Pricelist code. Not using this field returns every pricelist

string

String length: inclusive between 0 and 6

ItemCode

The item code. Not using this field returns every item

string

String length: inclusive between 0 and 30

Validate

Setting "validate" field to true return only the currently active pricelists

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "Company": "DEMO",
  "LastSyncDate": "2019-01-01T14:30:00",
  "Code": "001",
  "ItemCode": null,
  "Validate": false
}

Response Information

Resource Description

PricelistRes
NameDescriptionTypeAdditional information
msgControl

Message control - Will contain information about the response

MsgControl

None.

Pricelists

List of pricelists

Collection of Pricelist

None.

Response Formats

application/json, text/json

Sample:
{
  "msgControl": {
    "result": 0,
    "Message": "Corresponding success and error message",
    "MethodName": "api/Pricelist GET",
    "AppName": "EsoftWebApi",
    "EsoftUser": "ESOFT",
    "User": "Username",
    "Password": "Password",
    "SystemDate": "2025-01-06T22:32:15.2189577+02:00",
    "GenList": [],
    "GenMsg1": "",
    "GenMsg2": "",
    "GenMsg3": ""
  },
  "Pricelists": [
    {
      "Company": "DEMO",
      "Code": "001",
      "Description": "Pricelist description",
      "PriceList": [
        {
          "ItemCode": "0.5LURSUS",
          "Quantity": 1,
          "StartDate": "2019-12-25T00:00:00",
          "EndDate": "2019-12-25T00:00:00",
          "PriceCode": "1",
          "Price": 40.0,
          "DiscountType": "%",
          "Discount": 10.0,
          "DiscountType2": "A",
          "Discount2": 15.0,
          "Remarks": ""
        },
        {
          "ItemCode": "COde",
          "Quantity": 2,
          "StartDate": "2019-12-25T00:00:00",
          "EndDate": "2019-12-25T00:00:00",
          "PriceCode": "1",
          "Price": 15.0,
          "DiscountType": "A",
          "Discount": 1.0,
          "DiscountType2": "N",
          "Discount2": 0.0,
          "Remarks": ""
        }
      ]
    }
  ]
}