Общее описание

API-интерфейс FreshOffice предназначен для обмена данными между базами данных приложений FreshOffice и внешними клиентами.

Протокол

Доступ к API осуществляется по протоколу Open Data Protocol (OData). OData — это стандартизованный протокол, специально предназначенный для использования в системах API. Приведённые ниже примеры иллюстрируют некоторые полезные возможности OData в части выборки и представления данных, однако сами по себе эти примеры не являются достаточными для полного понимания принципов работы протокола. Перед использованием API, пожалуйста, ознакомьтесь с официальной документацией протокола OData. Особенное внимание следует обратить на разделы, посвящённые соглашениям URL и операциям.

В большинстве случаев FreshOffice API соответствует протоколу OData, за исключением следующих моментов:

Авторизация и аутентификация

Для доступа к API применяется базовая аутентификация (Basic access authentication). Каждый запрос должен содержать заголовок Authorization, со значением "Basic" + [пробел] + строка вида "<Идентификатор API>:<Пароль API>", кодированная в Base64. Например, если Идентификатор API имеет значение 42, а Пароль API имеет значение ajhkJ5SbaIa0hJrqbD53I6XukGFOaPl2, то заголовок будет иметь вид Authorization: Basic NDI6YWpoa0o1U2JhSWEwaEpycWJENTNJNlh1a0dGT2FQbDI=. Идентификатор API и Пароль API можно получить в Панели управления при создании нового аккаунта API доступа.

Структура данных

Структура данных, доступных через API, приблизительно соответствует структуре базы данных, используемой приложением. В терминах модели данных, ипользуемой API, таблицам соответствуют типы записей (или сущности), полям таблицы — свойства, а связанным по внешнему ключу таблицам — свойства навигации.

Типы записей

Название

Значение

Выборка данных

Вставка данных

companies

Контрагенты

Пример

Пример

company_groups

Группы контрагентов

Пример

Не поддерживается

company_requisites_legal

Ревизиты контрагента (юридического лица)

Пример

Пример

company_requisites_natural

Реквизиты контрагента (физического лица)

Пример

Пример

company_types

Типы контрагентов

Пример

Не поддерживается

contacts

Контактные лица

Пример

Пример

contact_statuses

Статусы контактных лиц

Пример

Не поддерживается

emails

Адреса электронной почты

Пример

Пример

messages

Сообщения

Пример

Пример

message_statuses

Статусы сообщений

Пример

Не поддерживается

message_types

Типы сообщений

Пример

Не поддерживается

phones

Номера телефонов

Пример

Пример

payments

Финансовые движения (платежи)

Пример

Пример

payment_accounts

Счета платежей

Пример

Пример

payment_currencies

Валюты платежей

Пример

Пример

payment_items

Статьи оплаты

Пример

Пример

payment_methods

Способы оплаты

Пример

Не поддерживается

payment_statuses

Статусы платежей

Пример

Не поддерживается

tasks

Задачи

Пример

Пример

task_categories

Категории задач

Пример

Не поддерживается

task_statuses

Статусы задач

Пример

Не поддерживается

task_types

Типы задач

Пример

Не поддерживается

users

Пользователи

Пример

Не поддерживается

documents

Документы

Пример

Пример

deal

Сделки

Пример

Пример

project

Проекты

Пример

Пример

tovar_doc

Товары документов

Пример

Пример

tovar_deal

Товары сделок

Пример

Пример

tovar_project

Товары проектов

Пример

Пример

priznak_documents

Статусы документов

Пример

Не поддерживается

tip_documents

Типы документов

Пример

Не поддерживается

tip_deal

Типы сделок

Пример

Не поддерживается

status_deal

Статусы сделок

Пример

Не поддерживается

priznak_project

Статусы проектов

Пример

Не поддерживается

list_spr_project

Типы проектов

Пример

Не поддерживается

tovar_list

Товарный справочник

Пример

Пример

user_groups

Группы пользователей

Пример

Не поддерживается

companies: контрагенты

Структура данных

Свойства

Название

Тип данных

Значение

id

int

Идентификатор контрагента

