ПланФакт API API Reference

Как работать с API

  • Доступом к API управляет владелец аккаунта. При работе с API установленные для присоединенного пользователя права и настройки доступа сохраняются.
  • В своей учетной записи получите ключ к API (ApiKey) (раздел https://app.planfact.io/manage/security-settings). Будьте внимательны — ключ к API дает доступ к данным учетной записи, не передавайте его никому.
  • В качестве примера приведен cURL-запрос, в ответ на который API ПланФакта вернет список валют: 
    curl -X GET \
		--header 'Accept: application/json' \
		--header 'X-ApiKey: [ABCD]' \
		'https://api.planfact.io/api/v1/currencies'
    где [ABCD] — это ключ для работы с API.
  • Для тестирования запросов и ответов без консоли можно использовать https://reqbin.com/curl, отправляя cURL-запросы через веб-интерфейс.
  • Примеры
  • Для оперативного решения технических вопросов с API можно обращаться в поддержку на сайте сервиса ПланФакт или в официальной группе в Telegram - https://t.me/planfact_api

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

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)",
    "modifyDate": "string (date)",
    "createDate": "string (date)",
    "actionStatus": "string",
    "isUndistributed": "boolean",
    "startingRemainderDate": "string (date)",
    "startingRemainderValue": "number (double)",
    "startingRemainderValueInUserCurrency": "number (double)",
    "correspondentAcct": "string",
    "accountAliases": [
      {
        "accountId": "integer (int32)",
        "alias": "string",
        "accountAcct": "string",
        "accountBank": "string",
        "accountBik": "string"
      }
    ],
    "acquiringIntegrations": [
      {
        "acquiringIntegrationSettingsId": "00000000-0000-0000-0000-000000000000",
        "acquiringAccount": {
          "accountId": "integer (int32)",
          "title": "string",
          "externalId": "string"
        },
        "acquiringService": "string",
        "connectionDate": "string (date)",
        "settlementAccount": {
          "accountId": "integer (int32)",
          "title": "string",
          "externalId": "string"
        },
        "shopId": "string",
        "shopTitle": "string",
        "contractNumber": "string"
      }
    ],
    "settlementAcquiringIntegrations": [
      {
        "acquiringIntegrationSettingsId": "00000000-0000-0000-0000-000000000000",
        "acquiringAccount": {
          "accountId": "integer (int32)",
          "title": "string",
          "externalId": "string"
        },
        "acquiringService": "string",
        "connectionDate": "string (date)",
        "settlementAccount": {
          "accountId": "integer (int32)",
          "title": "string",
          "externalId": "string"
        },
        "shopId": "string",
        "shopTitle": "string",
        "contractNumber": "string"
      }
    ],
    "accountGroup": {
      "accountGroupId": "integer (int32)",
      "title": "string"
    },
    "accountId": "integer (int32)",
    "title": "string",
    "externalId": "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",
  "correspondentAcct": "string",
  "accountBik": "string",
  "accountBank": "string",
  "currencyCode": "string",
  "active": "boolean",
  "remainder": "number (double)",
  "remainderDate": "string (date)",
  "externalId": "string",
  "accountGroupId": "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)",
    "modifyDate": "string (date)",
    "createDate": "string (date)",
    "actionStatus": "string",
    "isUndistributed": "boolean",
    "startingRemainderDate": "string (date)",
    "startingRemainderValue": "number (double)",
    "startingRemainderValueInUserCurrency": "number (double)",
    "correspondentAcct": "string",
    "accountAliases": [
      {
        "accountId": "integer (int32)",
        "alias": "string",
        "accountAcct": "string",
        "accountBank": "string",
        "accountBik": "string"
      }
    ],
    "acquiringIntegrations": [
      {
        "acquiringIntegrationSettingsId": "00000000-0000-0000-0000-000000000000",
        "acquiringAccount": {
          "accountId": "integer (int32)",
          "title": "string",
          "externalId": "string"
        },
        "acquiringService": "string",
        "connectionDate": "string (date)",
        "settlementAccount": {
          "accountId": "integer (int32)",
          "title": "string",
          "externalId": "string"
        },
        "shopId": "string",
        "shopTitle": "string",
        "contractNumber": "string"
      }
    ],
    "settlementAcquiringIntegrations": [
      {
        "acquiringIntegrationSettingsId": "00000000-0000-0000-0000-000000000000",
        "acquiringAccount": {
          "accountId": "integer (int32)",
          "title": "string",
          "externalId": "string"
        },
        "acquiringService": "string",
        "connectionDate": "string (date)",
        "settlementAccount": {
          "accountId": "integer (int32)",
          "title": "string",
          "externalId": "string"
        },
        "shopId": "string",
        "shopTitle": "string",
        "contractNumber": "string"
      }
    ],
    "accountGroup": {
      "accountGroupId": "integer (int32)",
      "title": "string"
    },
    "accountId": "integer (int32)",
    "title": "string",
    "externalId": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
Accounts

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

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

(no description)

ignoreRules
in query
boolean

Признак игнорирования проверки привязки правил

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, IndividualCard, Electronic

Тип счёта

filter.title
in query
string

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

filter.longTitle
in query
string

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

filter.description
in query
string

Описание

filter.accountAcct
in query
string

Номер счета

filter.correspondentAcct
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, RON, BDT, AZN, NOK, CHF, MVR, LKR, GEL, ILS, TJS, TMT, AUD, NZD, IDR, TRX, PHP, PEN, EGP, VND

Код валюты

filter.active
in query
boolean

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

filter.changesFromDate
in query
string (date)

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

filter.externalId
in query
string[]

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

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

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

paging.limit
in query
integer (int32)

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

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

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

sorting.direction
in query
string Asc, Desc

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

formatting.userCurrencyCode
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, RON, BDT, AZN, NOK, CHF, MVR, LKR, GEL, ILS, TJS, TMT, AUD, NZD, IDR, TRX, PHP, PEN, EGP, VND

Код валюты для пересчета начальны остатков (по умолчанию - валюта аккаунта)

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)",
        "modifyDate": "string (date)",
        "createDate": "string (date)",
        "actionStatus": "string",
        "isUndistributed": "boolean",
        "startingRemainderDate": "string (date)",
        "startingRemainderValue": "number (double)",
        "startingRemainderValueInUserCurrency": "number (double)",
        "correspondentAcct": "string",
        "accountAliases": [
          {
            "accountId": "integer (int32)",
            "alias": "string",
            "accountAcct": "string",
            "accountBank": "string",
            "accountBik": "string"
          }
        ],
        "acquiringIntegrations": [
          {
            "acquiringIntegrationSettingsId": "00000000-0000-0000-0000-000000000000",
            "acquiringAccount": {
              "accountId": "integer (int32)",
              "title": "string",
              "externalId": "string"
            },
            "acquiringService": "string",
            "connectionDate": "string (date)",
            "settlementAccount": {
              "accountId": "integer (int32)",
              "title": "string",
              "externalId": "string"
            },
            "shopId": "string",
            "shopTitle": "string",
            "contractNumber": "string"
          }
        ],
        "settlementAcquiringIntegrations": [
          {
            "acquiringIntegrationSettingsId": "00000000-0000-0000-0000-000000000000",
            "acquiringAccount": {
              "accountId": "integer (int32)",
              "title": "string",
              "externalId": "string"
            },
            "acquiringService": "string",
            "connectionDate": "string (date)",
            "settlementAccount": {
              "accountId": "integer (int32)",
              "title": "string",
              "externalId": "string"
            },
            "shopId": "string",
            "shopTitle": "string",
            "contractNumber": "string"
          }
        ],
        "accountGroup": {
          "accountGroupId": "integer (int32)",
          "title": "string"
        },
        "accountId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      }
    ],
    "total": "integer (int32)",
    "deletedItems": [
      {
        "entityId": "integer (int32)",
        "deleteDate": "string (date)"
      }
    ],
    "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",
  "correspondentAcct": "string",
  "accountBik": "string",
  "accountBank": "string",
  "currencyCode": "string",
  "active": "boolean",
  "remainder": "number (double)",
  "remainderDate": "string (date)",
  "externalId": "string",
  "accountGroupId": "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)",
    "modifyDate": "string (date)",
    "createDate": "string (date)",
    "actionStatus": "string",
    "isUndistributed": "boolean",
    "startingRemainderDate": "string (date)",
    "startingRemainderValue": "number (double)",
    "startingRemainderValueInUserCurrency": "number (double)",
    "correspondentAcct": "string",
    "accountAliases": [
      {
        "accountId": "integer (int32)",
        "alias": "string",
        "accountAcct": "string",
        "accountBank": "string",
        "accountBik": "string"
      }
    ],
    "acquiringIntegrations": [
      {
        "acquiringIntegrationSettingsId": "00000000-0000-0000-0000-000000000000",
        "acquiringAccount": {
          "accountId": "integer (int32)",
          "title": "string",
          "externalId": "string"
        },
        "acquiringService": "string",
        "connectionDate": "string (date)",
        "settlementAccount": {
          "accountId": "integer (int32)",
          "title": "string",
          "externalId": "string"
        },
        "shopId": "string",
        "shopTitle": "string",
        "contractNumber": "string"
      }
    ],
    "settlementAcquiringIntegrations": [
      {
        "acquiringIntegrationSettingsId": "00000000-0000-0000-0000-000000000000",
        "acquiringAccount": {
          "accountId": "integer (int32)",
          "title": "string",
          "externalId": "string"
        },
        "acquiringService": "string",
        "connectionDate": "string (date)",
        "settlementAccount": {
          "accountId": "integer (int32)",
          "title": "string",
          "externalId": "string"
        },
        "shopId": "string",
        "shopTitle": "string",
        "contractNumber": "string"
      }
    ],
    "accountGroup": {
      "accountGroupId": "integer (int32)",
      "title": "string"
    },
    "accountId": "integer (int32)",
    "title": "string",
    "externalId": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
Accounts

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

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

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

paging.limit
in query
integer (int32)

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

