Calculate allocations

Sample Calculate Allocations request:

{
    "rightsDimensionId": "1e7033ea-7430-11ee-b962-0242ac120002", // optional
    "catalogDistribution": "EVENLY",
    "hierarchyDistribution": "SELECTED_CATALOG",
    "rollupToOneAmount": false,
    "allocationRows":[
        {
            "catalogRecordId": 100,
            "paymentScheduleRecordId": 500,
            "allocatedAmount": 2000.01 // optional
        },
        {
            "catalogRecordId": 101,
            "paymentScheduleRecordId": 500,
            "allocatedAmount": 3999.99 // optional
        },
        {
            "catalogRecordId": 102,
            "paymentScheduleRecordId": 500,
            "allocatedAmount": 4000.00 // optional
        }
    ]
}

Specifying an allocatedAmount for each allocation row will override the distribution type and will instead create amounts with the specified allocatedAmount value.

Calculate allocations

POST https://ris.rightsline.com/v4/deal/:dealID/calculate-allocations

This endpoint allows you to calculate allocations.

Path Parameters

Name	Type	Description
dealID*	int	The deal ID.

Headers

Name	Type	Description
x-api-key*	string	Your company's API key.
Authentication*	string	Authentication token.

Request Body

Name	Type	Description
rightsDimensionId	Guid	The allocation model ID (optional).
catalogDistribution*	String	EVENLY or BY_RIGHTS_DURATION
hierarchyDistribution*	String	SELECTED_CATALOG or IMMEDIATE_CHILDREN
rollupToOneAmount*	bool	Roll up to one amount.
allocationRows*	AllocationRow[]	List of allocation rows.

202: Accepted Batch created successfully.

{
    "batchId": 456840,
    "batchStatus": "Created"
}

409: Conflict Insufficient rights.

{
    "message": "The selected model cannot be applied to these catalog items due to insufficient rights: [100,101]"
}

409: Conflict No Fee value.

{
    "message": "Payment Schedule table does not have a Fee value."
}

409: Conflict Amounts do not add up to Fee.

{
    "message": "The sum of the allocated amounts does not equal the Payment Schedule table 500 fee.."
}

409: Conflict Allocation template not configured for deal.

{
    "message": "Configuration does not allow for Allocation tables to be created on deal {id}."
}

409: Conflict Sub-allocation template not configured on Allocation table.

{
    "message": "Configuration does not allow for Sub-Allocation amounts to be created on Allocation tables."
}