Print Forms API

---

List of Print Form Templates

GET /api/templates

Response:

[
  {
    "id": 76, // ID печатной формы
    "title": "", // Название печатной формы
    "scopes": {
      "lead": true,
      "client": true,
      "contract": true,
      "loanApp": false,
      "signatures": false,
      "depositContract": false,
      "shareContract": false,
      "fundTransactions": false,
      "groupConvention": false,
      "collateralLine": false,
      "committee": false
    },
    "createdAt": "2020-12-29T16:40:19+00:00",
    "updatedAt": "2022-02-18T08:50:23+00:00"
  }
]

Print Form Generation

POST /api/documents/generate

The following headers must be sent in the request

• bsauth - BrainySoft authorization token
• customer-key - Organization code name

Possible parameters

• sync=false (Default: true) - Synchronous print form generation

Request body:

{
  "templateId": 111, //ID печатной формы
  "lead": 1, // ID лида
  "client": 2, // ID клиента
  "loanapp": 3, // ID заявки
  "contract": 4, // ID контракта
  "collateralline": 5 // ID кредитной линии
}

Response:

{
  "status": "ok",
  "timestamp": 1617623638000,
  "data": {
    "uuid": "идентификатор генерации",
    "status": "статус генерации",
    "selector": "Адрес страницы фыбора варианта скачивания ПФ",
    "original": {
      "download": "Ссылка на скачивание формы в формате docx",
      "preview": null
    },
    "pdf": {
      "download": "Ссылка на скачивание формы в формате pdf",
      "preview": "Ссылка на просмотр формы в браузере"
    }
  }
}

Print Form Generation with Additional Variables

POST /api/documents/generate/data-raw

The following headers must be sent in the request

• bsauth - BrainySoft authorization token
• customer-key - Organization code name

This method works only in synchronous mode

Request body:

{
    "templateId": 111, //ID печатной формы
    "lead": 1, // ID лида
    "client": 2, // ID клиента
    "loanapp": 3, // ID заявки
    "contract": 4, // ID контракта
    "collateralline": 5 // ID кредитной линии
    "variables": { // Объект с дополнытельными переменными
        "smsCode": "" // переменную ${smsCode} можно будет использовать в ПФ
    }
}

Response:

{
  "status": "ok",
  "timestamp": 1617623638000,
  "data": {
    "selector": "Адрес страницы фыбора варианта скачивания ПФ",
    "original": {
      "download": "Ссылка на скачивание формы в формате docx",
      "preview": null
    },
    "pdf": {
      "download": "Ссылка на скачивание формы в формате pdf",
      "preview": "Ссылка на просмотр формы в браузере"
    }
  }
}

---

Generation Status

GET /api/documents/{uuid}

The following headers must be sent in the request

• bsauth - BrainySoft authorization token
• customer-key - Organization code name

Response

{
  "status": "ok",
  "timestamp": 1617623638000,
  "data": {
    "uuid": "идентификатор генерации",
    "status": "статус генерации",
    "selector": "Адрес страницы фыбора варианта скачивания ПФ",
    "original": {
      "download": "Ссылка на скачивание формы в формате docx",
      "preview": null
    },
    "pdf": {
      "download": "Ссылка на скачивание формы в формате pdf",
      "preview": "Ссылка на просмотр формы в браузере"
    }
  }
}

Possible generation status values

waiting - In queue

preparing - Collecting data

generating - Generating print form

error - Error during generation

done - Print form successfully generated