name

nvarchar(200)

Наименование контрагента

address

nvarchar(200)

Адрес контрагента

city

nvarchar(255)

Город контрагента

region

nvarchar(255)

Регион контрагента

country

nvarchar(100)

Страна контрагента

property_form

nvarchar(100)

Форма собственности контрагента

activity_type

nvarchar(200)

Род деятельности контрагента

person

int

1 — юридическое лицо, 2 — физическое лицо

first_name

nvarchar(255)

Имя (физического лица)

middle_name

nvarchar(255)

Отчество (физического лица)

last_name

nvarchar(255)

Фамилия (физическое лица)

url

varchar(150)

Url вебсайта контрагента

type_id

int

Идентификатор типа контрагента

group_id

int

Идентификатор группы контрагента

user_id

int

Идентификатор ответственного пользователя

created

datetime

Дата и время добавления контрагента

created_by

nvarchar(200)

Имя пользователя или способ добавления контрагента

info_source

nvarchar(200)

Источник информации о контрагенте

Свойства навигации

Название

Связанная сущность

Значение

Связь по свойству

 

contacts

contacts

Контактные лица контрагента

contacts.company_id

 

phones

phones

Телефоны контрагента

phones.company_id

 

emails

emails

Адреса электронной почты контрагента

emails.company_id

 

group

company_groups

Группа контрагента

companies.group_id

 

type

company_types

Тип контрагента

companies.type_id

 

user

users

Пользователь, ответственный за контрагента

companies.user_id

 

tasks

tasks

Задачи по контрагенту

tasks.company_id

 

requisites_legal

company_requisites_legal

Реквизиты контрагента (юридического лица)

company_requisites_legal.company_id

 

documents

documents

Документы контрагента

documents

 

deal

deal

Сделки контрагента

deal

project

project

Проекты контрагента

project

requisites_natural

company_requisites_natural

Реквизиты контрагента (физического лица)

company_requisites_natural.company_id

 

Примеры запросов

Выборка данных
Запрос
GET https://api.myfreshcloud.com/companies(1)?$select=id,name,city,country,property_form,activity_type,group/descr&$expand=group
Authorization: Basic NDI6YWpoa0o1U2JhSWEwaEpycWJENTNJNlh1a0dGT2FQbDI=
Ответ
HTTP/1.1 200 OK DataServiceVersion: 3.0; Content-Type: text/javascript;odata=verbose;charset=utf-8
{
  "d":{
    "group":{"descr":"ОТДЕЛ ПРОДАЖ"},
    "id":1,
    "name":"Свежие решения",
    "city":"Санкт-Петербург",
    "country":"РОССИЯ",
    "activity_type":"Программное обеспечение",
    "property_form":"ООО"
  }
}
Добавление данных
Запрос
POST https://api.myfreshcloud.com/companies
Authorization: Basic NDI6YWpoa0o1U2JhSWEwaEpycWJENTNJNlh1a0dGT2FQbDI=
Content-Type: application/json;odata=verbose
MaxDataServiceVersion: 3.0
{
  "name":"Рога и копыта",
  "address":"ул. Касательная, д. 1",
  "city":"Черноморск",
  "country":"СССР",
  "property_form":"Подставная контора",
  "activity_type":"Заготовка рогов и копыт для гребеночной и мундштучной промышленности",
  "person":1,
  "type_id":1,
  "group_id":2,
  "user_id":37,
  "created":"2013-08-29T11:00:00",
  "created_by":"Fresh API",
  "info_source":"Регистрация на сайте",
  "requisites_legal":[
    {
      "short_name":"Рога и Копыта",
      "full_name":"Черноморское отделение Арбатовской конторы по заготовке рогов и копыт"
    }
  ],
  "contacts":[
    {
      "first_name":"Шура",
      "last_name":"Балаганов",
      "post":"Уполномоченный по копытам",
      "note":"сын лейтенанта Шмидта",
      "status_id":1,
      "emails":[
        {"email":"schmidt@example.com"},
        {"email":"balagan@example.com"}
      ],
      "phones":[
        {"phone":"+0123456789","descr":"рабочий"}
      ]
    },
    {
      "first_name":"Михаил",
      "middle_name":"Самуэлевич",
      "last_name":"Паниковский",
      "post":"Курьер",
      "note":"Человек без паспорта",
      "status_id":1,
      "emails":[
        {"email":"panikovsky@example.com"}
      ]
    }
  ],
  "tasks":[
    {
      "user_id":37,
      "category_id":2,
      "status_id":1,
      "type_id":1,
      "date_from":"2013-08-29T11:00:00",
      "date_till":"2013-08-29T19:00:00",
      "note":"Первый контакт"
    }
  ]
}
Ответ
HTTP/1.1 201 Created DataServiceVersion: 3.0; Content-Type: text/javascript;odata=verbose;charset=utf-8
{
  "d":{
    "id":18,
    "name":"Рога и копыта",
    "address":"ул. Касательная, д. 1",
    "created":"2013-08-29T11:00:00",
    "city":"Черноморск",
    "region":null,
    "country":"СССР",
    "activity_type":"Заготовка рогов и копыт для гребеночной и мундштучной промышленности",
    "property_form":"Подставная контора",
    "type_id":1,
    "created_by":"Fresh API",
    "info_source":"Регистрация на сайте",
    "group_id":2,
    "first_name":null,
    "middle_name":null,
    "last_name":null,
    "url":null,
    "user_id":37,
    "person":1
  }
}

