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

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

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

Authentication

apiKey

Api key

type
apiKey
name
X-ApiKey
in
header

Accounts

Accounts

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

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

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

200 OK
Response[AccountModel]

OK

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

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

PUT /api/v1/accounts/{accountId}
AccountModificationRequest

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

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)"
}
200 OK
Response[AccountModel]

OK

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

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

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

(no description)

200 OK
Response

OK

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

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

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, ModifyDate

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

sorting.direction
in query
string Asc, Desc

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

200 OK
Response[ListModel[AccountModel]]

OK

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)",
    "deletedItems": [
      null
    ],
    "totalDeleted": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
Accounts

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

POST /api/v1/accounts
AccountCreationRequest

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

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)"
}
200 OK
Response[AccountModel]

OK

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

BizInfos

BizInfos

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

GET /api/v1/bizinfos/accountshistory
200 OK
Response[IEnumerable[AccountsHistoryModel]]

OK

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

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

GET /api/v1/bizinfos/layoutinfo
200 OK
Response[LayoutInfoModel]

OK

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

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

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
filter.firstAdditionalOperationAttributeId
in query
integer[][]

Идентификаторы 1-го дополнительного атрибута операции

Array values passed as multiple parameters: ?filter.firstAdditionalOperationAttributeId=aaa&filter.firstAdditionalOperationAttributeId=bbb
200 OK
Response[IEnumerable[IncomeOutcomeAccountModel]]

OK

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)",
          "firstAdditionalOperationAttributeId": "integer (int32)"
        }
      ]
    }
  ],
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
BizInfos

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

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
filter.firstAdditionalOperationAttributeId
in query
integer[][]

Идентификаторы 1-го дополнительного атрибута операции

Array values passed as multiple parameters: ?filter.firstAdditionalOperationAttributeId=aaa&filter.firstAdditionalOperationAttributeId=bbb
200 OK
Response[IEnumerable[IncomeOutcomeOperationCategoryModel]]

OK

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)",
          "firstAdditionalOperationAttributeId": "integer (int32)"
        }
      ]
    }
  ],
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
BizInfos

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

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
filter.firstAdditionalOperationAttributeId
in query
integer[][]

Идентификаторы 1-го дополнительного атрибута операции

Array values passed as multiple parameters: ?filter.firstAdditionalOperationAttributeId=aaa&filter.firstAdditionalOperationAttributeId=bbb
200 OK
Response[IEnumerable[IncomeOutcomeProjectModel]]

OK

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)",
          "firstAdditionalOperationAttributeId": "integer (int32)"
        }
      ]
    }
  ],
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
BizInfos

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

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
filter.firstAdditionalOperationAttributeId
in query
integer[][]

Идентификаторы 1-го дополнительного атрибута операции

Array values passed as multiple parameters: ?filter.firstAdditionalOperationAttributeId=aaa&filter.firstAdditionalOperationAttributeId=bbb
200 OK
Response[IEnumerable[IncomeOutcomeContrAgentModel]]

OK

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)",
          "firstAdditionalOperationAttributeId": "integer (int32)"
        }
      ]
    }
  ],
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
BizInfos

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

GET /api/v1/bizinfos/incomeoutcomehistorybyfirstadditionaloperationattribute
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
filter.firstAdditionalOperationAttributeId
in query
integer[][]

Идентификаторы 1-го дополнительного атрибута операции

Array values passed as multiple parameters: ?filter.firstAdditionalOperationAttributeId=aaa&filter.firstAdditionalOperationAttributeId=bbb
200 OK
Response[IEnumerable[IncomeOutcomeFirstAdditionalOperationAttributeModel]]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": [
    {
      "firstAdditionalOperationAttributeId": "integer (int32)",
      "details": [
        {
          "date": "string (date)",
          "factValue": "number (double)",
          "planValue": "number (double)",
          "operationCategoryId": "integer (int32)",
          "accountId": "integer (int32)",
          "contrAgentId": "integer (int32)",
          "operationTypeId": "integer (int32)",
          "projectId": "integer (int32)"
        }
      ]
    }
  ],
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

Businesses

Businesses

Регистрация нового бизнеса

POST /api/v1/businesses
BusinessCreationRequest

undefined

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "email": "string",
  "countryIso2Code": "string",
  "phoneNumber": "string",
  "firstName": "string",
  "partnerApiKey": "string"
}
200 OK
Response[BusinessApiKeyModel]

OK

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

Companies

Companies

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

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

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

200 OK
Response[CompanyModel]

OK

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

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

PUT /api/v1/companies/{companyId}
CompanyModificationRequest

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

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"
}
200 OK
Response[CompanyModel]

OK

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

Удаление компании

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

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

200 OK
Response

OK

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

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

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, ModifyDate

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

sorting.direction
in query
string Asc, Desc

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

200 OK
Response[ListModel[CompanyModel]]

OK

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)",
    "deletedItems": [
      null
    ],
    "totalDeleted": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
Companies

Создание новой компании

POST /api/v1/companies
CompanyCreationRequest

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

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"
}
200 OK
Response[CompanyModel]

OK

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

ContrAgents

ContrAgents

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

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

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

200 OK
Response[ContrAgentModel]

OK

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",
    "isUndistributed": "boolean",
    "contrAgentId": "integer (int32)",
    "title": "string",
    "externalId": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
ContrAgents

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

PUT /api/v1/contragents/{contrAgentId}
ContrAgentModificationRequest

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

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"
}
200 OK
Response[ContrAgentModel]

OK

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",
    "isUndistributed": "boolean",
    "contrAgentId": "integer (int32)",
    "title": "string",
    "externalId": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
