Agreements

Отримати список угод

Метод повертає список угод згідно з налаштованими фільтрами. <br/>Присутня пагінація по 25 елементів на сторінці, нові елементи знаходяться зверху, старі - знизу.<br/> Детальніше про фільтрування

get/agreements

Query parameters

q[ordered_at_lteq]string

Угоди створені до вказаної дати YYYY-MM-DD (включно)

q[ordered_at_gteq]string

Угоди створені після вказаної дати YYYY-MM-DD (включно)

q[source_id_eq]string

Угоди з вказаним джерелом

q[client_id_eq]string

Угоди вказаного клієнта

q[result_eq]'archived' | 'successful' | 'failed'

Архівні (завершені) угоди з вказаним результатом:

archived - архівна
successful - виграна
failed - програна

pageinteger

Номер сторінки

Response

Успішна відповідь

Example response

{
  "items": [
    {
      "id": 1,
      "title": "#725 - Замовлення з сайту",
      "total": 500,
      "stage": {
        "name": "В роботі"
      },
      "main_responsible": {
        "id": 1,
        "name": "Прізвище Імʼя По батькові"
      },
      "client": {
        "id": 1,
        "person": "Прізвище Імʼя По батькові",
        "email": "pib@example.com",
        "lead": false,
        "phones": [
          "+380000000001"
        ],
        "custom_fields": {
          "Адреса": "Ужгород-1"
        }
      },
      "deliveries": [
        {
          "ttn": 2032323123123,
          "status_description": "Видано кінцевому користувачу"
        }
      ],
      "jobs": [
        {
          "id": 1,
          "sku": 129,
          "title": "Книга English is Easy",
          "discount": 0,
          "amount": 2,
          "price": 123.12,
          "cost": 99.99,
          "total": 246.24,
          "custom_fields": {
            "Палітурка": "Жорстка"
          }
        }
      ],
      "custom_fields": {
        "Тип оплати": "При отриманні",
        "Тип доставки": "Нова Пошта"
      }
    }
  ]
}

Changes

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