200 OK
Response[ListModel[AccountGroupModel]]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "items": [
      {
        "accountGroupId": "integer (int32)",
        "title": "string",
        "description": "string",
        "isUndistributed": "boolean",
        "active": "boolean",
        "headerPosition": "integer (int32)"
      }
    ],
    "total": "integer (int32)",
    "deletedItems": [
      {
        "entityId": "integer (int32)",
        "deleteDate": "string (date)"
      }
    ],
    "totalDeleted": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
Accounts

Создание новой группы счетов

POST /api/v1/accounts/groups
AccountGroupCreationRequest

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

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "title": "string",
  "description": "string",
  "headerPosition": "integer (int32)"
}
200 OK
Response[AccountGroupModel]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "accountGroupId": "integer (int32)",
    "title": "string",
    "description": "string",
    "isUndistributed": "boolean",
    "active": "boolean",
    "headerPosition": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
Accounts

Изменение существующей группы счетов

PUT /api/v1/accounts/groups/{accountGroupId}
AccountGroupModificationRequest

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

accountGroupId
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",
  "headerPosition": "integer (int32)"
}
200 OK
Response[AccountGroupModel]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "accountGroupId": "integer (int32)",
    "title": "string",
    "description": "string",
    "isUndistributed": "boolean",
    "active": "boolean",
    "headerPosition": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
Accounts

Удаление группы счетов

DELETE /api/v1/accounts/groups/{accountGroupId}
accountGroupId
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"
}

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)",
          "factValueInUserCurrency": "number (double)",
          "planValueInUserCurrency": "number (double)",
          "accountCurrencyUserCurrencyRate": "number (double)"
        }
      ]
    }
  ],
  "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",
    "selfReferralCode": "string",
    "accessAlert": "string",
    "paymentRateTitle": "string",
    "paymentPriceCode": "integer (int32)",
    "accessEndDate": "string (date)",
    "lastAccessEndDate": "string (date)",
    "isPayer": "boolean",
    "webinarLink": "string",
    "hasAccess": "boolean",
    "isReadOnly": "boolean",
    "referral": "string",
    "businessEmail": "string"
  },
  "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
filter.userCurrencyCode
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, RON, BDT, AZN, NOK, CHF, MVR, LKR, GEL, ILS, TJS, TMT, AUD, NZD, IDR, TRX, PHP, PEN, EGP, VND

Код валюты для пересчета (по умолчанию - валюта аккаунта)

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)",
          "factValueInUserCurrency": "number (double)",
          "planValueInUserCurrency": "number (double)",
          "accountCurrencyUserCurrencyRate": "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
filter.userCurrencyCode
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, RON, BDT, AZN, NOK, CHF, MVR, LKR, GEL, ILS, TJS, TMT, AUD, NZD, IDR, TRX, PHP, PEN, EGP, VND

Код валюты для пересчета (по умолчанию - валюта аккаунта)

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)",
          "factValueInUserCurrency": "number (double)",
          "planValueInUserCurrency": "number (double)",
          "accountCurrencyUserCurrencyRate": "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
filter.userCurrencyCode
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, RON, BDT, AZN, NOK, CHF, MVR, LKR, GEL, ILS, TJS, TMT, AUD, NZD, IDR, TRX, PHP, PEN, EGP, VND

Код валюты для пересчета (по умолчанию - валюта аккаунта)

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)",
          "factValueInUserCurrency": "number (double)",
          "planValueInUserCurrency": "number (double)",
          "accountCurrencyUserCurrencyRate": "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
filter.userCurrencyCode
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, RON, BDT, AZN, NOK, CHF, MVR, LKR, GEL, ILS, TJS, TMT, AUD, NZD, IDR, TRX, PHP, PEN, EGP, VND

Код валюты для пересчета (по умолчанию - валюта аккаунта)

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)",
          "factValueInUserCurrency": "number (double)",
          "planValueInUserCurrency": "number (double)",
          "accountCurrencyUserCurrencyRate": "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
filter.userCurrencyCode
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, RON, BDT, AZN, NOK, CHF, MVR, LKR, GEL, ILS, TJS, TMT, AUD, NZD, IDR, TRX, PHP, PEN, EGP, VND

Код валюты для пересчета (по умолчанию - валюта аккаунта)

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)",
          "factValueInUserCurrency": "number (double)",
          "planValueInUserCurrency": "number (double)",
          "accountCurrencyUserCurrencyRate": "number (double)",
          "operationCategoryId": "integer (int32)",
          "accountId": "integer (int32)",
          "contrAgentId": "integer (int32)",
          "operationTypeId": "integer (int32)",
          "projectId": "integer (int32)"
        }
      ]
    }
  ],
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

Budgets

Budgets

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

GET /api/v1/budgets/{budgetId}
budgetId
in path
string (uuid)

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

200 OK
Response[BudgetDetailModel]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "versions": [
      {
        "budgetType": "string",
        "budgetDirectionType": "string",
        "createDate": "string (date)",
        "modifyDate": "string (date)",
        "info": {
          "entityIds": [
            "integer (int32)"
          ],
          "items": [
            {
              "operationCategoryId": "integer (int32)",
              "outcomeOperationCategoryClassification": "string",
              "entityId": "integer (int32)",
              "date": "string (date)",
              "value": "number (double)",
              "valueInUserCurrency": "number (double)"
            }
          ]
        }
      }
    ],
    "budgetId": "00000000-0000-0000-0000-000000000000",
    "userEmail": "string",
    "title": "string",
    "budgetStatus": "string",
    "createDate": "string (date)",
    "modifyDate": "string (date)",
    "startDate": "string (date)",
    "endDate": "string (date)",
    "entityIds": [
      "integer (int32)"
    ],
    "currencyCode": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
Budgets

Изменение существующего бюджета

PUT /api/v1/budgets/{budgetId}
BudgetModificationRequest

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

budgetId
in path
string (uuid)

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

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "title": "string",
  "startDate": "string (date)",
  "endDate": "string (date)",
  "budgetStatus": "string",
  "versions": [
    {
      "budgetType": "string",
      "budgetDirectionType": "string",
      "info": {
        "entityIds": [
          "integer (int32)"
        ],
        "items": [
          {
            "operationCategoryId": "integer (int32)",
            "outcomeOperationCategoryClassification": "string",
            "entityId": "integer (int32)",
            "date": "string (date)",
            "value": "number (double)",
            "valueInUserCurrency": "number (double)"
          }
        ]
      }
    }
  ],
  "currencyCode": "string"
}
200 OK
Response[BudgetDetailModel]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "versions": [
      {
        "budgetType": "string",
        "budgetDirectionType": "string",
        "createDate": "string (date)",
        "modifyDate": "string (date)",
        "info": {
          "entityIds": [
            "integer (int32)"
          ],
          "items": [
            {
              "operationCategoryId": "integer (int32)",
              "outcomeOperationCategoryClassification": "string",
              "entityId": "integer (int32)",
              "date": "string (date)",
              "value": "number (double)",
              "valueInUserCurrency": "number (double)"
            }
          ]
        }
      }
    ],
    "budgetId": "00000000-0000-0000-0000-000000000000",
    "userEmail": "string",
    "title": "string",
    "budgetStatus": "string",
    "createDate": "string (date)",
    "modifyDate": "string (date)",
    "startDate": "string (date)",
    "endDate": "string (date)",
    "entityIds": [
      "integer (int32)"
    ],
    "currencyCode": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
Budgets

Удаление бюджета

DELETE /api/v1/budgets/{budgetId}
budgetId
in path
string (uuid)

(no description)

200 OK
Response

OK

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

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

GET /api/v1/budgets/settings/{budgetId}
budgetId
in path
string (uuid)

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

200 OK
Response[BudgetSettingsModel]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "budgetId": "00000000-0000-0000-0000-000000000000",
    "isGrossProfit": "boolean",
    "isOperatingProfit": "boolean",
    "isEBITDA": "boolean",
    "isEBIT": "boolean",
    "isEBT": "boolean",
    "groupByType": "string",
    "isShowFact": "boolean",
    "isDelta": "boolean",
    "isPercentOfPlan": "boolean",
    "isPercentOfDelta": "boolean"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
Budgets

Изменение существующих настроек бюджета

PUT /api/v1/budgets/settings/{budgetId}
BudgetSettingsModificationRequest

Обновленные значения настроек бюджета

budgetId
in path
string (uuid)

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

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "isGrossProfit": "boolean",
  "isOperatingProfit": "boolean",
  "isEBITDA": "boolean",
  "isEBIT": "boolean",
  "isEBT": "boolean",
  "groupByType": "string",
  "isShowFact": "boolean",
  "isDelta": "boolean",
  "isPercentOfPlan": "boolean",
  "isPercentOfDelta": "boolean"
}
200 OK
Response[BudgetSettingsModel]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "budgetId": "00000000-0000-0000-0000-000000000000",
    "isGrossProfit": "boolean",
    "isOperatingProfit": "boolean",
    "isEBITDA": "boolean",
    "isEBIT": "boolean",
    "isEBT": "boolean",
    "groupByType": "string",
    "isShowFact": "boolean",
    "isDelta": "boolean",
    "isPercentOfPlan": "boolean",
    "isPercentOfDelta": "boolean"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
Budgets

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

GET /api/v1/budgets
filter.title
in query
string

Наименование

filter.projectId
in query
integer[]

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

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

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

paging.limit
in query
integer (int32)

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

sorting.field
in query
string Title, ModifyDate

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

sorting.direction
in query
string Asc, Desc

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

200 OK
Response[ListModel[BudgetModel]]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "items": [
      {
        "budgetId": "00000000-0000-0000-0000-000000000000",
        "userEmail": "string",
        "title": "string",
        "budgetStatus": "string",
        "createDate": "string (date)",
        "modifyDate": "string (date)",
        "startDate": "string (date)",
        "endDate": "string (date)",
        "entityIds": [
          "integer (int32)"
        ],
        "currencyCode": "string"
      }
    ],
    "total": "integer (int32)",
    "deletedItems": [
      {
        "entityId": "integer (int32)",
        "deleteDate": "string (date)"
      }
    ],
    "totalDeleted": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
Budgets

Создание нового бюджета