ContrAgents

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

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

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

200 OK
Response

OK

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

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

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

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

200 OK
Response[ContrAgentModel]

OK

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",
    "isUndistributed": "boolean",
    "contrAgentId": "integer (int32)",
    "title": "string",
    "externalId": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
ContrAgents

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

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)

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

filter.inn
in query
string

ИНН

paging.offset
in query
integer (int32)

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

paging.limit
in query
integer (int32)

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

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

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

sorting.direction
in query
string Asc, Desc

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

200 OK
Response[ListModel[ContrAgentModel]]

OK

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",
        "isUndistributed": "boolean",
        "contrAgentId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      }
    ],
    "total": "integer (int32)",
    "deletedItems": [
      null
    ],
    "totalDeleted": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
ContrAgents

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

POST /api/v1/contragents
ContrAgentCreationRequest

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

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"
}
200 OK
Response[ContrAgentModel]

OK

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",
    "isUndistributed": "boolean",
    "contrAgentId": "integer (int32)",
    "title": "string",
    "externalId": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
ContrAgents

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

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)

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

filter.inn
in query
string

ИНН

paging.offset
in query
integer (int32)

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

paging.limit
in query
integer (int32)

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

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

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

sorting.direction
in query
string Asc, Desc

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

200 OK
Response[ListModel[ContrAgentModel]]

OK

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",
        "isUndistributed": "boolean",
        "contrAgentId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      }
    ],
    "total": "integer (int32)",
    "deletedItems": [
      null
    ],
    "totalDeleted": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
ContrAgents

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

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

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

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

OK

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

CoreApi

CoreApi

Получение баланса по всем юрлицам

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

(no description)

filter.toDate
in query
string (date)

(no description)

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

(no description)

paging.offset
in query
integer (int32)

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

paging.limit
in query
integer (int32)

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

200 OK
Response[IDictionary[Int32,TotalsWithCrcs]]

OK

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

Currencies

Currencies

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

GET /api/v1/currencies
200 OK
Response[ListModel[CurrencyModel]]

OK

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)",
    "deletedItems": [
      null
    ],
    "totalDeleted": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

FirstAdditionalOperationAttributes

FirstAdditionalOperationAttributes

Получение 1-го дополнительного атрибута операции по идентификатору

GET /api/v1/firstadditionalpperationattributes/{firstAdditionalOperationAttributeId}
firstAdditionalOperationAttributeId
in path
integer (int32)

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

200 OK
Response[FirstAdditionalOperationAttributeModel]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "description": "string",
    "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",
    "isUndistributed": "boolean",
    "firstAdditionalOperationAttributeId": "integer (int32)",
    "title": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
FirstAdditionalOperationAttributes

Изменение существующего 1-го дополнительного атрибута операции

PUT /api/v1/firstadditionalpperationattributes/{firstAdditionalOperationAttributeId}
FirstAdditionalOperationAttributeModificationRequest

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

firstAdditionalOperationAttributeId
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"
}
200 OK
Response[FirstAdditionalOperationAttributeModel]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "description": "string",
    "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",
    "isUndistributed": "boolean",
    "firstAdditionalOperationAttributeId": "integer (int32)",
    "title": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
FirstAdditionalOperationAttributes

Удаление 1-го дополнительного атрибута операции

DELETE /api/v1/firstadditionalpperationattributes/{firstAdditionalOperationAttributeId}
firstAdditionalOperationAttributeId
in path
integer (int32)

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

200 OK
Response

OK

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

Получение 1-го дополнительного атрибута операции со сводкой по идентификатору

GET /api/v1/firstadditionalpperationattributes/{firstAdditionalOperationAttributeId}/summary
firstAdditionalOperationAttributeId
in path
integer (int32)

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

200 OK
Response[FirstAdditionalOperationAttributeModel]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "description": "string",
    "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",
    "isUndistributed": "boolean",
    "firstAdditionalOperationAttributeId": "integer (int32)",
    "title": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
FirstAdditionalOperationAttributes

Получение списка 1-го дополнительного атрибута операций

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

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

filter.startDateTime
in query
string (date)

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

filter.endDateTime
in query
string (date)

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

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, FirstOperationDate, LastOperationDate, ModifyDate

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

sorting.direction
in query
string Asc, Desc

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

200 OK
Response[ListModel[FirstAdditionalOperationAttributeModel]]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "items": [
      {
        "description": "string",
        "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",
        "isUndistributed": "boolean",
        "firstAdditionalOperationAttributeId": "integer (int32)",
        "title": "string"
      }
    ],
    "total": "integer (int32)",
    "deletedItems": [
      null
    ],
    "totalDeleted": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
FirstAdditionalOperationAttributes

Создание нового 1-го дополнительного атрибута операции

POST /api/v1/firstadditionalpperationattributes
FirstAdditionalOperationAttributeCreationRequest

Запрос на создание 1-го дополнительного атрибута операции

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "title": "string",
  "description": "string"
}
200 OK
Response[FirstAdditionalOperationAttributeModel]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "description": "string",
    "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",
    "isUndistributed": "boolean",
    "firstAdditionalOperationAttributeId": "integer (int32)",
    "title": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
FirstAdditionalOperationAttributes

Получение списка 1-го дополнительного атрибута операции со сводкой

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

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

filter.startDateTime
in query
string (date)

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

filter.endDateTime
in query
string (date)

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

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, FirstOperationDate, LastOperationDate, ModifyDate

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

sorting.direction
in query
string Asc, Desc

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

