ПланФакт.API API Reference

Документация к API ПланФакта

API Endpoint
https://api.planfact.io
Schemes: https
Version: v1

Authentication

apiKey

Api key

type
apiKey
name
X-ApiKey
in
header

Accounts

Получение счета по идентификатору

GET /api/v1/accounts/{accountId}
accountId
in path
integer (int32)

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

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "companyId": "integer (int32)",
    "accountType": "string",
    "accountTypeTitle": "string",
    "currencyCode": "string",
    "longTitle": "string",
    "description": "string",
    "accountAcct": "string",
    "accountBik": "string",
    "accountBank": "string",
    "currencyTitle": "string",
    "active": "boolean",
    "remainder": "number (double)",
    "coreAccountId": "00000000-0000-0000-0000-000000000000",
    "accountId": "integer (int32)",
    "title": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Изменение существующего счета

PUT /api/v1/accounts/{accountId}

Обновленные значения атрибутов счета

accountId
in path
integer (int32)

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

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "title": "string",
  "longTitle": "string",
  "description": "string",
  "companyId": "integer (int32)",
  "accountType": "string",
  "accountAcct": "string",
  "accountBik": "string",
  "accountBank": "string",
  "currencyCode": "string",
  "active": "boolean",
  "remainder": "number (double)",
  "remainderDate": "string (date)"
}
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "companyId": "integer (int32)",
    "accountType": "string",
    "accountTypeTitle": "string",
    "currencyCode": "string",
    "longTitle": "string",
    "description": "string",
    "accountAcct": "string",
    "accountBik": "string",
    "accountBank": "string",
    "currencyTitle": "string",
    "active": "boolean",
    "remainder": "number (double)",
    "coreAccountId": "00000000-0000-0000-0000-000000000000",
    "accountId": "integer (int32)",
    "title": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Удаление счета

DELETE /api/v1/accounts/{accountId}
accountId
in path
integer (int32)

(no description)

200 OK

OK

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Получение списка счетов

GET /api/v1/accounts
filter.agentId
in query
integer (int32)

Id юрлица

filter.accountType
in query
string Cash, Card

Тип счёта

filter.title
in query
string

Название счета

filter.longTitle
in query
string

Полное название счета

filter.description
in query
string

Описание

filter.accountAcct
in query
string

Номер счета

filter.accountBik
in query
string

БИК счета

filter.accountBank
in query
string

Банк счета

filter.currencyCode
in query
string USD, EUR, GBP, RUB, BYN, UAH, KZT, CNY, TRY, KGS, AMD, AED, INR, JPY, MDL, UZS, PLN, SGD, BTC, ETH, BCH, XRP, LTC, DASH, XMR, ETC, ZEC, STRAT, DCR, DOGE, SC, CAD

Код валюты

filter.active
in query
boolean

Отображение активных счетов

paging.offset
in query
integer (int32)

Смещение от начала списка. По умолчанию 0

paging.limit
in query
integer (int32)

Размер фрейма

sorting.field
in query
string CompanyTitle, AccountTypeTitle, Title, LongTitle, Description, AccountAcct, AccountBik, AccountBank, CurrencyTitle, Active

Поле сортировки

sorting.direction
in query
string Asc, Desc

Направление сортировки (По умолчанию Asc)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "items": [
      {
        "companyId": "integer (int32)",
        "accountType": "string",
        "accountTypeTitle": "string",
        "currencyCode": "string",
        "longTitle": "string",
        "description": "string",
        "accountAcct": "string",
        "accountBik": "string",
        "accountBank": "string",
        "currencyTitle": "string",
        "active": "boolean",
        "remainder": "number (double)",
        "coreAccountId": "00000000-0000-0000-0000-000000000000",
        "accountId": "integer (int32)",
        "title": "string"
      }
    ],
    "total": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Создание нового счета

POST /api/v1/accounts

Атрибуты создаваемого счета

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "title": "string",
  "longTitle": "string",
  "description": "string",
  "companyId": "integer (int32)",
  "accountType": "string",
  "accountAcct": "string",
  "accountBik": "string",
  "accountBank": "string",
  "currencyCode": "string",
  "active": "boolean",
  "remainder": "number (double)",
  "remainderDate": "string (date)"
}
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "companyId": "integer (int32)",
    "accountType": "string",
    "accountTypeTitle": "string",
    "currencyCode": "string",
    "longTitle": "string",
    "description": "string",
    "accountAcct": "string",
    "accountBik": "string",
    "accountBank": "string",
    "currencyTitle": "string",
    "active": "boolean",
    "remainder": "number (double)",
    "coreAccountId": "00000000-0000-0000-0000-000000000000",
    "accountId": "integer (int32)",
    "title": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Получение остатков по счету

GET /api/v1/accounts/{accountId}/remainders
accountId
in path
integer (int32)

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

period.startDate
in query
string (date)

Начальная дата

period.endDate
in query
string (date)

Конечная дата

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": [
    {
      "date": "string (date)",
      "value": "number (double)"
    }
  ],
  "isSuccess": "boolean",
  "errorMessage": "string"
}

BizInfos

Получение главных показателей

GET /api/v1/bizinfos/mainindicators
periodType
in query
string Quarter, Month, Week

Степень подробности

filter.periodStartDate
in query
string (date)

Дата начала периода

filter.periodEndDate
in query
string (date)

Дата окончания периода

filter.companyId
in query
integer[]

Набор идентификаторов юрлиц

Array values passed as multiple parameters: ?filter.companyId=aaa&filter.companyId=bbb
filter.projectId
in query
integer[]

Набор идентификаторов проектов

Array values passed as multiple parameters: ?filter.projectId=aaa&filter.projectId=bbb
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "total": {
      "date": "string (date)",
      "incomePlan": "number (double)",
      "incomeFact": "number (double)",
      "outcomePlan": "number (double)",
      "outcomeFact": "number (double)",
      "profitPlan": "number (double)",
      "profitFact": "number (double)",
      "profitabilityPlan": "number (double)",
      "profitabilityFact": "number (double)",
      "dividendsPlan": "number (double)",
      "dividendsFact": "number (double)"
    },
    "items": [
      {
        "date": "string (date)",
        "incomePlan": "number (double)",
        "incomeFact": "number (double)",
        "outcomePlan": "number (double)",
        "outcomeFact": "number (double)",
        "profitPlan": "number (double)",
        "profitFact": "number (double)",
        "profitabilityPlan": "number (double)",
        "profitabilityFact": "number (double)",
        "dividendsPlan": "number (double)",
        "dividendsFact": "number (double)"
      }
    ]
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Получение истории остатков на счетах

GET /api/v1/bizinfos/remaindershistory
filter.periodStartDate
in query
string (date)

Дата начала периода

filter.periodEndDate
in query
string (date)

Дата окончания периода

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": [
    {
      "date": "string (date)",
      "total": {
        "accountId": "integer (int32)",
        "value": "number (double)",
        "hasCorrection": "boolean"
      },
      "details": [
        {
          "accountId": "integer (int32)",
          "value": "number (double)",
          "hasCorrection": "boolean"
        }
      ]
    }
  ],
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Получение результатов по видам деятельности

GET /api/v1/bizinfos/resultsbyactivitytype
periodType
in query
string Quarter, Month, Week

Степень подробности

filter.periodStartDate
in query
string (date)

Дата начала периода

filter.periodEndDate
in query
string (date)

Дата окончания периода

filter.companyId
in query
integer[]

Набор идентификаторов юрлиц

Array values passed as multiple parameters: ?filter.companyId=aaa&filter.companyId=bbb
filter.projectId
in query
integer[]

Набор идентификаторов проектов

Array values passed as multiple parameters: ?filter.projectId=aaa&filter.projectId=bbb
filter.activityType
in query
string Operating, Finance, Investment, All, WithoutCategory

Вид деятельности

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "total": {
      "date": "string (date)",
      "incomePlan": "number (double)",
      "incomeFact": "number (double)",
      "outcomePlan": "number (double)",
      "outcomeFact": "number (double)",
      "profitPlan": "number (double)",
      "profitFact": "number (double)"
    },
    "items": [
      {
        "date": "string (date)",
        "incomePlan": "number (double)",
        "incomeFact": "number (double)",
        "outcomePlan": "number (double)",
        "outcomeFact": "number (double)",
        "profitPlan": "number (double)",
        "profitFact": "number (double)"
      }
    ]
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Получение структуры поступлений (доходов) или списаний (расходов)

GET /api/v1/bizinfos/structure
periodType
in query
string Quarter, Month, Week

Степень подробности

filter.periodStartDate
in query
string (date)

Дата начала периода

filter.periodEndDate
in query
string (date)

Дата окончания периода

filter.companyId
in query
integer[]

Набор идентификаторов юрлиц

Array values passed as multiple parameters: ?filter.companyId=aaa&filter.companyId=bbb
filter.projectId
in query
integer[]

Набор идентификаторов проектов

Array values passed as multiple parameters: ?filter.projectId=aaa&filter.projectId=bbb
filter.activityType
in query
string Operating, Finance, Investment, All, WithoutCategory

Вид деятельности (обязательное поле для кассового метода)

filter.budgetAccountMethod
in query
string Cash, BDDS, BDR

Вид метода рассчета. 1) Если у пользователя не выбран "Метод начисления", то возможен только один вариант: BudgetAccountMethod = (int) BudgetAccountMethodEnum.Cash; //1 2) Если у пользователя выбран "Метод начисления", то возможны варианты: 2.1) Кассовый: BudgetAccountMethod = (int)BudgetAccountMethodEnum.BDDS; //2 2.2) Метод начисления: BudgetAccountMethod = (int) BudgetAccountMethodEnum.BDR; //3

filter.isIncome
in query
boolean

Если истина, то учитываем поступления (доходы) Если ложь, то учитываем списания (расходы)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": [
    {
      "activityType": "string",
      "operationCategoryId": "integer (int32)",
      "parentOperationCategoryId": "integer (int32)",
      "title": "string",
      "valuePlan": "number (double)",
      "valueFact": "number (double)",
      "details": [
        {
          "date": "string (date)",
          "valuePlan": "number (double)",
          "valueFact": "number (double)"
        }
      ]
    }
  ],
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Получение рейтинга проектов

GET /api/v1/bizinfos/projectsrating
filter.periodStartDate
in query
string (date)

Дата начала периода

filter.periodEndDate
in query
string (date)

Дата окончания периода

filter.companyId
in query
integer[]

Набор идентификаторов юрлиц

Array values passed as multiple parameters: ?filter.companyId=aaa&filter.companyId=bbb
filter.projectId
in query
integer[]

Набор идентификаторов проектов

Array values passed as multiple parameters: ?filter.projectId=aaa&filter.projectId=bbb
filter.activityType
in query
string Operating, Finance, Investment, All, WithoutCategory

Вид деятельности (обязательное поле для кассового метода)

filter.budgetAccountMethod
in query
string Cash, BDDS, BDR

Вид метода рассчета. 1) Если у пользователя не выбран "Метод начисления", то возможен только один вариант: BudgetAccountMethod = (int) BudgetAccountMethodEnum.Cash; (=1) 2) Если у пользователя выбран "Метод начисления", то возможны варианты: 2.1) Кассовый: BudgetAccountMethod = (int)BudgetAccountMethodEnum.BDDS (=2) 2.2) Метод начисления: BudgetAccountMethod = (int) BudgetAccountMethodEnum.BDR; (=3)

sorting.field
in query
string ProfitPlan, ProfitFact, ProfitabilityPlan, ProfitabilityFact

Поле сортировки

sorting.direction
in query
string Asc, Desc

Направление сортировки (По умолчанию Asc)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": [
    {
      "projectId": "integer (int32)",
      "title": "string",
      "profitPlan": "number (double)",
      "profitFact": "number (double)",
      "profitabilityPlan": "number (double)",
      "profitabilityFact": "number (double)"
    }
  ],
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Получение рейтинга клиентов

GET /api/v1/bizinfos/clientsrating
filter.periodStartDate
in query
string (date)

Дата начала периода

filter.periodEndDate
in query
string (date)

Дата окончания периода

filter.companyId
in query
integer[]

Набор идентификаторов юрлиц

Array values passed as multiple parameters: ?filter.companyId=aaa&filter.companyId=bbb
filter.projectId
in query
integer[]

Набор идентификаторов проектов

Array values passed as multiple parameters: ?filter.projectId=aaa&filter.projectId=bbb
filter.activityType
in query
string Operating, Finance, Investment, All, WithoutCategory

Вид деятельности (обязательное поле для кассового метода)

filter.budgetAccountMethod
in query
string Cash, BDDS, BDR

Вид метода рассчета. 1) Если у пользователя не выбран "Метод начисления", то возможен только один вариант: BudgetAccountMethod = (int) BudgetAccountMethodEnum.Cash; (=1) 2) Если у пользователя выбран "Метод начисления", то возможны варианты: 2.1) Кассовый: BudgetAccountMethod = (int)BudgetAccountMethodEnum.BDDS (=2) 2.2) Метод начисления: BudgetAccountMethod = (int) BudgetAccountMethodEnum.BDR; (=3)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "incomeTotal": "number (double)",
    "clientsInfo": [
      {
        "contrAgentId": "integer (int32)",
        "title": "string",
        "value": "number (double)",
        "percent": "number (double)"
      }
    ]
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Получение общих сведений о бизнесе и доступе

GET /api/v1/bizinfos/layoutinfo
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "balance": "number (double)",
    "cashGapDate": "string (date)",
    "childCashGapDate": "string (date)",
    "accountOperationInfos": [
      {
        "title": "string",
        "value": "number (double)",
        "comment": "string",
        "accountId": "integer (int32)",
        "cashGapDate": "string (date)",
        "valueInCurrency": "number (double)",
        "currency": "string"
      }
    ],
    "firstName": "string",
    "accessAlert": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Получение общих остатков по счетам за текущий год за каждую неделю

GET /api/v1/bizinfos/graph
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": [
    "number (double)"
  ],
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Companies

Получение юрлица по идентификатору

GET /api/v1/companies/{companyId}
companyId
in path
integer (int32)

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

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "longTitle": "string",
    "companyInn": "string",
    "companyKpp": "string",
    "description": "string",
    "active": "boolean",
    "companyId": "integer (int32)",
    "title": "string",
    "externalId": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Изменение существующего юрлица

PUT /api/v1/companies/{companyId}

Запрос на изменение юрлица

companyId
in path
integer (int32)

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

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "title": "string",
  "longTitle": "string",
  "companyInn": "string",
  "companyKpp": "string",
  "description": "string",
  "externalId": "string",
  "active": "boolean"
}
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "longTitle": "string",
    "companyInn": "string",
    "companyKpp": "string",
    "description": "string",
    "active": "boolean",
    "companyId": "integer (int32)",
    "title": "string",
    "externalId": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Удаление юрлица

DELETE /api/v1/companies/{companyId}
companyId
in path
integer (int32)

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

200 OK

OK

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "isSuccess": "boolean",
  "errorMessage": "string"
}

GET /api/v1/companies

filter.companyId
in query
integer[]

Набор искомых идентификаторов

Array values passed as multiple parameters: ?filter.companyId=aaa&filter.companyId=bbb
filter.title
in query
string (3 to 256 chars)

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

filter.longTitle
in query
string

Полное название

filter.companyInn
in query
string

ИНН

filter.companyKpp
in query
string

КПП

filter.description
in query
string

Комментарий

