General

Create document from template

<small>Requires an API token with the Document Manager role.</small>

POST

/documents/create-from-template

curl --request POST \
  --url https://app.fynk.com/v1/api/documents/create-from-template \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dynamic_field_values": {
    "My Text Field": "Vienna",
    "a1b2c3d4-e5f6-7890-abcd-ef1234567890": "EUR;95000;yearly"
  },
  "initial_stage": "signing",
  "name": "Kundenvertrag Muster GmbH",
  "owner_emails": [
    "jsmith@example.com"
  ],
  "parties": {
    "3b326b6a-65d4-4e1f-9529-f0884e257d79": {
      "address": "Musterstraße 1, 12345 Berlin",
      "entity_name": "Muster GmbH"
    }
  },
  "signatories": {
    "c397e454-fdde-457a-9dce-d1036cc15aed": [
      {
        "email": "john@example.com",
        "first_name": "John",
        "last_name": "Doe"
      }
    ]
  },
  "template_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

{
  "data": {
    "archived_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "document_type_uuid": "58ac52bb-8885-4580-88c1-7a7bc772c87d",
    "dynamic_fields": [
      {
        "autofill_type": "document_created_date",
        "format": {
          "decimal_separator": ".",
          "decimals": 2,
          "thousands_separator": ","
        },
        "is_mandatory": true,
        "name": "Gross salary",
        "order": 123,
        "question": "What is the employee's gross salary in EUR?",
        "question_external": "<string>",
        "ref_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "scope": "internal",
        "select_values": [
          "<string>"
        ],
        "settings": {
          "currencies": [
            "EUR",
            "USD"
          ]
        },
        "type": "id",
        "uuid": "7dae3dad-e56d-45e9-86e5-b69dc30597dc",
        "value": "EUR;95000;yearly"
      }
    ],
    "external_signatory_invitation_message": "<string>",
    "integration_reference": {
      "external_id": "000000000000Abc",
      "external_name": "Example Opportunity",
      "integration_type": "pipedrive",
      "object_type": "Opportunity"
    },
    "locale": "de-AT",
    "metadata_values": [
      {
        "computed_at": "2023-11-07T05:31:56Z",
        "computed_status": "missing_information",
        "computed_value": "EUR;95000;yearly",
        "is_attached": true,
        "metadata": {
          "always_exists": true,
          "description": "The discount rate applied to the company valuation in a follow-on financing round.",
          "display_name": "Discount Rate",
          "is_contract_value": true,
          "keywords": "discount, rate, valuation",
          "name": "discount_rate",
          "prompt": "Extract the discount rate percentage from the document.",
          "relevant_document_type_uuids": [
            "<string>"
          ],
          "select_values": [
            "<string>"
          ],
          "settings": {
            "currencies": [
              "EUR",
              "USD"
            ]
          },
          "type": "system_autofilled",
          "uuid": "7dae3dad-e56d-45e9-86e5-b69dc30597dc",
          "value_type": "id"
        },
        "reference_dynamic_field_uuid": "7dae3dad-e56d-45e9-86e5-b69dc30597dc",
        "uuid": "4ed6c60b-bc4f-4390-bbf5-ed384e3443c9",
        "value": "EUR;95000;yearly",
        "value_currency_monthly": "<string>",
        "value_currency_yearly": "<string>",
        "value_source": "user"
      }
    ],

Creates a new document based on the template with the given UUID.

Note: When a provided signatory's email corresponds to an existing user in the current fynk account, the signatory will be linked to that user. Any additional fields (first_name, last_name, mobile_phone, title) will be ignored and the signatory information will be populated from the existing user's profile.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Initial values for the document's dynamic fields. Each key must identify a dynamic field on the template by either its ref_uuid or its name. Values accept the same format as the Update dynamic field endpoint.

initial_stageenum<string> | null

If set, the document will be moved to this stage after creation. The default is draft. Depending on the template, moving to signing may require that the dynamic_field_values, parties and/or signatories fields are also provided.

Available options: draft, signing

Example: signing

namestring | null

The new document's name. If omitted, the name of the template will be used as the new document's name

Maximum string length: 255

Example: Kundenvertrag Muster GmbH

owner_emailsstring[]

Email addresses of the user(s) from your account who should be given ownership of the new document

partiesobject[]

Party data to update on document creation, keyed by the party's ref_uuid, reference, or entity_name from the template.

Show child attributes

signatoriesobject[][]

Signatories to add to the document on creation, keyed by their party's ref_uuid, reference, or entity_name from the template. Signatories provided here are added to the new document in addition to any signatories defined in the source template. If an email corresponds to an existing user in the current fynk account, the signatory will be linked to that user and first_name, last_name, mobile_phone and title will be populated from the user's profile.

template_uuidstringrequired

UUID of the template to use as a basis for the new document

Response

DocumentDetailResource

dataobjectrequired

Show child attributes

Still need help? Share an idea

Authorizations

Body

Response