POST /api/v1/budgets
BudgetCreationRequest

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

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "title": "string",
  "startDate": "string (date)",
  "endDate": "string (date)",
  "budgetType": "string",
  "entityIds": [
    "integer (int32)"
  ],
  "currencyCode": "string"
}
200 OK
Response[BudgetDetailModel]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "versions": [
      {
        "budgetType": "string",
        "budgetDirectionType": "string",
        "createDate": "string (date)",
        "modifyDate": "string (date)",
        "info": {
          "entityIds": [
            "integer (int32)"
          ],
          "items": [
            {
              "operationCategoryId": "integer (int32)",
              "outcomeOperationCategoryClassification": "string",
              "entityId": "integer (int32)",
              "date": "string (date)",
              "value": "number (double)",
              "valueInUserCurrency": "number (double)"
            }
          ]
        }
      }
    ],
    "budgetId": "00000000-0000-0000-0000-000000000000",
    "userEmail": "string",
    "title": "string",
    "budgetStatus": "string",
    "createDate": "string (date)",
    "modifyDate": "string (date)",
    "startDate": "string (date)",
    "endDate": "string (date)",
    "entityIds": [
      "integer (int32)"
    ],
    "currencyCode": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
Budgets

Закрытие бюджета

POST /api/v1/budgets/close/{budgetId}
budgetId
in path
string (uuid)

(no description)

200 OK
Response

OK

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

Businesses

Businesses

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

GET /api/v1/businesses
filter.actionLogDateStart
in query
string (date)

Дата действия. Начало.

filter.actionLogDateEnd
in query
string (date)

Дата действия. Конец.

filter.userId
in query
string[]

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

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

Подстрока для поиска

paging.offset
in query
integer (int32)

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

paging.limit
in query
integer (int32)

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

sorting.field
in query
string ActionDate, User

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

sorting.direction
in query
string Asc, Desc

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

200 OK
Response[ListModel[ActionLogModel]]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "items": [
      {
        "actionDate": "string (date)",
        "userId": "string",
        "description": "string"
      }
    ],
    "total": "integer (int32)",
    "deletedItems": [
      {
        "entityId": "integer (int32)",
        "deleteDate": "string (date)"
      }
    ],
    "totalDeleted": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
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",
    "directorFIO": "string",
    "directorSignFileId": "00000000-0000-0000-0000-000000000000",
    "companyStampFileId": "00000000-0000-0000-0000-000000000000",
    "accountantFIO": "string",
    "accountantSignFileId": "00000000-0000-0000-0000-000000000000",
    "companyLogoFileId": "00000000-0000-0000-0000-000000000000",
    "bankIntegrationTokens": [
      {
        "bankId": "integer (int32)",
        "bankIntegrationTokenId": "integer (int32)"
      }
    ],
    "headerPosition": "integer (int32)",
    "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",
  "directorFIO": "string",
  "directorSignFileId": "00000000-0000-0000-0000-000000000000",
  "companyStampFileId": "00000000-0000-0000-0000-000000000000",
  "accountantFIO": "string",
  "accountantSignFileId": "00000000-0000-0000-0000-000000000000",
  "companyLogoFileId": "00000000-0000-0000-0000-000000000000",
  "headerPosition": "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",
    "directorFIO": "string",
    "directorSignFileId": "00000000-0000-0000-0000-000000000000",
    "companyStampFileId": "00000000-0000-0000-0000-000000000000",
    "accountantFIO": "string",
    "accountantSignFileId": "00000000-0000-0000-0000-000000000000",
    "companyLogoFileId": "00000000-0000-0000-0000-000000000000",
    "bankIntegrationTokens": [
      {
        "bankId": "integer (int32)",
        "bankIntegrationTokenId": "integer (int32)"
      }
    ],
    "headerPosition": "integer (int32)",
    "companyId": "integer (int32)",
    "title": "string",
    "externalId": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
Companies

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

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

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

ignoreRules
in query
boolean

Признак игнорирования проверки привязки правил

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",
        "directorFIO": "string",
        "directorSignFileId": "00000000-0000-0000-0000-000000000000",
        "companyStampFileId": "00000000-0000-0000-0000-000000000000",
        "accountantFIO": "string",
        "accountantSignFileId": "00000000-0000-0000-0000-000000000000",
        "companyLogoFileId": "00000000-0000-0000-0000-000000000000",
        "bankIntegrationTokens": [
          {
            "bankId": "integer (int32)",
            "bankIntegrationTokenId": "integer (int32)"
          }
        ],
        "headerPosition": "integer (int32)",
        "companyId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      }
    ],
    "total": "integer (int32)",
    "deletedItems": [
      {
        "entityId": "integer (int32)",
        "deleteDate": "string (date)"
      }
    ],
    "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",
  "directorFIO": "string",
  "directorSignFileId": "00000000-0000-0000-0000-000000000000",
  "companyStampFileId": "00000000-0000-0000-0000-000000000000",
  "accountantFIO": "string",
  "accountantSignFileId": "00000000-0000-0000-0000-000000000000",
  "companyLogoFileId": "00000000-0000-0000-0000-000000000000",
  "headerPosition": "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",
    "directorFIO": "string",
    "directorSignFileId": "00000000-0000-0000-0000-000000000000",
    "companyStampFileId": "00000000-0000-0000-0000-000000000000",
    "accountantFIO": "string",
    "accountantSignFileId": "00000000-0000-0000-0000-000000000000",
    "companyLogoFileId": "00000000-0000-0000-0000-000000000000",
    "bankIntegrationTokens": [
      {
        "bankId": "integer (int32)",
        "bankIntegrationTokenId": "integer (int32)"
      }
    ],
    "headerPosition": "integer (int32)",
    "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",
    "contrAgentAcct": "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",
    "contrAgentAliases": [
      {
        "contrAgentId": "integer (int32)",
        "alias": "string",
        "contrAgentInn": "string",
        "contrAgentAcct": "string"
      }
    ],
    "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",
  "contrAgentAcct": "string",
  "contrAgentKpp": "string",
  "description": "string",
  "contrAgentType": "string",
  "rememberCategory": "boolean",
  "operationIncomeCategoryId": "integer (int32)",
  "operationOutcomeCategoryId": "integer (int32)",
  "active": "boolean",
  "externalId": "string"
}
200 OK
Response[ContrAgentModel]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "longTitle": "string",
    "contrAgentInn": "string",
    "contrAgentAcct": "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",
    "contrAgentAliases": [
      {
        "contrAgentId": "integer (int32)",
        "alias": "string",
        "contrAgentInn": "string",
        "contrAgentAcct": "string"
      }
    ],
    "contrAgentId": "integer (int32)",
    "title": "string",
    "externalId": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
ContrAgents

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

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

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

ignoreRules
in query
boolean

Признак игнорирования проверки привязки правил

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",
    "contrAgentAcct": "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",
    "contrAgentAliases": [
      {
        "contrAgentId": "integer (int32)",
        "alias": "string",
        "contrAgentInn": "string",
        "contrAgentAcct": "string"
      }
    ],
    "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

ИНН

filter.externalId
in query
string[]

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

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

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

paging.limit
in query
integer (int32)

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

sorting.field
in query
string Title, 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",
        "contrAgentAcct": "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",
        "contrAgentAliases": [
          {
            "contrAgentId": "integer (int32)",
            "alias": "string",
            "contrAgentInn": "string",
            "contrAgentAcct": "string"
          }
        ],
        "contrAgentId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      }
    ],
    "total": "integer (int32)",
    "deletedItems": [
      {
        "entityId": "integer (int32)",
        "deleteDate": "string (date)"
      }
    ],
    "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",
  "contrAgentAcct": "string",
  "contrAgentKpp": "string",
  "description": "string",
  "contrAgentType": "string",
  "rememberCategory": "boolean",
  "operationIncomeCategoryId": "integer (int32)",
  "operationOutcomeCategoryId": "integer (int32)",
  "active": "boolean",
  "externalId": "string"
}
200 OK
Response[ContrAgentModel]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "longTitle": "string",
    "contrAgentInn": "string",
    "contrAgentAcct": "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",
    "contrAgentAliases": [
      {
        "contrAgentId": "integer (int32)",
        "alias": "string",
        "contrAgentInn": "string",
        "contrAgentAcct": "string"
      }
    ],
    "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

ИНН

filter.externalId
in query
string[]

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

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

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

paging.limit
in query
integer (int32)

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

sorting.field
in query
string Title, 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",
        "contrAgentAcct": "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",
        "contrAgentAliases": [
          {
            "contrAgentId": "integer (int32)",
            "alias": "string",
            "contrAgentInn": "string",
            "contrAgentAcct": "string"
          }
        ],
        "contrAgentId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      }
    ],
    "total": "integer (int32)",
    "deletedItems": [
      {
        "entityId": "integer (int32)",
        "deleteDate": "string (date)"
      }
    ],
    "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)

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, RON, BDT, AZN, NOK, CHF, MVR, LKR, GEL, ILS, TJS, TMT, AUD, NZD, IDR, TRX, PHP, PEN, EGP, VND

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

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

GET /api/v1/coreapi/core-links
200 OK
Response[CoreLinksModel]

OK

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

Проверка доступности баланса по правам доступа

GET /api/v1/coreapi/check-permissions
200 OK
Response[Boolean]

OK

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

Currencies

Currencies

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

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

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "date": "string (date)",
    "items": [
      {
        "shortTitle": "string",
        "value": "number (double)",
        "currencyCode": "string",
        "title": "string"
      }
    ],
    "total": "integer (int32)",
    "deletedItems": [
      {
        "entityId": "integer (int32)",
        "deleteDate": "string (date)"
      }
    ],
    "totalDeleted": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
Currencies

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

GET /api/v1/currencies/history
filter.currencyIds
in query
integer[]

Фильтр идентификаторов валют

Array values passed as multiple parameters: ?filter.currencyIds=aaa&filter.currencyIds=bbb
filter.startDate
in query
string (date)

Дата начала истории (включительно)

filter.endDate
in query
string (date)

Дата окончания истории (включительно)

200 OK
Response[Dictionary[Int32,Dictionary[DateTime,Decimal]]]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": "object",
  "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",
    "externalId": "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",
  "externalId": "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",
    "externalId": "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",
    "externalId": "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)

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

filter.externalId
in query
string[]

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

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

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

paging.limit
in query
integer (int32)

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