filter.active
in query
boolean

Статус

filter.externalId
in query
string[]

Набор искомых внешних идентификаторов

Array values passed as multiple parameters: ?filter.externalId=aaa&filter.externalId=bbb
paging.offset
in query
integer (int32)

Смещение от начала списка. По умолчанию 0

paging.limit
in query
integer (int32)

Размер фрейма

sorting.field
in query
string Title, LongTitle, CompanyInn, CompanyKpp, Active

Поле сортировки

sorting.direction
in query
string Asc, Desc

Направление сортировки (По умолчанию Asc)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "items": [
      {
        "longTitle": "string",
        "companyInn": "string",
        "companyKpp": "string",
        "description": "string",
        "active": "boolean",
        "companyId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      }
    ],
    "total": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Создание нового юрлица

POST /api/v1/companies

Запрос на создание юрлица

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "title": "string",
  "longTitle": "string",
  "companyInn": "string",
  "companyKpp": "string",
  "description": "string",
  "externalId": "string"
}
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "longTitle": "string",
    "companyInn": "string",
    "companyKpp": "string",
    "description": "string",
    "active": "boolean",
    "companyId": "integer (int32)",
    "title": "string",
    "externalId": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

ContrAgents

Получение контрагента по идентификатору

GET /api/v1/contragents/{contrAgentId}
contrAgentId
in path
integer (int32)

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

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "longTitle": "string",
    "contrAgentInn": "string",
    "contrAgentKpp": "string",
    "description": "string",
    "contrAgentType": "string",
    "rememberCategory": "boolean",
    "operationIncomeCategoryId": "integer (int32)",
    "operationOutcomeCategoryId": "integer (int32)",
    "active": "boolean",
    "firstOperationDate": "string (date)",
    "lastOperationDate": "string (date)",
    "balance": "number (double)",
    "currencyCode": "string",
    "contrAgentId": "integer (int32)",
    "title": "string",
    "externalId": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Изменение существующего контрагента

PUT /api/v1/contragents/{contrAgentId}

Запрос на изменение контрагента

contrAgentId
in path
integer (int32)

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

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "title": "string",
  "longTitle": "string",
  "contrAgentInn": "string",
  "contrAgentKpp": "string",
  "description": "string",
  "contrAgentType": "string",
  "rememberCategory": "boolean",
  "operationIncomeCategoryId": "integer (int32)",
  "operationOutcomeCategoryId": "integer (int32)",
  "active": "boolean"
}
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "longTitle": "string",
    "contrAgentInn": "string",
    "contrAgentKpp": "string",
    "description": "string",
    "contrAgentType": "string",
    "rememberCategory": "boolean",
    "operationIncomeCategoryId": "integer (int32)",
    "operationOutcomeCategoryId": "integer (int32)",
    "active": "boolean",
    "firstOperationDate": "string (date)",
    "lastOperationDate": "string (date)",
    "balance": "number (double)",
    "currencyCode": "string",
    "contrAgentId": "integer (int32)",
    "title": "string",
    "externalId": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

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

DELETE /api/v1/contragents/{contrAgentId}
contrAgentId
in path
integer (int32)

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

200 OK

OK

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Получение контрагента со сводкой по идентификатору

GET /api/v1/contragents/{contrAgentId}/summary
contrAgentId
in path
integer (int32)

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

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "longTitle": "string",
    "contrAgentInn": "string",
    "contrAgentKpp": "string",
    "description": "string",
    "contrAgentType": "string",
    "rememberCategory": "boolean",
    "operationIncomeCategoryId": "integer (int32)",
    "operationOutcomeCategoryId": "integer (int32)",
    "active": "boolean",
    "firstOperationDate": "string (date)",
    "lastOperationDate": "string (date)",
    "balance": "number (double)",
    "currencyCode": "string",
    "contrAgentId": "integer (int32)",
    "title": "string",
    "externalId": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Получение списка контрагентов

GET /api/v1/contragents
filter.title
in query
string (3 to 256 chars)

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

filter.contrAgentType
in query
string Income, Outcome, Mixed

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

filter.startDateTime
in query
string (date)

Начальная дата поиска

filter.endDateTime
in query
string (date)

Конечная дата поиска

filter.active
in query
boolean

Статус

paging.offset
in query
integer (int32)

Смещение от начала списка. По умолчанию 0

paging.limit
in query
integer (int32)

Размер фрейма

sorting.field
in query
string Title, Active, ContrAgentType, FirstOperationDate, LastOperationDate, Balance

Поле сортировки

sorting.direction
in query
string Asc, Desc

Направление сортировки (По умолчанию Asc)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "items": [
      {
        "longTitle": "string",
        "contrAgentInn": "string",
        "contrAgentKpp": "string",
        "description": "string",
        "contrAgentType": "string",
        "rememberCategory": "boolean",
        "operationIncomeCategoryId": "integer (int32)",
        "operationOutcomeCategoryId": "integer (int32)",
        "active": "boolean",
        "firstOperationDate": "string (date)",
        "lastOperationDate": "string (date)",
        "balance": "number (double)",
        "currencyCode": "string",
        "contrAgentId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      }
    ],
    "total": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

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

POST /api/v1/contragents

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

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "title": "string",
  "longTitle": "string",
  "contrAgentInn": "string",
  "contrAgentKpp": "string",
  "description": "string",
  "contrAgentType": "string",
  "rememberCategory": "boolean",
  "operationIncomeCategoryId": "integer (int32)",
  "operationOutcomeCategoryId": "integer (int32)",
  "active": "boolean"
}
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "longTitle": "string",
    "contrAgentInn": "string",
    "contrAgentKpp": "string",
    "description": "string",
    "contrAgentType": "string",
    "rememberCategory": "boolean",
    "operationIncomeCategoryId": "integer (int32)",
    "operationOutcomeCategoryId": "integer (int32)",
    "active": "boolean",
    "firstOperationDate": "string (date)",
    "lastOperationDate": "string (date)",
    "balance": "number (double)",
    "currencyCode": "string",
    "contrAgentId": "integer (int32)",
    "title": "string",
    "externalId": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Получение списка контрагентов со сводкой

GET /api/v1/contragents/summary
filter.title
in query
string (3 to 256 chars)

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

filter.contrAgentType
in query
string Income, Outcome, Mixed

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

filter.startDateTime
in query
string (date)

Начальная дата поиска

filter.endDateTime
in query
string (date)

Конечная дата поиска

filter.active
in query
boolean

Статус

paging.offset
in query
integer (int32)

Смещение от начала списка. По умолчанию 0

paging.limit
in query
integer (int32)

Размер фрейма

sorting.field
in query
string Title, Active, ContrAgentType, FirstOperationDate, LastOperationDate, Balance

Поле сортировки

sorting.direction
in query
string Asc, Desc

Направление сортировки (По умолчанию Asc)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "items": [
      {
        "longTitle": "string",
        "contrAgentInn": "string",
        "contrAgentKpp": "string",
        "description": "string",
        "contrAgentType": "string",
        "rememberCategory": "boolean",
        "operationIncomeCategoryId": "integer (int32)",
        "operationOutcomeCategoryId": "integer (int32)",
        "active": "boolean",
        "firstOperationDate": "string (date)",
        "lastOperationDate": "string (date)",
        "balance": "number (double)",
        "currencyCode": "string",
        "contrAgentId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      }
    ],
    "total": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

CoreApi

Получение баланса

GET /api/v1/coreapi/totals
filter.fromDate
in query
string (date)

(no description)

filter.toDate
in query
string (date)

(no description)

filter.grouping
in query
string Day, Week, Month, Quarter, Year

(no description)

paging.offset
in query
integer (int32)

Смещение от начала списка. По умолчанию 0

paging.limit
in query
integer (int32)

Размер фрейма

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": [
    {
      "accountId": "00000000-0000-0000-0000-000000000000",
      "creditBefore": "number (double)",
      "debitBefore": "number (double)",
      "items": [
        {
          "groupingKey": "string (date)",
          "creditSum": "number (double)",
          "debitSum": "number (double)"
        }
      ]
    }
  ],
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Currencies

Получение списка валют

GET /api/v1/currencies
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "items": [
      {
        "shortTitle": "string",
        "value": "number (double)",
        "currencyCode": "string",
        "title": "string"
      }
    ],
    "total": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

ImportLogs

Получение списка логов импорта

GET /api/v1/importlogs
paging.offset
in query
integer (int32)

Смещение от начала списка. По умолчанию 0

paging.limit
in query
integer (int32)

Размер фрейма

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "items": [
      {
        "importLogId": "integer (int32)",
        "startDate": "string (date)",
        "accountTitle": "string"
      }
    ],
    "total": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

OperationCategories

Получение статьи по идентификатору

GET /api/v1/operationcategories/{operationCategoryId}
operationCategoryId
in path
integer (int32)

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

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "operationCategoryType": "string",
    "activityType": "string",
    "parentOperationCategoryId": "integer (int32)",
    "sort": "integer (int32)",
    "isVisible": "boolean",
    "isFixed": "boolean",
    "accountCategoryType": "string",
    "coreAccountId": "00000000-0000-0000-0000-000000000000",
    "operationCategoryId": "integer (int32)",
    "title": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Изменение существующей статьи

PUT /api/v1/operationcategories/{operationCategoryId}

Запрос на изменение

operationCategoryId
in path
integer (int32)

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

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "title": "string",
  "operationCategoryType": "string",
  "activityType": "string",
  "parentOperationCategoryId": "integer (int32)",
  "sort": "integer (int32)"
}
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "operationCategoryType": "string",
    "activityType": "string",
    "parentOperationCategoryId": "integer (int32)",
    "sort": "integer (int32)",
    "isVisible": "boolean",
    "isFixed": "boolean",
    "accountCategoryType": "string",
    "coreAccountId": "00000000-0000-0000-0000-000000000000",
    "operationCategoryId": "integer (int32)",
    "title": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Удаление статьи

DELETE /api/v1/operationcategories/{operationCategoryId}
operationCategoryId
in path
integer (int32)

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

200 OK

OK

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Получение списка статей

GET /api/v1/operationcategories
filter.operationCategoryId
in query
integer[]

Набор искомых идентификаторов

Array values passed as multiple parameters: ?filter.operationCategoryId=aaa&filter.operationCategoryId=bbb
filter.title
in query
string (up to 256 chars)

Название

filter.operationCategoryType
in query
string Outcome, Income, Assets, Liabilities, Capital

Тип

filter.activityType
in query
string Operating, Finance, Investment

Вид деятельности

filter.parentOperationCategoryId
in query
integer (int32)

Родительская статья доходов

paging.offset
in query
integer (int32)

Смещение от начала списка. По умолчанию 0

paging.limit
in query
integer (int32)

Размер фрейма

sorting.field
in query
string Title, OperationCategoryType, ActivityType

Поле сортировки

sorting.direction
in query
string Asc, Desc

Направление сортировки (По умолчанию Asc)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "items": [
      {
        "operationCategoryType": "string",
        "activityType": "string",
        "parentOperationCategoryId": "integer (int32)",
        "sort": "integer (int32)",
        "isVisible": "boolean",
        "isFixed": "boolean",
        "accountCategoryType": "string",
        "coreAccountId": "00000000-0000-0000-0000-000000000000",
        "operationCategoryId": "integer (int32)",
        "title": "string"
      }
    ],
    "total": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Создание новой статьи

POST /api/v1/operationcategories

Запрос на создание

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "title": "string",
  "operationCategoryType": "string",
  "activityType": "string",
  "parentOperationCategoryId": "integer (int32)",
  "sort": "integer (int32)"
}
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "operationCategoryType": "string",
    "activityType": "string",
    "parentOperationCategoryId": "integer (int32)",
    "sort": "integer (int32)",
    "isVisible": "boolean",
    "isFixed": "boolean",
    "accountCategoryType": "string",
    "coreAccountId": "00000000-0000-0000-0000-000000000000",
    "operationCategoryId": "integer (int32)",
    "title": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Operations

Получение операции по идентификатору

GET /api/v1/operations/{operationId}
operationId
in path
integer (int32)

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

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "operationId": "integer (int32)",
    "operationType": "string",
    "operationDate": "string (date)",
    "calculationPeriodDate": "string (date)",
    "contrAgent": {
      "contrAgentId": "integer (int32)",
      "title": "string",
      "externalId": "string"
    },
    "account": {
      "accountId": "integer (int32)",
      "title": "string"
    },
    "accountCompany": {
      "companyId": "integer (int32)",
      "title": "string",
      "externalId": "string"
    },
    "accountCurrency": {
      "currencyCode": "string",
      "title": "string"
    },
    "operationCategory": {
      "operationCategoryId": "integer (int32)",
      "title": "string"
    },
    "operationCategoryActivityType": "string",
    "comment": "string",
    "value": "number (double)",
    "valueByProjects": [
      {
        "value": "number (double)",
        "project": {
          "projectId": "integer (int32)",
          "title": "string"
        }
      }
    ],
    "isCommitted": "boolean",
    "lastModificationDate": "string (date)",
    "externalId": "string",
    "importLogId": "integer (int32)",
    "boundMoveOperationId": "integer (int32)",
    "correctRemainder": "number (double)",
    "coreEntryIds": [
      "00000000-0000-0000-0000-000000000000"
    ]
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Удаление операции

DELETE /api/v1/operations/{operationId}
operationId
in path
integer (int32)

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

200 OK

OK

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Получение списка операций

GET /api/v1/operations
filter.operationDateStart
in query
string (date)

Дата операции. Начало.

filter.operationDateEnd
in query
string (date)

Дата операции. Конец.

filter.calculationPeriodDateStart
in query
string (date)

Период начисления. Начало.

filter.calculationPeriodDateEnd
in query
string (date)

Период начисления. Конец.

filter.contrAgentId
in query
integer[]

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

Array values passed as multiple parameters: ?filter.contrAgentId=aaa&filter.contrAgentId=bbb
filter.accountId
in query
integer[]

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

Array values passed as multiple parameters: ?filter.accountId=aaa&filter.accountId=bbb
filter.accountCompanyId
in query
integer[]

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

Array values passed as multiple parameters: ?filter.accountCompanyId=aaa&filter.accountCompanyId=bbb
filter.operationType
in query
string[]

Типы операций

Array values passed as multiple parameters: ?filter.operationType=aaa&filter.operationType=bbb
filter.operationCategoryActivityType
in query
string[]

Виды деятельности

Array values passed as multiple parameters: ?filter.operationCategoryActivityType=aaa&filter.operationCategoryActivityType=bbb
filter.operationCategoryId
in query
integer[]

Идентификаторы стетей

Array values passed as multiple parameters: ?filter.operationCategoryId=aaa&filter.operationCategoryId=bbb
filter.valueMin
in query
number (double)

Общая сумма. Минимум

filter.valueMax
in query
number (double)

Общая сумма. Максимум

filter.projectId
in query
integer[]

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

Array values passed as multiple parameters: ?filter.projectId=aaa&filter.projectId=bbb
filter.isCommitted
in query
boolean

Признак того, что операция проведена

filter.lastModificationDateStart
in query
string (date)

Дата последней модификации. Начало.

filter.lastModificationDateEnd
in query
string (date)

Дата последней модификации. Конец.

filter.externalId
in query
string[]

Внешние идентификаторы

Array values passed as multiple parameters: ?filter.externalId=aaa&filter.externalId=bbb
filter.importLogId
in query
integer[]

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

