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

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

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

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)",
    "remainderOperationId": "integer (int32)",
    "bankImportIntegrationTokenId": "integer (int32)",
    "bankImportIntegrationTokenBankId": "integer (int32)",
    "coreAccountId": "00000000-0000-0000-0000-000000000000",
    "modifyDate": "string (date)",
    "createDate": "string (date)",
    "actionStatus": "string",
    "accountId": "integer (int32)",
    "title": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "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)",
  "bankImportIntegrationTokenId": "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)",
    "remainderOperationId": "integer (int32)",
    "bankImportIntegrationTokenId": "integer (int32)",
    "bankImportIntegrationTokenBankId": "integer (int32)",
    "coreAccountId": "00000000-0000-0000-0000-000000000000",
    "modifyDate": "string (date)",
    "createDate": "string (date)",
    "actionStatus": "string",
    "accountId": "integer (int32)",
    "title": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "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",
  "errorCode": "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, THB, HUF, CZK, HRK

Код валюты

filter.active
in query
boolean

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

filter.changesFromDate
in query
string (date)

Начальная дата изменений

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)",
        "remainderOperationId": "integer (int32)",
        "bankImportIntegrationTokenId": "integer (int32)",
        "bankImportIntegrationTokenBankId": "integer (int32)",
        "coreAccountId": "00000000-0000-0000-0000-000000000000",
        "modifyDate": "string (date)",
        "createDate": "string (date)",
        "actionStatus": "string",
        "accountId": "integer (int32)",
        "title": "string"
      }
    ],
    "total": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "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)",
    "remainderOperationId": "integer (int32)",
    "bankImportIntegrationTokenId": "integer (int32)",
    "bankImportIntegrationTokenBankId": "integer (int32)",
    "coreAccountId": "00000000-0000-0000-0000-000000000000",
    "modifyDate": "string (date)",
    "createDate": "string (date)",
    "actionStatus": "string",
    "accountId": "integer (int32)",
    "title": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

AccountToContragentTransformationTasks

Получение списка задач

GET /api/v1/accounttocontragenttransformationtasks
filter.state
in query
string None, InProgress, Done, Error

Текущий статус задания преобразования

filter.accountId
in query
integer (int32)

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

filter.contrAgentId
in query
integer (int32)

Идентификатор контрагента, в которого происходит трансформация

paging.offset
in query
integer (int32)

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

paging.limit
in query
integer (int32)

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

sorting.field
in query
string AccountId, State

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

sorting.direction
in query
string Asc, Desc

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

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "items": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "businessId": "00000000-0000-0000-0000-000000000000",
        "percent": "integer (int32)",
        "state": "string"
      }
    ],
    "total": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

Преобразование счета в контрагента

POST /api/v1/accounttocontragenttransformationtasks

Атрибуты для преобразования счета в контрагента

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "accountId": "integer (int32)",
  "title": "string"
}

OK

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

Получение статуса трансформации счета

GET /api/v1/accounttocontragenttransformationtasks/{guid}
guid
in path
string (uuid)

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

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "businessId": "00000000-0000-0000-0000-000000000000",
    "percent": "integer (int32)",
    "state": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

Удаление задания

DELETE /api/v1/accounttocontragenttransformationtasks/{guid}
guid
in path
string (uuid)

(no description)

200 OK

OK

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

BizInfos

Получение истории изменений на счетах

GET /api/v1/bizinfos/accountshistory
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": [
    {
      "accountId": "integer (int32)",
      "details": [
        {
          "date": "string (date)",
          "factValue": "number (double)",
          "planValue": "number (double)",
          "count": "integer (int32)",
          "notComittedCount": "integer (int32)"
        }
      ]
    }
  ],
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

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

GET /api/v1/bizinfos/layoutinfo
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "firstName": "string",
    "accessAlert": "string",
    "hasAccess": "boolean",
    "isReadOnly": "boolean"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

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

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

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

filter.periodEndDate
in query
string (date)

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

filter.isCalculation
in query
boolean

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

filter.accountId
in query
integer[]

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

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

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

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

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

Array values passed as multiple parameters: ?filter.operationCategoryId=aaa&filter.operationCategoryId=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": [
    {
      "accountId": "integer (int32)",
      "details": [
        {
          "date": "string (date)",
          "factValue": "number (double)",
          "planValue": "number (double)",
          "operationCategoryId": "integer (int32)",
          "projectId": "integer (int32)",
          "contrAgentId": "integer (int32)",
          "operationTypeId": "integer (int32)"
        }
      ]
    }
  ],
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

Получение истории поступлений/выплат сгруппированной по статьям

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

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

filter.periodEndDate
in query
string (date)

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

filter.isCalculation
in query
boolean

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

filter.accountId
in query
integer[]

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

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

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

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

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

Array values passed as multiple parameters: ?filter.operationCategoryId=aaa&filter.operationCategoryId=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": [
    {
      "operationCategoryId": "integer (int32)",
      "details": [
        {
          "date": "string (date)",
          "factValue": "number (double)",
          "planValue": "number (double)",
          "accountId": "integer (int32)",
          "projectId": "integer (int32)",
          "contrAgentId": "integer (int32)",
          "operationTypeId": "integer (int32)"
        }
      ]
    }
  ],
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

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

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

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

filter.periodEndDate
in query
string (date)

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

filter.isCalculation
in query
boolean

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

filter.accountId
in query
integer[]

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

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

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

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

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

Array values passed as multiple parameters: ?filter.operationCategoryId=aaa&filter.operationCategoryId=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": [
    {
      "projectId": "integer (int32)",
      "details": [
        {
          "date": "string (date)",
          "factValue": "number (double)",
          "planValue": "number (double)",
          "operationCategoryId": "integer (int32)",
          "accountId": "integer (int32)",
          "contrAgentId": "integer (int32)",
          "operationTypeId": "integer (int32)"
        }
      ]
    }
  ],
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

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

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

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

filter.periodEndDate
in query
string (date)

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

filter.isCalculation
in query
boolean

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

filter.accountId
in query
integer[]

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

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

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

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

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

Array values passed as multiple parameters: ?filter.operationCategoryId=aaa&filter.operationCategoryId=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": [
    {
      "contrAgentId": "integer (int32)",
      "details": [
        {
          "date": "string (date)",
          "factValue": "number (double)",
          "planValue": "number (double)",
          "operationCategoryId": "integer (int32)",
          "accountId": "integer (int32)",
          "projectId": "integer (int32)",
          "operationTypeId": "integer (int32)"
        }
      ]
    }
  ],
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "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",
    "modifyDate": "string (date)",
    "createDate": "string (date)",
    "actionStatus": "string",
    "companyId": "integer (int32)",
    "title": "string",
    "externalId": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "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",
    "modifyDate": "string (date)",
    "createDate": "string (date)",
    "actionStatus": "string",
    "companyId": "integer (int32)",
    "title": "string",
    "externalId": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "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",
  "errorCode": "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
filter.changesFromDate
in query
string (date)

Начальная дата изменений

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",
        "modifyDate": "string (date)",
        "createDate": "string (date)",
        "actionStatus": "string",
        "companyId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      }
    ],
    "total": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "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",
    "modifyDate": "string (date)",
    "createDate": "string (date)",
    "actionStatus": "string",
    "companyId": "integer (int32)",
    "title": "string",
    "externalId": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

ContrAgentConsolidationTasks

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

GET /api/v1/contragentConsolidationTasks
filter.state
in query
string None, InProgress, Done, Error