sorting.field
in query
string Title, 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",
        "externalId": "string"
      }
    ],
    "total": "integer (int32)",
    "deletedItems": [
      {
        "entityId": "integer (int32)",
        "deleteDate": "string (date)"
      }
    ],
    "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",
  "externalId": "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",
    "externalId": "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)

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

filter.externalId
in query
string[]

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

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

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

paging.limit
in query
integer (int32)

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

sorting.field
in query
string Title, 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",
        "externalId": "string"
      }
    ],
    "total": "integer (int32)",
    "deletedItems": [
      {
        "entityId": "integer (int32)",
        "deleteDate": "string (date)"
      }
    ],
    "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": [
      {
        "entityId": "integer (int32)",
        "deleteDate": "string (date)"
      }
    ],
    "totalDeleted": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

Invoices

Invoices

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

GET /api/v1/invoices/{invoiceId}
invoiceId
in path
string (uuid)

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

200 OK
Response[InvoiceModel]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "billingDate": "string (date)",
    "operationDate": "string (date)",
    "calculationDate": "string (date)",
    "account": {
      "accountId": "integer (int32)",
      "title": "string",
      "externalId": "string"
    },
    "contrAgent": {
      "contrAgentId": "integer (int32)",
      "title": "string",
      "externalId": "string"
    },
    "invoiceParts": [
      {
        "invoicePartId": "00000000-0000-0000-0000-000000000000",
        "productId": "00000000-0000-0000-0000-000000000000",
        "product": {
          "productId": "00000000-0000-0000-0000-000000000000",
          "title": "string",
          "externalId": "string"
        },
        "value": "number (double)",
        "discount": "number (double)",
        "count": "integer (int32)",
        "vat": "number (double)",
        "sort": "integer (int32)"
      }
    ],
    "operationCommittedValue": "number (double)",
    "calculationCommittedValue": "number (double)",
    "debitExpiredValue": "number (double)",
    "debitNotExpiredValue": "number (double)",
    "creditExpiredValue": "number (double)",
    "creditNotExpiredValue": "number (double)",
    "lastBindOperationDate": "string (date)",
    "expiredDays": "integer (int32)",
    "state": "integer (int32)",
    "comment": "string",
    "useVat": "boolean",
    "invoiceId": "00000000-0000-0000-0000-000000000000",
    "number": "string",
    "externalId": "string",
    "operationValue": "number (double)",
    "calculationValue": "number (double)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
Invoices

Удаление счета на оплату

DELETE /api/v1/invoices/{invoiceId}
invoiceId
in path
string (uuid)

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

200 OK
Response

OK

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

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

GET /api/v1/invoices
filter.billingDateStart
in query
string (date)

Дата выставления. Начало.

filter.billingDateEnd
in query
string (date)

Дата выставления. Конец.

filter.valueMin
in query
number (double)

Сумма счета. Минимум

filter.valueMax
in query
number (double)

Сумма счета. Максимум

filter.factOperationDateStart
in query
string (date)

Фактическая дата оплаты. Начало.

filter.factOperationDateEnd
in query
string (date)

Фактическая дата оплаты. Конец.

filter.planOperationDateStart
in query
string (date)

Плановая дата оплаты. Начало.

filter.planOperationDateEnd
in query
string (date)

Плановая дата оплаты. Конец.

filter.committedVariation
in query
string[]

Статус счета

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

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

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

Дата оплаты просрочена

filter.isOperationDateNotExpired
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.invoiceId
in query
string[]

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

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

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

filter.externalId
in query
string[]

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

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

Поисковая строка

paging.offset
in query
integer (int32)

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

paging.limit
in query
integer (int32)

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

sorting.field
in query
string BillingDate, OperationDate, ContrAgent, State, ExpiredDays, Value, DebtValue

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

sorting.direction
in query
string Asc, Desc

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

200 OK
Response[ListModel[InvoiceModel]]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "items": [
      {
        "billingDate": "string (date)",
        "operationDate": "string (date)",
        "calculationDate": "string (date)",
        "account": {
          "accountId": "integer (int32)",
          "title": "string",
          "externalId": "string"
        },
        "contrAgent": {
          "contrAgentId": "integer (int32)",
          "title": "string",
          "externalId": "string"
        },
        "invoiceParts": [
          {
            "invoicePartId": "00000000-0000-0000-0000-000000000000",
            "productId": "00000000-0000-0000-0000-000000000000",
            "product": {
              "productId": "00000000-0000-0000-0000-000000000000",
              "title": "string",
              "externalId": "string"
            },
            "value": "number (double)",
            "discount": "number (double)",
            "count": "integer (int32)",
            "vat": "number (double)",
            "sort": "integer (int32)"
          }
        ],
        "operationCommittedValue": "number (double)",
        "calculationCommittedValue": "number (double)",
        "debitExpiredValue": "number (double)",
        "debitNotExpiredValue": "number (double)",
        "creditExpiredValue": "number (double)",
        "creditNotExpiredValue": "number (double)",
        "lastBindOperationDate": "string (date)",
        "expiredDays": "integer (int32)",
        "state": "integer (int32)",
        "comment": "string",
        "useVat": "boolean",
        "invoiceId": "00000000-0000-0000-0000-000000000000",
        "number": "string",
        "externalId": "string",
        "operationValue": "number (double)",
        "calculationValue": "number (double)"
      }
    ],
    "total": "integer (int32)",
    "deletedItems": [
      {
        "entityId": "integer (int32)",
        "deleteDate": "string (date)"
      }
    ],
    "totalDeleted": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
Invoices

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

POST /api/v1/invoices/income
InvoiceCreationRequest

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

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "billingDate": "string (date)",
  "operationDate": "string (date)",
  "calculationDate": "string (date)",
  "number": "string",
  "accountId": "integer (int32)",
  "contrAgentId": "integer (int32)",
  "items": [
    {
      "productId": "00000000-0000-0000-0000-000000000000",
      "value": "number (double)",
      "discount": "number (double)",
      "count": "integer (int32)",
      "vat": "number (double)",
      "sort": "integer (int32)"
    }
  ],
  "comment": "string",
  "useVat": "boolean",
  "externalId": "string"
}
200 OK
Response[InvoiceModel]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "billingDate": "string (date)",
    "operationDate": "string (date)",
    "calculationDate": "string (date)",
    "account": {
      "accountId": "integer (int32)",
      "title": "string",
      "externalId": "string"
    },
    "contrAgent": {
      "contrAgentId": "integer (int32)",
      "title": "string",
      "externalId": "string"
    },
    "invoiceParts": [
      {
        "invoicePartId": "00000000-0000-0000-0000-000000000000",
        "productId": "00000000-0000-0000-0000-000000000000",
        "product": {
          "productId": "00000000-0000-0000-0000-000000000000",
          "title": "string",
          "externalId": "string"
        },
        "value": "number (double)",
        "discount": "number (double)",
        "count": "integer (int32)",
        "vat": "number (double)",
        "sort": "integer (int32)"
      }
    ],
    "operationCommittedValue": "number (double)",
    "calculationCommittedValue": "number (double)",
    "debitExpiredValue": "number (double)",
    "debitNotExpiredValue": "number (double)",
    "creditExpiredValue": "number (double)",
    "creditNotExpiredValue": "number (double)",
    "lastBindOperationDate": "string (date)",
    "expiredDays": "integer (int32)",
    "state": "integer (int32)",
    "comment": "string",
    "useVat": "boolean",
    "invoiceId": "00000000-0000-0000-0000-000000000000",
    "number": "string",
    "externalId": "string",
    "operationValue": "number (double)",
    "calculationValue": "number (double)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
Invoices

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

PUT /api/v1/invoices/income/{invoiceId}
InvoiceModificationRequest

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

invoiceId
in path
string (uuid)

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

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "billingDate": "string (date)",
  "operationDate": "string (date)",
  "calculationDate": "string (date)",
  "number": "string",
  "accountId": "integer (int32)",
  "contrAgentId": "integer (int32)",
  "items": [
    {
      "productId": "00000000-0000-0000-0000-000000000000",
      "value": "number (double)",
      "discount": "number (double)",
      "count": "integer (int32)",
      "vat": "number (double)",
      "sort": "integer (int32)"
    }
  ],
  "comment": "string",
  "useVat": "boolean",
  "externalId": "string"
}
200 OK
Response[InvoiceModel]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "billingDate": "string (date)",
    "operationDate": "string (date)",
    "calculationDate": "string (date)",
    "account": {
      "accountId": "integer (int32)",
      "title": "string",
      "externalId": "string"
    },
    "contrAgent": {
      "contrAgentId": "integer (int32)",
      "title": "string",
      "externalId": "string"
    },
    "invoiceParts": [
      {
        "invoicePartId": "00000000-0000-0000-0000-000000000000",
        "productId": "00000000-0000-0000-0000-000000000000",
        "product": {
          "productId": "00000000-0000-0000-0000-000000000000",
          "title": "string",
          "externalId": "string"
        },
        "value": "number (double)",
        "discount": "number (double)",
        "count": "integer (int32)",
        "vat": "number (double)",
        "sort": "integer (int32)"
      }
    ],
    "operationCommittedValue": "number (double)",
    "calculationCommittedValue": "number (double)",
    "debitExpiredValue": "number (double)",
    "debitNotExpiredValue": "number (double)",
    "creditExpiredValue": "number (double)",
    "creditNotExpiredValue": "number (double)",
    "lastBindOperationDate": "string (date)",
    "expiredDays": "integer (int32)",
    "state": "integer (int32)",
    "comment": "string",
    "useVat": "boolean",
    "invoiceId": "00000000-0000-0000-0000-000000000000",
    "number": "string",
    "externalId": "string",
    "operationValue": "number (double)",
    "calculationValue": "number (double)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
Invoices

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

GET /api/v1/invoices/summary
filter.billingDateStart
in query
string (date)

Дата выставления. Начало.

filter.billingDateEnd
in query
string (date)

Дата выставления. Конец.

filter.valueMin
in query
number (double)

Сумма счета. Минимум

filter.valueMax
in query
number (double)

Сумма счета. Максимум

filter.factOperationDateStart
in query
string (date)

Фактическая дата оплаты. Начало.

filter.factOperationDateEnd
in query
string (date)