company_groups: группы контрагентов

Структура данных

Свойства

Название

Тип данных

Значение

id

int

Идентификатор группы контрагентов

descr

nvarchar(255)

Описание группы контрагентов

Свойства навигации

Название

Связанная сущность

Значение

Связь по свойству

companies

companies

Контрагенты данной группы

companies.group_id

Примеры запросов

Выборка данных
Запрос
GET https://api.myfreshcloud.com/company_groups?$orderby=id
Authorization: Basic NDI6YWpoa0o1U2JhSWEwaEpycWJENTNJNlh1a0dGT2FQbDI=
Ответ
HTTP/1.1 200 OK DataServiceVersion: 3.0; Content-Type: text/javascript;odata=verbose;charset=utf-8
{
  "d":{
    "results":[
      {"id":1,"descr":"ОТДЕЛ ПРОДАЖ"},
      {"id":2,"descr":"КЛИЕНТСКИЙ ОТДЕЛ"},
      {"id":3,"descr":"ОТДЕЛ МАРКЕТИНГА"},
      {"id":4,"descr":"ОТДЕЛ СЕРВИСА"},
      {"id":5,"descr":"ОТДЕЛ РЕКЛАМЫ"}
    ]
  }
}

Структура данных

Свойства

Название

Тип данных

Значение

id

int

Идентификатор реквизитов контрагента

company_id

int

Идентификатор контрагента

short_name

varchar(255)

Краткое название контрагента

full_name

varchar(255)

Полное наименование контрагента

Свойства навигации

Название

Связанная сущность

Значение

Связь по свойству

company

companies

Контрагент, которому принадлежат данные реквизиты

company_requisites_legal.company_id

Примеры запросов

Запрос
GET https://api.myfreshcloud.com/company_requisites_legal?$filter=company_id eq 3
Authorization: Basic NDI6YWpoa0o1U2JhSWEwaEpycWJENTNJNlh1a0dGT2FQbDI=
Ответ
HTTP/1.1 200 OK DataServiceVersion: 3.0; Content-Type: text/javascript;odata=verbose;charset=utf-8
{
  "d":{
    "results":[
      {"id":2,"company_id":3,"short_name":"ЗАО Интерьер-Дизайн","full_name":"ЗАО Интерьер-Дизайн"}
    ]
  }
}
Запрос
POST https://api.myfreshcloud.com/company_requisites_legal
Authorization: Basic NDI6YWpoa0o1U2JhSWEwaEpycWJENTNJNlh1a0dGT2FQbDI=
Content-Type: application/json;odata=verbose
MaxDataServiceVersion: 3.0
{
  "company_id":17,
  "short_name":"Рога и Копыта",
  "full_name":"Черноморское отделение Арбатовской конторы по заготовке рогов и копыт"
}
Ответ
HTTP/1.1 201 Created DataServiceVersion: 3.0; Content-Type: text/javascript;odata=verbose;charset=utf-8
{
  "d":{
    "id":16,
    "company_id":17,
    "short_name":"Рога и Копыта",
    "full_name":"Черноморское отделение Арбатовской конторы по заготовке рогов и копыт"
  }
}