Array values passed as multiple parameters: ?filter.importLogId=aaa&filter.importLogId=bbb
filter.boundMoveOperationId
in query
integer[]

Идентификаторы связанных операции

Array values passed as multiple parameters: ?filter.boundMoveOperationId=aaa&filter.boundMoveOperationId=bbb
filter.searchString
in query
string

Строка для расширенного поиска по. Атрибуты, участвующие в поиске:

  • Комментарий
  • Название контрагента
  • Название счета
  • Название юрлица
  • Название статьи
paging.offset
in query
integer (int32)

Смещение от начала списка. По умолчанию 0

paging.limit
in query
integer (int32)

Размер фрейма

sorting.field
in query
string OperationDate, CalculationPeriodDate, ContrAgent, Account, AccountCompany, OperationCategory, OperationCategoryActivityType, LastModificationDate

Поле сортировки

sorting.direction
in query
string Asc, Desc

Направление сортировки (По умолчанию Asc)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "items": [
      {
        "operationId": "integer (int32)",
        "operationType": "string",
        "operationDate": "string (date)",
        "calculationPeriodDate": "string (date)",
        "contrAgent": {
          "contrAgentId": "integer (int32)",
          "title": "string",
          "externalId": "string"
        },
        "account": {
          "accountId": "integer (int32)",
          "title": "string"
        },
        "accountCompany": {
          "companyId": "integer (int32)",
          "title": "string",
          "externalId": "string"
        },
        "accountCurrency": {
          "currencyCode": "string",
          "title": "string"
        },
        "operationCategory": {
          "operationCategoryId": "integer (int32)",
          "title": "string"
        },
        "operationCategoryActivityType": "string",
        "comment": "string",
        "value": "number (double)",
        "valueByProjects": [
          {
            "value": "number (double)",
            "project": {
              "projectId": "integer (int32)",
              "title": "string"
            }
          }
        ],
        "isCommitted": "boolean",
        "lastModificationDate": "string (date)",
        "externalId": "string",
        "importLogId": "integer (int32)",
        "boundMoveOperationId": "integer (int32)",
        "correctRemainder": "number (double)",
        "coreEntryIds": [
          "00000000-0000-0000-0000-000000000000"
        ]
      }
    ],
    "total": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Создание новой операции поступления

POST /api/v1/operations/income

Запрос на создание

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "operationDate": "string (date)",
  "calculationPeriodDate": "string (date)",
  "contrAgentId": "integer (int32)",
  "accountId": "integer (int32)",
  "operationCategoryId": "integer (int32)",
  "comment": "string",
  "value": "number (double)",
  "valueByProjects": "object",
  "isCommitted": "boolean",
  "importLogId": "integer (int32)"
}
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "operationId": "integer (int32)",
    "operationType": "string",
    "operationDate": "string (date)",
    "calculationPeriodDate": "string (date)",
    "contrAgent": {
      "contrAgentId": "integer (int32)",
      "title": "string",
      "externalId": "string"
    },
    "account": {
      "accountId": "integer (int32)",
      "title": "string"
    },
    "accountCompany": {
      "companyId": "integer (int32)",
      "title": "string",
      "externalId": "string"
    },
    "accountCurrency": {
      "currencyCode": "string",
      "title": "string"
    },
    "operationCategory": {
      "operationCategoryId": "integer (int32)",
      "title": "string"
    },
    "operationCategoryActivityType": "string",
    "comment": "string",
    "value": "number (double)",
    "valueByProjects": [
      {
        "value": "number (double)",
        "project": {
          "projectId": "integer (int32)",
          "title": "string"
        }
      }
    ],
    "isCommitted": "boolean",
    "lastModificationDate": "string (date)",
    "externalId": "string",
    "importLogId": "integer (int32)",
    "boundMoveOperationId": "integer (int32)",
    "correctRemainder": "number (double)",
    "coreEntryIds": [
      "00000000-0000-0000-0000-000000000000"
    ]
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Создание новой операции списания

POST /api/v1/operations/outcome

Запрос на создание

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "operationDate": "string (date)",
  "calculationPeriodDate": "string (date)",
  "contrAgentId": "integer (int32)",
  "accountId": "integer (int32)",
  "operationCategoryId": "integer (int32)",
  "comment": "string",
  "value": "number (double)",
  "valueByProjects": "object",
  "isCommitted": "boolean",
  "importLogId": "integer (int32)"
}
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "operationId": "integer (int32)",
    "operationType": "string",
    "operationDate": "string (date)",
    "calculationPeriodDate": "string (date)",
    "contrAgent": {
      "contrAgentId": "integer (int32)",
      "title": "string",
      "externalId": "string"
    },
    "account": {
      "accountId": "integer (int32)",
      "title": "string"
    },
    "accountCompany": {
      "companyId": "integer (int32)",
      "title": "string",
      "externalId": "string"
    },
    "accountCurrency": {
      "currencyCode": "string",
      "title": "string"
    },
    "operationCategory": {
      "operationCategoryId": "integer (int32)",
      "title": "string"
    },
    "operationCategoryActivityType": "string",
    "comment": "string",
    "value": "number (double)",
    "valueByProjects": [
      {
        "value": "number (double)",
        "project": {
          "projectId": "integer (int32)",
          "title": "string"
        }
      }
    ],
    "isCommitted": "boolean",
    "lastModificationDate": "string (date)",
    "externalId": "string",
    "importLogId": "integer (int32)",
    "boundMoveOperationId": "integer (int32)",
    "correctRemainder": "number (double)",
    "coreEntryIds": [
      "00000000-0000-0000-0000-000000000000"
    ]
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Создание новой операции перемещения

POST /api/v1/operations/move

Запрос на создание

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "debitingDate": "string (date)",
  "admissionDate": "string (date)",
  "debitingAccountId": "integer (int32)",
  "admissionAccountId": "integer (int32)",
  "debitingValue": "number (double)",
  "admissionValue": "number (double)",
  "comment": "string",
  "valueByProjects": "object",
  "isCommitted": "boolean",
  "importLogId": "integer (int32)"
}
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": [
    {
      "operationId": "integer (int32)",
      "operationType": "string",
      "operationDate": "string (date)",
      "calculationPeriodDate": "string (date)",
      "contrAgent": {
        "contrAgentId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      },
      "account": {
        "accountId": "integer (int32)",
        "title": "string"
      },
      "accountCompany": {
        "companyId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      },
      "accountCurrency": {
        "currencyCode": "string",
        "title": "string"
      },
      "operationCategory": {
        "operationCategoryId": "integer (int32)",
        "title": "string"
      },
      "operationCategoryActivityType": "string",
      "comment": "string",
      "value": "number (double)",
      "valueByProjects": [
        {
          "value": "number (double)",
          "project": {
            "projectId": "integer (int32)",
            "title": "string"
          }
        }
      ],
      "isCommitted": "boolean",
      "lastModificationDate": "string (date)",
      "externalId": "string",
      "importLogId": "integer (int32)",
      "boundMoveOperationId": "integer (int32)",
      "correctRemainder": "number (double)",
      "coreEntryIds": [
        "00000000-0000-0000-0000-000000000000"
      ]
    }
  ],
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Изменение существующей операции поступления

PUT /api/v1/operations/income/{operationId}

Запрос на изменение

operationId
in path
integer (int32)

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

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "operationDate": "string (date)",
  "calculationPeriodDate": "string (date)",
  "contrAgentId": "integer (int32)",
  "accountId": "integer (int32)",
  "operationCategoryId": "integer (int32)",
  "comment": "string",
  "value": "number (double)",
  "valueByProjects": "object",
  "isCommitted": "boolean",
  "importLogId": "integer (int32)"
}
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "operationId": "integer (int32)",
    "operationType": "string",
    "operationDate": "string (date)",
    "calculationPeriodDate": "string (date)",
    "contrAgent": {
      "contrAgentId": "integer (int32)",
      "title": "string",
      "externalId": "string"
    },
    "account": {
      "accountId": "integer (int32)",
      "title": "string"
    },
    "accountCompany": {
      "companyId": "integer (int32)",
      "title": "string",
      "externalId": "string"
    },
    "accountCurrency": {
      "currencyCode": "string",
      "title": "string"
    },
    "operationCategory": {
      "operationCategoryId": "integer (int32)",
      "title": "string"
    },
    "operationCategoryActivityType": "string",
    "comment": "string",
    "value": "number (double)",
    "valueByProjects": [
      {
        "value": "number (double)",
        "project": {
          "projectId": "integer (int32)",
          "title": "string"
        }
      }
    ],
    "isCommitted": "boolean",
    "lastModificationDate": "string (date)",
    "externalId": "string",
    "importLogId": "integer (int32)",
    "boundMoveOperationId": "integer (int32)",
    "correctRemainder": "number (double)",
    "coreEntryIds": [
      "00000000-0000-0000-0000-000000000000"
    ]
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Изменение существующей операции списания

PUT /api/v1/operations/outcome/{operationId}

Запрос на изменение

operationId
in path
integer (int32)

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

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "operationDate": "string (date)",
  "calculationPeriodDate": "string (date)",
  "contrAgentId": "integer (int32)",
  "accountId": "integer (int32)",
  "operationCategoryId": "integer (int32)",
  "comment": "string",
  "value": "number (double)",
  "valueByProjects": "object",
  "isCommitted": "boolean",
  "importLogId": "integer (int32)"
}
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "operationId": "integer (int32)",
    "operationType": "string",
    "operationDate": "string (date)",
    "calculationPeriodDate": "string (date)",
    "contrAgent": {
      "contrAgentId": "integer (int32)",
      "title": "string",
      "externalId": "string"
    },
    "account": {
      "accountId": "integer (int32)",
      "title": "string"
    },
    "accountCompany": {
      "companyId": "integer (int32)",
      "title": "string",
      "externalId": "string"
    },
    "accountCurrency": {
      "currencyCode": "string",
      "title": "string"
    },
    "operationCategory": {
      "operationCategoryId": "integer (int32)",
      "title": "string"
    },
    "operationCategoryActivityType": "string",
    "comment": "string",
    "value": "number (double)",
    "valueByProjects": [
      {
        "value": "number (double)",
        "project": {
          "projectId": "integer (int32)",
          "title": "string"
        }
      }
    ],
    "isCommitted": "boolean",
    "lastModificationDate": "string (date)",
    "externalId": "string",
    "importLogId": "integer (int32)",
    "boundMoveOperationId": "integer (int32)",
    "correctRemainder": "number (double)",
    "coreEntryIds": [
      "00000000-0000-0000-0000-000000000000"
    ]
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Изменение существующей операции перемещения

PUT /api/v1/operations/move/{operationId}

Запрос на изменение

operationId
in path
integer (int32)

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

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "debitingDate": "string (date)",
  "admissionDate": "string (date)",
  "debitingAccountId": "integer (int32)",
  "admissionAccountId": "integer (int32)",
  "debitingValue": "number (double)",
  "admissionValue": "number (double)",
  "comment": "string",
  "valueByProjects": "object",
  "isCommitted": "boolean",
  "importLogId": "integer (int32)"
}
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "operationId": "integer (int32)",
    "operationType": "string",
    "operationDate": "string (date)",
    "calculationPeriodDate": "string (date)",
    "contrAgent": {
      "contrAgentId": "integer (int32)",
      "title": "string",
      "externalId": "string"
    },
    "account": {
      "accountId": "integer (int32)",
      "title": "string"
    },
    "accountCompany": {
      "companyId": "integer (int32)",
      "title": "string",
      "externalId": "string"
    },
    "accountCurrency": {
      "currencyCode": "string",
      "title": "string"
    },
    "operationCategory": {
      "operationCategoryId": "integer (int32)",
      "title": "string"
    },
    "operationCategoryActivityType": "string",
    "comment": "string",
    "value": "number (double)",
    "valueByProjects": [
      {
        "value": "number (double)",
        "project": {
          "projectId": "integer (int32)",
          "title": "string"
        }
      }
    ],
    "isCommitted": "boolean",
    "lastModificationDate": "string (date)",
    "externalId": "string",
    "importLogId": "integer (int32)",
    "boundMoveOperationId": "integer (int32)",
    "correctRemainder": "number (double)",
    "coreEntryIds": [
      "00000000-0000-0000-0000-000000000000"
    ]
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Объединение операций в перемещение

PUT /api/v1/operations/consolidate

Запрос на объединение операций в перемещение

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "incomeOperationId": "integer (int32)",
  "outcomeOperationId": "integer (int32)"
}
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "operations": [
      {
        "operationId": "integer (int32)",
        "operationType": "string",
        "operationDate": "string (date)",
        "calculationPeriodDate": "string (date)",
        "contrAgent": {
          "contrAgentId": "integer (int32)",
          "title": "string",
          "externalId": "string"
        },
        "account": {
          "accountId": "integer (int32)",
          "title": "string"
        },
        "accountCompany": {
          "companyId": "integer (int32)",
          "title": "string",
          "externalId": "string"
        },
        "accountCurrency": {
          "currencyCode": "string",
          "title": "string"
        },
        "operationCategory": {
          "operationCategoryId": "integer (int32)",
          "title": "string"
        },
        "operationCategoryActivityType": "string",
        "comment": "string",
        "value": "number (double)",
        "valueByProjects": [
          {
            "value": "number (double)",
            "project": {
              "projectId": "integer (int32)",
              "title": "string"
            }
          }
        ],
        "isCommitted": "boolean",
        "lastModificationDate": "string (date)",
        "externalId": "string",
        "importLogId": "integer (int32)",
        "boundMoveOperationId": "integer (int32)",
        "correctRemainder": "number (double)",
        "coreEntryIds": [
          "00000000-0000-0000-0000-000000000000"
        ]
      }
    ]
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Разъединение операций

PUT /api/v1/operations/split/{operationId}
operationId
in path
integer (int32)

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

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "operations": [
      {
        "operationId": "integer (int32)",
        "operationType": "string",
        "operationDate": "string (date)",
        "calculationPeriodDate": "string (date)",
        "contrAgent": {
          "contrAgentId": "integer (int32)",
          "title": "string",
          "externalId": "string"
        },
        "account": {
          "accountId": "integer (int32)",
          "title": "string"
        },
        "accountCompany": {
          "companyId": "integer (int32)",
          "title": "string",
          "externalId": "string"
        },
        "accountCurrency": {
          "currencyCode": "string",
          "title": "string"
        },
        "operationCategory": {
          "operationCategoryId": "integer (int32)",
          "title": "string"
        },
        "operationCategoryActivityType": "string",
        "comment": "string",
        "value": "number (double)",
        "valueByProjects": [
          {
            "value": "number (double)",
            "project": {
              "projectId": "integer (int32)",
              "title": "string"
            }
          }
        ],
        "isCommitted": "boolean",
        "lastModificationDate": "string (date)",
        "externalId": "string",
        "importLogId": "integer (int32)",
        "boundMoveOperationId": "integer (int32)",
        "correctRemainder": "number (double)",
        "coreEntryIds": [
          "00000000-0000-0000-0000-000000000000"
        ]
      }
    ]
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Projects

Получение проекта по идентификатору

GET /api/v1/projects/{projectId}
projectId
in path
integer (int32)

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

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "description": "string",
    "active": "boolean",
    "firstOperationDate": "string (date)",
    "lastOperationDate": "string (date)",
    "sumOfIncome": "number (double)",
    "sumOfOutcome": "number (double)",
    "balance": "number (double)",
    "percentOfDifference": "number (double)",
    "profitability": "number (double)",
    "currencyCode": "string",
    "projectId": "integer (int32)",
    "title": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Изменение существующего проекта

