Switch financial document template

Switches the financial document record to a new template

Switch financial document template

POST https://ris.rightsline.com/v4/financial-document/:id/switch-template

This endpoint allows you to change the template of an financial-document.

Path Parameters

NameTypeDescription

id*

string

ID of the financial document to switch the template of.

Headers

NameTypeDescription

x-api-key

string

Your company's API key.

Authentication

string

Authentication token.

Request Body

NameTypeDescription

id*

string

ID of the financial document to switch the template of.

newTemplateId*

string

The ID of the new template.

title

string

Title of the record.

template.templateId*

string

The current template ID.

{
    "id": 1,
    "relationshipsNotMigrated": {
        "parties": [],
        "associations": {}
    },
    "characteristicsNotMigrated": [],
    "characteristicsRequiredOnNewTemplate": []
}

Check the new template before switching

POST https://ris.rightsline.com/v4/financial-document/:id/switch-template-check

This endpoint allows you to check what will happen to a record before switching the template.

Path Parameters

NameTypeDescription

id

string

ID of the financial document to switch the template of.

Headers

NameTypeDescription

x-api-key

string

Your company's API key.

Authentication

string

Authentication token.

Request Body

NameTypeDescription

id

string

ID of the financial document to switch the template of.

newTemplateId

string

The ID of the new template.

title

string

Title of the record.

template.templateId

string

The current template ID.

{
   "relationshipsNotMigrated": {
        "parties": [],
        "associations": {}
    },
    "characteristicsNotMigrated": [],
    "characteristicsRequiredOnNewTemplate": []
}

Last updated