Agreements

Створити угоду

Метод створює угоду разом з клієнтом та товарами. <br/>Якщо клієнта не знайдено, то його буде створено з вказаними даними. Якщо клієнт вже існує, то його буде приєднано до угоди. <br/>Якщо товар знайдено по артикулу чи назві в складі/прайс-листі (залежить від налаштувань), то буде приєднано, якщо ні, то створиться новий.

post/agreements

Query parameters

office_hash_idstring

UID філії (офісу) куди прикріпити сутність (за замовчування головний офіс)

Request body

titlestring required

Назва

totalnumber required

Загальна сума

currencystring

ISO валюти (UAH, USD, EUR...). При цьому вказана валюта має бути додана в налаштуваннях. За замовчуванням основна валюта

commentstring

Коментар

importantboolean

Важливо

discountnumber

Знижка

discount_kind'percent_discount' | 'absolute_discount'

Тип знижки (відсоток чи сума)

stage_idnumber

Ідентифікатор етапу угоди

source_idnumber

Ідентифікатор джерела

funnel_idnumber

Ідентифікатор воронки продажів

main_responsible_idinteger

Ідентифікатор відповідального працівника

client_idinteger

Ідентифікатор клієнта

products_total_as_totalboolean

Сума товарів дорівнює сумі угоди

deadline_atstring

Дата та час завершення в форматі DD.MM.YYYY HH:MM (UTC)

result'archived' | 'successful' | 'failed'

Результат угоди (тільки для архівних угод)

archive_status_idinteger

Ідентифікатор причини виграшу/програшу угоди

Example request

{
  "title": "#725 - Замовлення із сайту",
  "total": 500,
  "currency": "UAH",
  "stage_id": 6,
  "source_id": 5,
  "funnel_id": 1,
  "client_attributes": {
    "person": "Прізвище Імʼя По батькові",
    "email": "pib@example.com",
    "status_id": 1,
    "lead": false,
    "phones": [
      "+380000000001"
    ],
    "custom_fields": [
      {
        "name": "Адреса",
        "value": "Ужгород-1"
      }
    ]
  },
  "contractor_attributes": {
    "name": "Прізвище Імʼя По батькові",
    "email": "pib@example.com",
    "phone": 380000000001
  },
  "jobs_attributes": [
    {
      "amount": 2,
      "title": "Книга English is Easy",
      "product_attributes": {
        "sku": 1,
        "title": "Книга English is Easy",
        "price": 250,
        "currency": "UAH"
      },
      "custom_fields": [
        {
          "name": "Палітурка",
          "value": "Жорстка"
        }
      ]
    }
  ],
  "custom_fields": [
    {
      "name": "Тип оплати",
      "value": "При отриманні"
    },
    {
      "name": "Тип доставки",
      "value": "Нова Пошта"
    }
  ]
}

Response

Успішно створено

idinteger

Ідентифікатор сутності

created_atstring

Дата та час створення

updated_atstring

Дата та час оновлення

Example response

{
  "id": 1204,
  "updated_at": "2017-12-12Z00:00:00T",
  "created_at": "2017-12-12Z00:00:00T"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.