PUT /api/v1/projects/{projectId}

Запрос на изменение проекта

projectId
in path
integer (int32)

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

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "title": "string",
  "description": "string",
  "active": "boolean"
}
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "description": "string",
    "active": "boolean",
    "firstOperationDate": "string (date)",
    "lastOperationDate": "string (date)",
    "sumOfIncome": "number (double)",
    "sumOfOutcome": "number (double)",
    "balance": "number (double)",
    "percentOfDifference": "number (double)",
    "profitability": "number (double)",
    "currencyCode": "string",
    "projectId": "integer (int32)",
    "title": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Удаление проекта

DELETE /api/v1/projects/{projectId}
projectId
in path
integer (int32)

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

200 OK

OK

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Получение проекта со сводкой по идентификатору

GET /api/v1/projects/{projectId}/summary
projectId
in path
integer (int32)

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

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "description": "string",
    "active": "boolean",
    "firstOperationDate": "string (date)",
    "lastOperationDate": "string (date)",
    "sumOfIncome": "number (double)",
    "sumOfOutcome": "number (double)",
    "balance": "number (double)",
    "percentOfDifference": "number (double)",
    "profitability": "number (double)",
    "currencyCode": "string",
    "projectId": "integer (int32)",
    "title": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Получение списка проектов

GET /api/v1/projects
filter.title
in query
string (3 to 256 chars)

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

filter.startDateTime
in query
string (date)

Начальная дата поиска

filter.endDateTime
in query
string (date)

Конечная дата поиска

filter.active
in query
boolean

Статус

paging.offset
in query
integer (int32)

Смещение от начала списка. По умолчанию 0

paging.limit
in query
integer (int32)

Размер фрейма

sorting.field
in query
string Title, Active, FirstOperationDate, LastOperationDate

Поле сортировки

sorting.direction
in query
string Asc, Desc

Направление сортировки (По умолчанию Asc)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "items": [
      {
        "description": "string",
        "active": "boolean",
        "firstOperationDate": "string (date)",
        "lastOperationDate": "string (date)",
        "sumOfIncome": "number (double)",
        "sumOfOutcome": "number (double)",
        "balance": "number (double)",
        "percentOfDifference": "number (double)",
        "profitability": "number (double)",
        "currencyCode": "string",
        "projectId": "integer (int32)",
        "title": "string"
      }
    ],
    "total": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

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

POST /api/v1/projects

Запрос на создание проекта

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "title": "string",
  "description": "string"
}
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "description": "string",
    "active": "boolean",
    "firstOperationDate": "string (date)",
    "lastOperationDate": "string (date)",
    "sumOfIncome": "number (double)",
    "sumOfOutcome": "number (double)",
    "balance": "number (double)",
    "percentOfDifference": "number (double)",
    "profitability": "number (double)",
    "currencyCode": "string",
    "projectId": "integer (int32)",
    "title": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Получение списка проектов со сводкой

GET /api/v1/projects/summary
filter.title
in query
string (3 to 256 chars)

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

filter.startDateTime
in query
string (date)

Начальная дата поиска

filter.endDateTime
in query
string (date)

Конечная дата поиска

filter.active
in query
boolean

Статус

paging.offset
in query
integer (int32)

Смещение от начала списка. По умолчанию 0

paging.limit
in query
integer (int32)

Размер фрейма

sorting.field
in query
string Title, Active, FirstOperationDate, LastOperationDate

Поле сортировки

sorting.direction
in query
string Asc, Desc

Направление сортировки (По умолчанию Asc)

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "items": [
      {
        "description": "string",
        "active": "boolean",
        "firstOperationDate": "string (date)",
        "lastOperationDate": "string (date)",
        "sumOfIncome": "number (double)",
        "sumOfOutcome": "number (double)",
        "balance": "number (double)",
        "percentOfDifference": "number (double)",
        "profitability": "number (double)",
        "currencyCode": "string",
        "projectId": "integer (int32)",
        "title": "string"
      }
    ],
    "total": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Settings

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

GET /api/v1/settings
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "groupCompanyTitle": "string",
    "currency": {
      "currencyCode": "string",
      "title": "string"
    },
    "accountMethod": "string",
    "showKopeck": "boolean",
    "showPastCashGap": "boolean"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Изменение настроек учета текущего пользователя

PUT /api/v1/settings
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "currencyCode": "string",
  "accountMethod": "string",
  "showKopeck": "boolean",
  "showPastCashGap": "boolean"
}
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "groupCompanyTitle": "string",
    "currency": {
      "currencyCode": "string",
      "title": "string"
    },
    "accountMethod": "string",
    "showKopeck": "boolean",
    "showPastCashGap": "boolean"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Schema Definitions

UserLinkModel: object

Модель связи с пользователем

id: string

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

email: string

Email

emailConfirmed: boolean

Признак подтверждённости email-а

lastLoginDate: string (date)

Дата последнего захода

creationDate: string (date)

Дата создания

Example
{
  "id": "string",
  "email": "string",
  "emailConfirmed": "boolean",
  "lastLoginDate": "string (date)",
  "creationDate": "string (date)"
}

Response: object

Ответ

isSuccess: boolean

Признак успешности запроса

errorMessage: string

Сообщение о причине ошибки

