cash.contact.getList

Возвращает список контактов, связанных с операциями по счетам, к которым у пользователя есть доступ.

Параметры

  • offset GET Необязательно

    Смещение относительно общего списка найденных контактов. Смещение 0 обозначает получение списка с самого начала. Если не указано, используется значение по умолчанию 0.

  • limit GET Необязательно

    Максимальное количество контактов, которое нужно получить. Если не указано, используется значение по умолчанию 30.

  • format GET Необязательно

    Устанавливает формат ответа. Возможные значения: json (по умолчанию), xml.

Возвращаемое значение

Массив со следующими ключами:

  • data array Список контактов. Каждый элемент списка — массив со следующими ключами:
  • data[]['id'] int ID контакта.
  • data[]['firstname'] string Имя.
  • data[]['lastname'] string Фамилия.
  • data[]['name'] string Полное имя.
  • data[]['photo_url'] string Относительный URL уменьшенного изображения размером 96х96 пикселей.
  • data[]['photo_url_absolute'] string Абсолютный URL изображения.
  • data[]['last_transaction'] array Информация о последней операции, связанной с контактом, в виде массива со следующими ключами:
  • data[]['last_transaction']['amount'] float Сумма операции.
  • data[]['last_transaction']['amountShorten'] string Сокращённое локализованное обозначение суммы операции.
  • data[]['last_transaction']['currency'] string 3-буквенное обозначение валюты.
  • data[]['last_transaction']['date'] date Дата операции.
  • data[]['stat'] array Список операций, связанных с контактом. Каждый элемент списка — массив со следующими ключами:
  • data[]['stat'][]['currency'] string 3-буквенное обозначение валюты.
  • data[]['stat'][]['data'] array Статистика операции в виде массива со следующими ключами:
  • data[]['stat'][]['data']['expense'] float Затраты.
  • data[]['stat'][]['data']['expenseShorten'] string Сокращённое локализованное обозначение затрат.
  • data[]['stat'][]['data']['income'] float Доходы.
  • data[]['stat'][]['data']['incomeShorten'] string Сокращённое локализованное обозначение доходов.
  • data[]['stat'][]['data']['summary'] float Дельта — доходы за вычетом расходов и размера выведенных средств.
  • data[]['stat'][]['data']['summaryShorten'] string Сокращённое локализованное обозначение дельты.
  • total int Общее количество найденных контактов.
  • offset int Применённое значение параметра offset.
  • limit int Применённое значение параметра limit.

Пример

https://demo1-ru.webasyst.com/api.php/cash.contact.getList?