> For the complete documentation index, see [llms.txt](https://api-docs.rightsline.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api-docs.rightsline.com/entities/financial-document/switch-financial-document-template.md).

# Switch financial document template

## Switch financial document template

<mark style="color:green;">`POST`</mark> `https://ris.rightsline.com/v4/financial-document/:id/switch-template`

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

#### Path Parameters

| Name                                 | Type   | Description                                             |
| ------------------------------------ | ------ | ------------------------------------------------------- |
| id<mark style="color:red;">\*</mark> | string | ID of the financial document to switch the template of. |

#### Headers

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

#### Request Body

| Name                                                  | Type   | Description                                             |
| ----------------------------------------------------- | ------ | ------------------------------------------------------- |
| id<mark style="color:red;">\*</mark>                  | string | ID of the financial document to switch the template of. |
| newTemplateId<mark style="color:red;">\*</mark>       | string | The ID of the new template.                             |
| title                                                 | string | Title of the record.                                    |
| template.templateId<mark style="color:red;">\*</mark> | string | The current template ID.                                |

{% tabs %}
{% tab title="200 Template switched. Returns template switch object." %}

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

{% endtab %}
{% endtabs %}

## Check the new template before switching

<mark style="color:green;">`POST`</mark> `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

| Name | Type   | Description                                              |
| ---- | ------ | -------------------------------------------------------- |
| id   | string | ID of the financial  document to switch the template of. |

#### Headers

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

#### Request Body

| Name                | Type   | Description                                             |
| ------------------- | ------ | ------------------------------------------------------- |
| 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.                                |

{% tabs %}
{% tab title="200 Returns template check object." %}

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

{% endtab %}
{% endtabs %}