Фактическая дата оплаты. Конец.

filter.planOperationDateStart
in query
string (date)

Плановая дата оплаты. Начало.

filter.planOperationDateEnd
in query
string (date)

Плановая дата оплаты. Конец.

filter.committedVariation
in query
string[]

Статус счета

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

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

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

Дата оплаты просрочена

filter.isOperationDateNotExpired
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.invoiceId
in query
string[]

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

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

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

filter.externalId
in query
string[]

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

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

Поисковая строка

200 OK
Response[InvoiceSummaryModel]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "totalValue": "number (double)",
    "committedValue": "number (double)",
    "uncommittedValue": "number (double)",
    "expiredUncommittedValue": "number (double)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
Invoices

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

POST /api/v1/invoices/bind
InvoiceBindRequest

undefined

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "invoiceId": "00000000-0000-0000-0000-000000000000",
  "operationId": "integer (int32)"
}
200 OK
Response

OK

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

Отвязка операции к счету на оплату

POST /api/v1/invoices/unbind
InvoiceUnbindRequest

undefined

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "invoiceId": "00000000-0000-0000-0000-000000000000",
  "operationId": "integer (int32)"
}
200 OK
Response

OK

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

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

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

Идентификатор задания на получение документа

200 OK
Response[InvoiceDocumentTaskModel]

OK

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

Получение документа по хэшу

GET /api/v1/invoices/document/shared
hash
in query
string

(no description)

200 OK
Response[FileModel]

OK

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

Создание задания на получение документа

POST /api/v1/invoices/document
InvoiceGenerationRequest

Модель счета на оплату

isGenerateHash
in query
boolean

(no description)

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "invoiceId": "00000000-0000-0000-0000-000000000000",
  "billingDate": "string (date)",
  "operationDate": "string (date)",
  "calculationDate": "string (date)",
  "number": "string",
  "accountId": "integer (int32)",
  "contrAgentId": "integer (int32)",
  "items": [
    {
      "productId": "00000000-0000-0000-0000-000000000000",
      "value": "number (double)",
      "discount": "number (double)",
      "count": "integer (int32)",
      "vat": "number (double)",
      "sort": "integer (int32)"
    }
  ],
  "comment": "string",
  "useVat": "boolean"
}
200 OK
Response[Guid]

OK

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

InvoiceTemplates

InvoiceTemplates

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

GET /api/v1/invoice-templates
paging.offset
in query
integer (int32)

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

paging.limit
in query
integer (int32)

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

200 OK
Response[ListModel[InvoiceTemplateModel]]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "items": [
      {
        "invoiceTemplateId": "00000000-0000-0000-0000-000000000000",
        "numberTemplate": "string",
        "startNumber": "integer (int32)",
        "active": "boolean"
      }
    ],
    "total": "integer (int32)",
    "deletedItems": [
      {
        "entityId": "integer (int32)",
        "deleteDate": "string (date)"
      }
    ],
    "totalDeleted": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
InvoiceTemplates

Создание нового шаблона счета на оплату

POST /api/v1/invoice-templates
InvoiceTemplateCreationRequest

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

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "numberTemplate": "string",
  "startNumber": "integer (int32)",
  "active": "boolean"
}
200 OK
Response[InvoiceTemplateModel]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "invoiceTemplateId": "00000000-0000-0000-0000-000000000000",
    "numberTemplate": "string",
    "startNumber": "integer (int32)",
    "active": "boolean"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
InvoiceTemplates

Создание нового шаблона счета на оплату

POST /api/v1/invoice-templates/generate
InvoiceTemplateGenerationRequest

undefined

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "billingDate": "string (date)"
}
200 OK
Response[InvoiceTemplateGeneratedModel]

OK

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

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

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

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

ignoreRules
in query
boolean

Признак игнорирования проверки привязки правил

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)

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

filter.externalId
in query
string[]

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

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

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

paging.limit
in query
integer (int32)

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