Текущий статус задания объединения

filter.masterContrAgentId
in query
integer (int32)

Идентификатор контрагента, в которого происходит объединение

paging.offset
in query
integer (int32)

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

paging.limit
in query
integer (int32)

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

sorting.field
in query
string MasterContrAgentId, State

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

sorting.direction
in query
string Asc, Desc

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

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "items": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "businessId": "00000000-0000-0000-0000-000000000000",
        "percent": "integer (int32)",
        "errorMessage": "string",
        "state": "string"
      }
    ],
    "total": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

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

POST /api/v1/contragentConsolidationTasks

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

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "masterContrAgentId": "integer (int32)",
  "consolidateContrAgentIds": [
    "integer (int32)"
  ]
}

OK

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

Получение статуса задания на объединение контрагентов

GET /api/v1/contragentConsolidationTasks/{taskGuid}
taskGuid
in path
string (uuid)

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

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "businessId": "00000000-0000-0000-0000-000000000000",
    "percent": "integer (int32)",
    "errorMessage": "string",
    "state": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

Удаление задания

DELETE /api/v1/contragentConsolidationTasks/{taskGuid}
taskGuid
in path
string (uuid)

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

200 OK

OK

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "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)",
    "balanceFact": "number (double)",
    "currencyCode": "string",
    "modifyDate": "string (date)",
    "createDate": "string (date)",
    "actionStatus": "string",
    "canTransformedToAgent": "boolean",
    "contrAgentId": "integer (int32)",
    "title": "string",
    "externalId": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "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)",
    "balanceFact": "number (double)",
    "currencyCode": "string",
    "modifyDate": "string (date)",
    "createDate": "string (date)",
    "actionStatus": "string",
    "canTransformedToAgent": "boolean",
    "contrAgentId": "integer (int32)",
    "title": "string",
    "externalId": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "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",
  "errorCode": "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)",
    "balanceFact": "number (double)",
    "currencyCode": "string",
    "modifyDate": "string (date)",
    "createDate": "string (date)",
    "actionStatus": "string",
    "canTransformedToAgent": "boolean",
    "contrAgentId": "integer (int32)",
    "title": "string",
    "externalId": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "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

Статус

filter.changesFromDate
in query
string (date)

Начальная дата изменений

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)",
        "balanceFact": "number (double)",
        "currencyCode": "string",
        "modifyDate": "string (date)",
        "createDate": "string (date)",
        "actionStatus": "string",
        "canTransformedToAgent": "boolean",
        "contrAgentId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      }
    ],
    "total": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "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)",
    "balanceFact": "number (double)",
    "currencyCode": "string",
    "modifyDate": "string (date)",
    "createDate": "string (date)",
    "actionStatus": "string",
    "canTransformedToAgent": "boolean",
    "contrAgentId": "integer (int32)",
    "title": "string",
    "externalId": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "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

Статус

filter.changesFromDate
in query
string (date)

Начальная дата изменений

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)",
        "balanceFact": "number (double)",
        "currencyCode": "string",
        "modifyDate": "string (date)",
        "createDate": "string (date)",
        "actionStatus": "string",
        "canTransformedToAgent": "boolean",
        "contrAgentId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      }
    ],
    "total": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

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

GET /api/v1/contragents/calculations
calculationListRequest.contrAgentId
in query
integer[]

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

Array values passed as multiple parameters: ?calculationListRequest.contrAgentId=aaa&calculationListRequest.contrAgentId=bbb
200 OK

OK

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

ContragentToAccountTransformationTasks

Получение списка задач

GET /api/v1/contragentToAccountTransformationTasks
filter.state
in query
string None, InProgress, Done, Error

Текущий статус задания преобразования

filter.contrAgentId
in query
integer (int32)

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

paging.offset
in query
integer (int32)

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

paging.limit
in query
integer (int32)

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

sorting.field
in query
string ContrAgentId, State

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

sorting.direction
in query
string Asc, Desc

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

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "items": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "businessId": "00000000-0000-0000-0000-000000000000",
        "percent": "integer (int32)",
        "errorMessage": "string",
        "state": "string"
      }
    ],
    "total": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

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

GET /api/v1/contragentToAccountTransformationTasks/{taskGuid}
taskGuid
in path
string (uuid)

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

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "businessId": "00000000-0000-0000-0000-000000000000",
    "percent": "integer (int32)",
    "errorMessage": "string",
    "state": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

Удаление задания

DELETE /api/v1/contragentToAccountTransformationTasks/{taskGuid}
taskGuid
in path
string (uuid)

(no description)

200 OK

OK

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

Преобразование контрагента в счет

POST /api/v1/contragentToAccountTransformationTasks/{contrAgentId}
contrAgentId
in path
integer (int32)

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

OK

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

CoreApi

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

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

(no description)

filter.toDate
in query
string (date)

(no description)

filter.companyId
in query
integer[]

(no description)

Array values passed as multiple parameters: ?filter.companyId=aaa&filter.companyId=bbb
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",
  "errorCode": "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",
  "errorCode": "string"
}

ExportDataTasks

Получение статуса задачи экспорта данных

GET /api/v1/export-data/xlsx/{taskGuid}
taskGuid
in path
string (uuid)

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

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "businessId": "00000000-0000-0000-0000-000000000000",
    "percent": "integer (int32)",
    "filePath": "string",
    "state": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

Удаление задания

DELETE /api/v1/export-data/xlsx/{taskGuid}
taskGuid
in path
string (uuid)

(no description)

200 OK

OK

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

Экспортирование данных в xlsx

POST /api/v1/export-data/xlsx

Запрос

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "fileName": "string",
  "columns": [
    {
      "width": "integer (int32)"
    }
  ],
  "rows": [
    {
      "level": "integer (int32)",
      "cells": [
        {
          "value": "string",
          "type": "string",
          "reference": "string",
          "formula": "string",
          "style": "integer (int32)"
        }
      ]
    }
  ],
  "cellStyles": [
    {
      "horizontalAlignment": "string",
      "font": {
        "bold": "boolean",
        "fontSize": "number (double)",
        "color": "string"
      },
      "border": {
        "color": "string",
        "top": "boolean",
        "right": "boolean",
        "bottom": "boolean",
        "left": "boolean"
      }
    }
  ]
}

OK

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

ExportOperationsTasks

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

GET /api/v1/export/{taskGuid}
taskGuid
in path
string (uuid)

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

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "businessId": "00000000-0000-0000-0000-000000000000",
    "percent": "integer (int32)",
    "filePath": "string",
    "state": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

Удаление задания

DELETE /api/v1/export/{taskGuid}
taskGuid
in path
string (uuid)

(no description)

200 OK

OK

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

Экспортирование операций в csv

POST /api/v1/export/csv
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "operationDateStart": "string (date)",
  "operationDateEnd": "string (date)",
  "calculationPeriodDateStart": "string (date)",
  "calculationPeriodDateEnd": "string (date)",
  "withoutContrAgentId": "boolean",
  "contrAgentId": [
    "integer (int32)"
  ],
  "accountId": [
    "integer (int32)"
  ],
  "accountCompanyId": [
    "integer (int32)"
  ],
  "operationType": [
    "string"
  ],
  "operationCategoryActivityType": "string",
  "operationCategoryId": [
    "integer (int32)"
  ],
  "valueMin": "number (double)",
  "valueMax": "number (double)",
  "withoutProjectId": "boolean",
  "projectId": [
    "integer (int32)"
  ],
  "isCommitted": "boolean",
  "isCalculationCommitted": "boolean",
  "externalId": [
    "string"
  ],
  "importLogId": [
    "integer (int32)"
  ],
  "boundMoveOperationId": [
    "integer (int32)"
  ],
  "searchString": "string",
  "sortingField": "string",
  "sortingDirection": "string"
}

