Get a Rebate Agreement

post/rebateagreement.fetch/{uniqueName}

Retrieves details of the specified Rebate Agreement.

Securitybasic or X-PriceFx-jwt
Request
path Parameters
uniqueName
required
string

The uniqueName of the Rebate Agreement you want to retrieve details for.

Example: R-2147483871
Responses
200

Example response

Response Schema: application/json
object
node
string non-empty
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
headerText
string
Array of objects non-empty unique
object
outputs
Array of objects
lastUpdateByName
string non-empty
createdByName
string non-empty
submittedByName
any
calculationStatus
number
dirty
boolean
refreshInputs
boolean
nodeId
any
userGroupEdit
any
userGroupViewDetails
any
serverMessages
Array of strings
additionalInfo1
any
additionalInfo2
any
additionalInfo3
any
additionalInfo4
any
numberOfAttachments
number
creationWorkflowStatus
any
creationWorkflowCurrentStep
any
creationWorkflowStepCount
any
creationWorkflowStepLabel
any
signature
any
lineItems
Array of objects
seller
any
object
startDate
string non-empty
endDate
string non-empty
payoutDate
string non-empty
rebateRecordSetId
any
rebateRecordSetLabel
any
simulationSet
any
simulationType
any
status
string non-empty
rebateAgreementStatus
string non-empty
approvedByName
any
deniedByName
any
renderInfo
any
Array of objects non-empty unique
approvalRequiredEmailAttachmentsJson
any
hasWorkflowHistory
boolean
createDate
string non-empty
createdBy
number
lastUpdateDate
string non-empty
lastUpdateBy
number
supersededBy
any
prevRev
any
rootUniqueName
string non-empty
headerRebateType
any
sellerName
any
status
required
number
Request samples
Response samples
application/json
{
  • "response": {
    • "node": "e2e-templates-node",
    • "data": [
      • {
        • "version": 4,
        • "typedId": "2147483868.RBA",
        • "uniqueName": "R-2147483868",
        • "label": "RBA001",
        • "targetDate": "2021-11-26",
        • "workflowStatus": "DRAFT",
        • "headerText": "",
        • "inputs": [
          ],
        • "viewState": {
          },
        • "outputs": [ ],
        • "lastUpdateByName": "admin",
        • "createdByName": "admin",
        • "submittedByName": null,
        • "calculationStatus": 0,
        • "dirty": false,
        • "refreshInputs": false,
        • "nodeId": null,
        • "userGroupEdit": null,
        • "userGroupViewDetails": null,
        • "serverMessages": [
          ],
        • "additionalInfo1": null,
        • "additionalInfo2": null,
        • "additionalInfo3": null,
        • "additionalInfo4": null,
        • "numberOfAttachments": 0,
        • "creationWorkflowStatus": null,
        • "creationWorkflowCurrentStep": null,
        • "creationWorkflowStepCount": null,
        • "creationWorkflowStepLabel": null,
        • "signature": null,
        • "lineItems": [ ],
        • "seller": null,
        • "customerGroup": {
          },
        • "startDate": "2021-11-26",
        • "endDate": "2021-11-26",
        • "payoutDate": "2021-11-26",
        • "rebateRecordSetId": null,
        • "rebateRecordSetLabel": null,
        • "simulationSet": null,
        • "simulationType": null,
        • "status": "DRAFT",
        • "rebateAgreementStatus": "DRAFT",
        • "approvedByName": null,
        • "deniedByName": null,
        • "renderInfo": null,
        • "serverMessagesExtended": [
          ],
        • "approvalRequiredEmailAttachmentsJson": null,
        • "hasWorkflowHistory": false,
        • "createDate": "2021-11-26T13:43:47",
        • "createdBy": 2147490696,
        • "lastUpdateDate": "2021-11-26T13:43:47",
        • "lastUpdateBy": 2147490696,
        • "supersededBy": null,
        • "prevRev": null,
        • "rootUniqueName": "R-2147483868",
        • "headerRebateType": null,
        • "sellerName": null
        }
      ],
    • "status": 0
    }
}