200 OK
Response[ListModel[FirstAdditionalOperationAttributeModel]]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "items": [
      {
        "description": "string",
        "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",
        "isUndistributed": "boolean",
        "firstAdditionalOperationAttributeId": "integer (int32)",
        "title": "string"
      }
    ],
    "total": "integer (int32)",
    "deletedItems": [
      null
    ],
    "totalDeleted": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

ImportLogs

ImportLogs

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

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

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

paging.limit
in query
integer (int32)

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

200 OK
Response[ListModel[ImportLogModel]]

OK

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

OperationCategories

OperationCategories

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

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

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

200 OK
Response[OperationCategoryModel]

OK

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

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

PUT /api/v1/operationcategories/{operationCategoryId}
OperationCategoryModificationRequest

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

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)"
}
200 OK
Response[OperationCategoryModel]

OK

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

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

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

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

200 OK
Response

OK

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

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

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, ModifyDate

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

sorting.direction
in query
string Asc, Desc

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

200 OK
Response[ListModel[OperationCategoryModel]]

OK

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)",
    "deletedItems": [
      null
    ],
    "totalDeleted": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
OperationCategories

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

POST /api/v1/operationcategories
OperationCategoryCreationRequest

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

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)"
}
200 OK
Response[OperationCategoryModel]

OK

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

Operations

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

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

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

200 OK
Response[OperationModel]

OK

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)",
      "operationParts": [
        {
          "calculationDate": "string (date)",
          "isCalculationCommitted": "boolean",
          "project": {
            "projectId": "integer (int32)",
            "title": "string"
          },
          "contrAgent": {
            "contrAgentId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "operationCategory": {
            "operationCategoryId": "integer (int32)",
            "title": "string"
          },
          "operationCategoryActivityType": "string",
          "firstAdditionalOperationAttribute": {
            "firstAdditionalOperationAttributeId": "integer (int32)",
            "title": "string"
          },
          "value": "number (double)"
        }
      ],
      "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"
  }
}
Operations

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

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

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

200 OK
Response

OK

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

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

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.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, ModifyDate, FirstAdditionalOperationAttribute

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

sorting.direction
in query
string Asc, Desc

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

200 OK
Response[ListModel[OperationModel]]

OK

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)",
          "operationParts": [
            {
              "calculationDate": "string (date)",
              "isCalculationCommitted": "boolean",
              "project": {
                "projectId": "integer (int32)",
                "title": "string"
              },
              "contrAgent": {
                "contrAgentId": "integer (int32)",
                "title": "string",
                "externalId": "string"
              },
              "operationCategory": {
                "operationCategoryId": "integer (int32)",
                "title": "string"
              },
              "operationCategoryActivityType": "string",
              "firstAdditionalOperationAttribute": {
                "firstAdditionalOperationAttributeId": "integer (int32)",
                "title": "string"
              },
              "value": "number (double)"
            }
          ],
          "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)"
        }
      }
    ]
  }
}
Operations

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

POST /api/v1/operations/income
IncomeOutcomeOperationCreationRequest

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

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "operationDate": "string (date)",
  "calculationDate": "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)",
  "items": [
    {
      "calculationDate": "string (date)",
      "isCalculationCommitted": "boolean",
      "contrAgentId": "integer (int32)",
      "operationCategoryId": "integer (int32)",
      "projectId": "integer (int32)",
      "firstAdditionalOperationAttributeId": "integer (int32)",
      "value": "number (double)"
    }
  ]
}
200 OK
Response[OperationModel]

OK

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)",
      "operationParts": [
        {
          "calculationDate": "string (date)",
          "isCalculationCommitted": "boolean",
          "project": {
            "projectId": "integer (int32)",
            "title": "string"
          },
          "contrAgent": {
            "contrAgentId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "operationCategory": {
            "operationCategoryId": "integer (int32)",
            "title": "string"
          },
          "operationCategoryActivityType": "string",
          "firstAdditionalOperationAttribute": {
            "firstAdditionalOperationAttributeId": "integer (int32)",
            "title": "string"
          },
          "value": "number (double)"
        }
      ],
      "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"
  }
}
Operations

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

POST /api/v1/operations/outcome
IncomeOutcomeOperationCreationRequest

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

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "operationDate": "string (date)",
  "calculationDate": "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)",
  "items": [
    {
      "calculationDate": "string (date)",
      "isCalculationCommitted": "boolean",
      "contrAgentId": "integer (int32)",
      "operationCategoryId": "integer (int32)",
      "projectId": "integer (int32)",
      "firstAdditionalOperationAttributeId": "integer (int32)",
      "value": "number (double)"
    }
  ]
}
200 OK
Response[OperationModel]

OK

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)",
      "operationParts": [
        {
          "calculationDate": "string (date)",
          "isCalculationCommitted": "boolean",
          "project": {
            "projectId": "integer (int32)",
            "title": "string"
          },
          "contrAgent": {
            "contrAgentId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "operationCategory": {
            "operationCategoryId": "integer (int32)",
            "title": "string"
          },
          "operationCategoryActivityType": "string",
          "firstAdditionalOperationAttribute": {
            "firstAdditionalOperationAttributeId": "integer (int32)",
            "title": "string"
          },
          "value": "number (double)"
        }
      ],
      "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"
  }
}
Operations

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

POST /api/v1/operations/move
MoveOperationCreationRequest

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

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)",
  "debitingItems": [
    {
      "calculationDate": "string (date)",
      "isCalculationCommitted": "boolean",
      "contrAgentId": "integer (int32)",
      "operationCategoryId": "integer (int32)",
      "projectId": "integer (int32)",
      "firstAdditionalOperationAttributeId": "integer (int32)",
      "value": "number (double)"
    }
  ],
  "admissionItems": [
    {
      "calculationDate": "string (date)",
      "isCalculationCommitted": "boolean",
      "contrAgentId": "integer (int32)",
      "operationCategoryId": "integer (int32)",
      "projectId": "integer (int32)",
      "firstAdditionalOperationAttributeId": "integer (int32)",
      "value": "number (double)"
    }
  ]
}
200 OK
Response[OperationModel[]]