OK

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

Экспортирование операций в xlsx

POST /api/v1/export/xlsx
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "operationDateStart": "string (date)",
  "operationDateEnd": "string (date)",
  "calculationPeriodDateStart": "string (date)",
  "calculationPeriodDateEnd": "string (date)",
  "withoutContrAgentId": "boolean",
  "contrAgentId": [
    "integer (int32)"
  ],
  "accountId": [
    "integer (int32)"
  ],
  "accountCompanyId": [
    "integer (int32)"
  ],
  "operationType": [
    "string"
  ],
  "operationCategoryActivityType": "string",
  "operationCategoryId": [
    "integer (int32)"
  ],
  "valueMin": "number (double)",
  "valueMax": "number (double)",
  "withoutProjectId": "boolean",
  "projectId": [
    "integer (int32)"
  ],
  "isCommitted": "boolean",
  "isCalculationCommitted": "boolean",
  "externalId": [
    "string"
  ],
  "importLogId": [
    "integer (int32)"
  ],
  "boundMoveOperationId": [
    "integer (int32)"
  ],
  "searchString": "string",
  "sortingField": "string",
  "sortingDirection": "string"
}

OK

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": "00000000-0000-0000-0000-000000000000",
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "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",
  "errorCode": "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",
    "outcomeClassification": "string",
    "parentOperationCategoryId": "integer (int32)",
    "sort": "integer (int32)",
    "isVisible": "boolean",
    "isFixed": "boolean",
    "accountCategoryType": "string",
    "coreAccountId": "00000000-0000-0000-0000-000000000000",
    "modifyDate": "string (date)",
    "createDate": "string (date)",
    "actionStatus": "string",
    "operationCategoryId": "integer (int32)",
    "title": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "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",
  "outcomeClassification": "string",
  "parentOperationCategoryId": "integer (int32)",
  "sort": "integer (int32)"
}
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "operationCategoryType": "string",
    "activityType": "string",
    "outcomeClassification": "string",
    "parentOperationCategoryId": "integer (int32)",
    "sort": "integer (int32)",
    "isVisible": "boolean",
    "isFixed": "boolean",
    "accountCategoryType": "string",
    "coreAccountId": "00000000-0000-0000-0000-000000000000",
    "modifyDate": "string (date)",
    "createDate": "string (date)",
    "actionStatus": "string",
    "operationCategoryId": "integer (int32)",
    "title": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "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",
  "errorCode": "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)

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

filter.changesFromDate
in query
string (date)

Начальная дата изменений

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",
        "outcomeClassification": "string",
        "parentOperationCategoryId": "integer (int32)",
        "sort": "integer (int32)",
        "isVisible": "boolean",
        "isFixed": "boolean",
        "accountCategoryType": "string",
        "coreAccountId": "00000000-0000-0000-0000-000000000000",
        "modifyDate": "string (date)",
        "createDate": "string (date)",
        "actionStatus": "string",
        "operationCategoryId": "integer (int32)",
        "title": "string"
      }
    ],
    "total": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "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",
  "outcomeClassification": "string",
  "parentOperationCategoryId": "integer (int32)",
  "sort": "integer (int32)"
}
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "operationCategoryType": "string",
    "activityType": "string",
    "outcomeClassification": "string",
    "parentOperationCategoryId": "integer (int32)",
    "sort": "integer (int32)",
    "isVisible": "boolean",
    "isFixed": "boolean",
    "accountCategoryType": "string",
    "coreAccountId": "00000000-0000-0000-0000-000000000000",
    "modifyDate": "string (date)",
    "createDate": "string (date)",
    "actionStatus": "string",
    "operationCategoryId": "integer (int32)",
    "title": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

Operations

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

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

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

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "boundMoveOperation": {
      "operationId": "integer (int32)",
      "operationType": "string",
      "operationDate": "string (date)",
      "calculationPeriodDate": "string (date)",
      "isCalculationCommitted": "boolean",
      "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"
      ],
      "modifyDate": "string (date)",
      "createDate": "string (date)",
      "actionStatus": "string"
    },
    "operationId": "integer (int32)",
    "operationType": "string",
    "operationDate": "string (date)",
    "calculationPeriodDate": "string (date)",
    "isCalculationCommitted": "boolean",
    "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": [
      null
    ]
  }
}

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

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",
  "errorCode": "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.withoutContrAgentId
in query
boolean

Без контрагента

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.withoutProjectId
in query
boolean

Без проектов

filter.projectId
in query
integer[]

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

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

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

filter.isCalculationCommitted
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

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

  • Комментарий
  • Название контрагента
  • Название счета
  • Название компании
  • Название статьи
filter.changesFromDate
in query
string (date)

Начальная дата изменений

filter.disableNavigationProperties
in query
boolean

Отключить загрузку свойств навигации

filter.groupMoveOperations
in query
boolean

Cгруппировать перемещения

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, OperationType, Value, Project

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