company_requisites_natural: реквизиты контрагентов (физических лиц)

Структура данных

Свойства

Название

Тип данных

Значение

id

int

Идентификатор реквизитов контрагента

company_id

int

Идентификатор контрагента

name

varchar(255)

ФИО контрагента в именительном падеже: Иванов Иван Иванович

name_ini

varchar(255)

Фамилия и инициалы контрагента: Иванов И. И.

name_gen

varchar(255)

ФИО контрагента в родительном падеже: Иванова Ивана Ивановича

name_dat

varchar(255)

ФИО контрагента в дательном падеже: Иванову Ивану Ивановичу

name_ins

varchar(255)

ФИО контрагента в творительном падеже: Ивановым Иваном Ивановичем

Свойства навигации

Название

Связанная сущность

Значение

Связь по свойству

company

companies

Контрагент, которому принадлежат данные реквизиты

company_requisites_natural.company_id

Примеры запросов

Выборка данных
Запрос
GET https://api.myfreshcloud.com/company_requisites_natural
Authorization: Basic NDI6YWpoa0o1U2JhSWEwaEpycWJENTNJNlh1a0dGT2FQbDI=
Ответ
HTTP/1.1 200 OK DataServiceVersion: 3.0; Content-Type: text/javascript;odata=verbose;charset=utf-8
{
  "d":{
    "results":[]
  }
}
Добавление данных
Запрос
POST https://api.myfreshcloud.com/company_requisites_natural
Authorization: Basic NDI6YWpoa0o1U2JhSWEwaEpycWJENTNJNlh1a0dGT2FQbDI=
Content-Type: application/json;odata=verbose
MaxDataServiceVersion: 3.0
{
  "company_id":3,
  "name":"Иванов Иван Иванович",
  "name_ini":"Иванов И. И.",
  "name_gen":"Иванова Ивана Ивановича",
  "name_dat":"Иванову Ивану Ивановичу",
  "name_ins":"Ивановым Иваном Ивановичем"
}
Ответ
HTTP/1.1 201 Created DataServiceVersion: 3.0; Content-Type: text/javascript;odata=verbose;charset=utf-8
{
  "d":{
    "id":3,
    "company_id":17,
    "name":"Иванов Иван Иванович",
    "name_ini":"Иванов И. И.",
    "name_gen":"Иванова Ивана Ивановича",
    "name_dat":"Иванову Ивану Ивановичу",
    "name_ins":"Ивановым Иваном Ивановичем"
  }
}

company_types: типы контрагентов

Структура данных

Свойства

Название

Тип данных

Значение

id

int

Идентификатор вида контрагента

descr

varchar(100)

описание вида контрагента

Свойства навигации

Название

Связанная сущность

Значение

Связь по свойству

companies

companies

Контрагенты, принадлежащие к данному типу

companies.type_id

Примеры запросов

Выборка данных
Запрос
GET https://api.myfreshcloud.com/company_types?$top=1&orderby=id
Authorization: Basic NDI6YWpoa0o1U2JhSWEwaEpycWJENTNJNlh1a0dGT2FQbDI=
Ответ
HTTP/1.1 200 OK DataServiceVersion: 3.0; Content-Type: text/javascript;odata=verbose;charset=utf-8
{
  "d":{
    "results":[
      {"id":1,"descr":"НОВАЯ КОМПАНИЯ"}
    ]
  }
}

contacts: контактные лица

Структура данных

Свойства

Название

Тип данных

Значение

id

int

Идентификатор контактного лица

company_id

int

Идентификатор контрагента

name

varchar(200)

Название контактного лица

first_name