OK

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)",
        "operationParts": [
          {
            "calculationDate": "string (date)",
            "isCalculationCommitted": "boolean",
            "project": {
              "projectId": "integer (int32)",
              "title": "string"
            },
            "contrAgent": {
              "contrAgentId": "integer (int32)",
              "title": "string",
              "externalId": "string"
            },
            "operationCategory": {
              "operationCategoryId": "integer (int32)",
              "title": "string"
            },
            "operationCategoryActivityType": "string",
            "firstAdditionalOperationAttribute": {
              "firstAdditionalOperationAttributeId": "integer (int32)",
              "title": "string"
            },
            "value": "number (double)"
          }
        ],
        "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"
    }
  ]
}
Operations

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

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

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

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)",
  "calculationDate": "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)",
  "items": [
    {
      "calculationDate": "string (date)",
      "isCalculationCommitted": "boolean",
      "contrAgentId": "integer (int32)",
      "operationCategoryId": "integer (int32)",
      "projectId": "integer (int32)",
      "firstAdditionalOperationAttributeId": "integer (int32)",
      "value": "number (double)"
    }
  ]
}
200 OK
Response[OperationModel]

OK

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)",
      "operationParts": [
        {
          "calculationDate": "string (date)",
          "isCalculationCommitted": "boolean",
          "project": {
            "projectId": "integer (int32)",
            "title": "string"
          },
          "contrAgent": {
            "contrAgentId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "operationCategory": {
            "operationCategoryId": "integer (int32)",
            "title": "string"
          },
          "operationCategoryActivityType": "string",
          "firstAdditionalOperationAttribute": {
            "firstAdditionalOperationAttributeId": "integer (int32)",
            "title": "string"
          },
          "value": "number (double)"
        }
      ],
      "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"
  }
}
Operations

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

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

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

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)",
  "calculationDate": "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)",
  "items": [
    {
      "calculationDate": "string (date)",
      "isCalculationCommitted": "boolean",
      "contrAgentId": "integer (int32)",
      "operationCategoryId": "integer (int32)",
      "projectId": "integer (int32)",
      "firstAdditionalOperationAttributeId": "integer (int32)",
      "value": "number (double)"
    }
  ]
}
200 OK
Response[OperationModel]

OK

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)",
      "operationParts": [
        {
          "calculationDate": "string (date)",
          "isCalculationCommitted": "boolean",
          "project": {
            "projectId": "integer (int32)",
            "title": "string"
          },
          "contrAgent": {
            "contrAgentId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "operationCategory": {
            "operationCategoryId": "integer (int32)",
            "title": "string"
          },
          "operationCategoryActivityType": "string",
          "firstAdditionalOperationAttribute": {
            "firstAdditionalOperationAttributeId": "integer (int32)",
            "title": "string"
          },
          "value": "number (double)"
        }
      ],
      "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"
  }
}
Operations

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

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

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

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)",
  "debitingItems": [
    {
      "calculationDate": "string (date)",
      "isCalculationCommitted": "boolean",
      "contrAgentId": "integer (int32)",
      "operationCategoryId": "integer (int32)",
      "projectId": "integer (int32)",
      "firstAdditionalOperationAttributeId": "integer (int32)",
      "value": "number (double)"
    }
  ],
  "admissionItems": [
    {
      "calculationDate": "string (date)",
      "isCalculationCommitted": "boolean",
      "contrAgentId": "integer (int32)",
      "operationCategoryId": "integer (int32)",
      "projectId": "integer (int32)",
      "firstAdditionalOperationAttributeId": "integer (int32)",
      "value": "number (double)"
    }
  ]
}
200 OK
Response[OperationModel[]]

OK

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)",
        "operationParts": [
          {
            "calculationDate": "string (date)",
            "isCalculationCommitted": "boolean",
            "project": {
              "projectId": "integer (int32)",
              "title": "string"
            },
            "contrAgent": {
              "contrAgentId": "integer (int32)",
              "title": "string",
              "externalId": "string"
            },
            "operationCategory": {
              "operationCategoryId": "integer (int32)",
              "title": "string"
            },
            "operationCategoryActivityType": "string",
            "firstAdditionalOperationAttribute": {
              "firstAdditionalOperationAttributeId": "integer (int32)",
              "title": "string"
            },
            "value": "number (double)"
          }
        ],
        "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"
    }
  ]
}
Operations

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

PUT /api/v1/operations/consolidate
OperationConsolidateRequest

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

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
200 OK
Response[MultipleOperationModel]

OK

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)",
          "operationParts": [
            {
              "calculationDate": "string (date)",
              "isCalculationCommitted": "boolean",
              "project": {
                "projectId": "integer (int32)",
                "title": "string"
              },
              "contrAgent": {
                "contrAgentId": "integer (int32)",
                "title": "string",
                "externalId": "string"
              },
              "operationCategory": {
                "operationCategoryId": "integer (int32)",
                "title": "string"
              },
              "operationCategoryActivityType": "string",
              "firstAdditionalOperationAttribute": {
                "firstAdditionalOperationAttributeId": "integer (int32)",
                "title": "string"
              },
              "value": "number (double)"
            }
          ],
          "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)"
        }
      }
    ]
  }
}
Operations

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

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

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

