search

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
        }
    ]
}
circle-info

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

hashtag
Calculate allocations

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

This endpoint allows you to calculate allocations.

hashtag
Path Parameters

Name
Type
Description

dealID*

int

The deal ID.

hashtag
Headers

Name
Type
Description

x-api-key*

string

Your company's API key.

Authentication*

string

Authentication token.

hashtag
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.

PreviousGet allocation modelsNextFinancial periods

Last updated

Was this helpful?