Sign in

v1

latestOpenAPI 3.0.02026-07-2418630310.7 KB
Templates

Get details of a reconciliation template

Get details of a reconciliation template. <br> <b>Required scope(s):</b> administration:read

get/api/v4/f/{firm_id}/reconciliations/{reconciliation_id}

Path parameters

firm_idinteger required
reconciliation_idinteger required

Headers

Acceptstring
Accept-Languagestring

Response

Successful response

namestring
name_enstring
name_frstring
name_nlstring
handlestring
textstring
auto_hide_formulastring
text_configurationstring
virtual_account_numberstring
reconciliation_typestring
publicboolean
allow_duplicate_reconciliationsboolean
is_activeboolean
use_full_widthboolean
downloadable_as_docxboolean
externally_managedboolean

When this value is set to true the shared parts are not allowed to be edited via the web interface, only via API.

testsstring
idinteger
marketplace_template_idinteger

Example response

{
  "name": "Reconciliation Name",
  "name_en": "Reconciliation Name",
  "name_fr": "Reconciliation Name",
  "name_nl": "Reconciliation Name",
  "handle": "reconciliation_handle",
  "text": "{% comment %}liquid code in main part{% endcomment %}",
  "text_parts": [
    {
      "name": "part_name",
      "content": "{% comment %}liquid code in part{% endcomment %}"
    }
  ],
  "auto_hide_formula": "'{% comment %}liquid code in auto hide formula{% endcomment %}'\n",
  "text_configuration": "'{% comment %}liquid code in text configuration{% endcomment %}'\n",
  "virtual_account_number": "1500",
  "reconciliation_type": "only_reconciled_with_data",
  "is_active": true,
  "id": 1977,
  "marketplace_template_id": 25
}