sorting.field
in query
string Title, 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",
        "modifyDate": "string (date)",
        "createDate": "string (date)",
        "actionStatus": "string",
        "operationCategoryId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      }
    ],
    "total": "integer (int32)",
    "deletedItems": [
      {
        "entityId": "integer (int32)",
        "deleteDate": "string (date)"
      }
    ],
    "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)",
  "externalId": "string"
}
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",
    "modifyDate": "string (date)",
    "createDate": "string (date)",
    "actionStatus": "string",
    "operationCategoryId": "integer (int32)",
    "title": "string",
    "externalId": "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": {
    "invoiceId": "00000000-0000-0000-0000-000000000000",
    "invoice": {
      "invoiceId": "00000000-0000-0000-0000-000000000000",
      "number": "string",
      "externalId": "string",
      "operationValue": "number (double)",
      "calculationValue": "number (double)",
      "billingDate": "string (date)"
    },
    "isAutoLinkedToInvoice": "boolean",
    "distributeCalculationDate": "string (date)",
    "distributeCalculationType": "string",
    "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",
        "externalId": "string"
      },
      "accountCompany": {
        "companyId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      },
      "accountCurrency": {
        "currencyCode": "string",
        "title": "string"
      },
      "operationCategory": {
        "operationCategoryId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      },
      "operationCategoryActivityType": "string",
      "comment": "string",
      "value": "number (double)",
      "operationParts": [
        {
          "calculationDate": "string (date)",
          "isCalculationCommitted": "boolean",
          "project": {
            "projectId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "contrAgent": {
            "contrAgentId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "operationCategory": {
            "operationCategoryId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "operationCategoryActivityType": "string",
          "firstAdditionalOperationAttribute": {
            "firstAdditionalOperationAttributeId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "value": "number (double)",
          "valueInUserCurrency": "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",
      "valueInUserCurrency": "number (double)",
      "documentNumber": "string"
    },
    "operationId": "integer (int32)",
    "operationType": "string",
    "operationDate": "string (date)",
    "calculationPeriodDate": "string (date)",
    "isCalculationCommitted": "boolean",
    "contrAgent": {
      "contrAgentId": "integer (int32)",
      "title": "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.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.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.valueOnlyOfWholeOperation
in query
boolean

Фильтровать только по сумме целой операции

filter.projectId
in query
integer[]

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

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

Без счета на оплату

filter.invoiceId
in query
string[]

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

Array values passed as multiple parameters: ?filter.invoiceId=aaa&filter.invoiceId=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.invoiceSearchString
in query
string

Строка для расширенного поиска по номеру счета

filter.changesFromDate
in query
string (date)

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

filter.disableNavigationProperties
in query
boolean

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

filter.groupMoveOperations
in query
boolean

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

filter.moveComplexOperationType
in query
string IncomePart, OutcomePart

Подтип операции перемещение

filter.accrualComplexOperationType
in query
string IncomePart, OutcomePart

Подтип операции начисление

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, Invoice, ValueInUserCurrency

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

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": [
      {
        "invoiceId": "00000000-0000-0000-0000-000000000000",
        "invoice": {
          "invoiceId": "00000000-0000-0000-0000-000000000000",
          "number": "string",
          "externalId": "string",
          "operationValue": "number (double)",
          "calculationValue": "number (double)",
          "billingDate": "string (date)"
        },
        "isAutoLinkedToInvoice": "boolean",
        "distributeCalculationDate": "string (date)",
        "distributeCalculationType": "string",
        "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",
            "externalId": "string"
          },
          "accountCompany": {
            "companyId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "accountCurrency": {
            "currencyCode": "string",
            "title": "string"
          },
          "operationCategory": {
            "operationCategoryId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "operationCategoryActivityType": "string",
          "comment": "string",
          "value": "number (double)",
          "operationParts": [
            {
              "calculationDate": "string (date)",
              "isCalculationCommitted": "boolean",
              "project": {
                "projectId": "integer (int32)",
                "title": "string",
                "externalId": "string"
              },
              "contrAgent": {
                "contrAgentId": "integer (int32)",
                "title": "string",
                "externalId": "string"
              },
              "operationCategory": {
                "operationCategoryId": "integer (int32)",
                "title": "string",
                "externalId": "string"
              },
              "operationCategoryActivityType": "string",
              "firstAdditionalOperationAttribute": {
                "firstAdditionalOperationAttributeId": "integer (int32)",
                "title": "string",
                "externalId": "string"
              },
              "value": "number (double)",
              "valueInUserCurrency": "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",
          "valueInUserCurrency": "number (double)",
          "documentNumber": "string"
        },
        "operationId": "integer (int32)",
        "operationType": "string",
        "operationDate": "string (date)",
        "calculationPeriodDate": "string (date)",
        "isCalculationCommitted": "boolean"
      }
    ]
  }
}
Operations

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

POST /api/v1/operations/list
OperationListRequest

Запрос

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, Invoice, ValueInUserCurrency

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

sorting.direction
in query
string Asc, Desc

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

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "operationId": [
    "integer (int32)"
  ],
  "operationDateStart": "string (date)",
  "operationDateEnd": "string (date)",
  "calculationPeriodDateStart": "string (date)",
  "calculationPeriodDateEnd": "string (date)",
  "withoutContrAgentId": "boolean",
  "contrAgentId": [
    "integer (int32)"
  ],
  "accountId": [
    "integer (int32)"
  ],
  "accountCompanyId": [
    "integer (int32)"
  ],
  "operationType": [
    "string"
  ],
  "operationCategoryActivityType": [
    "string"
  ],
  "operationCategoryId": [
    "integer (int32)"
  ],
  "valueMin": "number (double)",
  "valueMax": "number (double)",
  "valueOnlyOfWholeOperation": "boolean",
  "projectId": [
    "integer (int32)"
  ],
  "withoutInvoiсeId": "boolean",
  "invoiceId": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "isCommitted": "boolean",
  "isCalculationCommitted": "boolean",
  "lastModificationDateStart": "string (date)",
  "lastModificationDateEnd": "string (date)",
  "externalId": [
    "string"
  ],
  "importLogId": [
    "integer (int32)"
  ],
  "boundMoveOperationId": [
    "integer (int32)"
  ],
  "searchString": "string",
  "invoiceSearchString": "string",
  "changesFromDate": "string (date)",
  "disableNavigationProperties": "boolean",
  "groupMoveOperations": "boolean",
  "moveComplexOperationType": "string",
  "accrualComplexOperationType": "string"
}
200 OK
Response[ListModel[OperationModel]]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "items": [
      {
        "invoiceId": "00000000-0000-0000-0000-000000000000",
        "invoice": {
          "invoiceId": "00000000-0000-0000-0000-000000000000",
          "number": "string",
          "externalId": "string",
          "operationValue": "number (double)",
          "calculationValue": "number (double)",
          "billingDate": "string (date)"
        },
        "isAutoLinkedToInvoice": "boolean",
        "distributeCalculationDate": "string (date)",
        "distributeCalculationType": "string",
        "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",
            "externalId": "string"
          },
          "accountCompany": {
            "companyId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "accountCurrency": {
            "currencyCode": "string",
            "title": "string"
          },
          "operationCategory": {
            "operationCategoryId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "operationCategoryActivityType": "string",
          "comment": "string",
          "value": "number (double)",
          "operationParts": [
            {
              "calculationDate": "string (date)",
              "isCalculationCommitted": "boolean",
              "project": {
                "projectId": "integer (int32)",
                "title": "string",
                "externalId": "string"
              },
              "contrAgent": {
                "contrAgentId": "integer (int32)",
                "title": "string",
                "externalId": "string"
              },
              "operationCategory": {
                "operationCategoryId": "integer (int32)",
                "title": "string",
                "externalId": "string"
              },
              "operationCategoryActivityType": "string",
              "firstAdditionalOperationAttribute": {
                "firstAdditionalOperationAttributeId": "integer (int32)",
                "title": "string",
                "externalId": "string"
              },
              "value": "number (double)",
              "valueInUserCurrency": "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",
          "valueInUserCurrency": "number (double)",
          "documentNumber": "string"
        },
        "operationId": "integer (int32)",
        "operationType": "string",
        "operationDate": "string (date)",
        "calculationPeriodDate": "string (date)",
        "isCalculationCommitted": "boolean"
      }
    ]
  }
}
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)"
    }
  ],
  "externalId": "string",
  "distributeCalculationDate": "string (date)",
  "distributeCalculationType": "string"
}
200 OK
Response[OperationModel]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "invoiceId": "00000000-0000-0000-0000-000000000000",
    "invoice": {
      "invoiceId": "00000000-0000-0000-0000-000000000000",
      "number": "string",
      "externalId": "string",
      "operationValue": "number (double)",
      "calculationValue": "number (double)",
      "billingDate": "string (date)"
    },
    "isAutoLinkedToInvoice": "boolean",
    "distributeCalculationDate": "string (date)",
    "distributeCalculationType": "string",
    "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",
        "externalId": "string"
      },
      "accountCompany": {
        "companyId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      },
      "accountCurrency": {
        "currencyCode": "string",
        "title": "string"
      },
      "operationCategory": {
        "operationCategoryId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      },
      "operationCategoryActivityType": "string",
      "comment": "string",
      "value": "number (double)",
      "operationParts": [
        {
          "calculationDate": "string (date)",
          "isCalculationCommitted": "boolean",
          "project": {
            "projectId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "contrAgent": {
            "contrAgentId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "operationCategory": {
            "operationCategoryId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "operationCategoryActivityType": "string",
          "firstAdditionalOperationAttribute": {
            "firstAdditionalOperationAttributeId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "value": "number (double)",
          "valueInUserCurrency": "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",
      "valueInUserCurrency": "number (double)",
      "documentNumber": "string"
    },
    "operationId": "integer (int32)",
    "operationType": "string",
    "operationDate": "string (date)",
    "calculationPeriodDate": "string (date)",
    "isCalculationCommitted": "boolean",
    "contrAgent": {
      "contrAgentId": "integer (int32)",
      "title": "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)"
    }
  ],
  "externalId": "string",
  "distributeCalculationDate": "string (date)",
  "distributeCalculationType": "string"
}
200 OK
Response[OperationModel]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "invoiceId": "00000000-0000-0000-0000-000000000000",
    "invoice": {
      "invoiceId": "00000000-0000-0000-0000-000000000000",
      "number": "string",
      "externalId": "string",
      "operationValue": "number (double)",
      "calculationValue": "number (double)",
      "billingDate": "string (date)"
    },
    "isAutoLinkedToInvoice": "boolean",
    "distributeCalculationDate": "string (date)",
    "distributeCalculationType": "string",
    "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",
        "externalId": "string"
      },
      "accountCompany": {
        "companyId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      },
      "accountCurrency": {
        "currencyCode": "string",
        "title": "string"
      },
      "operationCategory": {
        "operationCategoryId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      },
      "operationCategoryActivityType": "string",
      "comment": "string",
      "value": "number (double)",
      "operationParts": [
        {
          "calculationDate": "string (date)",
          "isCalculationCommitted": "boolean",
          "project": {
            "projectId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "contrAgent": {
            "contrAgentId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "operationCategory": {
            "operationCategoryId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "operationCategoryActivityType": "string",
          "firstAdditionalOperationAttribute": {
            "firstAdditionalOperationAttributeId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "value": "number (double)",
          "valueInUserCurrency": "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",
      "valueInUserCurrency": "number (double)",
      "documentNumber": "string"
    },
    "operationId": "integer (int32)",
    "operationType": "string",
    "operationDate": "string (date)",
    "calculationPeriodDate": "string (date)",
    "isCalculationCommitted": "boolean",
    "contrAgent": {
      "contrAgentId": "integer (int32)",
      "title": "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)"
    }
  ],
  "debitingExternalId": "string",
  "admissionExternalId": "string"
}
200 OK
Response[OperationModel[]]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": [
    {
      "invoiceId": "00000000-0000-0000-0000-000000000000",
      "invoice": {
        "invoiceId": "00000000-0000-0000-0000-000000000000",
        "number": "string",
        "externalId": "string",
        "operationValue": "number (double)",
        "calculationValue": "number (double)",
        "billingDate": "string (date)"
      },
      "isAutoLinkedToInvoice": "boolean",
      "distributeCalculationDate": "string (date)",
      "distributeCalculationType": "string",
      "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",
          "externalId": "string"
        },
        "accountCompany": {
          "companyId": "integer (int32)",
          "title": "string",
          "externalId": "string"
        },
        "accountCurrency": {
          "currencyCode": "string",
          "title": "string"
        },
        "operationCategory": {
          "operationCategoryId": "integer (int32)",
          "title": "string",
          "externalId": "string"
        },
        "operationCategoryActivityType": "string",
        "comment": "string",
        "value": "number (double)",
        "operationParts": [
          {
            "calculationDate": "string (date)",
            "isCalculationCommitted": "boolean",
            "project": {
              "projectId": "integer (int32)",
              "title": "string",
              "externalId": "string"
            },
            "contrAgent": {
              "contrAgentId": "integer (int32)",
              "title": "string",
              "externalId": "string"
            },
            "operationCategory": {
              "operationCategoryId": "integer (int32)",
              "title": "string",
              "externalId": "string"
            },
            "operationCategoryActivityType": "string",
            "firstAdditionalOperationAttribute": {
              "firstAdditionalOperationAttributeId": "integer (int32)",
              "title": "string",
              "externalId": "string"
            },
            "value": "number (double)",
            "valueInUserCurrency": "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",
        "valueInUserCurrency": "number (double)",
        "documentNumber": "string"
      },
      "operationId": "integer (int32)",
      "operationType": "string",
      "operationDate": "string (date)",
      "calculationPeriodDate": "string (date)",
      "isCalculationCommitted": "boolean",
      "contrAgent": {
        "contrAgentId": "integer (int32)"
      }
    }
  ]
}
Operations

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

POST /api/v1/operations/accrual
AccrualOperationCreationRequest

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

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "calculationDate": "string (date)",
  "isCalculationCommitted": "boolean",
  "companyId": "integer (int32)",
  "outcomeOperationCategoryId": "integer (int32)",
  "incomeOperationCategoryId": "integer (int32)",
  "incomeProjectId": "integer (int32)",
  "comment": "string",
  "value": "number (double)",
  "contrAgentId": "integer (int32)",
  "currencyCode": "string",
  "incomeExternalId": "string",
  "outcomeExternalId": "string"
}
200 OK
Response[OperationModel[]]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": [
    {
      "invoiceId": "00000000-0000-0000-0000-000000000000",
      "invoice": {
        "invoiceId": "00000000-0000-0000-0000-000000000000",
        "number": "string",
        "externalId": "string",
        "operationValue": "number (double)",
        "calculationValue": "number (double)",
        "billingDate": "string (date)"
      },
      "isAutoLinkedToInvoice": "boolean",
      "distributeCalculationDate": "string (date)",
      "distributeCalculationType": "string",
      "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",
          "externalId": "string"
        },
        "accountCompany": {
          "companyId": "integer (int32)",
          "title": "string",
          "externalId": "string"
        },
        "accountCurrency": {
          "currencyCode": "string",
          "title": "string"
        },
        "operationCategory": {
          "operationCategoryId": "integer (int32)",
          "title": "string",
          "externalId": "string"
        },
        "operationCategoryActivityType": "string",
        "comment": "string",
        "value": "number (double)",
        "operationParts": [
          {
            "calculationDate": "string (date)",
            "isCalculationCommitted": "boolean",
            "project": {
              "projectId": "integer (int32)",
              "title": "string",
              "externalId": "string"
            },
            "contrAgent": {
              "contrAgentId": "integer (int32)",
              "title": "string",
              "externalId": "string"
            },
            "operationCategory": {
              "operationCategoryId": "integer (int32)",
              "title": "string",
              "externalId": "string"
            },
            "operationCategoryActivityType": "string",
            "firstAdditionalOperationAttribute": {
              "firstAdditionalOperationAttributeId": "integer (int32)",
              "title": "string",
              "externalId": "string"
            },
            "value": "number (double)",
            "valueInUserCurrency": "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",
        "valueInUserCurrency": "number (double)",
        "documentNumber": "string"
      },
      "operationId": "integer (int32)",
      "operationType": "string",
      "operationDate": "string (date)",
      "calculationPeriodDate": "string (date)",
      "isCalculationCommitted": "boolean",
      "contrAgent": {
        "contrAgentId": "integer (int32)"
      }
    }
  ]
}
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)"
    }
  ],
  "externalId": "string",
  "distributeCalculationDate": "string (date)",
  "distributeCalculationType": "string"
}
200 OK
Response[OperationModel]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "invoiceId": "00000000-0000-0000-0000-000000000000",
    "invoice": {
      "invoiceId": "00000000-0000-0000-0000-000000000000",
      "number": "string",
      "externalId": "string",
      "operationValue": "number (double)",
      "calculationValue": "number (double)",
      "billingDate": "string (date)"
    },
    "isAutoLinkedToInvoice": "boolean",
    "distributeCalculationDate": "string (date)",
    "distributeCalculationType": "string",
    "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",
        "externalId": "string"
      },
      "accountCompany": {
        "companyId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      },
      "accountCurrency": {
        "currencyCode": "string",
        "title": "string"
      },
      "operationCategory": {
        "operationCategoryId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      },
      "operationCategoryActivityType": "string",
      "comment": "string",
      "value": "number (double)",
      "operationParts": [
        {
          "calculationDate": "string (date)",
          "isCalculationCommitted": "boolean",
          "project": {
            "projectId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "contrAgent": {
            "contrAgentId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "operationCategory": {
            "operationCategoryId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "operationCategoryActivityType": "string",
          "firstAdditionalOperationAttribute": {
            "firstAdditionalOperationAttributeId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "value": "number (double)",
          "valueInUserCurrency": "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",
      "valueInUserCurrency": "number (double)",
      "documentNumber": "string"
    },
    "operationId": "integer (int32)",
    "operationType": "string",
    "operationDate": "string (date)",
    "calculationPeriodDate": "string (date)",
    "isCalculationCommitted": "boolean",
    "contrAgent": {
      "contrAgentId": "integer (int32)",
      "title": "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)"
    }
  ],
  "externalId": "string",
  "distributeCalculationDate": "string (date)",
  "distributeCalculationType": "string"
}
200 OK
Response[OperationModel]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "invoiceId": "00000000-0000-0000-0000-000000000000",
    "invoice": {
      "invoiceId": "00000000-0000-0000-0000-000000000000",
      "number": "string",
      "externalId": "string",
      "operationValue": "number (double)",
      "calculationValue": "number (double)",
      "billingDate": "string (date)"
    },
    "isAutoLinkedToInvoice": "boolean",
    "distributeCalculationDate": "string (date)",
    "distributeCalculationType": "string",
    "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",
        "externalId": "string"
      },
      "accountCompany": {
        "companyId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      },
      "accountCurrency": {
        "currencyCode": "string",
        "title": "string"
      },
      "operationCategory": {
        "operationCategoryId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      },
      "operationCategoryActivityType": "string",
      "comment": "string",
      "value": "number (double)",
      "operationParts": [
        {
          "calculationDate": "string (date)",
          "isCalculationCommitted": "boolean",
          "project": {
            "projectId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "contrAgent": {
            "contrAgentId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "operationCategory": {
            "operationCategoryId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "operationCategoryActivityType": "string",
          "firstAdditionalOperationAttribute": {
            "firstAdditionalOperationAttributeId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "value": "number (double)",
          "valueInUserCurrency": "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",
      "valueInUserCurrency": "number (double)",
      "documentNumber": "string"
    },
    "operationId": "integer (int32)",
    "operationType": "string",
    "operationDate": "string (date)",
    "calculationPeriodDate": "string (date)",
    "isCalculationCommitted": "boolean",
    "contrAgent": {
      "contrAgentId": "integer (int32)",
      "title": "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)"
    }
  ],
  "debitingExternalId": "string",
  "admissionExternalId": "string"
}
200 OK
Response[OperationModel[]]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": [
    {
      "invoiceId": "00000000-0000-0000-0000-000000000000",
      "invoice": {
        "invoiceId": "00000000-0000-0000-0000-000000000000",
        "number": "string",
        "externalId": "string",
        "operationValue": "number (double)",
        "calculationValue": "number (double)",
        "billingDate": "string (date)"
      },
      "isAutoLinkedToInvoice": "boolean",
      "distributeCalculationDate": "string (date)",
      "distributeCalculationType": "string",
      "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",
          "externalId": "string"
        },
        "accountCompany": {
          "companyId": "integer (int32)",
          "title": "string",
          "externalId": "string"
        },
        "accountCurrency": {
          "currencyCode": "string",
          "title": "string"
        },
        "operationCategory": {
          "operationCategoryId": "integer (int32)",
          "title": "string",
          "externalId": "string"
        },
        "operationCategoryActivityType": "string",
        "comment": "string",
        "value": "number (double)",
        "operationParts": [
          {
            "calculationDate": "string (date)",
            "isCalculationCommitted": "boolean",
            "project": {
              "projectId": "integer (int32)",
              "title": "string",
              "externalId": "string"
            },
            "contrAgent": {
              "contrAgentId": "integer (int32)",
              "title": "string",
              "externalId": "string"
            },
            "operationCategory": {
              "operationCategoryId": "integer (int32)",
              "title": "string",
              "externalId": "string"
            },
            "operationCategoryActivityType": "string",
            "firstAdditionalOperationAttribute": {
              "firstAdditionalOperationAttributeId": "integer (int32)",
              "title": "string",
              "externalId": "string"
            },
            "value": "number (double)",
            "valueInUserCurrency": "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",
        "valueInUserCurrency": "number (double)",
        "documentNumber": "string"
      },
      "operationId": "integer (int32)",
      "operationType": "string",
      "operationDate": "string (date)",
      "calculationPeriodDate": "string (date)",
      "isCalculationCommitted": "boolean",
      "contrAgent": {
        "contrAgentId": "integer (int32)"
      }
    }
  ]
}
Operations

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

PUT /api/v1/operations/accrual/{operationId}
AccrualOperationModificationRequest

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

operationId
in path
integer (int32)

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

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "calculationDate": "string (date)",
  "isCalculationCommitted": "boolean",
  "companyId": "integer (int32)",
  "outcomeOperationCategoryId": "integer (int32)",
  "incomeOperationCategoryId": "integer (int32)",
  "incomeProjectId": "integer (int32)",
  "comment": "string",
  "value": "number (double)",
  "contrAgentId": "integer (int32)",
  "currencyCode": "string",
  "incomeExternalId": "string",
  "outcomeExternalId": "string"
}
200 OK
Response[OperationModel[]]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": [
    {
      "invoiceId": "00000000-0000-0000-0000-000000000000",
      "invoice": {
        "invoiceId": "00000000-0000-0000-0000-000000000000",
        "number": "string",
        "externalId": "string",
        "operationValue": "number (double)",
        "calculationValue": "number (double)",
        "billingDate": "string (date)"
      },
      "isAutoLinkedToInvoice": "boolean",
      "distributeCalculationDate": "string (date)",
      "distributeCalculationType": "string",
      "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",
          "externalId": "string"
        },
        "accountCompany": {
          "companyId": "integer (int32)",
          "title": "string",
          "externalId": "string"
        },
        "accountCurrency": {
          "currencyCode": "string",
          "title": "string"
        },
        "operationCategory": {
          "operationCategoryId": "integer (int32)",
          "title": "string",
          "externalId": "string"
        },
        "operationCategoryActivityType": "string",
        "comment": "string",
        "value": "number (double)",
        "operationParts": [
          {
            "calculationDate": "string (date)",
            "isCalculationCommitted": "boolean",
            "project": {
              "projectId": "integer (int32)",
              "title": "string",
              "externalId": "string"
            },
            "contrAgent": {
              "contrAgentId": "integer (int32)",
              "title": "string",
              "externalId": "string"
            },
            "operationCategory": {
              "operationCategoryId": "integer (int32)",
              "title": "string",
              "externalId": "string"
            },
            "operationCategoryActivityType": "string",
            "firstAdditionalOperationAttribute": {
              "firstAdditionalOperationAttributeId": "integer (int32)",
              "title": "string",
              "externalId": "string"
            },
            "value": "number (double)",
            "valueInUserCurrency": "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",
        "valueInUserCurrency": "number (double)",
        "documentNumber": "string"
      },
      "operationId": "integer (int32)",
      "operationType": "string",
      "operationDate": "string (date)",
      "calculationPeriodDate": "string (date)",
      "isCalculationCommitted": "boolean",
      "contrAgent": {
        "contrAgentId": "integer (int32)"
      }
    }
  ]
}
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
{
  "incomeOperationId": "integer (int32)",
  "outcomeOperationId": "integer (int32)"
}
200 OK
Response[MultipleOperationModel]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "operations": [
      {
        "invoiceId": "00000000-0000-0000-0000-000000000000",
        "invoice": {
          "invoiceId": "00000000-0000-0000-0000-000000000000",
          "number": "string",
          "externalId": "string",
          "operationValue": "number (double)",
          "calculationValue": "number (double)",
          "billingDate": "string (date)"
        },
        "isAutoLinkedToInvoice": "boolean",
        "distributeCalculationDate": "string (date)",
        "distributeCalculationType": "string",
        "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",
            "externalId": "string"
          },
          "accountCompany": {
            "companyId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "accountCurrency": {
            "currencyCode": "string",
            "title": "string"
          },
          "operationCategory": {
            "operationCategoryId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "operationCategoryActivityType": "string",
          "comment": "string",
          "value": "number (double)",
          "operationParts": [
            {
              "calculationDate": "string (date)",
              "isCalculationCommitted": "boolean",
              "project": {
                "projectId": "integer (int32)",
                "title": "string",
                "externalId": "string"
              },
              "contrAgent": {
                "contrAgentId": "integer (int32)",
                "title": "string",
                "externalId": "string"
              },
              "operationCategory": {
                "operationCategoryId": "integer (int32)",
                "title": "string",
                "externalId": "string"
              },
              "operationCategoryActivityType": "string",
              "firstAdditionalOperationAttribute": {
                "firstAdditionalOperationAttributeId": "integer (int32)",
                "title": "string",
                "externalId": "string"
              },
              "value": "number (double)",
              "valueInUserCurrency": "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",
          "valueInUserCurrency": "number (double)",
          "documentNumber": "string"
        },
        "operationId": "integer (int32)",
        "operationType": "string",
        "operationDate": "string (date)",
        "calculationPeriodDate": "string (date)",
        "isCalculationCommitted": "boolean"
      }
    ]
  }
}
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": [
      {
        "invoiceId": "00000000-0000-0000-0000-000000000000",
        "invoice": {
          "invoiceId": "00000000-0000-0000-0000-000000000000",
          "number": "string",
          "externalId": "string",
          "operationValue": "number (double)",
          "calculationValue": "number (double)",
          "billingDate": "string (date)"
        },
        "isAutoLinkedToInvoice": "boolean",
        "distributeCalculationDate": "string (date)",
        "distributeCalculationType": "string",
        "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",
            "externalId": "string"
          },
          "accountCompany": {
            "companyId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "accountCurrency": {
            "currencyCode": "string",
            "title": "string"
          },
          "operationCategory": {
            "operationCategoryId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "operationCategoryActivityType": "string",
          "comment": "string",
          "value": "number (double)",
          "operationParts": [
            {
              "calculationDate": "string (date)",
              "isCalculationCommitted": "boolean",
              "project": {
                "projectId": "integer (int32)",
                "title": "string",
                "externalId": "string"
              },
              "contrAgent": {
                "contrAgentId": "integer (int32)",
                "title": "string",
                "externalId": "string"
              },
              "operationCategory": {
                "operationCategoryId": "integer (int32)",
                "title": "string",
                "externalId": "string"
              },
              "operationCategoryActivityType": "string",
              "firstAdditionalOperationAttribute": {
                "firstAdditionalOperationAttributeId": "integer (int32)",
                "title": "string",
                "externalId": "string"
              },
              "value": "number (double)",
              "valueInUserCurrency": "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",
          "valueInUserCurrency": "number (double)",
          "documentNumber": "string"
        },
        "operationId": "integer (int32)",
        "operationType": "string",
        "operationDate": "string (date)",
        "calculationPeriodDate": "string (date)",
        "isCalculationCommitted": "boolean"
      }
    ]
  }
}
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": {
    "invoiceId": "00000000-0000-0000-0000-000000000000",
    "invoice": {
      "invoiceId": "00000000-0000-0000-0000-000000000000",
      "number": "string",
      "externalId": "string",
      "operationValue": "number (double)",
      "calculationValue": "number (double)",
      "billingDate": "string (date)"
    },
    "isAutoLinkedToInvoice": "boolean",
    "distributeCalculationDate": "string (date)",
    "distributeCalculationType": "string",
    "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",
        "externalId": "string"
      },
      "accountCompany": {
        "companyId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      },
      "accountCurrency": {
        "currencyCode": "string",
        "title": "string"
      },
      "operationCategory": {
        "operationCategoryId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      },
      "operationCategoryActivityType": "string",
      "comment": "string",
      "value": "number (double)",
      "operationParts": [
        {
          "calculationDate": "string (date)",
          "isCalculationCommitted": "boolean",
          "project": {
            "projectId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "contrAgent": {
            "contrAgentId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "operationCategory": {
            "operationCategoryId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "operationCategoryActivityType": "string",
          "firstAdditionalOperationAttribute": {
            "firstAdditionalOperationAttributeId": "integer (int32)",
            "title": "string",
            "externalId": "string"
          },
          "value": "number (double)",
          "valueInUserCurrency": "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",
      "valueInUserCurrency": "number (double)",
      "documentNumber": "string"
    },
    "operationId": "integer (int32)",
    "operationType": "string",
    "operationDate": "string (date)",
    "calculationPeriodDate": "string (date)",
    "isCalculationCommitted": "boolean",
    "contrAgent": {
      "contrAgentId": "integer (int32)",
      "title": "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.withoutInvoiсeId
in query
boolean

Без счета на оплату

filter.invoiceId
in query
string[]

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

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

Фильтровать только по сумме целой операции

filter.isCommitted
in query
boolean

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

filter.isCalculationCommitted
in query
boolean

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

filter.searchString
in query
string

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

  • Комментарий
  • Название контрагента
  • Название счета
  • Название компании
  • Название статьи
  • Название проекта
  • Название 1-го дополнительного атрибута операции
filter.invoiceSearchString
in query
string

Строка для расширенного поиска по номеру счета

filter.moveComplexOperationType
in query
string IncomePart, OutcomePart

Подтип операции перемещение

filter.accrualComplexOperationType
in query
string IncomePart, OutcomePart

Подтип операции начисление

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)",
    "accrualCount": "integer (int32)",
    "accrualAmount": "number (double)",
    "accrualFullAmount": "number (double)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
Operations

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

POST /api/v1/operations/summary
OperationFilterSummaryRequest

Запрос

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "operationId": [
    "integer (int32)"
  ],
  "operationDateStart": "string (date)",
  "operationDateEnd": "string (date)",
  "calculationPeriodDateStart": "string (date)",
  "calculationPeriodDateEnd": "string (date)",
  "accountId": [
    "integer (int32)"
  ],
  "contrAgentId": [
    "integer (int32)"
  ],
  "operationCategoryId": [
    "integer (int32)"
  ],
  "operationType": [
    "string"
  ],
  "projectId": [
    "integer (int32)"
  ],
  "firstAdditionalOperationAttributeId": [
    "integer (int32)"
  ],
  "withoutInvoiсeId": "boolean",
  "invoiceId": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "importLogId": [
    "integer (int32)"
  ],
  "valueMin": "number (double)",
  "valueMax": "number (double)",
  "valueOnlyOfWholeOperation": "boolean",
  "isCommitted": "boolean",
  "isCalculationCommitted": "boolean",
  "searchString": "string",
  "invoiceSearchString": "string",
  "moveComplexOperationType": "string",
  "accrualComplexOperationType": "string"
}
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)",
    "accrualCount": "integer (int32)",
    "accrualAmount": "number (double)",
    "accrualFullAmount": "number (double)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}

Products

Products

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

GET /api/v1/products/{productId}
productId
in path
string (uuid)

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

200 OK
Response[ProductModel]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "value": "number (double)",
    "currencyCode": "string",
    "vat": "number (double)",
    "comment": "string",
    "productId": "00000000-0000-0000-0000-000000000000",
    "title": "string",
    "externalId": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
Products

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

PUT /api/v1/products/{productId}
ProductModificationRequest

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

productId
in path
string (uuid)

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

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "title": "string",
  "value": "number (double)",
  "currencyCode": "string",
  "vat": "number (double)",
  "comment": "string",
  "externalId": "string"
}
200 OK
Response[ProductModel]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "value": "number (double)",
    "currencyCode": "string",
    "vat": "number (double)",
    "comment": "string",
    "productId": "00000000-0000-0000-0000-000000000000",
    "title": "string",
    "externalId": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
Products

Удаление товара

DELETE /api/v1/products/{productId}
productId
in path
string (uuid)

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

200 OK
Response

OK

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

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

GET /api/v1/products
filter.searchString
in query
string

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

  • Название товара
filter.externalId
in query
string[]

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

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

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

paging.limit
in query
integer (int32)

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

sorting.field
in query
string Title, Value, Vat

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

sorting.direction
in query
string Asc, Desc

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

200 OK
Response[ListModel[ProductModel]]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "items": [
      {
        "value": "number (double)",
        "currencyCode": "string",
        "vat": "number (double)",
        "comment": "string",
        "productId": "00000000-0000-0000-0000-000000000000",
        "title": "string",
        "externalId": "string"
      }
    ],
    "total": "integer (int32)",
    "deletedItems": [
      {
        "entityId": "integer (int32)",
        "deleteDate": "string (date)"
      }
    ],
    "totalDeleted": "integer (int32)"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
Products

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

POST /api/v1/products
ProductCreationRequest

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

Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "title": "string",
  "value": "number (double)",
  "currencyCode": "string",
  "vat": "number (double)",
  "comment": "string",
  "externalId": "string"
}
200 OK
Response[ProductModel]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "value": "number (double)",
    "currencyCode": "string",
    "vat": "number (double)",
    "comment": "string",
    "productId": "00000000-0000-0000-0000-000000000000",
    "title": "string",
    "externalId": "string"
  },
  "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",
    "closed": "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",
    "budgetId": "00000000-0000-0000-0000-000000000000",
    "projectGroup": {
      "projectGroupId": "integer (int32)",
      "title": "string"
    },
    "projectId": "integer (int32)",
    "title": "string",
    "externalId": "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",
  "externalId": "string",
  "projectGroupId": "integer (int32)",
  "budgetId": "00000000-0000-0000-0000-000000000000",
  "closed": "boolean"
}
200 OK
Response[ProjectModel]