varchar(100)

Имя контактного лица

middle_name

varchar(100)

Отчество контактного лица

last_name

varchar(100)

Фамилия контактного лица

post

varchar(200)

Должность контактного лица

note

varchar(200)

Примечание

status_id

int

Статус контактного лица

Свойства навигации

Название

Связанная сущность

Значение

Связь по свойству

company

companies

Контрагент

contacts.company_id

status

contact_statuses

Статус контактного лица

contacts.status_id

emails

emails

Контрагенты, принадлежащие к данному типу

emails.contact_id

phones

phones

Контрагенты, принадлежащие к данному типу

phones.contact_id

tasks

tasks

Контрагенты, принадлежащие к данному типу

tasks.contact_id

Примеры запросов

Выборка данных
Запрос
GET https://api.myfreshcloud.com/contacts(2225)
Authorization: Basic NDI6YWpoa0o1U2JhSWEwaEpycWJENTNJNlh1a0dGT2FQbDI=
Ответ
HTTP/1.1 200 OK DataServiceVersion: 3.0; Content-Type: text/javascript;odata=verbose;charset=utf-8
{
  "d":{
    "id":2225,
    "company_id":2,
    "name":"Васильев Максим Сергеевич",
    "first_name":"Максим",
    "middle_name":"Сергеевич",
    "last_name":"Васильев",
    "post":"Коммерческий директор",
    "note":null,
    "status_id":null
  }
}
Добавление данных
Запрос
POST https://api.myfreshcloud.com/contacts
Authorization: Basic NDI6YWpoa0o1U2JhSWEwaEpycWJENTNJNlh1a0dGT2FQbDI=
Content-Type: application/json;odata=verbose
MaxDataServiceVersion: 3.0
{
  "company_id":1,
  "first_name":"Шура",
  "last_name":"Балаганов",
  "post":"Уполномоченный по копытам",
  "note":"сын лейтенанта Шмидта",
  "status_id":1,
  "emails":[
    {"company_id":1,"email":"schmidt@example.com"},
    {"company_id":1,"email":"balagan@example.com"}
  ],
  "phones":[
    {"company_id":1,"phone":"+0123456789","descr":"рабочий"}
  ]
}
Ответ
HTTP/1.1 201 Created DataServiceVersion: 3.0; Content-Type: text/javascript;odata=verbose;charset=utf-8
{
  "d":{
    "id":2237,
    "company_id":1,
    "name":"Шура Балаганов",
    "first_name":"Шура",
    "middle_name":null,
    "last_name":"Балаганов",
    "post":"Уполномоченный по копытам",
    "note":"сын лейтенанта Шмидта",
    "status_id":1
  }
}

contact_statuses: статусы контактных лиц

Структура данных

Свойства

Название

Тип данных

Значение

id

int

Идентификатор статуса контактного лица

descr

nvarchar(255)

Описание статуса контактного лица

Свойства навигации

Название

Связанная сущность

Значение

Связь по свойству

contacts

contacts

Контактные лица

contacts.status_id

Примеры запросов

Выборка данных
Запрос
GET https://api.myfreshcloud.com/contact_statuses
Authorization: Basic NDI6YWpoa0o1U2JhSWEwaEpycWJENTNJNlh1a0dGT2FQbDI=
Ответ
HTTP/1.1 200 OK DataServiceVersion: 3.0; Content-Type: text/javascript;odata=verbose;charset=utf-8
{
  "d":{
    "results":[
      {"id":1,"descr":"Работает"},
      {"id":2,"descr":"Уволен"},
      {"id":3,"descr":"в отпуске"}
    ]
  }
}

emails: адреса электронной почты

Структура данных

Свойства

Название

Тип данных

Значение

id

int

Идентификатор адреса электронной почты

company_id

int

Идентификатор контрагента

contact_id

int

Идентификатор контактного лица

email

nvarchar(50)

Адрес электронной почты

Свойства навигации

Название

Связанная сущность

Значение

Связь по свойству

company

companies

Контрагент

emails.company_id

contact

contacts

Контактное лицо

emails.contact_id

Примеры запросов