200 OK
Response[MultipleOperationModel]

OK

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)",
          "operationParts": [
            {
              "calculationDate": "string (date)",
              "isCalculationCommitted": "boolean",
              "project": {
                "projectId": "integer (int32)",
                "title": "string"
              },
              "contrAgent": {
                "contrAgentId": "integer (int32)",
                "title": "string",
                "externalId": "string"
              },
              "operationCategory": {
                "operationCategoryId": "integer (int32)",
                "title": "string"
              },
              "operationCategoryActivityType": "string",
              "firstAdditionalOperationAttribute": {
                "firstAdditionalOperationAttributeId": "integer (int32)",
                "title": "string"
              },
              "value": "number (double)"
            }
          ],
          "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)"
        }
      }
    ]
  }
}
Operations

Смена типа операции

PUT /api/v1/operations/change-type/{operationId}
operationId
in path
integer (int32)

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

200 OK
Response[OperationModel]

OK

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)",
      "operationParts": [
        {
          "calculationDate": "string (date)",
          "isCalculationCommitted": "boolean",
          "project": {
            "projectId": "integer (int32)",
            "title": "string"
          },
          "contrAgent": {
            "contrAgentId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "operationCategory": {
            "operationCategoryId": "integer (int32)",
            "title": "string"
          },
          "operationCategoryActivityType": "string",
          "firstAdditionalOperationAttribute": {
            "firstAdditionalOperationAttributeId": "integer (int32)",
            "title": "string"
          },
          "value": "number (double)"
        }
      ],
      "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"
  }
}
Operations

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

GET /api/v1/operations/summary
filter.operationId
in query
integer[]

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

Array values passed as multiple parameters: ?filter.operationId=aaa&filter.operationId=bbb
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.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.operationType
in query
string[]

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

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

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

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

Идентификаторы 1-го дополнительного атрибута

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

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

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

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

filter.valueMax
in query
number (double)

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

filter.isCommitted
in query
boolean

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

filter.isCalculationCommitted
in query
boolean

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

filter.searchString
in query
string

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

  • Комментарий
  • Название контрагента
  • Название счета
  • Название компании
  • Название статьи
  • Название проекта
  • Название 1-го дополнительного атрибута операции
200 OK
Response[OperationFilterSummaryModel]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "incomeCount": "integer (int32)",
    "incomeAmount": "number (double)",
    "incomeFullAmount": "number (double)",
    "outcomeCount": "integer (int32)",
    "outcomeAmount": "number (double)",
    "outcomeFullAmount": "number (double)",
    "moveCount": "integer (int32)",
    "moveAmount": "number (double)",
    "moveFullAmount": "number (double)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

Projects

Projects

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

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

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

200 OK
Response[ProjectModel]

OK

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",
    "isUndistributed": "boolean",
    "projectId": "integer (int32)",
    "title": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
Projects

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

PUT /api/v1/projects/{projectId}
ProjectModificationRequest

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

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"
}
200 OK
Response[ProjectModel]

OK

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",
    "isUndistributed": "boolean",
    "projectId": "integer (int32)",
    "title": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
Projects

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

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

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

200 OK
Response

OK

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

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

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

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

200 OK
Response[ProjectModel]

OK

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",
    "isUndistributed": "boolean",
    "projectId": "integer (int32)",
    "title": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
Projects

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

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, ModifyDate

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

sorting.direction
in query
string Asc, Desc

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

200 OK
Response[ListModel[ProjectModel]]

OK

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",
        "isUndistributed": "boolean",
        "projectId": "integer (int32)",
        "title": "string"
      }
    ],
    "total": "integer (int32)",
    "deletedItems": [
      null
    ],
    "totalDeleted": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
Projects

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

POST /api/v1/projects
ProjectCreationRequest

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

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "title": "string",
  "description": "string"
}
200 OK
Response[ProjectModel]

OK

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",
    "isUndistributed": "boolean",
    "projectId": "integer (int32)",
    "title": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
Projects

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

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, ModifyDate

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

sorting.direction
in query
string Asc, Desc

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

200 OK
Response[ListModel[ProjectModel]]

OK

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",
        "isUndistributed": "boolean",
        "projectId": "integer (int32)",
        "title": "string"
      }
    ],
    "total": "integer (int32)",
    "deletedItems": [
      null
    ],
    "totalDeleted": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

Settings

Settings

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

GET /api/v1/settings
200 OK
Response[SettingsModel]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "groupCompanyTitle": "string",
    "useAgentsTotals": "boolean",
    "currency": {
      "currencyCode": "string",
      "title": "string"
    },
    "showKopeck": "boolean",
    "showPastCashGap": "boolean",
    "showCalculationPeriod": "boolean",
    "showCalculationPeriodFilter": "boolean",
    "showCalculationPeriodFilterCanChanged": "boolean",
    "outcomeOperationCategoryClassificationType": "string",
    "apiToken": "string",
    "dayShiftCompareOnImport": "integer (int32)",
    "isOperationCommentRequired": "boolean"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
Settings

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

PUT /api/v1/settings
SettingsModificationRequest