OK

Response Content-Types: application/json, text/json
Response Example (200 OK) 
{
  "data": {
    "description": "string",
    "active": "boolean",
    "closed": "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",
    "budgetId": "00000000-0000-0000-0000-000000000000",
    "projectGroup": {
      "projectGroupId": "integer (int32)",
      "title": "string"
    },
    "projectId": "integer (int32)",
    "title": "string",
    "externalId": "string"
  },
  "isSuccess": "boolean",
  "errorMessage": "string",
  "errorCode": "string"
}
Projects

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

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

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

ignoreRules
in query
boolean

Признак игнорирования проверки привязки правил

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",
    "closed": "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",
    "budgetId": "00000000-0000-0000-0000-000000000000",
    "projectGroup": {
      "projectGroupId": "integer (int32)",
      "title": "string"
    },
    "projectId": "integer (int32)",
    "title": "string",
    "externalId": "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)

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

filter.externalId
in query
string[]

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

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

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

paging.limit
in query
integer (int32)

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

sorting.field
in query
string Title, 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",
        "closed": "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",
        "budgetId": "00000000-0000-0000-0000-000000000000",
        "projectGroup": {
          "projectGroupId": "integer (int32)",
          "title": "string"
        },
        "projectId": "integer (int32)",
        "title": "string",
        "externalId": "string"
      }
    ],
    "total": "integer (int32)",
    "deletedItems": [
      {
        "entityId": "integer (int32)",
        "deleteDate": "string (date)"
      }
    ],
    "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",
  "externalId": "string",
  "projectGroupId": "integer (int32)",
  "bud