ПланФакт 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
Accounts
Получение счета по идентификатору
Идентификатор
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"
}
Изменение существующего счета
Обновленные значения атрибутов счета
Идентификатор
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)"
}
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"
}
Удаление счета
(no description)
Признак игнорирования проверки привязки правил
OK
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Получение списка счетов
Id компания
Тип счёта
Название счета
Полное название счета
Описание
Номер счета
Корреспондентский номер счета
БИК счета
Банк счета
Код валюты
Отображение активных счетов
Начальная дата изменений
Набор искомых внешних идентификаторов
?filter.externalId=aaa&filter.externalId=bbb
Смещение от начала списка. По умолчанию 0
Размер фрейма
Поле сортировки
Направление сортировки (По умолчанию Asc)
Код валюты для пересчета начальны остатков (по умолчанию - валюта аккаунта)
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"
}
Создание нового счета
Атрибуты создаваемого счета
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)"
}
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"
}
Получение списка групп счетов
Смещение от начала списка. По умолчанию 0
Размер фрейма
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"
}
Создание новой группы счетов
Запрос на создание группы проектов
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)"
}
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"
}
Изменение существующей группы счетов
Запрос на изменение проекта
Идентификатор
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)"
}
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"
}
Удаление группы счетов
Идентификатор
OK
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
BizInfos
Получение истории изменений на счетах
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"
}
Получение общих сведений о бизнесе и доступе
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"
}
Получение истории поступлений/выплат сгруппированной по счетам
Дата окончания периода
Дата начала периода
Использовать для расчетов дату начисления
Идентификаторы счетов
?filter.accountId=aaa&filter.accountId=bbb
Идентификаторы контрагентов
?filter.contrAgentId=aaa&filter.contrAgentId=bbb
Идентификаторы стетей
?filter.operationCategoryId=aaa&filter.operationCategoryId=bbb
Идентификаторы проектов
?filter.projectId=aaa&filter.projectId=bbb
Идентификаторы 1-го дополнительного атрибута операции
?filter.firstAdditionalOperationAttributeId=aaa&filter.firstAdditionalOperationAttributeId=bbb
Код валюты для пересчета (по умолчанию - валюта аккаунта)
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"data": [
{
"accountId": "integer (int32)",
"details": [
{
"date": "string (date)",
"factValue": "number (double)",
"planValue": "number (double)",
"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"
}
Получение истории поступлений/выплат сгруппированной по статьям
Дата окончания периода
Дата начала периода
Использовать для расчетов дату начисления
Идентификаторы счетов
?filter.accountId=aaa&filter.accountId=bbb
Идентификаторы контрагентов
?filter.contrAgentId=aaa&filter.contrAgentId=bbb
Идентификаторы стетей
?filter.operationCategoryId=aaa&filter.operationCategoryId=bbb
Идентификаторы проектов
?filter.projectId=aaa&filter.projectId=bbb
Идентификаторы 1-го дополнительного атрибута операции
?filter.firstAdditionalOperationAttributeId=aaa&filter.firstAdditionalOperationAttributeId=bbb
Код валюты для пересчета (по умолчанию - валюта аккаунта)
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"data": [
{
"operationCategoryId": "integer (int32)",
"details": [
{
"date": "string (date)",
"factValue": "number (double)",
"planValue": "number (double)",
"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"
}
Получение истории поступлений/выплат сгруппированной по проектам
Дата окончания периода
Дата начала периода
Использовать для расчетов дату начисления
Идентификаторы счетов
?filter.accountId=aaa&filter.accountId=bbb
Идентификаторы контрагентов
?filter.contrAgentId=aaa&filter.contrAgentId=bbb
Идентификаторы стетей
?filter.operationCategoryId=aaa&filter.operationCategoryId=bbb
Идентификаторы проектов
?filter.projectId=aaa&filter.projectId=bbb
Идентификаторы 1-го дополнительного атрибута операции
?filter.firstAdditionalOperationAttributeId=aaa&filter.firstAdditionalOperationAttributeId=bbb
Код валюты для пересчета (по умолчанию - валюта аккаунта)
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"data": [
{
"projectId": "integer (int32)",
"details": [
{
"date": "string (date)",
"factValue": "number (double)",
"planValue": "number (double)",
"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"
}
Получение истории поступлений/выплат сгруппированной по контрагенту
Дата окончания периода
Дата начала периода
Использовать для расчетов дату начисления
Идентификаторы счетов
?filter.accountId=aaa&filter.accountId=bbb
Идентификаторы контрагентов
?filter.contrAgentId=aaa&filter.contrAgentId=bbb
Идентификаторы стетей
?filter.operationCategoryId=aaa&filter.operationCategoryId=bbb
Идентификаторы проектов
?filter.projectId=aaa&filter.projectId=bbb
Идентификаторы 1-го дополнительного атрибута операции
?filter.firstAdditionalOperationAttributeId=aaa&filter.firstAdditionalOperationAttributeId=bbb
Код валюты для пересчета (по умолчанию - валюта аккаунта)
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"data": [
{
"contrAgentId": "integer (int32)",
"details": [
{
"date": "string (date)",
"factValue": "number (double)",
"planValue": "number (double)",
"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"
}
Получение истории поступлений/выплат сгруппированной по 1-му дополнительному атрибуту
Дата окончания периода
Дата начала периода
Использовать для расчетов дату начисления
Идентификаторы счетов
?filter.accountId=aaa&filter.accountId=bbb
Идентификаторы контрагентов
?filter.contrAgentId=aaa&filter.contrAgentId=bbb
Идентификаторы стетей
?filter.operationCategoryId=aaa&filter.operationCategoryId=bbb
Идентификаторы проектов
?filter.projectId=aaa&filter.projectId=bbb
Идентификаторы 1-го дополнительного атрибута операции
?filter.firstAdditionalOperationAttributeId=aaa&filter.firstAdditionalOperationAttributeId=bbb
Код валюты для пересчета (по умолчанию - валюта аккаунта)
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
Получение бюджета по идентификатору
Идентификатор
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"
}
Изменение существующего бюджета
Обновленные значения атрибутов бюджета
Идентификатор
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"
}
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"
}
Удаление бюджета
(no description)
OK
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Получение настроек бюджета по идентификатору
Идентификатор
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"
}
Изменение существующих настроек бюджета
Обновленные значения настроек бюджета
Идентификатор
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"
}
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"
}
Получение списка бюджетов
Наименование
Идентификаторы проектов
?filter.projectId=aaa&filter.projectId=bbb
Смещение от начала списка. По умолчанию 0
Размер фрейма
Поле сортировки
Направление сортировки (По умолчанию Asc)
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"
}
Создание нового бюджета
Атрибуты создаваемого бюджета
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"
}
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"
}
Закрытие бюджета
(no description)
OK
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Businesses
Получение записей журнала действий
Дата действия. Начало.
Дата действия. Конец.
Идентификатор пользователя
?filter.userId=aaa&filter.userId=bbb
Подстрока для поиска
Смещение от начала списка. По умолчанию 0
Размер фрейма
Поле сортировки
Направление сортировки (По умолчанию Asc)
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"
}
Регистрация нового бизнеса для партнёра
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"
}
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
Получение компании по идентификатору
Идентификатор
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"
}
Изменение существующей компании
Запрос на изменение компании
Идентификатор
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)"
}
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"
}
Удаление компании
Идентификатор
Признак игнорирования проверки привязки правил
OK
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Получение списка юрлиц
Набор искомых идентификаторов
?filter.companyId=aaa&filter.companyId=bbb
Краткое название
Полное название
ИНН
КПП
Комментарий
Статус
Набор искомых внешних идентификаторов
?filter.externalId=aaa&filter.externalId=bbb
Начальная дата изменений
Смещение от начала списка. По умолчанию 0
Размер фрейма
Поле сортировки
Направление сортировки (По умолчанию Asc)
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"
}
Создание новой компании
Запрос на создание компании
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)"
}
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
Получение контрагента по идентификатору
Идентификатор
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"
}
Изменение существующего контрагента
Запрос на изменение контрагента
Идентификатор
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"
}
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"
}
Удаление контрагента
Идентификатор
Признак игнорирования проверки привязки правил
OK
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Получение контрагента со сводкой по идентификатору
Идентификатор
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"
}
Получение списка контрагентов
Краткое название
Тип контрагента
Начальная дата поиска
Конечная дата поиска
Статус
Начальная дата изменений
ИНН
Набор искомых внешних идентификаторов
?filter.externalId=aaa&filter.externalId=bbb
Смещение от начала списка. По умолчанию 0
Размер фрейма
Поле сортировки
Направление сортировки (По умолчанию Asc)
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"
}
Создание нового контрагента
Запрос на создание контрагента
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"
}
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"
}
Получение списка контрагентов со сводкой
Краткое название
Тип контрагента
Начальная дата поиска
Конечная дата поиска
Статус
Начальная дата изменений
ИНН
Набор искомых внешних идентификаторов
?filter.externalId=aaa&filter.externalId=bbb
Смещение от начала списка. По умолчанию 0
Размер фрейма
Поле сортировки
Направление сортировки (По умолчанию Asc)
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"
}
Получение расчетов по контрагентам
Идентификаторы контрагентов
?calculationListRequest.contrAgentId=aaa&calculationListRequest.contrAgentId=bbb
OK
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
CoreApi
Получение баланса по всем юрлицам
(no description)
(no description)
(no description)
(no description)
Смещение от начала списка. По умолчанию 0
Размер фрейма
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"data": "object",
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Получение связей с планом счетов
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"
}
Проверка доступности баланса по правам доступа
OK
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"data": "boolean",
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Currencies
Получение списка валют
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"
}
Получение истории курса валют
Фильтр идентификаторов валют
?filter.currencyIds=aaa&filter.currencyIds=bbb
Дата начала истории (включительно)
Дата окончания истории (включительно)
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"data": "object",
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
FirstAdditionalOperationAttributes
Получение 1-го дополнительного атрибута операции по идентификатору
Идентификатор
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"
}
Изменение существующего 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"
}
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"
}
Удаление 1-го дополнительного атрибута операции
Идентификатор
OK
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Получение 1-го дополнительного атрибута операции со сводкой по идентификатору
Идентификатор
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"
}
Получение списка 1-го дополнительного атрибута операций
Краткое название
Начальная дата поиска
Конечная дата поиска
Начальная дата изменений
Набор искомых внешних идентификаторов
?filter.externalId=aaa&filter.externalId=bbb
Смещение от начала списка. По умолчанию 0
Размер фрейма
Поле сортировки
Направление сортировки (По умолчанию Asc)
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"
}
Создание нового 1-го дополнительного атрибута операции
Запрос на создание 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"
}
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"
}
Получение списка 1-го дополнительного атрибута операции со сводкой
Краткое название
Начальная дата поиска
Конечная дата поиска
Начальная дата изменений
Набор искомых внешних идентификаторов
?filter.externalId=aaa&filter.externalId=bbb
Смещение от начала списка. По умолчанию 0
Размер фрейма
Поле сортировки
Направление сортировки (По умолчанию Asc)
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
Получение списка логов импорта
Смещение от начала списка. По умолчанию 0
Размер фрейма
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
Получение счета на оплату по идентификатору
Идентификатор
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"
}
Удаление счета на оплату
Идентификатор
OK
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Получение списка счетов на оплату
Дата выставления. Начало.
Дата выставления. Конец.
Сумма счета. Минимум
Сумма счета. Максимум
Фактическая дата оплаты. Начало.
Фактическая дата оплаты. Конец.
Плановая дата оплаты. Начало.
Плановая дата оплаты. Конец.
Статус счета
?filter.committedVariation=aaa&filter.committedVariation=bbb
Статус оплаты
?filter.paymentVariation=aaa&filter.paymentVariation=bbb
Дата оплаты просрочена
Дата оплаты не просрочена
Идентификаторы счетов
?filter.accountId=aaa&filter.accountId=bbb
Идентификаторы контрагентов
?filter.contrAgentId=aaa&filter.contrAgentId=bbb
Идентификаторы счетов на оплату
?filter.invoiceId=aaa&filter.invoiceId=bbb
Отключить загрузку свойств навигации
Набор искомых внешних идентификаторов
?filter.externalId=aaa&filter.externalId=bbb
Поисковая строка
Смещение от начала списка. По умолчанию 0
Размер фрейма
Поле сортировки
Направление сортировки (По умолчанию Asc)
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"
}
Создание нового счета на оплату
Запрос на создание
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"
}
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"
}
Изменение существующего счета на оплату
Запрос на изменение
Идентификатор
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"
}
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"
}
Получение сводной информации по фильтру счетов на оплату
Дата выставления. Начало.
Дата выставления. Конец.
Сумма счета. Минимум
Сумма счета. Максимум
Фактическая дата оплаты. Начало.
Фактическая дата оплаты. Конец.
Плановая дата оплаты. Начало.
Плановая дата оплаты. Конец.
Статус счета
?filter.committedVariation=aaa&filter.committedVariation=bbb
Статус оплаты
?filter.paymentVariation=aaa&filter.paymentVariation=bbb
Дата оплаты просрочена
Дата оплаты не просрочена
Идентификаторы счетов
?filter.accountId=aaa&filter.accountId=bbb
Идентификаторы контрагентов
?filter.contrAgentId=aaa&filter.contrAgentId=bbb
Идентификаторы счетов на оплату
?filter.invoiceId=aaa&filter.invoiceId=bbb
Отключить загрузку свойств навигации
Набор искомых внешних идентификаторов
?filter.externalId=aaa&filter.externalId=bbb
Поисковая строка
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"
}
Привязка операции к счету на оплату
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)"
}
OK
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Отвязка операции к счету на оплату
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)"
}
OK
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Получение статуса задания на получение документа
Идентификатор задания на получение документа
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"
}
Создание задания на получение документа
Модель счета на оплату
(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"
}
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
Получение списка шаблонов счетов на оплату
Смещение от начала списка. По умолчанию 0
Размер фрейма
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"
}
Создание нового шаблона счета на оплату
Запрос на создание
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"
}
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"
}
Создание нового шаблона счета на оплату
undefined
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"billingDate": "string (date)"
}
OK
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"data": {
"number": "string"
},
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
OperationCategories
Получение статьи по идентификатору
Идентификатор
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"
}
Изменение существующей статьи
Запрос на изменение
Идентификатор
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"
}
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"
}
Удаление статьи
Идентификатор
Признак игнорирования проверки привязки правил
OK
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Получение списка статей
Набор искомых идентификаторов
?filter.operationCategoryId=aaa&filter.operationCategoryId=bbb
Название
Тип
Вид деятельности
Родительская статья доходов
Начальная дата изменений
Набор искомых внешних идентификаторов
?filter.externalId=aaa&filter.externalId=bbb
Смещение от начала списка. По умолчанию 0
Размер фрейма
Поле сортировки
Направление сортировки (По умолчанию Asc)
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"data": {
"items": [
{
"operationCategoryType": "string",
"activityType": "string",
"outcomeClassification": "string",
"parentOperationCategoryId": "integer (int32)",
"sort": "integer (int32)",
"isVisible": "boolean",
"isFixed": "boolean",
"accountCategoryType": "string",
"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"
}
Создание новой статьи
Запрос на создание
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"
}
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
Получение операции по идентификатору
Идентификатор
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"
}
}
}
Удаление операции
Идентификатор
OK
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Получение списка операций
Идентификаторы операций
?filter.operationId=aaa&filter.operationId=bbb
Дата операции. Начало.
Дата операции. Конец.
Дата начисления. Начало.
Дата начисления. Конец.
Без контрагента
Идентификаторы контрагентов
?filter.contrAgentId=aaa&filter.contrAgentId=bbb
Идентификаторы счетов
?filter.accountId=aaa&filter.accountId=bbb
Идентификаторы компаний
?filter.accountCompanyId=aaa&filter.accountCompanyId=bbb
Типы операций
?filter.operationType=aaa&filter.operationType=bbb
Виды деятельности
?filter.operationCategoryActivityType=aaa&filter.operationCategoryActivityType=bbb
Идентификаторы стетей
?filter.operationCategoryId=aaa&filter.operationCategoryId=bbb
Общая сумма. Минимум
Общая сумма. Максимум
Фильтровать только по сумме целой операции
Идентификаторы проектов
?filter.projectId=aaa&filter.projectId=bbb
Без счета на оплату
Идентификаторы счетов на оплату
?filter.invoiceId=aaa&filter.invoiceId=bbb
Признак того, что операция проведена
Признак того, что операция в дату начисления подтверждена
Дата последней модификации. Начало.
Дата последней модификации. Конец.
Внешние идентификаторы
?filter.externalId=aaa&filter.externalId=bbb
Идентификаторы лога импорта
?filter.importLogId=aaa&filter.importLogId=bbb
Идентификаторы связанных операции
?filter.boundMoveOperationId=aaa&filter.boundMoveOperationId=bbb
Строка для расширенного поиска по. Атрибуты, участвующие в поиске:
- Комментарий
- Название контрагента
- Название счета
- Название компании
- Название статьи
Строка для расширенного поиска по номеру счета
Начальная дата изменений
Отключить загрузку свойств навигации
Cгруппировать перемещения
Подтип операции перемещение
Подтип операции начисление
Смещение от начала списка. По умолчанию 0
Размер фрейма
Поле сортировки
Направление сортировки (По умолчанию Asc)
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"
}
]
}
}
Получение списка операций
Запрос
Смещение от начала списка. По умолчанию 0
Размер фрейма
Поле сортировки
Направление сортировки (По умолчанию 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"
}
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"
}
]
}
}
Создание новой операции поступления
Запрос на создание
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"
}
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"
}
}
}
Создание новой операции списания
Запрос на создание
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"
}
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"
}
}
}
Создание новой операции перемещения
Запрос на создание
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"
}
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)"
}
}
]
}
Создание новой операции начисление
Запрос на создание
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"
}
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)"
}
}
]
}
Изменение существующей операции поступления
Запрос на изменение
Идентификатор
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"
}
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"
}
}
}
Изменение существующей операции списания
Запрос на изменение
Идентификатор
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"
}
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"
}
}
}
Изменение существующей операции перемещения
Запрос на изменение
Идентификатор
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"
}
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)"
}
}
]
}
Изменение существующей операции начисление
Запрос на изменение
Идентификатор
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"
}
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)"
}
}
]
}
Объединение операций в перемещение
Запрос на объединение операций в перемещение
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"incomeOperationId": "integer (int32)",
"outcomeOperationId": "integer (int32)"
}
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"
}
]
}
}
Разъединение операций
Идентификатор операции
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"
}
]
}
}
Смена типа операции
Идентификатор операции
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"
}
}
}
Получение сводной информации по фильтру операций
Идентификаторы операций
?filter.operationId=aaa&filter.operationId=bbb
Дата операции. Начало.
Дата операции. Конец.
Дата начисления. Начало.
Дата начисления. Конец.
Идентификаторы счетов
?filter.accountId=aaa&filter.accountId=bbb
Идентификаторы контрагентов
?filter.contrAgentId=aaa&filter.contrAgentId=bbb
Идентификаторы стетей
?filter.operationCategoryId=aaa&filter.operationCategoryId=bbb
Типы операций
?filter.operationType=aaa&filter.operationType=bbb
Идентификаторы проектов
?filter.projectId=aaa&filter.projectId=bbb
Идентификаторы 1-го дополнительного атрибута
?filter.firstAdditionalOperationAttributeId=aaa&filter.firstAdditionalOperationAttributeId=bbb
Без счета на оплату
Идентификаторы счетов на оплату
?filter.invoiceId=aaa&filter.invoiceId=bbb
Идентификаторы лога импорта
?filter.importLogId=aaa&filter.importLogId=bbb
Общая сумма. Минимум
Общая сумма. Максимум
Фильтровать только по сумме целой операции
Признак того, что операция проведена
Признак того, что операция в дату начисления подтверждена
Строка для расширенного поиска по. Атрибуты, участвующие в поиске:
- Комментарий
- Название контрагента
- Название счета
- Название компании
- Название статьи
- Название проекта
- Название 1-го дополнительного атрибута операции
Строка для расширенного поиска по номеру счета
Подтип операции перемещение
Подтип операции начисление
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"
}
Получение сводной информации по фильтру операций
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"
}
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
Получение товара по идентификатору
Идентификатор
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"
}
Изменение существующего товара
Запрос на изменение
Идентификатор
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"
}
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"
}
Удаление товара
Идентификатор
OK
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Получение списка товаров
Строка для расширенного поиска по. Атрибуты, участвующие в поиске:
- Название товара
Набор искомых внешних идентификаторов
?filter.externalId=aaa&filter.externalId=bbb
Смещение от начала списка. По умолчанию 0
Размер фрейма
Поле сортировки
Направление сортировки (По умолчанию Asc)
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"
}
Создание нового товара
Запрос на создание
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"
}
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
Получение проекта по идентификатору
Идентификатор
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"
}
Изменение существующего проекта
Запрос на изменение проекта
Идентификатор
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"
}
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"
}
Удаление проекта
Идентификатор
Признак игнорирования проверки привязки правил
OK
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Получение проекта со сводкой по идентификатору
Идентификатор
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"
}
Получение списка проектов
Краткое название
Начальная дата поиска
Конечная дата поиска
Статус
Начальная дата изменений
Набор искомых внешних идентификаторов
?filter.externalId=aaa&filter.externalId=bbb
Смещение от начала списка. По умолчанию 0
Размер фрейма
Поле сортировки
Направление сортировки (По умолчанию Asc)
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"
}
Создание нового проекта
Запрос на создание проекта
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