запрос

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "currencyCode": "string",
  "showKopeck": "boolean",
  "showPastCashGap": "boolean",
  "showCalculationPeriod": "boolean",
  "showCalculationPeriodFilter": "boolean",
  "groupCompanyTitle": "string",
  "outcomeOperationCategoryClassificationType": "string",
  "dayShiftCompareOnImport": "integer (int32)",
  "isOperationCommentRequired": "boolean"
}
200 OK
Response[SettingsModel]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "groupCompanyTitle": "string",
    "useAgentsTotals": "boolean",
    "currency": {
      "currencyCode": "string",
      "title": "string"
    },
    "showKopeck": "boolean",
    "showPastCashGap": "boolean",
    "showCalculationPeriod": "boolean",
    "showCalculationPeriodFilter": "boolean",
    "showCalculationPeriodFilterCanChanged": "boolean",
    "outcomeOperationCategoryClassificationType": "string",
    "apiToken": "string",
    "dayShiftCompareOnImport": "integer (int32)",
    "isOperationCommentRequired": "boolean"
  },
  "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, UndistributedProject, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle, UndistributedContrAgent, OperationFirstAdditionalOperationAttributeProjectExist, UndistributedFirstAdditionalOperationAttribute

Код ошибки

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

Response[AccountModel]: object

Ответ

data: AccountModel

Данные

isSuccess: boolean

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

errorMessage: string

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

errorCode: string None, AccountAccessDenied, ProjectAccessDenied, InvalidOperationDate, UndistributedProject, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle, UndistributedContrAgent, OperationFirstAdditionalOperationAttributeProjectExist, UndistributedFirstAdditionalOperationAttribute

Код ошибки

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)

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

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

AccountListRequest: object

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

agentId: integer (int32)

Id компания

accountType: string Cash, Card

Тип счёта

title: string

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

longTitle: string

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

description: string

Описание

accountAcct: string

Номер счета

accountBik: string

БИК счета

accountBank: string

Банк счета

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

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

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, UndistributedProject, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle, UndistributedContrAgent, OperationFirstAdditionalOperationAttributeProjectExist, UndistributedFirstAdditionalOperationAttribute

Код ошибки

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)",
    "deletedItems": [
      null
    ],
    "totalDeleted": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

ListModel[AccountModel]: object

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

items: AccountModel

Элементы

total: integer (int32)

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

deletedItems: DeletedEntityModel

Удалённые элементы

totalDeleted: 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)",
  "deletedItems": [
    null
  ],
  "totalDeleted": "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)"
}

Response[Guid]: object

Ответ

data: string (uuid)

Данные

isSuccess: boolean

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

errorMessage: string

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

errorCode: string None, AccountAccessDenied, ProjectAccessDenied, InvalidOperationDate, UndistributedProject, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle, UndistributedContrAgent, OperationFirstAdditionalOperationAttributeProjectExist, UndistributedFirstAdditionalOperationAttribute

Код ошибки

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

Response[Int32]: object

Ответ

data: integer (int32)

Данные

isSuccess: boolean

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

errorMessage: string

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

errorCode: string None, AccountAccessDenied, ProjectAccessDenied, InvalidOperationDate, UndistributedProject, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle, UndistributedContrAgent, OperationFirstAdditionalOperationAttributeProjectExist, UndistributedFirstAdditionalOperationAttribute

Код ошибки

Example
{
  "data": "integer (int32)",
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

Response[Boolean]: object

Ответ

data: boolean

Данные

isSuccess: boolean

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

errorMessage: string

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

errorCode: string None, AccountAccessDenied, ProjectAccessDenied, InvalidOperationDate, UndistributedProject, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle, UndistributedContrAgent, OperationFirstAdditionalOperationAttributeProjectExist, UndistributedFirstAdditionalOperationAttribute

Код ошибки

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

Response[Object]: object

Ответ

data: object

Данные

isSuccess: boolean

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

errorMessage: string

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

errorCode: string None, AccountAccessDenied, ProjectAccessDenied, InvalidOperationDate, UndistributedProject, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle, UndistributedContrAgent, OperationFirstAdditionalOperationAttributeProjectExist, UndistributedFirstAdditionalOperationAttribute

Код ошибки

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

BusinessApiKeyModel: object

Модель токена бизнеса

apiKey: string

Api key (токен API)

businessId: string (uuid)

Id бизнеса

businessTitle: string

Наименование бизнеса

Example
{
  "apiKey": "string",
  "businessId": "00000000-0000-0000-0000-000000000000",
  "businessTitle": "string"
}

Response[String]: object

Ответ

data: string

Данные

isSuccess: boolean

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

errorMessage: string

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

errorCode: string None, AccountAccessDenied, ProjectAccessDenied, InvalidOperationDate, UndistributedProject, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle, UndistributedContrAgent, OperationFirstAdditionalOperationAttributeProjectExist, UndistributedFirstAdditionalOperationAttribute

Код ошибки

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

Response[IEnumerable[AccountsHistoryModel]]: object

Ответ

data: AccountsHistoryModel

Данные

isSuccess: boolean

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

errorMessage: string

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

errorCode: string None, AccountAccessDenied, ProjectAccessDenied, InvalidOperationDate, UndistributedProject, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle, UndistributedContrAgent, OperationFirstAdditionalOperationAttributeProjectExist, UndistributedFirstAdditionalOperationAttribute

Код ошибки

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, UndistributedProject, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle, UndistributedContrAgent, OperationFirstAdditionalOperationAttributeProjectExist, UndistributedFirstAdditionalOperationAttribute

Код ошибки

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

LayoutInfoModel: object

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

firstName: string

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

accessAlert: string

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

isPayer: boolean

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

hasAccess: boolean

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

isReadOnly: boolean

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

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

IncomeOutcomeAccountHistoryRequest: object

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

periodStartDate: string (date)

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

periodEndDate: string (date)

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

isCalculation: boolean

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

accountId: integer[][]

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

contrAgentId: integer[][]

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

operationCategoryId: integer[][]

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

projectId: integer[][]

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

firstAdditionalOperationAttributeId: integer[][]

Идентификаторы 1-го дополнительного атрибута операции

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

Response[IEnumerable[IncomeOutcomeAccountModel]]: object

Ответ

data: IncomeOutcomeAccountModel

Данные

isSuccess: boolean

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

errorMessage: string

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

errorCode: string None, AccountAccessDenied, ProjectAccessDenied, InvalidOperationDate, UndistributedProject, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle, UndistributedContrAgent, OperationFirstAdditionalOperationAttributeProjectExist, UndistributedFirstAdditionalOperationAttribute

Код ошибки

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

IncomeOutcomeAccountItemModel: object

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

date: string (date)

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

factValue: number (double)

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

planValue: number (double)

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

operationCategoryId: integer (int32)

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

projectId: integer (int32)

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

contrAgentId: integer (int32)

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

operationTypeId: integer (int32)

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

firstAdditionalOperationAttributeId: integer (int32)

Идентификатор 1-го дополнительного атрибута операции

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

IncomeOutcomeOperationCategoryHistoryRequest: object

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

periodStartDate: string (date)

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

periodEndDate: string (date)

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

isCalculation: boolean

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

accountId: integer[][]

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

contrAgentId: integer[][]

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

operationCategoryId: integer[][]

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

projectId: integer[][]

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

firstAdditionalOperationAttributeId: integer[][]

Идентификаторы 1-го дополнительного атрибута операции

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

Response[IEnumerable[IncomeOutcomeOperationCategoryModel]]: object

Ответ

data: IncomeOutcomeOperationCategoryModel

Данные

isSuccess: boolean

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

errorMessage: string

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

errorCode: string None, AccountAccessDenied, ProjectAccessDenied, InvalidOperationDate, UndistributedProject, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle, UndistributedContrAgent, OperationFirstAdditionalOperationAttributeProjectExist, UndistributedFirstAdditionalOperationAttribute

Код ошибки

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)",
          "firstAdditionalOperationAttributeId": "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)",
      "firstAdditionalOperationAttributeId": "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)

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

