List Accrual Records

post/fetch/COAR

Retrieves Accrual Records. A filter can be applied.

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

OK

Response Schema: application/json
object
node
string
startRow
integer
Array of objects (CompensationAccrualRecord)
Array
compensationRecordUN
string <= 255 characters
compensationType
string
createDate
string <date-time>
createdBy
integer
string or string
label
string
lastStatusUpdateDate
string <date-time>
lastUpdateBy
integer
lastUpdateDate
string <date-time>
name
string <= 255 characters
string or string
string or string
status
string <= 255 characters
type
string <= 255 characters
typedId
string
version
integer
attribute1
string <= 70 characters
attribute2
string <= 70 characters
attribute3
string <= 70 characters
attribute4
string <= 70 characters
attribute5
string <= 70 characters
attribute6
number
attribute7
string <= 70 characters
attribute8
string <= 70 characters
attribute9
string <= 70 characters
attribute10
string <= 70 characters
attribute11
number
attribute12
string <= 70 characters
attribute13
string <= 70 characters
attribute14
string <= 70 characters
attribute15
string <= 70 characters
attribute16
number
attribute17
string <= 70 characters
attribute18
string <= 70 characters
attribute19
string <= 70 characters
attribute20
string <= 70 characters
number or string
attribute22
number
attribute23
number
attribute24
string <= 70 characters
attribute25
string <= 70 characters
attribute26
string <= 70 characters
attribute27
string <= 70 characters
attribute28
string <= 70 characters
attribute29
string <= 70 characters
attribute30
string <= 70 characters
attribute31
string <= 70 characters
attribute32
string <= 70 characters
attribute33
string <= 70 characters
attribute34
string <= 70 characters
attribute35
string <= 70 characters
attribute36
string <= 70 characters
attribute37
string <= 70 characters
attribute38
string <= 70 characters
attribute39
string <= 70 characters
attribute40
string <= 70 characters
attribute41
string <= 70 characters
attribute42
string <= 70 characters
attribute43
string <= 70 characters
attribute44
string <= 70 characters
attribute45
string <= 70 characters
attribute46
string <= 70 characters
attribute47
string <= 70 characters
attribute48
string <= 70 characters
attribute49
string <= 70 characters
attribute50
string <= 70 characters
attribute51
string <= 70 characters
attribute52
string <= 70 characters
attribute53
string <= 70 characters
attribute54
string <= 70 characters
attribute55
string <= 70 characters
attribute56
string <= 70 characters
attribute57
string <= 70 characters
attribute58
string <= 70 characters
attribute59
string <= 70 characters
attribute60
string <= 70 characters
attribute61
string <= 70 characters
attribute62
string <= 70 characters
attribute63
string <= 70 characters
attribute64
string <= 70 characters
attribute65
string <= 70 characters
attribute66
string <= 70 characters
attribute67
string <= 70 characters
attribute68
string <= 70 characters
attribute69
string <= 70 characters
attribute70
string <= 70 characters
attribute71
string <= 70 characters
attribute72
string <= 70 characters
attribute73
string <= 70 characters
attribute74
string <= 70 characters
attribute75
string <= 70 characters
attribute76
string <= 70 characters
attribute77
string <= 70 characters
attribute78
string <= 70 characters
attribute79
string <= 70 characters
attribute80
string <= 70 characters
attribute81
string <= 70 characters
attribute82
string <= 70 characters
attribute83
string <= 70 characters
attribute84
string <= 70 characters
attribute85
string <= 70 characters
attribute86
string <= 70 characters
attribute87
string <= 70 characters
attribute88
string <= 70 characters
attribute89
string <= 70 characters
attribute90
string <= 70 characters
attribute91
string <= 70 characters
attribute92
string <= 70 characters
attribute93
string <= 70 characters
attribute94
string <= 70 characters
attribute95
string <= 70 characters
attribute96
string <= 70 characters
attribute97
string <= 70 characters
attribute98
string <= 70 characters
attribute99
string <= 70 characters
attribute100
string <= 70 characters
endRow
integer
totalRows
integer
status
integer
Request samples
application/json
{
  • "endRow": 300,
  • "oldValues": null,
  • "operationType": "fetch",
  • "startRow": 0,
  • "textMatchStyle": "exact",
  • "data": {
    • "_constructor": "AdvancedCriteria",
    • "operator": "and",
    • "criteria": [
      • {
        • "fieldName": "compensationRecordUN",
        • "operator": "equals",
        • "value": "COR-100"
        }
      ]
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "node1",
    • "startRow": 0,
    • "data": [
      • {
        • "version": 0,
        • "typedId": "3692734.COAR",
        • "compensationRecordUN": "COR-100",
        • "type": "Sales Compensation",
        • "name": "2022-Q4 [SC] Single Target Amount-SC-002 - COAR Summary",
        • "startDate": "2022-10-01",
        • "endDate": "2022-12-31",
        • "payoutDate": "2023-01-02",
        • "createDate": "2022-06-22T09:58:52",
        • "createdBy": 290,
        • "lastUpdateDate": "2022-06-22T09:58:52",
        • "lastUpdateBy": 290,
        • "attribute1": "SC-002",
        • "attribute2": "",
        • "attribute3": "",
        • "attribute4": "",
        • "attribute5": "",
        • "attribute6": 0,
        • "attribute7": "",
        • "attribute8": "",
        • "attribute9": "",
        • "attribute10": "",
        • "attribute11": 0,
        • "attribute12": "",
        • "attribute13": "",
        • "attribute14": "",
        • "attribute15": "",
        • "attribute16": 0,
        • "attribute17": "",
        • "attribute18": "",
        • "attribute19": "Summary",
        • "attribute20": "0.75",
        • "attribute21": "CO-26",
        • "compensationType": "SC_SingleTargetAmount"
        }
      ],
    • "endRow": 1,
    • "totalRows": 1,
    • "status": 0
    }
}