List Rebate Agreement Items

post/rebateagreement.fetchitems

Retrieves Rebate Agreement Items. A filter can be applied.

Securitybasic or X-PriceFx-jwt
Request
Request Body schema: application/json
operationType
string non-empty
startRow
number
textMatchStyle
string non-empty
oldValues
any
distinctResults
boolean
object
object
label
string non-empty
headerText
any
Array of objects non-empty unique
Array (non-empty)
name
string non-empty
label
string non-empty
lookupTableId
any
url
any
type
string non-empty
value
any
valueHint
any
readOnly
any
filter
any
parameterGroup
any
required
any
labelTranslations
any
addUnknownValues
any
typedId
any
alwaysEditable
any
inputs
Array of objects
parameterConfig
object
formattingOptions
object
valueOptions
any
outputs
Array of objects
nodeId
number
userGroupEdit
any
userGroupViewDetails
any
lineItems
Array of objects
startDate
string non-empty
endDate
string non-empty
object
_constructor
string non-empty
operator
string non-empty
criteria
Array of objects
endRow
number
sortBy
Array of objects
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
uniqueName
string non-empty
label
string non-empty
userGroupEdit
any
userGroupViewDetails
any
formulaName
string non-empty
waterfallElement
any
createDate
string non-empty
createdBy
number
lastUpdateDate
string non-empty
lastUpdateBy
number
attribute1
any
attribute2
any
attribute3
any
attribute4
any
attribute5
any
attribute6
any
attribute7
any
attribute8
any
attribute9
any
attribute10
any
attribute11
any
attribute12
any
attribute13
any
attribute14
any
attribute15
any
attribute16
any
attribute17
any
attribute18
any
attribute19
any
attribute20
any
attribute21
any
attribute22
any
attribute23
any
attribute24
any
attribute25
any
attribute26
any
attribute27
any
attribute28
any
attribute29
any
attribute30
any
endRow
number
totalRows
number
status
number
Request samples
application/json
{
  • "operationType": "fetch",
  • "startRow": 0,
  • "textMatchStyle": "exact",
  • "oldValues": null,
  • "distinctResults": false,
  • "data": {
    • "rebateAgreement": {
      • "label": "New Rebate Agreement",
      • "headerText": null,
      • "inputs": [
        • {
          },
        • {
          }
        ],
      • "outputs": [ ],
      • "nodeId": 0,
      • "userGroupEdit": null,
      • "userGroupViewDetails": null,
      • "lineItems": [ ],
      • "startDate": "2021-10-19",
      • "endDate": "2021-10-19"
      },
    • "filterCriteria": {
      • "_constructor": "AdvancedCriteria",
      • "operator": "and",
      • "criteria": [ ]
      }
    },
  • "endRow": 300,
  • "sortBy": [ ]
}
Response samples
application/json
{
  • "response": {
    • "node": "string",
    • "startRow": 0,
    • "data": [
      • {
        • "version": 0,
        • "typedId": "string",
        • "uniqueName": "string",
        • "label": "string",
        • "userGroupEdit": null,
        • "userGroupViewDetails": null,
        • "formulaName": "string",
        • "waterfallElement": null,
        • "createDate": "string",
        • "createdBy": 0,
        • "lastUpdateDate": "string",
        • "lastUpdateBy": 0,
        • "attribute1": null,
        • "attribute2": null,
        • "attribute3": null,
        • "attribute4": null,
        • "attribute5": null,
        • "attribute6": null,
        • "attribute7": null,
        • "attribute8": null,
        • "attribute9": null,
        • "attribute10": null,
        • "attribute11": null,
        • "attribute12": null,
        • "attribute13": null,
        • "attribute14": null,
        • "attribute15": null,
        • "attribute16": null,
        • "attribute17": null,
        • "attribute18": null,
        • "attribute19": null,
        • "attribute20": null,
        • "attribute21": null,
        • "attribute22": null,
        • "attribute23": null,
        • "attribute24": null,
        • "attribute25": null,
        • "attribute26": null,
        • "attribute27": null,
        • "attribute28": null,
        • "attribute29": null,
        • "attribute30": null
        }
      ],
    • "endRow": 0,
    • "totalRows": 0,
    • "status": 0
    }
}