firstAdditionalOperationAttributeId: integer (int32)

Идентификатор 1-го дополнительного атрибута операции

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

IncomeOutcomeProjectHistoryRequest: object

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

periodStartDate: string (date)

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

periodEndDate: string (date)

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

isCalculation: boolean

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

accountId: integer[][]

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

contrAgentId: integer[][]

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

operationCategoryId: integer[][]

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

projectId: integer[][]

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

firstAdditionalOperationAttributeId: integer[][]

Идентификаторы 1-го дополнительного атрибута операции

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

Response[IEnumerable[IncomeOutcomeProjectModel]]: object

Ответ

data: IncomeOutcomeProjectModel

Данные

isSuccess: boolean

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

errorMessage: string

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

errorCode: string None, AccountAccessDenied, ProjectAccessDenied, InvalidOperationDate, UndistributedProject, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle, UndistributedContrAgent, OperationFirstAdditionalOperationAttributeProjectExist, UndistributedFirstAdditionalOperationAttribute

Код ошибки

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)",
          "firstAdditionalOperationAttributeId": "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)",
      "firstAdditionalOperationAttributeId": "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)

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

firstAdditionalOperationAttributeId: integer (int32)

Идентификатор 1-го дополнительного атрибута операции

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

IncomeOutcomeContrAgentHistoryRequest: object

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

periodStartDate: string (date)

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

periodEndDate: string (date)

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

isCalculation: boolean

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

accountId: integer[][]

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

contrAgentId: integer[][]

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

operationCategoryId: integer[][]

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

projectId: integer[][]

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

firstAdditionalOperationAttributeId: integer[][]

Идентификаторы 1-го дополнительного атрибута операции

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

Response[IEnumerable[IncomeOutcomeContrAgentModel]]: object

Ответ

data: IncomeOutcomeContrAgentModel

Данные

isSuccess: boolean

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

errorMessage: string

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

errorCode: string None, AccountAccessDenied, ProjectAccessDenied, InvalidOperationDate, UndistributedProject, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle, UndistributedContrAgent, OperationFirstAdditionalOperationAttributeProjectExist, UndistributedFirstAdditionalOperationAttribute

Код ошибки

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)",
          "firstAdditionalOperationAttributeId": "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)",
      "firstAdditionalOperationAttributeId": "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)

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

firstAdditionalOperationAttributeId: integer (int32)

Идентификатор 1-го дополнительного атрибута операции

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

IncomeOutcomeFirstAdditionalOperationAttributeHistoryRequest: object

Запрос истории поступлений/выплат сгруппированный по 1-му дополнительному атрибуту операции

periodStartDate: string (date)

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

periodEndDate: string (date)

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

isCalculation: boolean

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

accountId: integer[][]

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

contrAgentId: integer[][]

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

operationCategoryId: integer[][]

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

projectId: integer[][]

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

firstAdditionalOperationAttributeId: integer[][]

Идентификаторы 1-го дополнительного атрибута операции

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

Response[IEnumerable[IncomeOutcomeFirstAdditionalOperationAttributeModel]]: object

Ответ

data: IncomeOutcomeFirstAdditionalOperationAttributeModel

Данные

isSuccess: boolean

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

errorMessage: string

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

errorCode: string None, AccountAccessDenied, ProjectAccessDenied, InvalidOperationDate, UndistributedProject, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle, UndistributedContrAgent, OperationFirstAdditionalOperationAttributeProjectExist, UndistributedFirstAdditionalOperationAttribute

Код ошибки

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

IncomeOutcomeFirstAdditionalOperationAttributeModel: object

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

firstAdditionalOperationAttributeId: integer (int32)