sorting.direction
in query
string Asc, Desc

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

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "items": [
      {
        "boundMoveOperation": {
          "operationId": "integer (int32)",
          "operationType": "string",
          "operationDate": "string (date)",
          "calculationPeriodDate": "string (date)",
          "isCalculationCommitted": "boolean",
          "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"
          ],
          "modifyDate": "string (date)",
          "createDate": "string (date)",
          "actionStatus": "string"
        },
        "operationId": "integer (int32)",
        "operationType": "string",
        "operationDate": "string (date)",
        "calculationPeriodDate": "string (date)",
        "isCalculationCommitted": "boolean",
        "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)"
      }
    ]
  }
}

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

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)",
  "isCalculationCommitted": "boolean",
  "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": {
    "boundMoveOperation": {
      "operationId": "integer (int32)",
      "operationType": "string",
      "operationDate": "string (date)",
      "calculationPeriodDate": "string (date)",
      "isCalculationCommitted": "boolean",
      "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"
      ],
      "modifyDate": "string (date)",
      "createDate": "string (date)",
      "actionStatus": "string"
    },
    "operationId": "integer (int32)",
    "operationType": "string",
    "operationDate": "string (date)",
    "calculationPeriodDate": "string (date)",
    "isCalculationCommitted": "boolean",
    "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": [
      null
    ]
  }
}

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

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)",
  "isCalculationCommitted": "boolean",
  "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": {
    "boundMoveOperation": {
      "operationId": "integer (int32)",
      "operationType": "string",
      "operationDate": "string (date)",
      "calculationPeriodDate": "string (date)",
      "isCalculationCommitted": "boolean",
      "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"
      ],
      "modifyDate": "string (date)",
      "createDate": "string (date)",
      "actionStatus": "string"
    },
    "operationId": "integer (int32)",
    "operationType": "string",
    "operationDate": "string (date)",
    "calculationPeriodDate": "string (date)",
    "isCalculationCommitted": "boolean",
    "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": [
      null
    ]
  }
}

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

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": [
    {
      "boundMoveOperation": {
        "operationId": "integer (int32)",
        "operationType": "string",
        "operationDate": "string (date)",
        "calculationPeriodDate": "string (date)",
        "isCalculationCommitted": "boolean",
        "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"
        ],
        "modifyDate": "string (date)",
        "createDate": "string (date)",
        "actionStatus": "string"
      },
      "operationId": "integer (int32)",
      "operationType": "string",
      "operationDate": "string (date)",
      "calculationPeriodDate": "string (date)",
      "isCalculationCommitted": "boolean",
      "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)"
    }
  ]
}

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

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)",
  "isCalculationCommitted": "boolean",
  "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": {
    "boundMoveOperation": {
      "operationId": "integer (int32)",
      "operationType": "string",
      "operationDate": "string (date)",
      "calculationPeriodDate": "string (date)",
      "isCalculationCommitted": "boolean",
      "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"
      ],
      "modifyDate": "string (date)",
      "createDate": "string (date)",
      "actionStatus": "string"
    },
    "operationId": "integer (int32)",
    "operationType": "string",
    "operationDate": "string (date)",
    "calculationPeriodDate": "string (date)",
    "isCalculationCommitted": "boolean",
    "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": [
      null
    ]
  }
}

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

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)",
  "isCalculationCommitted": "boolean",
  "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": {
    "boundMoveOperation": {
      "operationId": "integer (int32)",
      "operationType": "string",
      "operationDate": "string (date)",
      "calculationPeriodDate": "string (date)",
      "isCalculationCommitted": "boolean",
      "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"
      ],
      "modifyDate": "string (date)",
      "createDate": "string (date)",
      "actionStatus": "string"
    },
    "operationId": "integer (int32)",
    "operationType": "string",
    "operationDate": "string (date)",
    "calculationPeriodDate": "string (date)",
    "isCalculationCommitted": "boolean",
    "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": [
      null
    ]
  }
}

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

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": [
    {
      "boundMoveOperation": {
        "operationId": "integer (int32)",
        "operationType": "string",
        "operationDate": "string (date)",
        "calculationPeriodDate": "string (date)",
        "isCalculationCommitted": "boolean",
        "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"
        ],
        "modifyDate": "string (date)",
        "createDate": "string (date)",
        "actionStatus": "string"
      },
      "operationId": "integer (int32)",
      "operationType": "string",
      "operationDate": "string (date)",
      "calculationPeriodDate": "string (date)",
      "isCalculationCommitted": "boolean",
      "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)"
    }
  ]
}

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

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": [
      {
        "boundMoveOperation": {
          "operationId": "integer (int32)",
          "operationType": "string",
          "operationDate": "string (date)",
          "calculationPeriodDate": "string (date)",
          "isCalculationCommitted": "boolean",
          "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"
          ],
          "modifyDate": "string (date)",
          "createDate": "string (date)",
          "actionStatus": "string"
        },
        "operationId": "integer (int32)",
        "operationType": "string",
        "operationDate": "string (date)",
        "calculationPeriodDate": "string (date)",
        "isCalculationCommitted": "boolean",
        "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)"
      }
    ]
  }
}

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

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

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

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "operations": [
      {
        "boundMoveOperation": {
          "operationId": "integer (int32)",
          "operationType": "string",
          "operationDate": "string (date)",
          "calculationPeriodDate": "string (date)",
          "isCalculationCommitted": "boolean",
          "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"
          ],
          "modifyDate": "string (date)",
          "createDate": "string (date)",
          "actionStatus": "string"
        },
        "operationId": "integer (int32)",
        "operationType": "string",
        "operationDate": "string (date)",
        "calculationPeriodDate": "string (date)",
        "isCalculationCommitted": "boolean",
        "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)"
      }
    ]
  }
}

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

GET /api/v1/operations/summary
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.withoutContrAgentId
in query
boolean

Без контрагента

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.operationType
in query
string[]

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

Array values passed as multiple parameters: ?filter.operationType=aaa&filter.operationType=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.withoutProjectId
in query
boolean

Без проектов

filter.projectId
in query
integer[]

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

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

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

filter.isCalculationCommitted
in query
boolean

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

filter.importLogId
in query
integer[]

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

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

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

  • Комментарий
  • Название контрагента
  • Название счета
  • Название компании
  • Название статьи
filter.showTotalAmountForFilteredProjects
in query
boolean

Суммы по фильтруемым проектам

Response Content-Types: application/json, text/json
Response Example (200 OK)
{
  "data": {
    "incomeCount": "integer (int32)",
    "incomeAmount": "number (double)",
    "outcomeCount": "integer (int32)",
    "outcomeAmount": "number (double)",
    "moveCount": "integer (int32)",
    "moveAmount": "number (double)",
    "firstOperationDate": "string (date)",
    "lastOperationDate": "string (date)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "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)",
    "sumOfIncomeFact": "number (double)",
    "sumOfOutcomeFact": "number (double)",
    "sumOfIncomePlan": "number (double)",
    "sumOfOutcomePlan": "number (double)",
    "balanceFact": "number (double)",
    "balancePlan": "number (double)",
    "percentOfDifferenceFact": "number (double)",
    "percentOfDifferencePlan": "number (double)",
    "currencyCode": "string",
    "modifyDate": "string (date)",
    "createDate": "string (date)",
    "actionStatus": "string",
    "projectId": "integer (int32)",
    "title": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "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)",
    "sumOfIncomeFact": "number (double)",
    "sumOfOutcomeFact": "number (double)",
    "sumOfIncomePlan": "number (double)",
    "sumOfOutcomePlan": "number (double)",
    "balanceFact": "number (double)",
    "balancePlan": "number (double)",
    "percentOfDifferenceFact": "number (double)",
    "percentOfDifferencePlan": "number (double)",
    "currencyCode": "string",
    "modifyDate": "string (date)",
    "createDate": "string (date)",
    "actionStatus": "string",
    "projectId": "integer (int32)",
    "title": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "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",
  "errorCode": "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)",
    "sumOfIncomeFact": "number (double)",
    "sumOfOutcomeFact": "number (double)",
    "sumOfIncomePlan": "number (double)",
    "sumOfOutcomePlan": "number (double)",
    "balanceFact": "number (double)",
    "balancePlan": "number (double)",
    "percentOfDifferenceFact": "number (double)",
    "percentOfDifferencePlan": "number (double)",
    "currencyCode": "string",
    "modifyDate": "string (date)",
    "createDate": "string (date)",
    "actionStatus": "string",
    "projectId": "integer (int32)",
    "title": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "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

Статус

filter.changesFromDate
in query
string (date)

Начальная дата изменений

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)",
        "sumOfIncomeFact": "number (double)",
        "sumOfOutcomeFact": "number (double)",
        "sumOfIncomePlan": "number (double)",
        "sumOfOutcomePlan": "number (double)",
        "balanceFact": "number (double)",
        "balancePlan": "number (double)",
        "percentOfDifferenceFact": "number (double)",
        "percentOfDifferencePlan": "number (double)",
        "currencyCode": "string",
        "modifyDate": "string (date)",
        "createDate": "string (date)",
        "actionStatus": "string",
        "projectId": "integer (int32)",
        "title": "string"
      }
    ],
    "total": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "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)",
    "sumOfIncomeFact": "number (double)",
    "sumOfOutcomeFact": "number (double)",
    "sumOfIncomePlan": "number (double)",
    "sumOfOutcomePlan": "number (double)",
    "balanceFact": "number (double)",
    "balancePlan": "number (double)",
    "percentOfDifferenceFact": "number (double)",
    "percentOfDifferencePlan": "number (double)",
    "currencyCode": "string",
    "modifyDate": "string (date)",
    "createDate": "string (date)",
    "actionStatus": "string",
    "projectId": "integer (int32)",
    "title": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "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

Статус