Выборка данных
Запрос
GET https://api.myfreshcloud.com/emails?$expand=company&$select=email,company/id,company/name&$skip=1
Authorization: Basic NDI6YWpoa0o1U2JhSWEwaEpycWJENTNJNlh1a0dGT2FQbDI=
Ответ
HTTP/1.1 200 OK DataServiceVersion: 3.0; Content-Type: text/javascript;odata=verbose;charset=utf-8
{
  "d":{
    "results":[
      {"company":{"id":2,"name":"Новая жемчужина"},"email":"info@gemchug.ru"},
      {"company":{"id":3,"name":"Интерьер-Дизайн"},"email":"info@inter-design.ru"},
      {"company":{"id":4,"name":"Море путешествий"},"email":"info@sea-travel.com"}
    ]
  }
}
Добавление данных
Запрос
POST https://api.myfreshcloud.com/emails
Authorization: Basic NDI6YWpoa0o1U2JhSWEwaEpycWJENTNJNlh1a0dGT2FQbDI=
Content-Type: application/json;odata=verbose
MaxDataServiceVersion: 3.0
{
  "company_id":18,
  "contact_id":2243,
  "email":"qwerty@example.com"
}
Ответ
HTTP/1.1 201 Created DataServiceVersion: 3.0; Content-Type: text/javascript;odata=verbose;charset=utf-8
{
  "d":{
    "id":2892,
    "company_id":18,
    "contact_id":2243,
    "email":"qwerty@example.com"
  }
}

messages: сообщения

Структура данных

Свойства

Название

Тип данных

Значение

id

int

Идентификатор сообщения

user_id

int

Идентификатор пользователя — получателя сообщения

sender_id

int

Идентификатор пользователя — отправителя сообщения

text

varchar(1500)

Текст сообщения

created

datetime

Дата и время отправки сообщения

type_id

int

Тип сообщения

status_id

int

Статус сообщения

Свойства навигации

Название

Связанная сущность

Значение

Связь по свойству

user

users

Пользователь получатель сообщения

messages.user_id

sender

users

Пользователь отправитель сообщения

messages.sender_id

status

message_statuses

Статус сообщения

messages.status_id

type

message_types

Тип сообщения

messages.type_id

Примеры запросов

Выборка данных
Запрос
GET https://api.myfreshcloud.com/messages?$filter=user_id eq 37 and year(created) eq 2013&$expand=type,status&$select=text,created,status/descr,type/descr,user&$orderby=created desc
Authorization: Basic NDI6YWpoa0o1U2JhSWEwaEpycWJENTNJNlh1a0dGT2FQbDI=
Ответ
HTTP/1.1 200 OK DataServiceVersion: 3.0; Content-Type: text/javascript;odata=verbose;charset=utf-8
{
  "d":{
    "results":[
      {
        "status":{"descr":"НЕ ПРОЧИТАНО"},
        "type":{"descr":"СООБЩЕНИЕ"},
        "text":"ВНИМАНИЕ! Вам поручен процесс.   Тип: Стандарный пример  №: 3   Дата :  Aug 22 2013 10:15AM",
        "created":"2013-08-22T10:15:34.097"
      },
      {
        "status":{"descr":"НЕ ПРОЧИТАНО"},
        "type":{"descr":"СООБЩЕНИЕ"},
        "text":"ВНИМАНИЕ! Вам поручен процесс.   Тип: Проведение event мероприятия  №: 2   Дата :  Aug 22 2013 10:15AM",
        "created":"2013-08-22T10:15:34.04"
      },
      {
        "status":{"descr":"НЕ ПРОЧИТАНО"},
        "type":{"descr":"СООБЩЕНИЕ"},
        "text":"ВНИМАНИЕ! Вам поручен процесс.   Тип: Стандарный пример  №: 1   Дата :  Aug 22 2013 10:15AM",
        "created":"2013-08-22T10:15:33.887"
      }
    ]
  }
}
Добавление данных
Запрос
POST https://api.myfreshcloud.com/messages
Authorization: Basic NDI6YWpoa0o1U2JhSWEwaEpycWJENTNJNlh1a0dGT2FQbDI=
Content-Type: application/json;odata=verbose
MaxDataServiceVersion: 3.0
{
  "user_id":37,
  "sender_id":37,
  "text":"ВНИМАНИЕ! Проверка слуха.",
  "created":"2013-08-29T16:25:00",
  "type_id":1,
  "status_id":2
}
Ответ
HTTP/1.1 201 Created DataServiceVersion: 3.0; Content-Type: text/javascript;odata=verbose;charset=utf-8
{
  "d":{
    "id":88,
    "sender_id":37,
    "text":"ВНИМАНИЕ! Проверка слуха.",
    "created":"2013-08-29T16:25:00",
    "type_id":1,
    "status_id":2,
    "user_id":37
  }
}

