List Rebate Agreements

post/fetch/RBA

Retrieves a list of rebate agreements.

Required Permission Roles with the Required Permission
REBATEAGREEMENT_FETCH Investigate for Support (SUPPORT), Administer Plasma (PLASMA), Administer RebateManager (RM_REBATEMANAGER), Administer Rebate Agreements (RM_REBATEAGREEMENTS_ADMIN), Manage Rebate Agreements (RM_REBATEAGREEMENTS), View Rebate Agreements (RM_REBATEAGREEMENTS_RO)
Securitybasic or X-PriceFx-jwt
Request
Request Body schema: application/json
endRow
number
oldValues
any
operationType
string non-empty
startRow
number
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

Specify an operator of the filter criteria.

Possible values: "equals" "iEquals" "notEqual" "iNotEqual" "isNull" "notNull" "contains" "iContains" "containsPattern" "iContainsPattern" "notContains" "iNotContains" "startsWith" "iStartsWith" "notStartsWith" "iNotStartsWith" "endsWith" "iEndsWith" "notEndsWith" "iNotEndsWith" … 4 more
value
string non-empty
sortBy
Array of strings
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
targetDate
string non-empty
workflowStatus
string non-empty
lastUpdateByName
string non-empty
createdByName
string non-empty
submittedByName
string non-empty
calculationStatus
number
dirty
boolean
refreshInputs
boolean
numberOfAttachments
number
startDate
string non-empty
endDate
string non-empty
payoutDate
string non-empty
status
string non-empty
rebateAgreementStatus
string non-empty
approvedByName
string non-empty
hasWorkflowHistory
boolean
createDate
string non-empty
createdBy
number
lastUpdateDate
string non-empty
lastUpdateBy
number
rootUniqueName
string non-empty
endRow
number
totalRows
number
status
number
Request samples
application/json
{
  • "endRow": 300,
  • "oldValues": null,
  • "operationType": "fetch",
  • "startRow": 0,
  • "textMatchStyle": "exact",
  • "data": {
    • "_constructor": "AdvancedCriteria",
    • "operator": "and",
    • "criteria": [
      • {
        • "fieldName": "createdByName",
        • "operator": "equals",
        • "value": "admin"
        }
      ]
    },
  • "sortBy": [
    • "createDate"
    ]
}
Response samples
application/json
{
  • "response": {
    • "node": "string",
    • "startRow": 0,
    • "data": [
      • {
        • "version": 0,
        • "typedId": "string",
        • "uniqueName": "string",
        • "label": "string",
        • "targetDate": "string",
        • "workflowStatus": "string",
        • "lastUpdateByName": "string",
        • "createdByName": "string",
        • "submittedByName": "string",
        • "calculationStatus": 0,
        • "dirty": true,
        • "refreshInputs": true,
        • "numberOfAttachments": 0,
        • "startDate": "string",
        • "endDate": "string",
        • "payoutDate": "string",
        • "status": "string",
        • "rebateAgreementStatus": "string",
        • "approvedByName": "string",
        • "hasWorkflowHistory": true,
        • "createDate": "string",
        • "createdBy": 0,
        • "lastUpdateDate": "string",
        • "lastUpdateBy": 0,
        • "rootUniqueName": "string"
        }
      ],
    • "endRow": 0,
    • "totalRows": 0,
    • "status": 0
    }
}