filter.changesFromDate
in query
string (date)

Начальная дата изменений

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)",
        "sumOfIncomeFact": "number (double)",
        "sumOfOutcomeFact": "number (double)",
        "sumOfIncomePlan": "number (double)",
        "sumOfOutcomePlan": "number (double)",
        "balanceFact": "number (double)",
        "balancePlan": "number (double)",
        "percentOfDifferenceFact": "number (double)",
        "percentOfDifferencePlan": "number (double)",
        "currencyCode": "string",
        "modifyDate": "string (date)",
        "createDate": "string (date)",
        "actionStatus": "string",
        "projectId": "integer (int32)",
        "title": "string"
      }
    ],
    "total": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "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",
    "showCalculationPeriod": "boolean",
    "showCalculationPeriodFilter": "boolean",
    "showCalculationPeriodFilterCanChanged": "boolean",
    "outcomeOperationCategoryClassificationType": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "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",
  "showCalculationPeriod": "boolean",
  "showCalculationPeriodFilter": "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",
    "showCalculationPeriod": "boolean",
    "showCalculationPeriodFilter": "boolean",
    "showCalculationPeriodFilterCanChanged": "boolean",
    "outcomeOperationCategoryClassificationType": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "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

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

errorCode: string None, AccountAccessDenied, ProjectAccessDenied, InvalidOperationDate, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle

Код ошибки

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

Response[AccountModel]: object

Ответ

data: AccountModel

Данные

isSuccess: boolean

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

errorMessage: string

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

errorCode: string None, AccountAccessDenied, ProjectAccessDenied, InvalidOperationDate, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle

Код ошибки

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)",
    "remainderOperationId": "integer (int32)",
    "bankImportIntegrationTokenId": "integer (int32)",
    "bankImportIntegrationTokenBankId": "integer (int32)",
    "coreAccountId": "00000000-0000-0000-0000-000000000000",
    "modifyDate": "string (date)",
    "createDate": "string (date)",
    "actionStatus": "string",
    "accountId": "integer (int32)",
    "title": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "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, THB, HUF, CZK, HRK

Код валюты

longTitle: string

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

description: string

Описание

accountAcct: string

Номер

accountBik: string

БИК

accountBank: string

Банк

currencyTitle: string

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

active: boolean

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

remainder: number (double)

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

remainderOperationId: integer (int32)

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

bankImportIntegrationTokenId: integer (int32)

Id токена интеграции с банком

bankImportIntegrationTokenBankId: integer (int32)

Id банка с которым интегрируется счет

coreAccountId: string (uuid)

Id в плане счетов

modifyDate: string (date)

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

createDate: string (date)

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

actionStatus: string None, Updated, Deleted

Статус последнего действия

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)",
  "remainderOperationId": "integer (int32)",
  "bankImportIntegrationTokenId": "integer (int32)",
  "bankImportIntegrationTokenBankId": "integer (int32)",
  "coreAccountId": "00000000-0000-0000-0000-000000000000",
  "modifyDate": "string (date)",
  "createDate": "string (date)",
  "actionStatus": "string",
  "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, THB, HUF, CZK, HRK

Код валюты

active: boolean

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

remainder: number (double)

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

remainderDate: string (date)

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

bankImportIntegrationTokenId: integer (int32)

Id токена интеграции с банком

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)",
  "bankImportIntegrationTokenId": "integer (int32)"
}

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, THB, HUF, CZK, HRK

Код валюты

active: boolean

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

changesFromDate: string (date)

Начальная дата изменений

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

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

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

errorCode: string None, AccountAccessDenied, ProjectAccessDenied, InvalidOperationDate, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle

Код ошибки

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)",
        "remainderOperationId": "integer (int32)",
        "bankImportIntegrationTokenId": "integer (int32)",
        "bankImportIntegrationTokenBankId": "integer (int32)",
        "coreAccountId": "00000000-0000-0000-0000-000000000000",
        "modifyDate": "string (date)",
        "createDate": "string (date)",
        "actionStatus": "string",
        "accountId": "integer (int32)",
        "title": "string"
      }
    ],
    "total": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "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)",
      "remainderOperationId": "integer (int32)",
      "bankImportIntegrationTokenId": "integer (int32)",
      "bankImportIntegrationTokenBankId": "integer (int32)",
      "coreAccountId": "00000000-0000-0000-0000-000000000000",
      "modifyDate": "string (date)",
      "createDate": "string (date)",
      "actionStatus": "string",
      "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, THB, HUF, CZK, HRK

Код валюты

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)"
}

AccountToContrAgentTransformationListRequest: object

Запрос списка заданий на преобразование счетов в контрагентов

state: string None, InProgress, Done, Error

Текущий статус задания преобразования

accountId: integer (int32)

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

contrAgentId: integer (int32)

Идентификатор контрагента, в которого происходит трансформация

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

Sorting[AccountToContrAgentTransformsSortingFields]: object

Сортировка

field: string AccountId, State

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

direction: string Asc, Desc

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

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

Response[ListModel[AccountToContrAgentTransformationModel]]: object

Ответ

data: ListModel[AccountToContrAgentTransformationModel]

Данные

isSuccess: boolean

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

errorMessage: string

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

errorCode: string None, AccountAccessDenied, ProjectAccessDenied, InvalidOperationDate, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle

Код ошибки

Example
{
  "data": {
    "items": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "businessId": "00000000-0000-0000-0000-000000000000",
        "percent": "integer (int32)",
        "state": "string"
      }
    ],
    "total": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

ListModel[AccountToContrAgentTransformationModel]: object

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

items: AccountToContrAgentTransformationModel

Элементы

total: integer (int32)

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

Example
{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "businessId": "00000000-0000-0000-0000-000000000000",
      "percent": "integer (int32)",
      "state": "string"
    }
  ],
  "total": "integer (int32)"
}

AccountToContrAgentTransformationModel: object

Модель сведений о преобразовании счета в контрагента

id: string (uuid)

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

businessId: string (uuid)

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

percent: integer (int32)

Процент выполнения

state: string None, InProgress, Done, Error

Текущий статус задания преобразования

Example
{
  "id": "00000000-0000-0000-0000-000000000000",
  "businessId": "00000000-0000-0000-0000-000000000000",
  "percent": "integer (int32)",
  "state": "string"
}

AccountToContrAgentTransformationRequest: object

Запрос на создание задания на преобразование счета в контрагента

accountId: integer (int32)

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

title: string (up to 256 chars)

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

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

Response[Guid]: object

Ответ

data: string (uuid)

Данные

isSuccess: boolean

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

errorMessage: string

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

errorCode: string None, AccountAccessDenied, ProjectAccessDenied, InvalidOperationDate, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle

Код ошибки

