Sign in

v1

latestOpenAPI 3.1.02026-07-1414757122.7 KB
documents

Generate document

Generates a document from a template for a specific CRM entity. The template variables are automatically filled with entity data.

post/crm/v1/documents

Request body

entity_typestring
entity_idinteger
template_idinteger

Example request

{
  "entity_type": "leads",
  "template_id": 2
}

Response

Created

namestring

Template name + document number

template_idnumber
created_datestring
updated_datestring
from_datenumber

Custom edition date, default = dateCreated in timestamp

numberstring

Editing number of document

signboolean

Signature and seal

created_byinteger

User who created

updated_byinteger

User who updated

Example response

{
  "name": "Рахунок на оплату 05.07.23 №1",
  "created_date": "2023-09-21",
  "updated_date": "2023-09-21",
  "requisite": {
    "fields": {
      "list": [
        {
          "name": "Source",
          "code": "source",
          "editable": true,
          "show": true,
          "fieldSectionId": 11,
          "default_value": "value",
          "tooltip": "example",
          "type": "entity_reference",
          "entity_reference_id": 123,
          "sort": 90
        }
      ]
    },
    "bank_requisites": [
      {
        "fields": {
          "list": [
            {
              "name": "Source",
              "code": "source",
              "editable": true,
              "show": true,
              "fieldSectionId": 11,
              "default_value": "value",
              "tooltip": "example",
              "type": "entity_reference",
              "entity_reference_id": 123,
              "sort": 90
            }
          ]
        }
      }
    ]
  },
  "bank_requisite": {
    "fields": {
      "list": [
        {
          "name": "Source",
          "code": "source",
          "editable": true,
          "show": true,
          "fieldSectionId": 11,
          "default_value": "value",
          "tooltip": "example",
          "type": "entity_reference",
          "entity_reference_id": 123,
          "sort": 90
        }
      ]
    }
  },
  "files": [
    {
      "extension": "pdf"
    }
  ]
}