Sign in

v1

latestOpenAPI 3.0.02026-07-2418630310.7 KB
Templates

Create a new export file template

Create a new export file template. <br> <b>Required scope(s):</b> administration:write

post/api/v4/f/{firm_id}/export_files

Path parameters

firm_idinteger required

Headers

Acceptstring

Request body

OR

Example request

{
  "name": "Export File Name",
  "name_nl": "Export file name (nl)",
  "name_en": "Export file name (en)",
  "name_fr": "Export file name (fr)",
  "name_de": "Export file name (de)",
  "name_da": "Export file name (da)",
  "name_se": "Export file name (se)",
  "file_name": "export_file.sxbrl",
  "enconding": "UTF-8",
  "text": "{% comment %}liquid code in main part{% endcomment %}",
  "text_parts": [
    {
      "name": "part_name",
      "content": "{% comment %}liquid code in part{% endcomment %}"
    }
  ]
}

Response

Successful response

idinteger
marketplace_template_idinteger
namestring required
name_nlstring
name_enstring
name_frstring
name_destring
name_dastring
name_sestring
file_namestring required
encondingstring
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.

textstring

Example response

{
  "id": 4,
  "marketplace_template_id": 25,
  "name": "Export File Name",
  "name_nl": "Export file name (nl)",
  "name_en": "Export file name (en)",
  "name_fr": "Export file name (fr)",
  "name_de": "Export file name (de)",
  "name_da": "Export file name (da)",
  "name_se": "Export file name (se)",
  "file_name": "export_file.sxbrl",
  "enconding": "UTF-8",
  "text": "{% comment %}liquid code in main part{% endcomment %}",
  "text_parts": [
    {
      "name": "part_name",
      "content": "{% comment %}liquid code in part{% endcomment %}"
    }
  ]
}