Example
{
  "data": "00000000-0000-0000-0000-000000000000",
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

Response[AccountToContrAgentTransformationModel]: object

Ответ

data: AccountToContrAgentTransformationModel

Данные

isSuccess: boolean

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

errorMessage: string

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

errorCode: string None, AccountAccessDenied, ProjectAccessDenied, InvalidOperationDate, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle

Код ошибки

Example
{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "businessId": "00000000-0000-0000-0000-000000000000",
    "percent": "integer (int32)",
    "state": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

Response[IEnumerable[AccountsHistoryModel]]: object

Ответ

data: AccountsHistoryModel

Данные

isSuccess: boolean

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

errorMessage: string

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

errorCode: string None, AccountAccessDenied, ProjectAccessDenied, InvalidOperationDate, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle

Код ошибки

Example
{
  "data": [
    {
      "accountId": "integer (int32)",
      "details": [
        {
          "date": "string (date)",
          "factValue": "number (double)",
          "planValue": "number (double)",
          "count": "integer (int32)",
          "notComittedCount": "integer (int32)"
        }
      ]
    }
  ],
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

AccountsHistoryModel: object

Модель изменений остатков на счете

accountId: integer (int32)

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

details: AccountsHistoryItemModel

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

Example
{
  "accountId": "integer (int32)",
  "details": [
    {
      "date": "string (date)",
      "factValue": "number (double)",
      "planValue": "number (double)",
      "count": "integer (int32)",
      "notComittedCount": "integer (int32)"
    }
  ]
}

AccountsHistoryItemModel: object

Описание изменения остатка на счете

date: string (date)

Дата изменения

factValue: number (double)

Величина изменений типа "Факт" на счете

planValue: number (double)

Величина изменений типа "План" на счете

count: integer (int32)

Количество операций за дату

notComittedCount: integer (int32)

Количество неподтвержденных операций за дату

Example
{
  "date": "string (date)",
  "factValue": "number (double)",
  "planValue": "number (double)",
  "count": "integer (int32)",
  "notComittedCount": "integer (int32)"
}

Response[LayoutInfoModel]: object

Ответ

data: LayoutInfoModel

Данные

isSuccess: boolean

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

errorMessage: string

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

errorCode: string None, AccountAccessDenied, ProjectAccessDenied, InvalidOperationDate, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle

Код ошибки

Example
{
  "data": {
    "firstName": "string",
    "accessAlert": "string",
    "hasAccess": "boolean",
    "isReadOnly": "boolean"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

LayoutInfoModel: object

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

firstName: string

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

accessAlert: string

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

hasAccess: boolean

Информация о наличии активной оплаты

isReadOnly: boolean

Информация о read-only доступе

Example
{
  "firstName": "string",
  "accessAlert": "string",
  "hasAccess": "boolean",
  "isReadOnly": "boolean"
}

IncomeOutcomeAccountHistoryRequest: object

Запрос истории поступлений/выплат сгруппированный по счетам

periodStartDate: string (date)

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

periodEndDate: string (date)

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

isCalculation: boolean

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

accountId: integer[]

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

contrAgentId: integer[]

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

operationCategoryId: integer[]

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

projectId: integer[]

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

Example
{
  "periodStartDate": "string (date)",
  "periodEndDate": "string (date)",
  "isCalculation": "boolean",
  "accountId": [
    "integer (int32)"
  ],
  "contrAgentId": [
    "integer (int32)"
  ],
  "operationCategoryId": [
    "integer (int32)"
  ],
  "projectId": [
    "integer (int32)"
  ]
}

Response[IEnumerable[IncomeOutcomeAccountModel]]: object

Ответ

data: IncomeOutcomeAccountModel

Данные

isSuccess: boolean

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

errorMessage: string

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

errorCode: string None, AccountAccessDenied, ProjectAccessDenied, InvalidOperationDate, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle

Код ошибки

Example
{
  "data": [
    {
      "accountId": "integer (int32)",
      "details": [
        {
          "date": "string (date)",
          "factValue": "number (double)",
          "planValue": "number (double)",
          "operationCategoryId": "integer (int32)",
          "projectId": "integer (int32)",
          "contrAgentId": "integer (int32)",
          "operationTypeId": "integer (int32)"
        }
      ]
    }
  ],
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

IncomeOutcomeAccountModel: object

Модель поступлений/выплат по дням

accountId: integer (int32)

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

details: IncomeOutcomeAccountItemModel

Сведения о поступлениях/выплатах за день

Example
{
  "accountId": "integer (int32)",
  "details": [
    {
      "date": "string (date)",
      "factValue": "number (double)",
      "planValue": "number (double)",
      "operationCategoryId": "integer (int32)",
      "projectId": "integer (int32)",
      "contrAgentId": "integer (int32)",
      "operationTypeId": "integer (int32)"
    }
  ]
}

IncomeOutcomeAccountItemModel: object

Модель описания поступлений/выплат за день

date: string (date)

Дата изменения

factValue: number (double)

Величина изменений типа "Факт" на счете

planValue: number (double)

Величина изменений типа "План" на счете

operationCategoryId: integer (int32)

Идентификатор статьи (0 - без статьи)

projectId: integer (int32)

Идентификатор проекта (0 - без проекта)

contrAgentId: integer (int32)

Идентификатор контрагента (0 - без контрагента)

operationTypeId: integer (int32)

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

Example
{
  "date": "string (date)",
  "factValue": "number (double)",
  "planValue": "number (double)",
  "operationCategoryId": "integer (int32)",
  "projectId": "integer (int32)",
  "contrAgentId": "integer (int32)",
  "operationTypeId": "integer (int32)"
}

IncomeOutcomeOperationCategoryHistoryRequest: object

Запрос истории поступлений/выплат сгруппированный по статьям

periodStartDate: string (date)

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

periodEndDate: string (date)

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

isCalculation: boolean

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

accountId: integer[]

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

contrAgentId: integer[]

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

operationCategoryId: integer[]

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

projectId: integer[]

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

Example
{
  "periodStartDate": "string (date)",
  "periodEndDate": "string (date)",
  "isCalculation": "boolean",
  "accountId": [
    "integer (int32)"
  ],
  "contrAgentId": [
    "integer (int32)"
  ],
  "operationCategoryId": [
    "integer (int32)"
  ],
  "projectId": [
    "integer (int32)"
  ]
}

Response[IEnumerable[IncomeOutcomeOperationCategoryModel]]: object

Ответ

data: IncomeOutcomeOperationCategoryModel

Данные

isSuccess: boolean

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

errorMessage: string

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

errorCode: string None, AccountAccessDenied, ProjectAccessDenied, InvalidOperationDate, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle

Код ошибки

Example
{
  "data": [
    {
      "operationCategoryId": "integer (int32)",
      "details": [
        {
          "date": "string (date)",
          "factValue": "number (double)",
          "planValue": "number (double)",
          "accountId": "integer (int32)",
          "projectId": "integer (int32)",
          "contrAgentId": "integer (int32)",
          "operationTypeId": "integer (int32)"
        }
      ]
    }
  ],
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

IncomeOutcomeOperationCategoryModel: object

Модель поступлений/выплат по дням

operationCategoryId: integer (int32)

Идентификатор статьи (0 - без статьи)

details: IncomeOutcomeOperationCategoryItemModel

Сведения о поступлениях/выплатах за день

Example
{
  "operationCategoryId": "integer (int32)",
  "details": [
    {
      "date": "string (date)",
      "factValue": "number (double)",
      "planValue": "number (double)",
      "accountId": "integer (int32)",
      "projectId": "integer (int32)",
      "contrAgentId": "integer (int32)",
      "operationTypeId": "integer (int32)"
    }
  ]
}

IncomeOutcomeOperationCategoryItemModel: object

Модель описания поступлений/выплат за день

date: string (date)

Дата изменения

factValue: number (double)

Величина изменений типа "Факт" на счете

planValue: number (double)

Величина изменений типа "План" на счете

accountId: integer (int32)

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

projectId: integer (int32)

Идентификатор проекта (0 - без проекта)

contrAgentId: integer (int32)

Идентификатор контрагента (0 - без контрагента)

operationTypeId: integer (int32)

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

Example
{
  "date": "string (date)",
  "factValue": "number (double)",
  "planValue": "number (double)",
  "accountId": "integer (int32)",
  "projectId": "integer (int32)",
  "contrAgentId": "integer (int32)",
  "operationTypeId": "integer (int32)"
}

IncomeOutcomeProjectHistoryRequest: object

Запрос истории поступлений/выплат сгруппированный по проектам

periodStartDate: string (date)

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

periodEndDate: string (date)

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

isCalculation: boolean

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

accountId: integer[]

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

contrAgentId: integer[]

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

operationCategoryId: integer[]

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

projectId: integer[]

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

Example
{
  "periodStartDate": "string (date)",
  "periodEndDate": "string (date)",
  "isCalculation": "boolean",
  "accountId": [
    "integer (int32)"
  ],
  "contrAgentId": [
    "integer (int32)"
  ],
  "operationCategoryId": [
    "integer (int32)"
  ],
  "projectId": [
    "integer (int32)"
  ]
}

Response[IEnumerable[IncomeOutcomeProjectModel]]: object

Ответ

data: IncomeOutcomeProjectModel

Данные

isSuccess: boolean

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

errorMessage: string

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

errorCode: string None, AccountAccessDenied, ProjectAccessDenied, InvalidOperationDate, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle

Код ошибки

Example
{
  "data": [
    {
      "projectId": "integer (int32)",
      "details": [
        {
          "date": "string (date)",
          "factValue": "number (double)",
          "planValue": "number (double)",
          "operationCategoryId": "integer (int32)",
          "accountId": "integer (int32)",
          "contrAgentId": "integer (int32)",
          "operationTypeId": "integer (int32)"
        }
      ]
    }
  ],
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

IncomeOutcomeProjectModel: object

Модель поступлений/выплат по дням

projectId: integer (int32)

Идентификатор проекта (0 - без проекта)

details: IncomeOutcomeProjectItemModel

Сведения о поступлениях/выплатах за день

Example
{
  "projectId": "integer (int32)",
  "details": [
    {
      "date": "string (date)",
      "factValue": "number (double)",
      "planValue": "number (double)",
      "operationCategoryId": "integer (int32)",
      "accountId": "integer (int32)",
      "contrAgentId": "integer (int32)",
      "operationTypeId": "integer (int32)"
    }
  ]
}

IncomeOutcomeProjectItemModel: object

Модель описания поступлений/выплат за день

date: string (date)

Дата изменения

factValue: number (double)

Величина изменений типа "Факт" на счете

planValue: number (double)

Величина изменений типа "План" на счете

operationCategoryId: integer (int32)

Идентификатор статьи (0 - без статьи)

accountId: integer (int32)

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

contrAgentId: integer (int32)

Идентификатор контрагента (0 - без контрагента)

operationTypeId: integer (int32)

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

Example
{
  "date": "string (date)",
  "factValue": "number (double)",
  "planValue": "number (double)",
  "operationCategoryId": "integer (int32)",
  "accountId": "integer (int32)",
  "contrAgentId": "integer (int32)",
  "operationTypeId": "integer (int32)"
}

IncomeOutcomeContrAgentHistoryRequest: object

Запрос истории поступлений/выплат сгруппированный по контрагентам

periodStartDate: string (date)

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

periodEndDate: string (date)

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

isCalculation: boolean

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

accountId: integer[]

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

contrAgentId: integer[]

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

operationCategoryId: integer[]

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

projectId: integer[]

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

Example
{
  "periodStartDate": "string (date)",
  "periodEndDate": "string (date)",
  "isCalculation": "boolean",
  "accountId": [
    "integer (int32)"
  ],
  "contrAgentId": [
    "integer (int32)"
  ],
  "operationCategoryId": [
    "integer (int32)"
  ],
  "projectId": [
    "integer (int32)"
  ]
}

Response[IEnumerable[IncomeOutcomeContrAgentModel]]: object

Ответ

data: IncomeOutcomeContrAgentModel

Данные

isSuccess: boolean

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

errorMessage: string

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

errorCode: string None, AccountAccessDenied, ProjectAccessDenied, InvalidOperationDate, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle

Код ошибки

Example
{
  "data": [
    {
      "contrAgentId": "integer (int32)",
      "details": [
        {
          "date": "string (date)",
          "factValue": "number (double)",
          "planValue": "number (double)",
          "operationCategoryId": "integer (int32)",
          "accountId": "integer (int32)",
          "projectId": "integer (int32)",
          "operationTypeId": "integer (int32)"
        }
      ]
    }
  ],
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

IncomeOutcomeContrAgentModel: object

Модель поступлений/выплат по дням

contrAgentId: integer (int32)

Идентификатор контрагента (0 - без контрагента)

details: IncomeOutcomeContrAgentItemModel

Сведения о поступлениях/выплатах за день

Example
{
  "contrAgentId": "integer (int32)",
  "details": [
    {
      "date": "string (date)",
      "factValue": "number (double)",
      "planValue": "number (double)",
      "operationCategoryId": "integer (int32)",
      "accountId": "integer (int32)",
      "projectId": "integer (int32)",
      "operationTypeId": "integer (int32)"
    }
  ]
}

IncomeOutcomeContrAgentItemModel: object

Модель описания поступлений/выплат за день

date: string (date)

Дата изменения

factValue: number (double)

Величина изменений типа "Факт" на счете

planValue: number (double)

Величина изменений типа "План" на счете

operationCategoryId: integer (int32)

Идентификатор статьи (0 - без статей)

accountId: integer (int32)

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

projectId: integer (int32)

Идентификатор проекта (0 - без проекта)

operationTypeId: integer (int32)

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

Example
{
  "date": "string (date)",
  "factValue": "number (double)",
  "planValue": "number (double)",
  "operationCategoryId": "integer (int32)",
  "accountId": "integer (int32)",
  "projectId": "integer (int32)",
  "operationTypeId": "integer (int32)"
}

Response[CompanyModel]: object

Ответ

data: CompanyModel

Данные

isSuccess: boolean

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

errorMessage: string

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

errorCode: string None, AccountAccessDenied, ProjectAccessDenied, InvalidOperationDate, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle

Код ошибки

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

CompanyModel: object

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

longTitle: string

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

companyInn: string

ИНН

companyKpp: string

КПП

description: string

Комментарий

active: boolean

Статус

modifyDate: string (date)

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

createDate: string (date)

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

actionStatus: string None, Updated, Deleted

Статус последнего действия

companyId: integer (int32)

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

title: string

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

externalId: string

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

Example
{
  "longTitle": "string",
  "companyInn": "string",
  "companyKpp": "string",
  "description": "string",
  "active": "boolean",
  "modifyDate": "string (date)",
  "createDate": "string (date)",
  "actionStatus": "string",
  "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[]

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

changesFromDate: string (date)

Начальная дата изменений

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

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

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

errorCode: string None, AccountAccessDenied, ProjectAccessDenied, InvalidOperationDate, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle

Код ошибки

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

ListModel[CompanyModel]: object

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

items: CompanyModel

Элементы

total: integer (int32)

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

Example
{
  "items": [
    {
      "longTitle": "string",
      "companyInn": "string",
      "companyKpp": "string",
      "description": "string",
      "active": "boolean",
      "modifyDate": "string (date)",
      "createDate": "string (date)",
      "actionStatus": "string",
      "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"
}

ContrAgentConsolidationListRequest: object

Запрос списка заданий на объединение контрагентов

state: string None, InProgress, Done, Error

Текущий статус задания объединения

masterContrAgentId: integer (int32)

Идентификатор контрагента, в которого происходит объединение

Example
{
  "state": "string",
  "masterContrAgentId": "integer (int32)"
}

Sorting[ContrAgentConsolidationsSortingFields]: object

Сортировка

field: string MasterContrAgentId, State

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

direction: string Asc, Desc

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

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

Response[ListModel[ContrAgentConsolidationTaskModel]]: object

Ответ

data: ListModel[ContrAgentConsolidationTaskModel]

Данные

isSuccess: boolean

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

errorMessage: string

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

errorCode: string None, AccountAccessDenied, ProjectAccessDenied, InvalidOperationDate, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle

Код ошибки

Example
{
  "data": {
    "items": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "businessId": "00000000-0000-0000-0000-000000000000",
        "percent": "integer (int32)",
        "errorMessage": "string",
        "state": "string"
      }
    ],
    "total": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

ListModel[ContrAgentConsolidationTaskModel]: object

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

items: ContrAgentConsolidationTaskModel

Элементы

total: integer (int32)

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

Example
{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "businessId": "00000000-0000-0000-0000-000000000000",
      "percent": "integer (int32)",
      "errorMessage": "string",
      "state": "string"
    }
  ],
  "total": "integer (int32)"
}

ContrAgentConsolidationTaskModel: object

Модель сведений об объединении контрагентов

id: string (uuid)

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

businessId: string (uuid)

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

percent: integer (int32)

Процент выполнения

errorMessage: string

Сообщение об ошибках

state: string None, InProgress, Done, Error

Текущий статус задания преобразования

Example
{
  "id": "00000000-0000-0000-0000-000000000000",
  "businessId": "00000000-0000-0000-0000-000000000000",
  "percent": "integer (int32)",
  "errorMessage": "string",
  "state": "string"
}

ContrAgentConsolidationRequest: object

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

masterContrAgentId: integer (int32)

Идентификатор контрагента, в которого будет произведено объединение

consolidateContrAgentIds: integer[]

Список идентификаторв контрагентов, которые будет объединены

Example
{
  "masterContrAgentId": "integer (int32)",
  "consolidateContrAgentIds": [
    "integer (int32)"
  ]
}

Response[ContrAgentConsolidationTaskModel]: object

Ответ

data: ContrAgentConsolidationTaskModel

Данные

isSuccess: boolean

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

errorMessage: string

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

errorCode: string None, AccountAccessDenied, ProjectAccessDenied, InvalidOperationDate, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle

Код ошибки

Example
{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "businessId": "00000000-0000-0000-0000-000000000000",
    "percent": "integer (int32)",
    "errorMessage": "string",
    "state": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

Response[ContrAgentModel]: object

Ответ

data: ContrAgentModel

Данные

isSuccess: boolean

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

errorMessage: string

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

errorCode: string None, AccountAccessDenied, ProjectAccessDenied, InvalidOperationDate, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle

Код ошибки

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)",
    "balanceFact": "number (double)",
    "currencyCode": "string",
    "modifyDate": "string (date)",
    "createDate": "string (date)",
    "actionStatus": "string",
    "canTransformedToAgent": "boolean",
    "contrAgentId": "integer (int32)",
    "title": "string",
    "externalId": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "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)

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

balanceFact: 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, THB, HUF, CZK, HRK

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

modifyDate: string (date)

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

createDate: string (date)

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

actionStatus: string None, Updated, Deleted

Статус последнего действия

canTransformedToAgent: boolean

Призак возможности преобразования к контрагенту

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)",
  "balanceFact": "number (double)",
  "currencyCode": "string",
  "modifyDate": "string (date)",
  "createDate": "string (date)",
  "actionStatus": "string",
  "canTransformedToAgent": "boolean",
  "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

Статус

changesFromDate: string (date)

Начальная дата изменений

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

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

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

errorCode: string None, AccountAccessDenied, ProjectAccessDenied, InvalidOperationDate, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle

Код ошибки

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)",
        "balanceFact": "number (double)",
        "currencyCode": "string",
        "modifyDate": "string (date)",
        "createDate": "string (date)",
        "actionStatus": "string",
        "canTransformedToAgent": "boolean",
        "contrAgentId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      }
    ],
    "total": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "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)",
      "balanceFact": "number (double)",
      "currencyCode": "string",
      "modifyDate": "string (date)",
      "createDate": "string (date)",
      "actionStatus": "string",
      "canTransformedToAgent": "boolean",
      "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"
}

CalculationListRequest: object

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

contrAgentId: integer[]

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

Example
{
  "contrAgentId": [
    "integer (int32)"
  ]
}

ContrAgentToAccountTransformationListRequest: object

Запрос списка заданий на преобразование контрагента в счет

state: string None, InProgress, Done, Error

Текущий статус задания преобразования

contrAgentId: integer (int32)

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

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

Sorting[ContrAgentToAccountTransformationsSortingFields]: object

Сортировка

field: string ContrAgentId, State

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

direction: string Asc, Desc

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

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

Response[ListModel[ContrAgentToAccountTransformationTaskModel]]: object

Ответ

data: ListModel[ContrAgentToAccountTransformationTaskModel]

Данные

isSuccess: boolean

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

errorMessage: string

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

errorCode: string None, AccountAccessDenied, ProjectAccessDenied, InvalidOperationDate, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle

Код ошибки

Example
{
  "data": {
    "items": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "businessId": "00000000-0000-0000-0000-000000000000",
        "percent": "integer (int32)",
        "errorMessage": "string",
        "state": "string"
      }
    ],
    "total": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

ListModel[ContrAgentToAccountTransformationTaskModel]: object

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

items: ContrAgentToAccountTransformationTaskModel

Элементы

total: integer (int32)

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

Example
{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "businessId": "00000000-0000-0000-0000-000000000000",
      "percent": "integer (int32)",
      "errorMessage": "string",
      "state": "string"
    }
  ],
  "total": "integer (int32)"
}

ContrAgentToAccountTransformationTaskModel: object

Модель сведений о преобразовании контрагента в счет

id: string (uuid)

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

businessId: string (uuid)

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

percent: integer (int32)

Процент выполнения

errorMessage: string

Сообщение об ошибках

state: string None, InProgress, Done, Error

Текущий статус задания преобразования

Example
{
  "id": "00000000-0000-0000-0000-000000000000",
  "businessId": "00000000-0000-0000-0000-000000000000",
  "percent": "integer (int32)",
  "errorMessage": "string",
  "state": "string"
}

Response[ContrAgentToAccountTransformationTaskModel]: object

Ответ

data: ContrAgentToAccountTransformationTaskModel

Данные

isSuccess: boolean

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

errorMessage: string

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

errorCode: string None, AccountAccessDenied, ProjectAccessDenied, InvalidOperationDate, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle

Код ошибки

Example
{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "businessId": "00000000-0000-0000-0000-000000000000",
    "percent": "integer (int32)",
    "errorMessage": "string",
    "state": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

TotalsRequest: object

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

fromDate: string (date)
toDate: string (date)
companyId: integer[]
grouping: string Day, Week, Month, Quarter, Year
Example
{
  "fromDate": "string (date)",
  "toDate": "string (date)",
  "companyId": [
    "integer (int32)"
  ],
  "grouping": "string"
}

Response[IList[TotalsView]]: object

Ответ

data: TotalsView

Данные

isSuccess: boolean

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

errorMessage: string

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

errorCode: string None, AccountAccessDenied, ProjectAccessDenied, InvalidOperationDate, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle

Код ошибки

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",
  "errorCode": "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