Example
{
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Response[AccountModel]: object

Ответ

data: AccountModel

Данные

isSuccess: boolean

Признак успешности запроса

errorMessage: string

Сообщение о причине ошибки

Example
{
  "data": {
    "companyId": "integer (int32)",
    "accountType": "string",
    "accountTypeTitle": "string",
    "currencyCode": "string",
    "longTitle": "string",
    "description": "string",
    "accountAcct": "string",
    "accountBik": "string",
    "accountBank": "string",
    "currencyTitle": "string",
    "active": "boolean",
    "remainder": "number (double)",
    "coreAccountId": "00000000-0000-0000-0000-000000000000",
    "accountId": "integer (int32)",
    "title": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

AccountModel: object

Модель представления счета

companyId: integer (int32)

Id юрлица

accountType: string Cash, Card

Тип счёта

accountTypeTitle: string

Название типа счета

currencyCode: string USD, EUR, GBP, RUB, BYN, UAH, KZT, CNY, TRY, KGS, AMD, AED, INR, JPY, MDL, UZS, PLN, SGD, BTC, ETH, BCH, XRP, LTC, DASH, XMR, ETC, ZEC, STRAT, DCR, DOGE, SC, CAD

Код валюты

longTitle: string

Полное название

description: string

Описание

accountAcct: string

Номер

accountBik: string

БИК

accountBank: string

Банк

currencyTitle: string

Название валюты

active: boolean

Активность счета

remainder: number (double)

Текущий остаток на счету

coreAccountId: string (uuid)
accountId: integer (int32)

Id Счета

title: string

Название

Example
{
  "companyId": "integer (int32)",
  "accountType": "string",
  "accountTypeTitle": "string",
  "currencyCode": "string",
  "longTitle": "string",
  "description": "string",
  "accountAcct": "string",
  "accountBik": "string",
  "accountBank": "string",
  "currencyTitle": "string",
  "active": "boolean",
  "remainder": "number (double)",
  "coreAccountId": "00000000-0000-0000-0000-000000000000",
  "accountId": "integer (int32)",
  "title": "string"
}

AccountModificationRequest: object

Модель запроса изменения счета

title: string (up to 256 chars)

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

longTitle: string (up to 256 chars)

"Полное название"

description: string (up to 256 chars)

Комментарий

companyId: integer (int32)

Id юрлица

accountType: string Cash, Card

Тип счёта

accountAcct: string

Номер

accountBik: string

БИК

accountBank: string

Банк

currencyCode: string USD, EUR, GBP, RUB, BYN, UAH, KZT, CNY, TRY, KGS, AMD, AED, INR, JPY, MDL, UZS, PLN, SGD, BTC, ETH, BCH, XRP, LTC, DASH, XMR, ETC, ZEC, STRAT, DCR, DOGE, SC, CAD

Код валюты

active: boolean

Активность счета

remainder: number (double)

Остаток на счету

remainderDate: string (date)

Дата остатка на счету

Example
{
  "title": "string",
  "longTitle": "string",
  "description": "string",
  "companyId": "integer (int32)",
  "accountType": "string",
  "accountAcct": "string",
  "accountBik": "string",
  "accountBank": "string",
  "currencyCode": "string",
  "active": "boolean",
  "remainder": "number (double)",
  "remainderDate": "string (date)"
}

AccountListRequest: object

Запрос списка счетов

agentId: integer (int32)

Id юрлица

accountType: string Cash, Card

Тип счёта

title: string

Название счета

longTitle: string

Полное название счета

description: string

Описание

accountAcct: string

Номер счета

accountBik: string

БИК счета

accountBank: string

Банк счета

currencyCode: string USD, EUR, GBP, RUB, BYN, UAH, KZT, CNY, TRY, KGS, AMD, AED, INR, JPY, MDL, UZS, PLN, SGD, BTC, ETH, BCH, XRP, LTC, DASH, XMR, ETC, ZEC, STRAT, DCR, DOGE, SC, CAD

Код валюты

active: boolean

Отображение активных счетов

Example
{
  "agentId": "integer (int32)",
  "accountType": "string",
  "title": "string",
  "longTitle": "string",
  "description": "string",
  "accountAcct": "string",
  "accountBik": "string",
  "accountBank": "string",
  "currencyCode": "string",
  "active": "boolean"
}

Paging: object

Пейджинг

offset: integer (int32)

Смещение от начала списка. По умолчанию 0

limit: integer (int32)

Размер фрейма

Example
{
  "offset": "integer (int32)",
  "limit": "integer (int32)"
}

Sorting[AccountsSortingFields]: object

Сортировка

field: string CompanyTitle, AccountTypeTitle, Title, LongTitle, Description, AccountAcct, AccountBik, AccountBank, CurrencyTitle, Active

Поле сортировки

direction: string Asc, Desc

Направление сортировки (По умолчанию Asc)

Example
{
  "field": "string",
  "direction": "string"
}

Response[ListModel[AccountModel]]: object

Ответ

data: ListModel[AccountModel]

Данные

isSuccess: boolean

Признак успешности запроса

errorMessage: string

Сообщение о причине ошибки

Example
{
  "data": {
    "items": [
      {
        "companyId": "integer (int32)",
        "accountType": "string",
        "accountTypeTitle": "string",
        "currencyCode": "string",
        "longTitle": "string",
        "description": "string",
        "accountAcct": "string",
        "accountBik": "string",
        "accountBank": "string",
        "currencyTitle": "string",
        "active": "boolean",
        "remainder": "number (double)",
        "coreAccountId": "00000000-0000-0000-0000-000000000000",
        "accountId": "integer (int32)",
        "title": "string"
      }
    ],
    "total": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

ListModel[AccountModel]: object

Список элементов и общее кол-во

items: AccountModel

Элементы

total: integer (int32)

Всего элементов в наборе

Example
{
  "items": [
    {
      "companyId": "integer (int32)",
      "accountType": "string",
      "accountTypeTitle": "string",
      "currencyCode": "string",
      "longTitle": "string",
      "description": "string",
      "accountAcct": "string",
      "accountBik": "string",
      "accountBank": "string",
      "currencyTitle": "string",
      "active": "boolean",
      "remainder": "number (double)",
      "coreAccountId": "00000000-0000-0000-0000-000000000000",
      "accountId": "integer (int32)",
      "title": "string"
    }
  ],
  "total": "integer (int32)"
}

AccountCreationRequest: object

Модель запроса создания счета

title: string (up to 256 chars)

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

longTitle: string (up to 256 chars)

"Полное название"

description: string (up to 256 chars)

Комментарий

companyId: integer (int32)

Id юрлица

accountType: string Cash, Card

Тип счёта

accountAcct: string

Номер

accountBik: string

БИК

accountBank: string

Банк

currencyCode: string USD, EUR, GBP, RUB, BYN, UAH, KZT, CNY, TRY, KGS, AMD, AED, INR, JPY, MDL, UZS, PLN, SGD, BTC, ETH, BCH, XRP, LTC, DASH, XMR, ETC, ZEC, STRAT, DCR, DOGE, SC, CAD

Код валюты

active: boolean

Активность счета

remainder: number (double)

Остаток на счету

remainderDate: string (date)

Дата остатка на счету

Example
{
  "title": "string",
  "longTitle": "string",
  "description": "string",
  "companyId": "integer (int32)",
  "accountType": "string",
  "accountAcct": "string",
  "accountBik": "string",
  "accountBank": "string",
  "currencyCode": "string",
  "active": "boolean",
  "remainder": "number (double)",
  "remainderDate": "string (date)"
}

AccountRemaindersRequest: object

Запрос остатков за период по счёту

startDate: string (date)

Начальная дата

endDate: string (date)

Конечная дата

Example
{
  "startDate": "string (date)",
  "endDate": "string (date)"
}

Response[IEnumerable[DateWithValueModel[Double]]]: object

Ответ

data: DateWithValueModel[Double]

Данные

isSuccess: boolean

Признак успешности запроса

errorMessage: string

Сообщение о причине ошибки

Example
{
  "data": [
    {
      "date": "string (date)",
      "value": "number (double)"
    }
  ],
  "isSuccess": "boolean",
  "errorMessage": "string"
}

DateWithValueModel[Double]: object

Модель пар дата-значение

date: string (date)

Дата

value: number (double)

Значение

Example
{
  "date": "string (date)",
  "value": "number (double)"
}

MainIndicatorsRequest: object

Запрос главных показателей

periodStartDate: string (date)

Дата начала периода

periodEndDate: string (date)

Дата окончания периода

companyId: integer[]

Набор идентификаторов юрлиц

projectId: integer[]

Набор идентификаторов проектов

Example
{
  "periodStartDate": "string (date)",
  "periodEndDate": "string (date)",
  "companyId": [
    "integer (int32)"
  ],
  "projectId": [
    "integer (int32)"
  ]
}

Response[MainIndicatorsModel]: object

Ответ

data: MainIndicatorsModel

Данные

isSuccess: boolean

Признак успешности запроса

errorMessage: string

Сообщение о причине ошибки

Example
{
  "data": {
    "total": {
      "date": "string (date)",
      "incomePlan": "number (double)",
      "incomeFact": "number (double)",
      "outcomePlan": "number (double)",
      "outcomeFact": "number (double)",
      "profitPlan": "number (double)",
      "profitFact": "number (double)",
      "profitabilityPlan": "number (double)",
      "profitabilityFact": "number (double)",
      "dividendsPlan": "number (double)",
      "dividendsFact": "number (double)"
    },
    "items": [
      {
        "date": "string (date)",
        "incomePlan": "number (double)",
        "incomeFact": "number (double)",
        "outcomePlan": "number (double)",
        "outcomeFact": "number (double)",
        "profitPlan": "number (double)",
        "profitFact": "number (double)",
        "profitabilityPlan": "number (double)",
        "profitabilityFact": "number (double)",
        "dividendsPlan": "number (double)",
        "dividendsFact": "number (double)"
      }
    ]
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

MainIndicatorsModel: object

Модель главных показателей

total: MainIndicatorsItemModel

Показатели за весь период

items: MainIndicatorsItemModel

Динамика показателей в течение периода

Example
{
  "total": {
    "date": "string (date)",
    "incomePlan": "number (double)",
    "incomeFact": "number (double)",
    "outcomePlan": "number (double)",
    "outcomeFact": "number (double)",
    "profitPlan": "number (double)",
    "profitFact": "number (double)",
    "profitabilityPlan": "number (double)",
    "profitabilityFact": "number (double)",
    "dividendsPlan": "number (double)",
    "dividendsFact": "number (double)"
  },
  "items": [
    {
      "date": "string (date)",
      "incomePlan": "number (double)",
      "incomeFact": "number (double)",
      "outcomePlan": "number (double)",
      "outcomeFact": "number (double)",
      "profitPlan": "number (double)",
      "profitFact": "number (double)",
      "profitabilityPlan": "number (double)",
      "profitabilityFact": "number (double)",
      "dividendsPlan": "number (double)",
      "dividendsFact": "number (double)"
    }
  ]
}

MainIndicatorsItemModel: object

Главные показателей на определенную дату

date: string (date)

Дата, для которой расчитаны показатели. Для итоговых показателей - null

incomePlan: number (double)

Доходы плановые

incomeFact: number (double)

Доходы фактические

outcomePlan: number (double)

Расходы плановые

outcomeFact: number (double)

Расходы фактические

profitPlan: number (double)

Прибыль плановая

profitFact: number (double)

Прибыль фактическая

profitabilityPlan: number (double)

Рентабельность плановая

profitabilityFact: number (double)

Рентабельность фактическая

dividendsPlan: number (double)

Дивиденды плановые

dividendsFact: number (double)

Дивиденды фактические

Example
{
  "date": "string (date)",
  "incomePlan": "number (double)",
  "incomeFact": "number (double)",
  "outcomePlan": "number (double)",
  "outcomeFact": "number (double)",
  "profitPlan": "number (double)",
  "profitFact": "number (double)",
  "profitabilityPlan": "number (double)",
  "profitabilityFact": "number (double)",
  "dividendsPlan": "number (double)",
  "dividendsFact": "number (double)"
}

RemainderHistoryRequest: object

Запрос истории остатков на счетах

periodStartDate: string (date)

Дата начала периода

periodEndDate: string (date)

Дата окончания периода

Example
{
  "periodStartDate": "string (date)",
  "periodEndDate": "string (date)"
}

Response[IEnumerable[RemaindersHistoryModel]]: object

Ответ

data: RemaindersHistoryModel

Данные

isSuccess: boolean

Признак успешности запроса

errorMessage: string

Сообщение о причине ошибки

Example
{
  "data": [
    {
      "date": "string (date)",
      "total": {
        "accountId": "integer (int32)",
        "value": "number (double)",
        "hasCorrection": "boolean"
      },
      "details": [
        {
          "accountId": "integer (int32)",
          "value": "number (double)",
          "hasCorrection": "boolean"
        }
      ]
    }
  ],
  "isSuccess": "boolean",
  "errorMessage": "string"
}

RemaindersHistoryModel: object

Модель об остатках на счете на конкретную дату

date: string (date)

Дата, на которую предоставлена информация об остатках

total: RemaindersHistoryItemModel

Суммарные остатки по всем счетам

details: RemaindersHistoryItemModel

Сведения об остатках на каждому счету

Example
{
  "date": "string (date)",
  "total": {
    "accountId": "integer (int32)",
    "value": "number (double)",
    "hasCorrection": "boolean"
  },
  "details": [
    {
      "accountId": "integer (int32)",
      "value": "number (double)",
      "hasCorrection": "boolean"
    }
  ]
}

RemaindersHistoryItemModel: object

Описание остатка на счете

accountId: integer (int32)

Идентификатор счета. Для суммарных остатков - null

value: number (double)

Величина остатка на счете

hasCorrection: boolean

Признак наличия корректировок в этот день

Example
{
  "accountId": "integer (int32)",
  "value": "number (double)",
  "hasCorrection": "boolean"
}

ResultsByActivityTypeRequest: object

Запрос результатов по видам деятельности

periodStartDate: string (date)

Дата начала периода

periodEndDate: string (date)

Дата окончания периода

companyId: integer[]

Набор идентификаторов юрлиц

projectId: integer[]

Набор идентификаторов проектов

activityType: string Operating, Finance, Investment, All, WithoutCategory

Вид деятельности

Example
{
  "periodStartDate": "string (date)",
  "periodEndDate": "string (date)",
  "companyId": [
    "integer (int32)"
  ],
  "projectId": [
    "integer (int32)"
  ],
  "activityType": "string"
}

Response[ResultsByActivityTypeModel]: object

Ответ

data: ResultsByActivityTypeModel

Данные

isSuccess: boolean

Признак успешности запроса

errorMessage: string

Сообщение о причине ошибки

Example
{
  "data": {
    "total": {
      "date": "string (date)",
      "incomePlan": "number (double)",
      "incomeFact": "number (double)",
      "outcomePlan": "number (double)",
      "outcomeFact": "number (double)",
      "profitPlan": "number (double)",
      "profitFact": "number (double)"
    },
    "items": [
      {
        "date": "string (date)",
        "incomePlan": "number (double)",
        "incomeFact": "number (double)",
        "outcomePlan": "number (double)",
        "outcomeFact": "number (double)",
        "profitPlan": "number (double)",
        "profitFact": "number (double)"
      }
    ]
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

ResultsByActivityTypeModel: object

Модель результатов по видам деятельности

total: ResultsByActivityTypeItemModel

Результатов за весь период

items: ResultsByActivityTypeItemModel

Динамика результатов в течение периода

Example
{
  "total": {
    "date": "string (date)",
    "incomePlan": "number (double)",
    "incomeFact": "number (double)",
    "outcomePlan": "number (double)",
    "outcomeFact": "number (double)",
    "profitPlan": "number (double)",
    "profitFact": "number (double)"
  },
  "items": [
    {
      "date": "string (date)",
      "incomePlan": "number (double)",
      "incomeFact": "number (double)",
      "outcomePlan": "number (double)",
      "outcomeFact": "number (double)",
      "profitPlan": "number (double)",
      "profitFact": "number (double)"
    }
  ]
}

ResultsByActivityTypeItemModel: object

Результаты по видам деятельности на определенную дату

date: string (date)

Дата, для которой расчитаны показатели. Для итоговых показателей - null

incomePlan: number (double)

Поступления плановые

incomeFact: number (double)

Поступления фактические

outcomePlan: number (double)

Выплаты плановые

outcomeFact: number (double)

Выплаты фактические

profitPlan: number (double)

Разница плановая

profitFact: number (double)

Разница фактическая

Example
{
  "date": "string (date)",
  "incomePlan": "number (double)",
  "incomeFact": "number (double)",
  "outcomePlan": "number (double)",
  "outcomeFact": "number (double)",
  "profitPlan": "number (double)",
  "profitFact": "number (double)"
}

StructureRequest: object

Запрос структуры поступлений (доходов) или списаний (расходов)

periodStartDate: string (date)

Дата начала периода

periodEndDate: string (date)

Дата окончания периода

companyId: integer[]

Набор идентификаторов юрлиц

projectId: integer[]

Набор идентификаторов проектов

activityType: string Operating, Finance, Investment, All, WithoutCategory

Вид деятельности (обязательное поле для кассового метода)

budgetAccountMethod: string Cash, BDDS, BDR

Вид метода рассчета. 1) Если у пользователя не выбран "Метод начисления", то возможен только один вариант: BudgetAccountMethod = (int) BudgetAccountMethodEnum.Cash; //1 2) Если у пользователя выбран "Метод начисления", то возможны варианты: 2.1) Кассовый: BudgetAccountMethod = (int)BudgetAccountMethodEnum.BDDS; //2 2.2) Метод начисления: BudgetAccountMethod = (int) BudgetAccountMethodEnum.BDR; //3

isIncome: boolean

Если истина, то учитываем поступления (доходы) Если ложь, то учитываем списания (расходы)

Example
{
  "periodStartDate": "string (date)",
  "periodEndDate": "string (date)",
  "companyId": [
    "integer (int32)"
  ],
  "projectId": [
    "integer (int32)"
  ],
  "activityType": "string",
  "budgetAccountMethod": "string",
  "isIncome": "boolean"
}

Response[IEnumerable[StructureModel]]: object

Ответ

data: StructureModel

Данные

isSuccess: boolean

Признак успешности запроса

errorMessage: string

Сообщение о причине ошибки

Example
{
  "data": [
    {
      "activityType": "string",
      "operationCategoryId": "integer (int32)",
      "parentOperationCategoryId": "integer (int32)",
      "title": "string",
      "valuePlan": "number (double)",
      "valueFact": "number (double)",
      "details": [
        {
          "date": "string (date)",
          "valuePlan": "number (double)",
          "valueFact": "number (double)"
        }
      ]
    }
  ],
  "isSuccess": "boolean",
  "errorMessage": "string"
}

StructureModel: object

Модель структуры поступлений (доходов) или списаний (расходов)

activityType: string Operating, Finance, Investment, All, WithoutCategory

Вид деятельности

operationCategoryId: integer (int32)

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

parentOperationCategoryId: integer (int32)

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

title: string

Название статьи

valuePlan: number (double)

Плановое значение

valueFact: number (double)

Факстическое значение

details: StructureItemModel

Динамика за указаныый период

Example
{
  "activityType": "string",
  "operationCategoryId": "integer (int32)",
  "parentOperationCategoryId": "integer (int32)",
  "title": "string",
  "valuePlan": "number (double)",
  "valueFact": "number (double)",
  "details": [
    {
      "date": "string (date)",
      "valuePlan": "number (double)",
      "valueFact": "number (double)"
    }
  ]
}

StructureItemModel: object

Подробности за микропериод для структуры поступлений (доходов) или списаний (расходов)

date: string (date)

Дата

valuePlan: number (double)

Плановое значение

valueFact: number (double)

Фактическое значение

Example
{
  "date": "string (date)",
  "valuePlan": "number (double)",
  "valueFact": "number (double)"
}

ProjectsRatingRequest: object

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

periodStartDate: string (date)

Дата начала периода

periodEndDate: string (date)

Дата окончания периода

companyId: integer[]

Набор идентификаторов юрлиц

projectId: integer[]

Набор идентификаторов проектов

activityType: string Operating, Finance, Investment, All, WithoutCategory

Вид деятельности (обязательное поле для кассового метода)

budgetAccountMethod: string Cash, BDDS, BDR

Вид метода рассчета. 1) Если у пользователя не выбран "Метод начисления", то возможен только один вариант: BudgetAccountMethod = (int) BudgetAccountMethodEnum.Cash; (=1) 2) Если у пользователя выбран "Метод начисления", то возможны варианты: 2.1) Кассовый: BudgetAccountMethod = (int)BudgetAccountMethodEnum.BDDS (=2) 2.2) Метод начисления: BudgetAccountMethod = (int) BudgetAccountMethodEnum.BDR; (=3)

Example
{
  "periodStartDate": "string (date)",
  "periodEndDate": "string (date)",
  "companyId": [
    "integer (int32)"
  ],
  "projectId": [
    "integer (int32)"
  ],
  "activityType": "string",
  "budgetAccountMethod": "string"
}

Sorting[ProjectsRatingSortingFields]: object

Сортировка

field: string ProfitPlan, ProfitFact, ProfitabilityPlan, ProfitabilityFact

Поле сортировки

direction: string Asc, Desc

Направление сортировки (По умолчанию Asc)

Example
{
  "field": "string",
  "direction": "string"
}

Response[IEnumerable[ProjectRatingModel]]: object

Ответ

data: ProjectRatingModel

Данные

isSuccess: boolean

Признак успешности запроса

errorMessage: string

Сообщение о причине ошибки

Example
{
  "data": [
    {
      "projectId": "integer (int32)",
      "title": "string",
      "profitPlan": "number (double)",
      "profitFact": "number (double)",
      "profitabilityPlan": "number (double)",
      "profitabilityFact": "number (double)"
    }
  ],
  "isSuccess": "boolean",
  "errorMessage": "string"
}

ProjectRatingModel: object

Данные по проекту

projectId: integer (int32)

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

title: string

Название проекта

profitPlan: number (double)

Плановая прибыльность

profitFact: number (double)

Фактическая прибыльность

profitabilityPlan: number (double)

Плановая рентабельность

profitabilityFact: number (double)

Фактическая рентабельность

Example
{
  "projectId": "integer (int32)",
  "title": "string",
  "profitPlan": "number (double)",
  "profitFact": "number (double)",
  "profitabilityPlan": "number (double)",
  "profitabilityFact": "number (double)"
}

Response[ClientsRatingModel]: object

Ответ

data: ClientsRatingModel

Данные

isSuccess: boolean

Признак успешности запроса

errorMessage: string

Сообщение о причине ошибки

Example
{
  "data": {
    "incomeTotal": "number (double)",
    "clientsInfo": [
      {
        "contrAgentId": "integer (int32)",
        "title": "string",
        "value": "number (double)",
        "percent": "number (double)"
      }
    ]
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

ClientsRatingModel: object

Модель рейтинга клинетов (контрагентов) по доходам

incomeTotal: number (double)

Суммарный приход

clientsInfo: ClientsRatingItemModel

Данные по клиентам

Example
{
  "incomeTotal": "number (double)",
  "clientsInfo": [
    {
      "contrAgentId": "integer (int32)",
      "title": "string",
      "value": "number (double)",
      "percent": "number (double)"
    }
  ]
}

ClientsRatingItemModel: object

Данные по клиенту (контрагенту)

contrAgentId: integer (int32)

Идентификатор контрагента Для операций без контрагента = null

title: string

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

value: number (double)

Сумма перечисленных контрагентом средств

percent: number (double)

Доля (в процентах) в общем приходе

Example
{
  "contrAgentId": "integer (int32)",
  "title": "string",
  "value": "number (double)",
  "percent": "number (double)"
}

Response[LayoutInfoModel]: object

Ответ

data: LayoutInfoModel

Данные

isSuccess: boolean

Признак успешности запроса

errorMessage: string

Сообщение о причине ошибки

Example
{
  "data": {
    "balance": "number (double)",
    "cashGapDate": "string (date)",
    "childCashGapDate": "string (date)",
    "accountOperationInfos": [
      {
        "title": "string",
        "value": "number (double)",
        "comment": "string",
        "accountId": "integer (int32)",
        "cashGapDate": "string (date)",
        "valueInCurrency": "number (double)",
        "currency": "string"
      }
    ],
    "firstName": "string",
    "accessAlert": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

LayoutInfoModel: object

Общая информация

balance: number (double)

Текущий баланс

cashGapDate: string (date)

Дата общего кассового разрыва

childCashGapDate: string (date)

Дата кассового разрыва по отдельному счету

accountOperationInfos: AccountOperationInfo

Информация по счетам

firstName: string

Имя пользователя

accessAlert: string

Информация о сроке оплаты доступа

Example
{
  "balance": "number (double)",
  "cashGapDate": "string (date)",
  "childCashGapDate": "string (date)",
  "accountOperationInfos": [
    {
      "title": "string",
      "value": "number (double)",
      "comment": "string",
      "accountId": "integer (int32)",
      "cashGapDate": "string (date)",
      "valueInCurrency": "number (double)",
      "currency": "string"
    }
  ],
  "firstName": "string",
  "accessAlert": "string"
}

AccountOperationInfo: object

title: string
value: number (double)
comment: string
accountId: integer (int32)
cashGapDate: string (date)
valueInCurrency: number (double)
currency: string
Example
{
  "title": "string",
  "value": "number (double)",
  "comment": "string",
  "accountId": "integer (int32)",
  "cashGapDate": "string (date)",
  "valueInCurrency": "number (double)",
  "currency": "string"
}

Response[IEnumerable[Double]]: object

Ответ

data: number[]

Данные

isSuccess: boolean

Признак успешности запроса

errorMessage: string

Сообщение о причине ошибки

Example
{
  "data": [
    "number (double)"
  ],
  "isSuccess": "boolean",
  "errorMessage": "string"
}

Response[CompanyModel]: object

Ответ

data: CompanyModel

Данные

isSuccess: boolean

Признак успешности запроса

errorMessage: string

Сообщение о причине ошибки

Example
{
  "data": {
    "longTitle": "string",
    "companyInn": "string",
    "companyKpp": "string",
    "description": "string",
    "active": "boolean",
    "companyId": "integer (int32)",
    "title": "string",
    "externalId": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

CompanyModel: object

Модель представления юрлиц

longTitle: string

Полное название

companyInn: string

ИНН

companyKpp: string

КПП

description: string

Комментарий

active: boolean

Статус

companyId: integer (int32)

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

title: string

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

externalId: string

Внешний идентификатор

Example
{
  "longTitle": "string",
  "companyInn": "string",
  "companyKpp": "string",
  "description": "string",
  "active": "boolean",
  "companyId": "integer (int32)",
  "title": "string",
  "externalId": "string"
}

CompanyModificationRequest: object

Модель запроса изменения юрлица

title: string (up to 256 chars)

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

longTitle: string

Полное название

companyInn: string

ИНН

companyKpp: string

КПП

description: string

Комментарий

externalId: string

Внешний идентификатор

active: boolean

Статус

Example
{
  "title": "string",
  "longTitle": "string",
  "companyInn": "string",
  "companyKpp": "string",
  "description": "string",
  "externalId": "string",
  "active": "boolean"
}

CompanyListRequest: object

Запрос списка юрлиц

companyId: integer[]

Набор искомых идентификаторов

title: string (3 to 256 chars)

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

longTitle: string

Полное название

companyInn: string

ИНН

companyKpp: string

КПП

description: string

Комментарий

active: boolean

Статус

externalId: string[]

Набор искомых внешних идентификаторов

Example
{
  "companyId": [
    "integer (int32)"
  ],
  "title": "string",
  "longTitle": "string",
  "companyInn": "string",
  "companyKpp": "string",
  "description": "string",
  "active": "boolean",
  "externalId": [
    "string"
  ]
}

Sorting[CompaniesSortingFields]: object

Сортировка

field: string Title, LongTitle, CompanyInn, CompanyKpp, Active

Поле сортировки

direction: string Asc, Desc

Направление сортировки (По умолчанию Asc)

Example
{
  "field": "string",
  "direction": "string"
}

Response[ListModel[CompanyModel]]: object

Ответ

data: ListModel[CompanyModel]

Данные

isSuccess: boolean

Признак успешности запроса

errorMessage: string

Сообщение о причине ошибки

Example
{
  "data": {
    "items": [
      {
        "longTitle": "string",
        "companyInn": "string",
        "companyKpp": "string",
        "description": "string",
        "active": "boolean",
        "companyId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      }
    ],
    "total": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

ListModel[CompanyModel]: object

Список элементов и общее кол-во

items: CompanyModel

Элементы

total: integer (int32)

Всего элементов в наборе

Example
{
  "items": [
    {
      "longTitle": "string",
      "companyInn": "string",
      "companyKpp": "string",
      "description": "string",
      "active": "boolean",
      "companyId": "integer (int32)",
      "title": "string",
      "externalId": "string"
    }
  ],
  "total": "integer (int32)"
}

CompanyCreationRequest: object

Модель запроса создания юрлица

title: string (up to 256 chars)

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

longTitle: string

Полное название

companyInn: string

ИНН

companyKpp: string

КПП

description: string

Комментарий

externalId: string

Внешний идентификатор

Example
{
  "title": "string",
  "longTitle": "string",
  "companyInn": "string",
  "companyKpp": "string",
  "description": "string",
  "externalId": "string"
}

Response[ContrAgentModel]: object

Ответ

data: ContrAgentModel

Данные

isSuccess: boolean

Признак успешности запроса

errorMessage: string

Сообщение о причине ошибки

Example
{
  "data": {
    "longTitle": "string",
    "contrAgentInn": "string",
    "contrAgentKpp": "string",
    "description": "string",
    "contrAgentType": "string",
    "rememberCategory": "boolean",
    "operationIncomeCategoryId": "integer (int32)",
    "operationOutcomeCategoryId": "integer (int32)",
    "active": "boolean",
    "firstOperationDate": "string (date)",
    "lastOperationDate": "string (date)",
    "balance": "number (double)",
    "currencyCode": "string",
    "contrAgentId": "integer (int32)",
    "title": "string",
    "externalId": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

ContrAgentModel: object

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

longTitle: string

"Полное название"

contrAgentInn: string

ИНН

contrAgentKpp: string

КПП

description: string

Комментарий

contrAgentType: string Income, Outcome, Mixed

Тип

rememberCategory: boolean

Применять статьи по умолчанию

operationIncomeCategoryId: integer (int32)

Идентификатор доходной статьи

operationOutcomeCategoryId: integer (int32)

Идентификатор расходной статьи

active: boolean

Статус

firstOperationDate: string (date)

Дата первой операции

lastOperationDate: string (date)

Дата последней операции

balance: number (double)

Сальдо

currencyCode: string USD, EUR, GBP, RUB, BYN, UAH, KZT, CNY, TRY, KGS, AMD, AED, INR, JPY, MDL, UZS, PLN, SGD, BTC, ETH, BCH, XRP, LTC, DASH, XMR, ETC, ZEC, STRAT, DCR, DOGE, SC, CAD

Код валюты сводки

contrAgentId: integer (int32)

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

title: string

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

externalId: string

Внешний идентификатор

Example
{
  "longTitle": "string",
  "contrAgentInn": "string",
  "contrAgentKpp": "string",
  "description": "string",
  "contrAgentType": "string",
  "rememberCategory": "boolean",
  "operationIncomeCategoryId": "integer (int32)",
  "operationOutcomeCategoryId": "integer (int32)",
  "active": "boolean",
  "firstOperationDate": "string (date)",
  "lastOperationDate": "string (date)",
  "balance": "number (double)",
  "currencyCode": "string",
  "contrAgentId": "integer (int32)",
  "title": "string",
  "externalId": "string"
}

ContrAgentModificationRequest: object

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

title: string (up to 256 chars)

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

longTitle: string (up to 256 chars)

"Полное название"

contrAgentInn: string

ИНН

contrAgentKpp: string

КПП

description: string

Комментарий

contrAgentType: string Income, Outcome, Mixed

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

rememberCategory: boolean

Применять статьи по умолчанию

operationIncomeCategoryId: integer (int32)

Идентификатор доходной статьи

operationOutcomeCategoryId: integer (int32)

Идентификатор расходной статьи

active: boolean

Статус

Example
{
  "title": "string",
  "longTitle": "string",
  "contrAgentInn": "string",
  "contrAgentKpp": "string",
  "description": "string",
  "contrAgentType": "string",
  "rememberCategory": "boolean",
  "operationIncomeCategoryId": "integer (int32)",
  "operationOutcomeCategoryId": "integer (int32)",
  "active": "boolean"
}

ContrAgentListRequest: object

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

title: string (3 to 256 chars)

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

contrAgentType: string Income, Outcome, Mixed

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

startDateTime: string (date)

Начальная дата поиска

endDateTime: string (date)

Конечная дата поиска

active: boolean

Статус

Example
{
  "title": "string",
  "contrAgentType": "string",
  "startDateTime": "string (date)",
  "endDateTime": "string (date)",
  "active": "boolean"
}

Sorting[ContrAgentsSortingFields]: object

Сортировка

field: string Title, Active, ContrAgentType, FirstOperationDate, LastOperationDate, Balance

Поле сортировки

direction: string Asc, Desc

Направление сортировки (По умолчанию Asc)

Example
{
  "field": "string",
  "direction": "string"
}

Response[ListModel[ContrAgentModel]]: object

Ответ

data: ListModel[ContrAgentModel]

Данные

isSuccess: boolean

Признак успешности запроса

errorMessage: string

Сообщение о причине ошибки

Example
{
  "data": {
    "items": [
      {
        "longTitle": "string",
        "contrAgentInn": "string",
        "contrAgentKpp": "string",
        "description": "string",
        "contrAgentType": "string",
        "rememberCategory": "boolean",
        "operationIncomeCategoryId": "integer (int32)",
        "operationOutcomeCategoryId": "integer (int32)",
        "active": "boolean",
        "firstOperationDate": "string (date)",
        "lastOperationDate": "string (date)",
        "balance": "number (double)",
        "currencyCode": "string",
        "contrAgentId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      }
    ],
    "total": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

ListModel[ContrAgentModel]: object

Список элементов и общее кол-во

items: ContrAgentModel

Элементы

total: integer (int32)

Всего элементов в наборе

Example
{
  "items": [
    {
      "longTitle": "string",
      "contrAgentInn": "string",
      "contrAgentKpp": "string",
      "description": "string",
      "contrAgentType": "string",
      "rememberCategory": "boolean",
      "operationIncomeCategoryId": "integer (int32)",
      "operationOutcomeCategoryId": "integer (int32)",
      "active": "boolean",
      "firstOperationDate": "string (date)",
      "lastOperationDate": "string (date)",
      "balance": "number (double)",
      "currencyCode": "string",
      "contrAgentId": "integer (int32)",
      "title": "string",
      "externalId": "string"
    }
  ],
  "total": "integer (int32)"
}

ContrAgentCreationRequest: object

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

title: string (up to 256 chars)

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

longTitle: string (up to 256 chars)

"Полное название"

contrAgentInn: string

ИНН

contrAgentKpp: string

КПП

description: string

Комментарий

contrAgentType: string Income, Outcome, Mixed

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

rememberCategory: boolean

Применять статьи по умолчанию

operationIncomeCategoryId: integer (int32)

Идентификатор доходной статьи

operationOutcomeCategoryId: integer (int32)

Идентификатор расходной статьи

active: boolean

Признак активности

Example
{
  "title": "string",
  "longTitle": "string",
  "contrAgentInn": "string",
  "contrAgentKpp": "string",
  "description": "string",
  "contrAgentType": "string",
  "rememberCategory": "boolean",
  "operationIncomeCategoryId": "integer (int32)",
  "operationOutcomeCategoryId": "integer (int32)",
  "active": "boolean"
}

TotalsRequest: object

Модель запроса сводки по счетам

fromDate: string (date)
toDate: string (date)
grouping: string Day, Week, Month, Quarter, Year
Example
{
  "fromDate": "string (date)",
  "toDate": "string (date)",
  "grouping": "string"
}

Response[IList[TotalsView]]: object

Ответ

data: TotalsView

Данные

isSuccess: boolean

Признак успешности запроса

errorMessage: string

Сообщение о причине ошибки

Example
{
  "data": [
    {
      "accountId": "00000000-0000-0000-0000-000000000000",
      "creditBefore": "number (double)",
      "debitBefore": "number (double)",
      "items": [
        {
          "groupingKey": "string (date)",
          "creditSum": "number (double)",
          "debitSum": "number (double)"
        }
      ]
    }
  ],
  "isSuccess": "boolean",
  "errorMessage": "string"
}

TotalsView: object

accountId: string (uuid)
creditBefore: number (double)
debitBefore: number (double)
items: TotalsItemView
Example
{
  "accountId": "00000000-0000-0000-0000-000000000000",
  "creditBefore": "number (double)",
  "debitBefore": "number (double)",
  "items": [
    {
      "groupingKey": "string (date)",
      "creditSum": "number (double)",
      "debitSum": "number (double)"
    }
  ]
}

TotalsItemView: object

groupingKey: string (date)
creditSum: number (double)
debitSum: number (double)
Example
{
  "groupingKey": "string (date)",
  "creditSum": "number (double)",
  "debitSum": "number (double)"
}

Response[ListModel[CurrencyModel]]: object

Ответ

data: ListModel[CurrencyModel]

Данные

isSuccess: boolean

Признак успешности запроса

errorMessage: string

Сообщение о причине ошибки

Example
{
  "data": {
    "items": [
      {
        "shortTitle": "string",
        "value": "number (double)",
        "currencyCode": "string",
        "title": "string"
      }
    ],
    "total": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

ListModel[CurrencyModel]: object

Список элементов и общее кол-во

items: CurrencyModel

Элементы

total: integer (int32)

Всего элементов в наборе

Example
{
  "items": [
    {
      "shortTitle": "string",
      "value": "number (double)",
      "currencyCode": "string",
      "title": "string"
    }
  ],
  "total": "integer (int32)"
}

CurrencyModel: object

Модель представления валюты

shortTitle: string

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

value: number (double)

Курс

currencyCode: string USD, EUR, GBP, RUB, BYN, UAH, KZT, CNY, TRY, KGS, AMD, AED, INR, JPY, MDL, UZS, PLN, SGD, BTC, ETH, BCH, XRP, LTC, DASH, XMR, ETC, ZEC, STRAT, DCR, DOGE, SC, CAD

Код валюты

title: string

Название

Example
{
  "shortTitle": "string",
  "value": "number (double)",
  "currencyCode": "string",
  "title": "string"
}

Response[ListModel[ImportLogModel]]: object

Ответ

data: ListModel[ImportLogModel]

Данные

isSuccess: boolean

Признак успешности запроса

errorMessage: string

Сообщение о причине ошибки

Example
{
  "data": {
    "items": [
      {
        "importLogId": "integer (int32)",
        "startDate": "string (date)",
        "accountTitle": "string"
      }
    ],
    "total": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

ListModel[ImportLogModel]: object

Список элементов и общее кол-во

items: ImportLogModel

Элементы

total: integer (int32)

Всего элементов в наборе

Example
{
  "items": [
    {
      "importLogId": "integer (int32)",
      "startDate": "string (date)",
      "accountTitle": "string"
    }
  ],
  "total": "integer (int32)"
}

ImportLogModel: object

Модель лога импорта

importLogId: integer (int32)

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

startDate: string (date)

Дата начала

accountTitle: string

Название счёта

Example
{
  "importLogId": "integer (int32)",
  "startDate": "string (date)",
  "accountTitle": "string"
}

Response[OperationCategoryModel]: object

Ответ

data: OperationCategoryModel

Данные

isSuccess: boolean

Признак успешности запроса

errorMessage: string

Сообщение о причине ошибки

Example
{
  "data": {
    "operationCategoryType": "string",
    "activityType": "string",
    "parentOperationCategoryId": "integer (int32)",
    "sort": "integer (int32)",
    "isVisible": "boolean",
    "isFixed": "boolean",
    "accountCategoryType": "string",
    "coreAccountId": "00000000-0000-0000-0000-000000000000",
    "operationCategoryId": "integer (int32)",
    "title": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

OperationCategoryModel: object

Модель представления статьи доходов/расходов

operationCategoryType: string Outcome, Income, Assets, Liabilities, Capital

Тип

activityType: string Operating, Finance, Investment

Вид деятельности

parentOperationCategoryId: integer (int32)

Родительская статья доходов

sort: integer (int32)

Порядок статьи

isVisible: boolean

Видимость статьи для пользователя

isFixed: boolean

Доступность для редактирования

accountCategoryType: string None, Assets, AssetsCurrent, AssetsCurrentMoney, AssetsCurrentMoneyBank, AssetsCurrentMoneyCash, AssetsCurrentMoneyTransfer, AssetsCurrentDebit, AssetsLong, AssetsLongFixed, AssetsLongIntangible, AssetsLongFinance, Liabilities, LiabilitiesCurrent, LiabilitiesCurrentCredit, LiabilitiesCurrentWage, LiabilitiesCurrentTax, LiabilitiesLong, Capital, CapitalContributed, CapitalDividends, CapitalProfit, Income, IncomeUndistributed, IncomeOther, Outcome, OutcomeUndistributed, OutcomeFixedWage, OutcomeTax, OutcomeDepreciation, OutcomeCreditPercent

Тип категории счёта в плане счетов

coreAccountId: string (uuid)
operationCategoryId: integer (int32)

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

title: string

Название

Example
{
  "operationCategoryType": "string",
  "activityType": "string",
  "parentOperationCategoryId": "integer (int32)",
  "sort": "integer (int32)",
  "isVisible": "boolean",
  "isFixed": "boolean",
  "accountCategoryType": "string",
  "coreAccountId": "00000000-0000-0000-0000-000000000000",
  "operationCategoryId": "integer (int32)",
  "title": "string"
}

OperationCategoryModificationRequest: object

Модель запроса изменения статьи

title: string (up to 256 chars)

Название

operationCategoryType: string Outcome, Income, Assets, Liabilities, Capital

Тип

activityType: string Operating, Finance, Investment

Вид деятельности

parentOperationCategoryId: integer (int32)

Родительская статья доходов

sort: integer (int32)

Порядок статьи

Example
{
  "title": "string",
  "operationCategoryType": "string",
  "activityType": "string",
  "parentOperationCategoryId": "integer (int32)",
  "sort": "integer (int32)"
}

OperationCategoryListRequest: object

Запрос списка проектов

operationCategoryId: integer[]

Набор искомых идентификаторов

title: string (up to 256 chars)

Название

operationCategoryType: string Outcome, Income, Assets, Liabilities, Capital

Тип

activityType: string Operating, Finance, Investment

Вид деятельности

parentOperationCategoryId: integer (int32)

Родительская статья доходов

Example
{
  "operationCategoryId": [
    "integer (int32)"
  ],
  "title": "string",
  "operationCategoryType": "string",
  "activityType": "string",
  "parentOperationCategoryId": "integer (int32)"
}

Sorting[OperationCategoriesSortingFields]: object

Сортировка

field: string Title, OperationCategoryType, ActivityType

Поле сортировки

direction: string Asc, Desc

Направление сортировки (По умолчанию Asc)

Example
{
  "field": "string",
  "direction": "string"
}

Response[ListModel[OperationCategoryModel]]: object

Ответ

data: ListModel[OperationCategoryModel]

Данные

isSuccess: boolean

Признак успешности запроса

errorMessage: string

Сообщение о причине ошибки

Example
{
  "data": {
    "items": [
      {
        "operationCategoryType": "string",
        "activityType": "string",
        "parentOperationCategoryId": "integer (int32)",
        "sort": "integer (int32)",
        "isVisible": "boolean",
        "isFixed": "boolean",
        "accountCategoryType": "string",
        "coreAccountId": "00000000-0000-0000-0000-000000000000",
        "operationCategoryId": "integer (int32)",
        "title": "string"
      }
    ],
    "total": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

ListModel[OperationCategoryModel]: object

Список элементов и общее кол-во

items: OperationCategoryModel

Элементы

total: integer (int32)

Всего элементов в наборе

Example
{
  "items": [
    {
      "operationCategoryType": "string",
      "activityType": "string",
      "parentOperationCategoryId": "integer (int32)",
      "sort": "integer (int32)",
      "isVisible": "boolean",
      "isFixed": "boolean",
      "accountCategoryType": "string",
      "coreAccountId": "00000000-0000-0000-0000-000000000000",
      "operationCategoryId": "integer (int32)",
      "title": "string"
    }
  ],
  "total": "integer (int32)"
}

OperationCategoryCreationRequest: object

Модель запроса создания статьи расходов/доходов

title: string (up to 256 chars)

Название

operationCategoryType: string Outcome, Income, Assets, Liabilities, Capital

Тип статьи

activityType: string Operating, Finance, Investment

Вид деятельности

parentOperationCategoryId: integer (int32)

Родительская статья доходов

sort: integer (int32)

Порядок статьи

Example
{
  "title": "string",
  "operationCategoryType": "string",
  "activityType": "string",
  "parentOperationCategoryId": "integer (int32)",
  "sort": "integer (int32)"
}

Response[OperationModel]: object

Ответ

data: OperationModel

Данные

isSuccess: boolean

Признак успешности запроса

errorMessage: string

Сообщение о причине ошибки

Example
{
  "data": {
    "operationId": "integer (int32)",
    "operationType": "string",
    "operationDate": "string (date)",
    "calculationPeriodDate": "string (date)",
    "contrAgent": {
      "contrAgentId": "integer (int32)",
      "title": "string",
      "externalId": "string"
    },
    "account": {
      "accountId": "integer (int32)",
      "title": "string"
    },
    "accountCompany": {
      "companyId": "integer (int32)",
      "title": "string",
      "externalId": "string"
    },
    "accountCurrency": {
      "currencyCode": "string",
      "title": "string"
    },
    "operationCategory": {
      "operationCategoryId": "integer (int32)",
      "title": "string"
    },
    "operationCategoryActivityType": "string",
    "comment": "string",
    "value": "number (double)",
    "valueByProjects": [
      {
        "value": "number (double)",
        "project": {
          "projectId": "integer (int32)",
          "title": "string"
        }
      }
    ],
    "isCommitted": "boolean",
    "lastModificationDate": "string (date)",
    "externalId": "string",
    "importLogId": "integer (int32)",
    "boundMoveOperationId": "integer (int32)",
    "correctRemainder": "number (double)",
    "coreEntryIds": [
      "00000000-0000-0000-0000-000000000000"
    ]
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

OperationModel: object

Модель операции

operationId: integer (int32)

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

operationType: string Income, Outcome, Move, Correction

Тип операции

operationDate: string (date)

Дата операции

calculationPeriodDate: string (date)

Период начисления

contrAgent: ContrAgentLinkModel

Контрагент

account: AccountLinkModel

Счет

accountCompany: CompanyLinkModel

Юрлицо

accountCurrency: CurrencyLinkModel

Валюта операции

operationCategory: OperationCategoryLinkModel

Статья

operationCategoryActivityType: string Operating, Finance, Investment

Вид деятельности статьи

comment: string

Комментарий

value: number (double)

Общая сумма

valueByProjects: OperationValueByProjectModel

Сумма по проектам

isCommitted: boolean

Признак того, что операция проведена

lastModificationDate: string (date)

Дата последней модификации

externalId: string

Внешний идентификатор

importLogId: integer (int32)

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

boundMoveOperationId: integer (int32)

Идентификатор связанной операции

correctRemainder: number (double)

Остаток для корректировки

coreEntryIds: string[]

Идентификаторы связанных проводок

Example
{
  "operationId": "integer (int32)",
  "operationType": "string",
  "operationDate": "string (date)",
  "calculationPeriodDate": "string (date)",
  "contrAgent": {
    "contrAgentId": "integer (int32)",
    "title": "string",
    "externalId": "string"
  },
  "account": {
    "accountId": "integer (int32)",
    "title": "string"
  },
  "accountCompany": {
    "companyId": "integer (int32)",
    "title": "string",
    "externalId": "string"
  },
  "accountCurrency": {
    "currencyCode": "string",
    "title": "string"
  },
  "operationCategory": {
    "operationCategoryId": "integer (int32)",
    "title": "string"
  },
  "operationCategoryActivityType": "string",
  "comment": "string",
  "value": "number (double)",
  "valueByProjects": [
    {
      "value": "number (double)",
      "project": {
        "projectId": "integer (int32)",
        "title": "string"
      }
    }
  ],
  "isCommitted": "boolean",
  "lastModificationDate": "string (date)",
  "externalId": "string",
  "importLogId": "integer (int32)",
  "boundMoveOperationId": "integer (int32)",
  "correctRemainder": "number (double)",
  "coreEntryIds": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

ContrAgentLinkModel: object

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

contrAgentId: integer (int32)

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

title: string

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

externalId: string

Внешний идентификатор

Example
{
  "contrAgentId": "integer (int32)",
  "title": "string",
  "externalId": "string"
}

AccountLinkModel: object

Модель связи со счетом

accountId: integer (int32)

Id Счета

title: string

Название

Example
{
  "accountId": "integer (int32)",
  "title": "string"
}

CompanyLinkModel: object

Модель связи с юрлицом

companyId: integer (int32)

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

title: string

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

externalId: string

Внешний идентификатор

Example
{
  "companyId": "integer (int32)",
  "title": "string",
  "externalId": "string"
}

CurrencyLinkModel: object

Модель связи с валютой

currencyCode: string USD, EUR, GBP, RUB, BYN, UAH, KZT, CNY, TRY, KGS, AMD, AED, INR, JPY, MDL, UZS, PLN, SGD, BTC, ETH, BCH, XRP, LTC, DASH, XMR, ETC, ZEC, STRAT, DCR, DOGE, SC, CAD

Код валюты

title: string

Название

Example
{
  "currencyCode": "string",
  "title": "string"
}

OperationCategoryLinkModel: object

Модель связи со статьёй

operationCategoryId: integer (int32)

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

title: string

Название

Example
{
  "operationCategoryId": "integer (int32)",
  "title": "string"
}

OperationValueByProjectModel: object

Модель суммы по проекту

value: number (double)

Сумма

project: ProjectLinkModel

Проект

Example
{
  "value": "number (double)",
  "project": {
    "projectId": "integer (int32)",
    "title": "string"
  }
}

ProjectLinkModel: object

Модель связи с проектом

projectId: integer (int32)

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

title: string

Название

Example
{
  "projectId": "integer (int32)",
  "title": "string"
}

OperationListRequest: object

Запрос списка операций

operationDateStart: string (date)

Дата операции. Начало.

operationDateEnd: string (date)

Дата операции. Конец.

calculationPeriodDateStart: string (date)

Период начисления. Начало.

calculationPeriodDateEnd: string (date)

Период начисления. Конец.

contrAgentId: integer[]

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

accountId: integer[]

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

accountCompanyId: integer[]

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

operationType: string[]

Типы операций

operationCategoryActivityType: string[]

Виды деятельности

operationCategoryId: integer[]

Идентификаторы стетей

valueMin: number (double)

Общая сумма. Минимум

valueMax: number (double)

Общая сумма. Максимум

projectId: integer[]

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

isCommitted: boolean

Признак того, что операция проведена

lastModificationDateStart: string (date)

Дата последней модификации. Начало.

lastModificationDateEnd: string (date)

Дата последней модификации. Конец.

externalId: string[]

Внешние идентификаторы

importLogId: integer[]

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

boundMoveOperationId: integer[]

Идентификаторы связанных операции

searchString: string

Строка для расширенного поиска по. Атрибуты, участвующие в поиске:

  • Комментарий
  • Название контрагента
  • Название счета
  • Название юрлица
  • Название статьи
Example
{
  "operationDateStart": "string (date)",
  "operationDateEnd": "string (date)",
  "calculationPeriodDateStart": "string (date)",
  "calculationPeriodDateEnd": "string (date)",
  "contrAgentId": [
    "integer (int32)"
  ],
  "accountId": [
    "integer (int32)"
  ],
  "accountCompanyId": [
    "integer (int32)"
  ],
  "operationType": [
    "string"
  ],
  "operationCategoryActivityType": [
    "string"
  ],
  "operationCategoryId": [
    "integer (int32)"
  ],
  "valueMin": "number (double)",
  "valueMax": "number (double)",
  "projectId": [
    "integer (int32)"
  ],
  "isCommitted": "boolean",
  "lastModificationDateStart": "string (date)",
  "lastModificationDateEnd": "string (date)",
  "externalId": [
    "string"
  ],
  "importLogId": [
    "integer (int32)"
  ],
  "boundMoveOperationId": [
    "integer (int32)"
  ],
  "searchString": "string"
}

Sorting[OperationsSortingFields]: object

Сортировка

field: string OperationDate, CalculationPeriodDate, ContrAgent, Account, AccountCompany, OperationCategory, OperationCategoryActivityType, LastModificationDate

Поле сортировки

direction: string Asc, Desc

Направление сортировки (По умолчанию Asc)

Example
{
  "field": "string",
  "direction": "string"
}

Response[ListModel[OperationModel]]: object

Ответ

data: ListModel[OperationModel]

Данные

isSuccess: boolean

Признак успешности запроса

errorMessage: string

Сообщение о причине ошибки

Example
{
  "data": {
    "items": [
      {
        "operationId": "integer (int32)",
        "operationType": "string",
        "operationDate": "string (date)",
        "calculationPeriodDate": "string (date)",
        "contrAgent": {
          "contrAgentId": "integer (int32)",
          "title": "string",
          "externalId": "string"
        },
        "account": {
          "accountId": "integer (int32)",
          "title": "string"
        },
        "accountCompany": {
          "companyId": "integer (int32)",
          "title": "string",
          "externalId": "string"
        },
        "accountCurrency": {
          "currencyCode": "string",
          "title": "string"
        },
        "operationCategory": {
          "operationCategoryId": "integer (int32)",
          "title": "string"
        },
        "operationCategoryActivityType": "string",
        "comment": "string",
        "value": "number (double)",
        "valueByProjects": [
          {
            "value": "number (double)",
            "project": {
              "projectId": "integer (int32)",
              "title": "string"
            }
          }
        ],
        "isCommitted": "boolean",
        "lastModificationDate": "string (date)",
        "externalId": "string",
        "importLogId": "integer (int32)",
        "boundMoveOperationId": "integer (int32)",
        "correctRemainder": "number (double)",
        "coreEntryIds": [
          "00000000-0000-0000-0000-000000000000"
        ]
      }
    ],
    "total": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

ListModel[OperationModel]: object

Список элементов и общее кол-во

items: OperationModel

Элементы

total: integer (int32)

Всего элементов в наборе

Example
{
  "items": [
    {
      "operationId": "integer (int32)",
      "operationType": "string",
      "operationDate": "string (date)",
      "calculationPeriodDate": "string (date)",
      "contrAgent": {
        "contrAgentId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      },
      "account": {
        "accountId": "integer (int32)",
        "title": "string"
      },
      "accountCompany": {
        "companyId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      },
      "accountCurrency": {
        "currencyCode": "string",
        "title": "string"
      },
      "operationCategory": {
        "operationCategoryId": "integer (int32)",
        "title": "string"
      },
      "operationCategoryActivityType": "string",
      "comment": "string",
      "value": "number (double)",
      "valueByProjects": [
        {
          "value": "number (double)",
          "project": {
            "projectId": "integer (int32)",
            "title": "string"
          }
        }
      ],
      "isCommitted": "boolean",
      "lastModificationDate": "string (date)",
      "externalId": "string",
      "importLogId": "integer (int32)",
      "boundMoveOperationId": "integer (int32)",
      "correctRemainder": "number (double)",
      "coreEntryIds": [
        "00000000-0000-0000-0000-000000000000"
      ]
    }
  ],
  "total": "integer (int32)"
}

IncomeOutcomeOperationCreationRequest: object

Модель запроса создания операции поступления/списания

operationDate: string (date)

Дата операции

calculationPeriodDate: string (date)

Период начисления

contrAgentId: integer (int32)

Контрагент

accountId: integer (int32)

Счет

operationCategoryId: integer (int32)

Идентификатор статьи расходов/доходов

comment: string

Комментарий

value: number (double) x ≥ 0

Общая сумма

valueByProjects: object

Сумма по проектам. Словарь. Передаётся как: { "{id проекта 1}" : {сумма по проекту 1}, "{id проекта 2}" : {сумма по проекту 2}, ... }

isCommitted: boolean

Признак того, что операция проведена

importLogId: integer (int32)

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

Example
{
  "operationDate": "string (date)",
  "calculationPeriodDate": "string (date)",
  "contrAgentId": "integer (int32)",
  "accountId": "integer (int32)",
  "operationCategoryId": "integer (int32)",
  "comment": "string",
  "value": "number (double)",
  "valueByProjects": "object",
  "isCommitted": "boolean",
  "importLogId": "integer (int32)"
}

MoveOperationCreationRequest: object

Модель запроса создания операции перемещения

debitingDate: string (date)

Дата списания

admissionDate: string (date)

Дата зачисления

debitingAccountId: integer (int32)

Счет списания

admissionAccountId: integer (int32)

Счет зачисления

debitingValue: number (double) x ≥ 0

Сумма списания

admissionValue: number (double) x ≥ 0

Сумма зачисления

comment: string

Комментарий

valueByProjects: object

Сумма по проектам

isCommitted: boolean

Признак того, что операция проведена

importLogId: integer (int32)

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

Example
{
  "debitingDate": "string (date)",
  "admissionDate": "string (date)",
  "debitingAccountId": "integer (int32)",
  "admissionAccountId": "integer (int32)",
  "debitingValue": "number (double)",
  "admissionValue": "number (double)",
  "comment": "string",
  "valueByProjects": "object",
  "isCommitted": "boolean",
  "importLogId": "integer (int32)"
}

Response[OperationModel[]]: object

Ответ

data: OperationModel

Данные

isSuccess: boolean

Признак успешности запроса

errorMessage: string

Сообщение о причине ошибки

Example
{
  "data": [
    {
      "operationId": "integer (int32)",
      "operationType": "string",
      "operationDate": "string (date)",
      "calculationPeriodDate": "string (date)",
      "contrAgent": {
        "contrAgentId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      },
      "account": {
        "accountId": "integer (int32)",
        "title": "string"
      },
      "accountCompany": {
        "companyId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      },
      "accountCurrency": {
        "currencyCode": "string",
        "title": "string"
      },
      "operationCategory": {
        "operationCategoryId": "integer (int32)",
        "title": "string"
      },
      "operationCategoryActivityType": "string",
      "comment": "string",
      "value": "number (double)",
      "valueByProjects": [
        {
          "value": "number (double)",
          "project": {
            "projectId": "integer (int32)",
            "title": "string"
          }
        }
      ],
      "isCommitted": "boolean",
      "lastModificationDate": "string (date)",
      "externalId": "string",
      "importLogId": "integer (int32)",
      "boundMoveOperationId": "integer (int32)",
      "correctRemainder": "number (double)",
      "coreEntryIds": [
        "00000000-0000-0000-0000-000000000000"
      ]
    }
  ],
  "isSuccess": "boolean",
  "errorMessage": "string"
}

IncomeOutcomeOperationModificationRequest: object

Модель запроса изменения операции поступления/списания

operationDate: string (date)

Дата операции

calculationPeriodDate: string (date)

Период начисления

contrAgentId: integer (int32)

Контрагент

accountId: integer (int32)

Счет

operationCategoryId: integer (int32)

Идентификатор статьи расходов/доходов

comment: string

Комментарий

value: number (double) x ≥ 0

Общая сумма

valueByProjects: object

Сумма по проектам. Словарь. Передаётся как: { "{id проекта 1}" : {сумма по проекту 1}, "{id проекта 2}" : {сумма по проекту 2}, ... }

isCommitted: boolean

Признак того, что операция проведена

importLogId: integer (int32)

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

Example
{
  "operationDate": "string (date)",
  "calculationPeriodDate": "string (date)",
  "contrAgentId": "integer (int32)",
  "accountId": "integer (int32)",
  "operationCategoryId": "integer (int32)",
  "comment": "string",
  "value": "number (double)",
  "valueByProjects": "object",
  "isCommitted": "boolean",
  "importLogId": "integer (int32)"
}

MoveOperationModificationRequest: object

Модель запроса изменения операции перемещения

debitingDate: string (date)

Дата списания

admissionDate: string (date)

Дата зачисления

debitingAccountId: integer (int32)

Счет списания

admissionAccountId: integer (int32)

Счет зачисления

debitingValue: number (double) x ≥ 0

Сумма списания

admissionValue: number (double) x ≥ 0

Сумма зачисления

comment: string

Комментарий

valueByProjects: object

Сумма по проектам

isCommitted: boolean

Признак того, что операция проведена

importLogId: integer (int32)

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

Example
{
  "debitingDate": "string (date)",
  "admissionDate": "string (date)",
  "debitingAccountId": "integer (int32)",
  "admissionAccountId": "integer (int32)",
  "debitingValue": "number (double)",
  "admissionValue": "number (double)",
  "comment": "string",
  "valueByProjects": "object",
  "isCommitted": "boolean",
  "importLogId": "integer (int32)"
}

OperationConsolidateRequest: object

Модель запроса на объединение операций в перемещение

incomeOperationId: integer (int32)

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

outcomeOperationId: integer (int32)

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

Example
{
  "incomeOperationId": "integer (int32)",
  "outcomeOperationId": "integer (int32)"
}

Response[MultipleOperationModel]: object

Ответ

data: MultipleOperationModel

Данные

isSuccess: boolean

Признак успешности запроса

errorMessage: string

Сообщение о причине ошибки

Example
{
  "data": {
    "operations": [
      {
        "operationId": "integer (int32)",
        "operationType": "string",
        "operationDate": "string (date)",
        "calculationPeriodDate": "string (date)",
        "contrAgent": {
          "contrAgentId": "integer (int32)",
          "title": "string",
          "externalId": "string"
        },
        "account": {
          "accountId": "integer (int32)",
          "title": "string"
        },
        "accountCompany": {
          "companyId": "integer (int32)",
          "title": "string",
          "externalId": "string"
        },
        "accountCurrency": {
          "currencyCode": "string",
          "title": "string"
        },
        "operationCategory": {
          "operationCategoryId": "integer (int32)",
          "title": "string"
        },
        "operationCategoryActivityType": "string",
        "comment": "string",
        "value": "number (double)",
        "valueByProjects": [
          {
            "value": "number (double)",
            "project": {
              "projectId": "integer (int32)",
              "title": "string"
            }
          }
        ],
        "isCommitted": "boolean",
        "lastModificationDate": "string (date)",
        "externalId": "string",
        "importLogId": "integer (int32)",
        "boundMoveOperationId": "integer (int32)",
        "correctRemainder": "number (double)",
        "coreEntryIds": [
          "00000000-0000-0000-0000-000000000000"
        ]
      }
    ]
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

MultipleOperationModel: object

Модель нескольких операций

operations: OperationModel

Операции

Example
{
  "operations": [
    {
      "operationId": "integer (int32)",
      "operationType": "string",
      "operationDate": "string (date)",
      "calculationPeriodDate": "string (date)",
      "contrAgent": {
        "contrAgentId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      },
      "account": {
        "accountId": "integer (int32)",
        "title": "string"
      },
      "accountCompany": {
        "companyId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      },
      "accountCurrency": {
        "currencyCode": "string",
        "title": "string"
      },
      "operationCategory": {
        "operationCategoryId": "integer (int32)",
        "title": "string"
      },
      "operationCategoryActivityType": "string",
      "comment": "string",
      "value": "number (double)",
      "valueByProjects": [
        {
          "value": "number (double)",
          "project": {
            "projectId": "integer (int32)",
            "title": "string"
          }
        }
      ],
      "isCommitted": "boolean",
      "lastModificationDate": "string (date)",
      "externalId": "string",
      "importLogId": "integer (int32)",
      "boundMoveOperationId": "integer (int32)",
      "correctRemainder": "number (double)",
      "coreEntryIds": [
        "00000000-0000-0000-0000-000000000000"
      ]
    }
  ]
}

Response[ProjectModel]: object

Ответ

data: ProjectModel

Данные

isSuccess: boolean

Признак успешности запроса

errorMessage: string

Сообщение о причине ошибки

Example
{
  "data": {
    "description": "string",
    "active": "boolean",
    "firstOperationDate": "string (date)",
    "lastOperationDate": "string (date)",
    "sumOfIncome": "number (double)",
    "sumOfOutcome": "number (double)",
    "balance": "number (double)",
    "percentOfDifference": "number (double)",
    "profitability": "number (double)",
    "currencyCode": "string",
    "projectId": "integer (int32)",
    "title": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

ProjectModel: object

Модель представления проекта

description: string

Комментарий

active: boolean

Статус

firstOperationDate: string (date)

Дата первой операции

lastOperationDate: string (date)

Дата последней операции

sumOfIncome: number (double)

Сумма поступлений

sumOfOutcome: number (double)

Сумма выплат

balance: number (double)

Сальдо

percentOfDifference: number (double)

Процент разницы

profitability: number (double)

Рентабельность

currencyCode: string USD, EUR, GBP, RUB, BYN, UAH, KZT, CNY, TRY, KGS, AMD, AED, INR, JPY, MDL, UZS, PLN, SGD, BTC, ETH, BCH, XRP, LTC, DASH, XMR, ETC, ZEC, STRAT, DCR, DOGE, SC, CAD

Код валюты сводки

projectId: integer (int32)

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

title: string

Название

Example
{
  "description": "string",
  "active": "boolean",
  "firstOperationDate": "string (date)",
  "lastOperationDate": "string (date)",
  "sumOfIncome": "number (double)",
  "sumOfOutcome": "number (double)",
  "balance": "number (double)",
  "percentOfDifference": "number (double)",
  "profitability": "number (double)",
  "currencyCode": "string",
  "projectId": "integer (int32)",
  "title": "string"
}

ProjectModificationRequest: object

Модель запроса изменения проекта

title: string (up to 256 chars)

Название

description: string

Комментарий

active: boolean

Статус

Example
{
  "title": "string",
  "description": "string",
  "active": "boolean"
}

ProjectListRequest: object

Запрос списка проектов

title: string (3 to 256 chars)

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

startDateTime: string (date)

Начальная дата поиска

endDateTime: string (date)

Конечная дата поиска

active: boolean

Статус

Example
{
  "title": "string",
  "startDateTime": "string (date)",
  "endDateTime": "string (date)",
  "active": "boolean"
}

Sorting[ProjectsSortingFields]: object

Сортировка

field: string Title, Active, FirstOperationDate, LastOperationDate

Поле сортировки

direction: string Asc, Desc

Направление сортировки (По умолчанию Asc)

Example
{
  "field": "string",
  "direction": "string"
}

Response[ListModel[ProjectModel]]: object

Ответ

data: ListModel[ProjectModel]

Данные

isSuccess: boolean

Признак успешности запроса

errorMessage: string

Сообщение о причине ошибки

Example
{
  "data": {
    "items": [
      {
        "description": "string",
        "active": "boolean",
        "firstOperationDate": "string (date)",
        "lastOperationDate": "string (date)",
        "sumOfIncome": "number (double)",
        "sumOfOutcome": "number (double)",
        "balance": "number (double)",
        "percentOfDifference": "number (double)",
        "profitability": "number (double)",
        "currencyCode": "string",
        "projectId": "integer (int32)",
        "title": "string"
      }
    ],
    "total": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

ListModel[ProjectModel]: object

Список элементов и общее кол-во

items: ProjectModel

Элементы

total: integer (int32)

Всего элементов в наборе

Example
{
  "items": [
    {
      "description": "string",
      "active": "boolean",
      "firstOperationDate": "string (date)",
      "lastOperationDate": "string (date)",
      "sumOfIncome": "number (double)",
      "sumOfOutcome": "number (double)",
      "balance": "number (double)",
      "percentOfDifference": "number (double)",
      "profitability": "number (double)",
      "currencyCode": "string",
      "projectId": "integer (int32)",
      "title": "string"
    }
  ],
  "total": "integer (int32)"
}

ProjectCreationRequest: object

Модель запроса создания проекта

title: string (up to 256 chars)

Название

description: string

Комментарий

Example
{
  "title": "string",
  "description": "string"
}

Response[SettingsModel]: object

Ответ

data: SettingsModel

Данные

isSuccess: boolean

Признак успешности запроса

errorMessage: string

Сообщение о причине ошибки

Example
{
  "data": {
    "groupCompanyTitle": "string",
    "currency": {
      "currencyCode": "string",
      "title": "string"
    },
    "accountMethod": "string",
    "showKopeck": "boolean",
    "showPastCashGap": "boolean"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

SettingsModel: object

Модель представления настроек учета

groupCompanyTitle: string

Название бизнесса

currency: CurrencyLinkModel

Основная валюта

accountMethod: string Cash, Calculation

Способ учета прибыли

showKopeck: boolean

Показывать копейки

showPastCashGap: boolean

Показывать кассовые разрывы в прошлом

Example
{
  "groupCompanyTitle": "string",
  "currency": {
    "currencyCode": "string",
    "title": "string"
  },
  "accountMethod": "string",
  "showKopeck": "boolean",
  "showPastCashGap": "boolean"
}

SettingsModificationRequest: object

Модель запроса изменения настроек

currencyCode: string USD, EUR, GBP, RUB, BYN, UAH, KZT, CNY, TRY, KGS, AMD, AED, INR, JPY, MDL, UZS, PLN, SGD, BTC, ETH, BCH, XRP, LTC, DASH, XMR, ETC, ZEC, STRAT, DCR, DOGE, SC, CAD

Код основной валюты

accountMethod: string Cash, Calculation

Способ учета прибыли

showKopeck: boolean

Показывать копейки

showPastCashGap: boolean

Показывать кассовые разрывы в прошлом

Example
{
  "currencyCode": "string",
  "accountMethod": "string",
  "showKopeck": "boolean",
  "showPastCashGap": "boolean"
}

Response[UserModel]: object

Ответ

data: UserModel

Данные

isSuccess: boolean

Признак успешности запроса

errorMessage: string

Сообщение о причине ошибки

Example
{
  "data": {
    "id": "string",
    "email": "string",
    "emailConfirmed": "boolean",
    "lastLoginDate": "string (date)",
    "creationDate": "string (date)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string"
}

UserModel: object

id: string

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

email: string

Email

emailConfirmed: boolean

Признак подтверждённости email-а

lastLoginDate: string (date)

Дата последнего захода

creationDate: string (date)

Дата создания

Example
{
  "id": "string",
  "email": "string",
  "emailConfirmed": "boolean",
  "lastLoginDate": "string (date)",
  "creationDate": "string (date)"
}

UserCreationRequest: object

email: string
Example
{
  "email": "string"
}

UserModificationRequest: object

email: string
Example
{
  "email": "string"
}