Идентификатор 1-го дополнительного атрибута

details: IncomeOutcomeFirstAdditionalOperationAttributeItemModel

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

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

IncomeOutcomeFirstAdditionalOperationAttributeItemModel: object

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

date: string (date)

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

factValue: number (double)

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

planValue: number (double)

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

operationCategoryId: integer (int32)

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

accountId: integer (int32)

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

contrAgentId: integer (int32)

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

operationTypeId: integer (int32)

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

projectId: integer (int32)

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

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

BusinessCreationRequest: object

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

email: string

Email владельца бизнеса

countryIso2Code: string Russia, Armenia, Azerbaijan, Belarus, China, Kazakhstan, Moldova, Tajikistan, Turkmenistan, Ukraine, Uzbekistan

Код страны

phoneNumber: string

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

firstName: string

Имя

partnerApiKey: string

Ключ Api для партнёра

Example
{
  "email": "string",
  "countryIso2Code": "string",
  "phoneNumber": "string",
  "firstName": "string",
  "partnerApiKey": "string"
}

Response[BusinessApiKeyModel]: object

Ответ

data: BusinessApiKeyModel

Данные

isSuccess: boolean

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

errorMessage: string

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

errorCode: string None, AccountAccessDenied, ProjectAccessDenied, InvalidOperationDate, UndistributedProject, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle, UndistributedContrAgent, OperationFirstAdditionalOperationAttributeProjectExist, UndistributedFirstAdditionalOperationAttribute

Код ошибки

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

Response[CompanyModel]: object

Ответ

data: CompanyModel

Данные

isSuccess: boolean

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

errorMessage: string

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

errorCode: string None, AccountAccessDenied, ProjectAccessDenied, InvalidOperationDate, UndistributedProject, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle, UndistributedContrAgent, OperationFirstAdditionalOperationAttributeProjectExist, UndistributedFirstAdditionalOperationAttribute

Код ошибки

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, ModifyDate

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

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, UndistributedProject, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle, UndistributedContrAgent, OperationFirstAdditionalOperationAttributeProjectExist, UndistributedFirstAdditionalOperationAttribute

Код ошибки

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)",
    "deletedItems": [
      null
    ],
    "totalDeleted": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

ListModel[CompanyModel]: object

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

items: CompanyModel

Элементы

total: integer (int32)

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

deletedItems: DeletedEntityModel

Удалённые элементы

totalDeleted: 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)",
  "deletedItems": [
    null
  ],
  "totalDeleted": "integer (int32)"
}

CompanyCreationRequest: object

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

title: string (up to 256 chars)

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

longTitle: string

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

companyInn: string

ИНН

companyKpp: string

КПП

description: string

Комментарий

externalId: string

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

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

Response[ContrAgentModel]: object

Ответ

data: ContrAgentModel

Данные

isSuccess: boolean

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

errorMessage: string

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

errorCode: string None, AccountAccessDenied, ProjectAccessDenied, InvalidOperationDate, UndistributedProject, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle, UndistributedContrAgent, OperationFirstAdditionalOperationAttributeProjectExist, UndistributedFirstAdditionalOperationAttribute

Код ошибки

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

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

isUndistributed: 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",
  "isUndistributed": "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)

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

inn: string

ИНН

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

Sorting[ContrAgentsSortingFields]: object

Сортировка

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

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

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, UndistributedProject, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle, UndistributedContrAgent, OperationFirstAdditionalOperationAttributeProjectExist, UndistributedFirstAdditionalOperationAttribute

Код ошибки

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",
        "isUndistributed": "boolean",
        "contrAgentId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      }
    ],
    "total": "integer (int32)",
    "deletedItems": [
      null
    ],
    "totalDeleted": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

ListModel[ContrAgentModel]: object

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

items: ContrAgentModel

Элементы

total: integer (int32)

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

deletedItems: DeletedEntityModel

Удалённые элементы

totalDeleted: 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",
      "isUndistributed": "boolean",
      "contrAgentId": "integer (int32)",
      "title": "string",
      "externalId": "string"
    }
  ],
  "total": "integer (int32)",
  "deletedItems": [
    null
  ],
  "totalDeleted": "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)"
  ]
}

TotalsRequest: object

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

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

Response[TotalsWithCrcs]: object

Ответ

data: TotalsWithCrcs

Данные

isSuccess: boolean

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

errorMessage: string

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

errorCode: string None, AccountAccessDenied, ProjectAccessDenied, InvalidOperationDate, UndistributedProject, OperationForProjectExist, OperationForContrAgentExist, OperationForAccountExist, AccountForAgentExist, DuplicateOperationCategoryTitle, UndistributedContrAgent, OperationFirstAdditionalOperationAttributeProjectExist, UndistributedFirstAdditionalOperationAttribute

Код ошибки

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

TotalsWithCrcs: object

totals: TotalsView
coreCrcs: CrcsView
pfCrcs: CrcsView
consistent: boolean
Example
{
  "totals": [
    {
      "accountId": "00000000-0000-0000-0000-000000000000",
      "creditBefore": "number (double)",
      "debitBefore": "number (double)",
      "items": [
        {
          "groupingKey": "string (date)",
          "creditSum": "number (double)",
          "debitSum": "number (double)"
        }
      ]
    }
  ],
  "coreCrcs": [
    {
      "groupingKey": "string (date)",
      "crc": "number (double)"
    }
  ],
  "pfCrcs": [
    {
      "groupingKey": "string (date)",
      "crc": "number (double)"
    }
  ],
  "consistent": "boolean"
}

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

CrcsView: object

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

TotalsItemView: object

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