message_statuses: статусы сообщений

Структура данных

Свойства

Название

Тип данных

Значение

id

int

Идентификатор статуса сообщения

descr

varchar(255)

Описание статуса сообщения

Свойства навигации

Название

Связанная сущность

Значение

Связь по свойству

messages

messages

Сообщения данного статуса

messages.status_id

Примеры запросов

Выборка данных
Запрос
GET https://api.myfreshcloud.com/message_statuses
Authorization: Basic NDI6YWpoa0o1U2JhSWEwaEpycWJENTNJNlh1a0dGT2FQbDI=
Ответ
HTTP/1.1 200 OK DataServiceVersion: 3.0; Content-Type: text/javascript;odata=verbose;charset=utf-8
{
  "d":{
    "results":[
      {"id":1,"descr":"ПРОЧИТАНО"},
      {"id":2,"descr":"НЕ ПРОЧИТАНО"}
    ]
  }
}

message_types: типы сообщений

Структура данных

Свойства

Название

Тип данных

Значение

id

int

Идентификатор типа сообщения

descr

nvarchar(255)

Описание типа сообщения

Свойства навигации

Название

Связанная сущность

Значение

Связь по свойству

messages

messages

Сообщения данного типа

messages.type_id

Примеры запросов

Выборка данных
Запрос
GET https://api.myfreshcloud.com/message_types?$orderby=descr
Authorization: Basic NDI6YWpoa0o1U2JhSWEwaEpycWJENTNJNlh1a0dGT2FQbDI=
Ответ
HTTP/1.1 200 OK DataServiceVersion: 3.0; Content-Type: text/javascript;odata=verbose;charset=utf-8
{
  "d":{
    "results":[
      {"id":3,"descr":"ОБЬЯВЛЕНИЕ"},
      {"id":2,"descr":"ПРЕДЛОЖЕНИЕ"},
      {"id":4,"descr":"ПРИКАЗ"},
      {"id":5,"descr":"РАСПОРЯЖЕНИЕ"},
      {"id":1,"descr":"СООБЩЕНИЕ"}
    ]
  }
}

payments: финансовые движения

Структура данных

Свойства

Название

Тип данных

Значение

id

int

Идентификатор платежа

made

datetime

Время совершения платежа

company_id

int

Идентификатор контрагента

method_id

int

Идентификатор способа платежа

status_id

int

Идентификатор статуса платежа

currency_id

int

Идентификатор валюты платежа

currency_rate

decimal

Курс валюты платежа

amount_currency

decimal

Сумма в валюте платежа

amount_local

decimal

Сумма в валюте счёта

note

nvarchar(255)

Примечание

direction

int

Направление платежа

item_id

int

Идентификатор статьи платежа

account_id

int

Идентификатор счёта

user_id

int

Идентификатор пользователя

created_by

nvarchar(255)

Пользователь, добавивший платёж

created

datetime

Время добавления платежа

Свойства навигации

Название

Связанная сущность

Значение

Связь по свойству

account

payment_accounts

Счёт платежа

payments.account_id

company

companies

Контрагент

payments.company_id

currency

payment_currencies

Валюта платежа

payments.currency_id

item

payment_items

Статья платежа

payments.item_id

method

payment_methods

Способ платежа

payments.method_id

status

payment_statuses

Статус платежа