List Price Lists

post/fetch/PL

Retrieves a list of Price Lists. You can apply a filter on returned price lists.

Securitybasic or X-PriceFx-jwt
Request
Request Body schema: application/json
endRow
number
Default: 300

The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.

oldValues
any
operationType
string non-empty
startRow
number

The number of the first row that defines the start of the result set's returned objects. Use this parameter if you want to implement paging for results.

textMatchStyle
string non-empty
object
_constructor
string non-empty
operator
string non-empty
Array of objects non-empty unique
Array (non-empty)
fieldName
string non-empty
operator
string non-empty
value
string non-empty
Responses
200

OK

Response Schema: application/json
object
node
string non-empty
startRow
number
Array of objects non-empty unique
Array (non-empty)
version
number
typedId
string non-empty
targetDate
string non-empty
label
string non-empty
calculationMessages
string non-empty
numberOfItems
number
keepManualOverrides
boolean
writeOnlyChangedItems
boolean
configuration
string non-empty
errorMode
string non-empty
pricelistType
string non-empty
approvalState
string non-empty
createdByName
string non-empty
lastUpdateByName
string non-empty
updatedBy
number
updateDate
string non-empty
createDate
string non-empty
createdBy
number
lastUpdateDate
string non-empty
lastUpdateBy
number
status
string non-empty
calculationDate
string non-empty
id
number
endRow
number
totalRows
number
status
number
Request samples
application/json
{
  • "endRow": 300,
  • "operationType": "fetch",
  • "startRow": 0,
  • "textMatchStyle": "exact",
  • "data": {
    • "_constructor": "AdvancedCriteria",
    • "operator": "and",
    • "criteria": [
      • {
        • "fieldName": "createDate",
        • "operator": "greaterThan",
        • "value": "2021-10-01T12:03:52"
        }
      ]
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "string",
    • "startRow": 0,
    • "data": [
      • {
        • "version": 0,
        • "typedId": "string",
        • "targetDate": "string",
        • "label": "string",
        • "calculationMessages": "string",
        • "numberOfItems": 0,
        • "keepManualOverrides": true,
        • "writeOnlyChangedItems": true,
        • "configuration": "string",
        • "errorMode": "string",
        • "pricelistType": "string",
        • "approvalState": "string",
        • "createdByName": "string",
        • "lastUpdateByName": "string",
        • "updatedBy": 0,
        • "updateDate": "string",
        • "createDate": "string",
        • "createdBy": 0,
        • "lastUpdateDate": "string",
        • "lastUpdateBy": 0,
        • "status": "string",
        • "calculationDate": "string",
        • "id": 0
        }
      ],
    • "endRow": 0,
    • "totalRows": 0,
    • "status": 0
    }
}