List Contract Price Records

post/fetch/CPR

Retrieves Contract Price Records (CPR). Use the filter (see the request sample) to exclude Quote Price Records from the returned Price Records.

To work with Contract Price Records, the option enableAPRecalculation must be set to true. Navigate to Administration > Configuration > System Configuration > Advanced Configuration Options and add the enableAPRecalculation option.

Securitybasic or X-PriceFx-jwt
Request
Request Body schema: application/json
endRow
integer
operationType
string
startRow
integer
textMatchStyle
string
object
Array of objects
Array
fieldName
string
operator
string
value
string
_constructor
string
operator
string
Responses
200

OK

Response Schema: application/json
object
node
string
startRow
integer
Array of objects (ContractPriceRecord)
Array
sourceId
string <= 255 characters
typedId
string
lastUpdateDate
string <date-time>
externalRef
string <= 255 characters
sourceIdNoRev
string <= 255 characters
userGroupViewDetails
string <= 255 characters
sku
string <= 255 characters
object
priority
integer
version
integer
attribute9
string <= 255 characters
attribute8
string <= 255 characters
uniqueName
string <= 255 characters
attribute5
string <= 255 characters
attribute4
string <= 255 characters
attribute7
string <= 255 characters
attribute6
string <= 255 characters
name
string <= 255 characters
attribute1
string <= 255 characters
attribute14
string <= 255 characters
attribute13
string <= 255 characters
userGroupEdit
string <= 255 characters
attribute3
string <= 255 characters
attribute12
string <= 255 characters
attribute2
string <= 255 characters
attribute11
string <= 255 characters
attribute10
string <= 255 characters
status
string <= 255 characters
Possible values: "ACTIVE" "REVOKED" "INVALIDATED"
attribute19
string <= 255 characters
attribute18
string <= 255 characters
attribute17
string <= 255 characters
attribute16
string <= 255 characters
attribute15
string <= 255 characters
expiryDate
string <date>
customerId
string <= 255 characters
attribute25
string <= 255 characters
attribute24
string <= 255 characters
attribute23
string <= 255 characters
attribute22
string <= 255 characters
attribute20
string <= 255 characters
attribute21
string <= 255 characters
validAfter
string <date>
createDate
string <date-time>
attribute29
string <= 255 characters
attribute28
string <= 255 characters
attribute27
string <= 255 characters
attribute26
string <= 255 characters
lineId
string <= 255 characters
label
string <= 255 characters
object
createdBy
integer
attribute30
string <= 255 characters
lastUpdateBy
integer
endRow
integer
totalRows
integer
status
integer
Request samples
application/json
{
  • "endRow": 300,
  • "oldValues": null,
  • "operationType": "fetch",
  • "startRow": 0,
  • "textMatchStyle": "exact",
  • "data": {
    • "criteria": [
      • {
        • "fieldName": "sourceId",
        • "operator": "notStartsWith",
        • "value": "P-",
        • "_constructor": "AdvancedCriteria"
        }
      ],
    • "operator": "and"
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "pricefx-cluster-app-frontend-6d6b77f6d9-z68h2",
    • "startRow": 0,
    • "data": [
      • {
        • "version": 1,
        • "typedId": "2.CPR",
        • "uniqueName": "CPR-2",
        • "status": "ACTIVE",
        • "sourceId": "C-16",
        • "lineId": "xrb3OqEZ66m3VXL",
        • "priority": 0,
        • "validAfter": "2018-04-04",
        • "expiryDate": "2019-01-01",
        • "externalRef": "",
        • "label": "newlyGeneratedRecord",
        • "createDate": "2023-11-07T08:12:35",
        • "createdBy": 2147490698,
        • "lastUpdateDate": "2023-11-07T08:12:35",
        • "lastUpdateBy": 2147490698,
        • "attribute1": "newlyGeneratedPR",
        • "sourceIdNoRev": "C-16"
        },
      • {
        • "version": 1,
        • "typedId": "3.CPR",
        • "uniqueName": "CPR-3",
        • "status": "ACTIVE",
        • "sourceId": "C-16",
        • "lineId": "TXtzimqBsvAaK8R",
        • "priority": 0,
        • "validAfter": "2018-04-04",
        • "expiryDate": "2019-01-01",
        • "externalRef": "",
        • "label": "newlyGeneratedRecord",
        • "createDate": "2023-11-07T08:12:35",
        • "createdBy": 2147490698,
        • "lastUpdateDate": "2023-11-07T08:12:35",
        • "lastUpdateBy": 2147490698,
        • "attribute1": "newlyGeneratedPR",
        • "sourceIdNoRev": "C-16"
        }
      ],
    • "endRow": 8,
    • "totalRows": 8,
    • "status": 0
    }
}