ПланФакт 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.ioSchemes: https
Version: v1.6
Authentication
apiKey
Api key
type
apiKey
name
X-ApiKey
in
header
Accounts
Получение счета по идентификатору
accountId:
integer
(int32)
in path
Идентификатор
200 OK
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",
"accountId": "integer (int32)",
"title": "string",
"externalId": "string"
},
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Изменение существующего счета
Обновленные значения атрибутов счета
accountId:
integer
(int32)
in path
Идентификатор
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"
}
200 OK
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",
"accountId": "integer (int32)",
"title": "string",
"externalId": "string"
},
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Удаление счета
accountId:
integer
(int32)
in path
(no description)
ignoreRules:
boolean
in query
Признак игнорирования проверки привязки правил
200 OK
OK
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Получение списка счетов
filter.agentId:
integer
(int32)
in query
Id компания
filter.accountType:
string
Cash,
Card
in query
Тип счёта
filter.title:
string
in query
Название счета
filter.longTitle:
string
in query
Полное название счета
filter.description:
string
in query
Описание
filter.accountAcct:
string
in query
Номер счета
filter.correspondentAcct:
string
in query
Корреспондентский номер счета
filter.accountBik:
string
in query
БИК счета
filter.accountBank:
string
in query
Банк счета
filter.currencyCode:
string
USD,
EUR,
GBP,
RUB,
BYN,
UAH,
KZT,
CNY,
TRY,
KGS,
AMD,
AED,
INR,
JPY,
MDL,
UZS,
PLN,
SGD,
BTC,
ETH,
BCH,
XRP,
LTC,
DASH,
XMR,
ETC,
ZEC,
STRAT,
DCR,
DOGE,
SC,
CAD,
THB,
HUF,
CZK,
HRK,
RON,
BDT,
AZN,
NOK,
CHF,
MVR,
LKR,
GEL,
ILS,
TJS,
TMT
in query
Код валюты
filter.active:
boolean
in query
Отображение активных счетов
filter.changesFromDate:
string
(date)
in query
Начальная дата изменений
filter.externalId:
string[]
in query
Набор искомых внешних идентификаторов
Array values passed as multiple parameters:
?filter.externalId=aaa&filter.externalId=bbb paging.offset:
integer
(int32)
in query
Смещение от начала списка. По умолчанию 0
paging.limit:
integer
(int32)
in query
Размер фрейма
sorting.field:
string
CompanyTitle,
AccountTypeTitle,
Title,
LongTitle,
Description,
AccountAcct,
AccountBik,
AccountBank,
CurrencyTitle,
Active,
ModifyDate
in query
Поле сортировки
sorting.direction:
string
Asc,
Desc
in query
Направление сортировки (По умолчанию 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",
"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"
}
200 OK
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",
"accountId": "integer (int32)",
"title": "string",
"externalId": "string"
},
"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"
}
Получение общих сведений о бизнесе и доступе
200 OK
OK
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"data": {
"firstName": "string",
"selfReferralCode": "string",
"accessAlert": "string",
"paymentRateTitle": "string",
"accessEndDate": "string (date)",
"isPayer": "boolean",
"webinarLink": "string",
"hasAccess": "boolean",
"isReadOnly": "boolean"
},
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Получение истории поступлений/выплат сгруппированной по счетам
filter.periodStartDate:
string
(date)
in query
Дата окончания периода
filter.periodEndDate:
string
(date)
in query
Дата начала периода
filter.isCalculation:
boolean
in query
Использовать для расчетов дату начисления
filter.accountId:
integer[][]
in query
Идентификаторы счетов
Array values passed as multiple parameters:
?filter.accountId=aaa&filter.accountId=bbb filter.contrAgentId:
integer[][]
in query
Идентификаторы контрагентов
Array values passed as multiple parameters:
?filter.contrAgentId=aaa&filter.contrAgentId=bbb filter.operationCategoryId:
integer[][]
in query
Идентификаторы стетей
Array values passed as multiple parameters:
?filter.operationCategoryId=aaa&filter.operationCategoryId=bbb filter.projectId:
integer[][]
in query
Идентификаторы проектов
Array values passed as multiple parameters:
?filter.projectId=aaa&filter.projectId=bbb filter.firstAdditionalOperationAttributeId:
integer[][]
in query
Идентификаторы 1-го дополнительного атрибута операции
Array values passed as multiple parameters:
?filter.firstAdditionalOperationAttributeId=aaa&filter.firstAdditionalOperationAttributeId=bbb filter.userCurrencyCode:
string
USD,
EUR,
GBP,
RUB,
BYN,
UAH,
KZT,
CNY,
TRY,
KGS,
AMD,
AED,
INR,
JPY,
MDL,
UZS,
PLN,
SGD,
BTC,
ETH,
BCH,
XRP,
LTC,
DASH,
XMR,
ETC,
ZEC,
STRAT,
DCR,
DOGE,
SC,
CAD,
THB,
HUF,
CZK,
HRK,
RON,
BDT,
AZN,
NOK,
CHF,
MVR,
LKR,
GEL,
ILS,
TJS,
TMT
in query
Код валюты для пересчета (по умолчанию - валюта аккаунта)
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.periodStartDate:
string
(date)
in query
Дата окончания периода
filter.periodEndDate:
string
(date)
in query
Дата начала периода
filter.isCalculation:
boolean
in query
Использовать для расчетов дату начисления
filter.accountId:
integer[][]
in query
Идентификаторы счетов
Array values passed as multiple parameters:
?filter.accountId=aaa&filter.accountId=bbb filter.contrAgentId:
integer[][]
in query
Идентификаторы контрагентов
Array values passed as multiple parameters:
?filter.contrAgentId=aaa&filter.contrAgentId=bbb filter.operationCategoryId:
integer[][]
in query
Идентификаторы стетей
Array values passed as multiple parameters:
?filter.operationCategoryId=aaa&filter.operationCategoryId=bbb filter.projectId:
integer[][]
in query
Идентификаторы проектов
Array values passed as multiple parameters:
?filter.projectId=aaa&filter.projectId=bbb filter.firstAdditionalOperationAttributeId:
integer[][]
in query
Идентификаторы 1-го дополнительного атрибута операции
Array values passed as multiple parameters:
?filter.firstAdditionalOperationAttributeId=aaa&filter.firstAdditionalOperationAttributeId=bbb filter.userCurrencyCode:
string
USD,
EUR,
GBP,
RUB,
BYN,
UAH,
KZT,
CNY,
TRY,
KGS,
AMD,
AED,
INR,
JPY,
MDL,
UZS,
PLN,
SGD,
BTC,
ETH,
BCH,
XRP,
LTC,
DASH,
XMR,
ETC,
ZEC,
STRAT,
DCR,
DOGE,
SC,
CAD,
THB,
HUF,
CZK,
HRK,
RON,
BDT,
AZN,
NOK,
CHF,
MVR,
LKR,
GEL,
ILS,
TJS,
TMT
in query
Код валюты для пересчета (по умолчанию - валюта аккаунта)
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.periodStartDate:
string
(date)
in query
Дата окончания периода
filter.periodEndDate:
string
(date)
in query
Дата начала периода
filter.isCalculation:
boolean
in query
Использовать для расчетов дату начисления
filter.accountId:
integer[][]
in query
Идентификаторы счетов
Array values passed as multiple parameters:
?filter.accountId=aaa&filter.accountId=bbb filter.contrAgentId:
integer[][]
in query
Идентификаторы контрагентов
Array values passed as multiple parameters:
?filter.contrAgentId=aaa&filter.contrAgentId=bbb filter.operationCategoryId:
integer[][]
in query
Идентификаторы стетей
Array values passed as multiple parameters:
?filter.operationCategoryId=aaa&filter.operationCategoryId=bbb filter.projectId:
integer[][]
in query
Идентификаторы проектов
Array values passed as multiple parameters:
?filter.projectId=aaa&filter.projectId=bbb filter.firstAdditionalOperationAttributeId:
integer[][]
in query
Идентификаторы 1-го дополнительного атрибута операции
Array values passed as multiple parameters:
?filter.firstAdditionalOperationAttributeId=aaa&filter.firstAdditionalOperationAttributeId=bbb filter.userCurrencyCode:
string
USD,
EUR,
GBP,
RUB,
BYN,
UAH,
KZT,
CNY,
TRY,
KGS,
AMD,
AED,
INR,
JPY,
MDL,
UZS,
PLN,
SGD,
BTC,
ETH,
BCH,
XRP,
LTC,
DASH,
XMR,
ETC,
ZEC,
STRAT,
DCR,
DOGE,
SC,
CAD,
THB,
HUF,
CZK,
HRK,
RON,
BDT,
AZN,
NOK,
CHF,
MVR,
LKR,
GEL,
ILS,
TJS,
TMT
in query
Код валюты для пересчета (по умолчанию - валюта аккаунта)
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.periodStartDate:
string
(date)
in query
Дата окончания периода
filter.periodEndDate:
string
(date)
in query
Дата начала периода
filter.isCalculation:
boolean
in query
Использовать для расчетов дату начисления
filter.accountId:
integer[][]
in query
Идентификаторы счетов
Array values passed as multiple parameters:
?filter.accountId=aaa&filter.accountId=bbb filter.contrAgentId:
integer[][]
in query
Идентификаторы контрагентов
Array values passed as multiple parameters:
?filter.contrAgentId=aaa&filter.contrAgentId=bbb filter.operationCategoryId:
integer[][]
in query
Идентификаторы стетей
Array values passed as multiple parameters:
?filter.operationCategoryId=aaa&filter.operationCategoryId=bbb filter.projectId:
integer[][]
in query
Идентификаторы проектов
Array values passed as multiple parameters:
?filter.projectId=aaa&filter.projectId=bbb filter.firstAdditionalOperationAttributeId:
integer[][]
in query
Идентификаторы 1-го дополнительного атрибута операции
Array values passed as multiple parameters:
?filter.firstAdditionalOperationAttributeId=aaa&filter.firstAdditionalOperationAttributeId=bbb filter.userCurrencyCode:
string
USD,
EUR,
GBP,
RUB,
BYN,
UAH,
KZT,
CNY,
TRY,
KGS,
AMD,
AED,
INR,
JPY,
MDL,
UZS,
PLN,
SGD,
BTC,
ETH,
BCH,
XRP,
LTC,
DASH,
XMR,
ETC,
ZEC,
STRAT,
DCR,
DOGE,
SC,
CAD,
THB,
HUF,
CZK,
HRK,
RON,
BDT,
AZN,
NOK,
CHF,
MVR,
LKR,
GEL,
ILS,
TJS,
TMT
in query
Код валюты для пересчета (по умолчанию - валюта аккаунта)
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.periodStartDate:
string
(date)
in query
Дата окончания периода
filter.periodEndDate:
string
(date)
in query
Дата начала периода
filter.isCalculation:
boolean
in query
Использовать для расчетов дату начисления
filter.accountId:
integer[][]
in query
Идентификаторы счетов
Array values passed as multiple parameters:
?filter.accountId=aaa&filter.accountId=bbb filter.contrAgentId:
integer[][]
in query
Идентификаторы контрагентов
Array values passed as multiple parameters:
?filter.contrAgentId=aaa&filter.contrAgentId=bbb filter.operationCategoryId:
integer[][]
in query
Идентификаторы стетей
Array values passed as multiple parameters:
?filter.operationCategoryId=aaa&filter.operationCategoryId=bbb filter.projectId:
integer[][]
in query
Идентификаторы проектов
Array values passed as multiple parameters:
?filter.projectId=aaa&filter.projectId=bbb filter.firstAdditionalOperationAttributeId:
integer[][]
in query
Идентификаторы 1-го дополнительного атрибута операции
Array values passed as multiple parameters:
?filter.firstAdditionalOperationAttributeId=aaa&filter.firstAdditionalOperationAttributeId=bbb filter.userCurrencyCode:
string
USD,
EUR,
GBP,
RUB,
BYN,
UAH,
KZT,
CNY,
TRY,
KGS,
AMD,
AED,
INR,
JPY,
MDL,
UZS,
PLN,
SGD,
BTC,
ETH,
BCH,
XRP,
LTC,
DASH,
XMR,
ETC,
ZEC,
STRAT,
DCR,
DOGE,
SC,
CAD,
THB,
HUF,
CZK,
HRK,
RON,
BDT,
AZN,
NOK,
CHF,
MVR,
LKR,
GEL,
ILS,
TJS,
TMT
in query
Код валюты для пересчета (по умолчанию - валюта аккаунта)
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
Получение бюджета по идентификатору
budgetId:
string
(uuid)
in path
Идентификатор
200 OK
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)"
}
]
}
}
],
"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"
}
Изменение существующего бюджета
Обновленные значения атрибутов бюджета
budgetId:
string
(uuid)
in path
Идентификатор
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)"
}
]
}
}
],
"currencyCode": "string"
}
200 OK
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)"
}
]
}
}
],
"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"
}
Удаление бюджета
budgetId:
string
(uuid)
in path
(no description)
200 OK
OK
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Получение настроек бюджета по идентификатору
budgetId:
string
(uuid)
in path
Идентификатор
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"
}
Изменение существующих настроек бюджета
Обновленные значения настроек бюджета
budgetId:
string
(uuid)
in path
Идентификатор
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.title:
string
in query
Наименование
paging.offset:
integer
(int32)
in query
Смещение от начала списка. По умолчанию 0
paging.limit:
integer
(int32)
in query
Размер фрейма
sorting.field:
string
Title,
ModifyDate
in query
Поле сортировки
sorting.direction:
string
Asc,
Desc
in query
Направление сортировки (По умолчанию 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"
}
200 OK
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)"
}
]
}
}
],
"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"
}
Закрытие бюджета
budgetId:
string
(uuid)
in path
(no description)
200 OK
OK
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Businesses
Получение записей журнала действий
filter.actionLogDateStart:
string
(date)
in query
Дата действия. Начало.
filter.actionLogDateEnd:
string
(date)
in query
Дата действия. Конец.
filter.userId:
string[]
in query
Идентификатор пользователя
Array values passed as multiple parameters:
?filter.userId=aaa&filter.userId=bbb filter.text:
string
in query
Подстрока для поиска
paging.offset:
integer
(int32)
in query
Смещение от начала списка. По умолчанию 0
paging.limit:
integer
(int32)
in query
Размер фрейма
sorting.field:
string
ActionDate,
User
in query
Поле сортировки
sorting.direction:
string
Asc,
Desc
in query
Направление сортировки (По умолчанию 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
Получение компании по идентификатору
companyId:
integer
(int32)
in path
Идентификатор
200 OK
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",
"companyId": "integer (int32)",
"title": "string",
"externalId": "string"
},
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Изменение существующей компании
Запрос на изменение компании
companyId:
integer
(int32)
in path
Идентификатор
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"
}
200 OK
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",
"companyId": "integer (int32)",
"title": "string",
"externalId": "string"
},
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Удаление компании
companyId:
integer
(int32)
in path
Идентификатор
ignoreRules:
boolean
in query
Признак игнорирования проверки привязки правил
200 OK
OK
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Получение списка юрлиц
filter.companyId:
integer[]
in query
Набор искомых идентификаторов
Array values passed as multiple parameters:
?filter.companyId=aaa&filter.companyId=bbb filter.title:
string
(3 to 256 chars)
in query
Краткое название
filter.longTitle:
string
in query
Полное название
filter.companyInn:
string
in query
ИНН
filter.companyKpp:
string
in query
КПП
filter.description:
string
in query
Комментарий
filter.active:
boolean
in query
Статус
filter.externalId:
string[]
in query
Набор искомых внешних идентификаторов
Array values passed as multiple parameters:
?filter.externalId=aaa&filter.externalId=bbb filter.changesFromDate:
string
(date)
in query
Начальная дата изменений
paging.offset:
integer
(int32)
in query
Смещение от начала списка. По умолчанию 0
paging.limit:
integer
(int32)
in query
Размер фрейма
sorting.field:
string
Title,
LongTitle,
CompanyInn,
CompanyKpp,
Active,
ModifyDate
in query
Поле сортировки
sorting.direction:
string
Asc,
Desc
in query
Направление сортировки (По умолчанию 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",
"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"
}
200 OK
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",
"companyId": "integer (int32)",
"title": "string",
"externalId": "string"
},
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
ContrAgents
Получение контрагента по идентификатору
contrAgentId:
integer
(int32)
in path
Идентификатор
200 OK
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",
"contrAgentId": "integer (int32)",
"title": "string",
"externalId": "string"
},
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Изменение существующего контрагента
Запрос на изменение контрагента
contrAgentId:
integer
(int32)
in path
Идентификатор
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"title": "string",
"longTitle": "string",
"contrAgentInn": "string",
"contrAgentAcct": "string",
"contrAgentKpp": "string",
"description": "string",
"contrAgentType": "string",
"rememberCategory": "boolean",
"operationIncomeCategoryId": "integer (int32)",
"operationOutcomeCategoryId": "integer (int32)",
"active": "boolean",
"externalId": "string"
}
200 OK
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",
"contrAgentId": "integer (int32)",
"title": "string",
"externalId": "string"
},
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Удаление контрагента
contrAgentId:
integer
(int32)
in path
Идентификатор
ignoreRules:
boolean
in query
Признак игнорирования проверки привязки правил
200 OK
OK
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Получение контрагента со сводкой по идентификатору
contrAgentId:
integer
(int32)
in path
Идентификатор
200 OK
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",
"contrAgentId": "integer (int32)",
"title": "string",
"externalId": "string"
},
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Получение списка контрагентов
filter.title:
string
(3 to 256 chars)
in query
Краткое название
filter.contrAgentType:
string
Income,
Outcome,
Mixed
in query
Тип контрагента
filter.startDateTime:
string
(date)
in query
Начальная дата поиска
filter.endDateTime:
string
(date)
in query
Конечная дата поиска
filter.active:
boolean
in query
Статус
filter.changesFromDate:
string
(date)
in query
Начальная дата изменений
filter.inn:
string
in query
ИНН
filter.externalId:
string[]
in query
Набор искомых внешних идентификаторов
Array values passed as multiple parameters:
?filter.externalId=aaa&filter.externalId=bbb paging.offset:
integer
(int32)
in query
Смещение от начала списка. По умолчанию 0
paging.limit:
integer
(int32)
in query
Размер фрейма
sorting.field:
string
Title,
Active,
ContrAgentType,
FirstOperationDate,
LastOperationDate,
Balance,
ModifyDate
in query
Поле сортировки
sorting.direction:
string
Asc,
Desc
in query
Направление сортировки (По умолчанию 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",
"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"
}
200 OK
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",
"contrAgentId": "integer (int32)",
"title": "string",
"externalId": "string"
},
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Получение списка контрагентов со сводкой
filter.title:
string
(3 to 256 chars)
in query
Краткое название
filter.contrAgentType:
string
Income,
Outcome,
Mixed
in query
Тип контрагента
filter.startDateTime:
string
(date)
in query
Начальная дата поиска
filter.endDateTime:
string
(date)
in query
Конечная дата поиска
filter.active:
boolean
in query
Статус
filter.changesFromDate:
string
(date)
in query
Начальная дата изменений
filter.inn:
string
in query
ИНН
filter.externalId:
string[]
in query
Набор искомых внешних идентификаторов
Array values passed as multiple parameters:
?filter.externalId=aaa&filter.externalId=bbb paging.offset:
integer
(int32)
in query
Смещение от начала списка. По умолчанию 0
paging.limit:
integer
(int32)
in query
Размер фрейма
sorting.field:
string
Title,
Active,
ContrAgentType,
FirstOperationDate,
LastOperationDate,
Balance,
ModifyDate
in query
Поле сортировки
sorting.direction:
string
Asc,
Desc
in query
Направление сортировки (По умолчанию 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",
"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:
integer[]
in query
Идентификаторы контрагентов
Array values passed as multiple parameters:
?calculationListRequest.contrAgentId=aaa&calculationListRequest.contrAgentId=bbb 200 OK
OK
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
CoreApi
Получение баланса по всем юрлицам
filter.fromDate:
string
(date)
in query
(no description)
filter.toDate:
string
(date)
in query
(no description)
filter.grouping:
string
Day,
Week,
Month,
Quarter,
Year
in query
(no description)
paging.offset:
integer
(int32)
in query
Смещение от начала списка. По умолчанию 0
paging.limit:
integer
(int32)
in query
Размер фрейма
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"data": "object",
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Получение связей с планом счетов
200 OK
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"
}
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:
integer[]
in query
Фильтр идентификаторов валют
Array values passed as multiple parameters:
?filter.currencyIds=aaa&filter.currencyIds=bbb filter.startDate:
string
(date)
in query
Дата начала истории (включительно)
filter.endDate:
string
(date)
in query
Дата окончания истории (включительно)
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"data": "object",
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
FirstAdditionalOperationAttributes
Получение 1-го дополнительного атрибута операции по идентификатору
firstAdditionalOperationAttributeId:
integer
(int32)
in path
Идентификатор
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-го дополнительного атрибута операции
Запрос на изменение проекта
firstAdditionalOperationAttributeId:
integer
(int32)
in path
Идентификатор
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-го дополнительного атрибута операции
firstAdditionalOperationAttributeId:
integer
(int32)
in path
Идентификатор
200 OK
OK
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Получение 1-го дополнительного атрибута операции со сводкой по идентификатору
firstAdditionalOperationAttributeId:
integer
(int32)
in path
Идентификатор
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.title:
string
(3 to 256 chars)
in query
Краткое название
filter.startDateTime:
string
(date)
in query
Начальная дата поиска
filter.endDateTime:
string
(date)
in query
Конечная дата поиска
filter.changesFromDate:
string
(date)
in query
Начальная дата изменений
filter.externalId:
string[]
in query
Набор искомых внешних идентификаторов
Array values passed as multiple parameters:
?filter.externalId=aaa&filter.externalId=bbb paging.offset:
integer
(int32)
in query
Смещение от начала списка. По умолчанию 0
paging.limit:
integer
(int32)
in query
Размер фрейма
sorting.field:
string
Title,
FirstOperationDate,
LastOperationDate,
ModifyDate
in query
Поле сортировки
sorting.direction:
string
Asc,
Desc
in query
Направление сортировки (По умолчанию 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.title:
string
(3 to 256 chars)
in query
Краткое название
filter.startDateTime:
string
(date)
in query
Начальная дата поиска
filter.endDateTime:
string
(date)
in query
Конечная дата поиска
filter.changesFromDate:
string
(date)
in query
Начальная дата изменений
filter.externalId:
string[]
in query
Набор искомых внешних идентификаторов
Array values passed as multiple parameters:
?filter.externalId=aaa&filter.externalId=bbb paging.offset:
integer
(int32)
in query
Смещение от начала списка. По умолчанию 0
paging.limit:
integer
(int32)
in query
Размер фрейма
sorting.field:
string
Title,
FirstOperationDate,
LastOperationDate,
ModifyDate
in query
Поле сортировки
sorting.direction:
string
Asc,
Desc
in query
Направление сортировки (По умолчанию 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
Получение списка логов импорта
paging.offset:
integer
(int32)
in query
Смещение от начала списка. По умолчанию 0
paging.limit:
integer
(int32)
in query
Размер фрейма
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
Получение счета на оплату по идентификатору
invoiceId:
string
(uuid)
in path
Идентификатор
200 OK
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"
}
Удаление счета на оплату
invoiceId:
string
(uuid)
in path
Идентификатор
200 OK
OK
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Получение списка счетов на оплату
filter.billingDateStart:
string
(date)
in query
Дата выставления. Начало.
filter.billingDateEnd:
string
(date)
in query
Дата выставления. Конец.
filter.valueMin:
number
(double)
in query
Сумма счета. Минимум
filter.valueMax:
number
(double)
in query
Сумма счета. Максимум
filter.factOperationDateStart:
string
(date)
in query
Фактическая дата оплаты. Начало.
filter.factOperationDateEnd:
string
(date)
in query
Фактическая дата оплаты. Конец.
filter.planOperationDateStart:
string
(date)
in query
Плановая дата оплаты. Начало.
filter.planOperationDateEnd:
string
(date)
in query
Плановая дата оплаты. Конец.
filter.committedVariation:
string[]
in query
Статус счета
Array values passed as multiple parameters:
?filter.committedVariation=aaa&filter.committedVariation=bbb filter.paymentVariation:
string[]
in query
Статус оплаты
Array values passed as multiple parameters:
?filter.paymentVariation=aaa&filter.paymentVariation=bbb filter.isOperationDateExpired:
boolean
in query
Дата оплаты просрочена
filter.isOperationDateNotExpired:
boolean
in query
Дата оплаты не просрочена
filter.accountId:
integer[]
in query
Идентификаторы счетов
Array values passed as multiple parameters:
?filter.accountId=aaa&filter.accountId=bbb filter.contrAgentId:
integer[]
in query
Идентификаторы контрагентов
Array values passed as multiple parameters:
?filter.contrAgentId=aaa&filter.contrAgentId=bbb filter.invoiceId:
string[]
in query
Идентификаторы счетов на оплату
Array values passed as multiple parameters:
?filter.invoiceId=aaa&filter.invoiceId=bbb filter.disableNavigationProperties:
boolean
in query
Отключить загрузку свойств навигации
filter.externalId:
string[]
in query
Набор искомых внешних идентификаторов
Array values passed as multiple parameters:
?filter.externalId=aaa&filter.externalId=bbb filter.searchString:
string
in query
Поисковая строка
paging.offset:
integer
(int32)
in query
Смещение от начала списка. По умолчанию 0
paging.limit:
integer
(int32)
in query
Размер фрейма
sorting.field:
string
BillingDate,
OperationDate,
ContrAgent,
State,
ExpiredDays,
Value,
DebtValue
in query
Поле сортировки
sorting.direction:
string
Asc,
Desc
in query
Направление сортировки (По умолчанию 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"
}
200 OK
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"
}
Изменение существующего счета на оплату
Запрос на изменение
invoiceId:
string
(uuid)
in path
Идентификатор
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"billingDate": "string (date)",
"operationDate": "string (date)",
"calculationDate": "string (date)",
"number": "string",
"accountId": "integer (int32)",
"contrAgentId": "integer (int32)",
"items": [
{
"productId": "00000000-0000-0000-0000-000000000000",
"value": "number (double)",
"discount": "number (double)",
"count": "integer (int32)",
"vat": "number (double)",
"sort": "integer (int32)"
}
],
"comment": "string",
"useVat": "boolean",
"externalId": "string"
}
200 OK
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.billingDateStart:
string
(date)
in query
Дата выставления. Начало.
filter.billingDateEnd:
string
(date)
in query
Дата выставления. Конец.
filter.valueMin:
number
(double)
in query
Сумма счета. Минимум
filter.valueMax:
number
(double)
in query
Сумма счета. Максимум
filter.factOperationDateStart:
string
(date)
in query
Фактическая дата оплаты. Начало.
filter.factOperationDateEnd:
string
(date)
in query
Фактическая дата оплаты. Конец.
filter.planOperationDateStart:
string
(date)
in query
Плановая дата оплаты. Начало.
filter.planOperationDateEnd:
string
(date)
in query
Плановая дата оплаты. Конец.
filter.committedVariation:
string[]
in query
Статус счета
Array values passed as multiple parameters:
?filter.committedVariation=aaa&filter.committedVariation=bbb filter.paymentVariation:
string[]
in query
Статус оплаты
Array values passed as multiple parameters:
?filter.paymentVariation=aaa&filter.paymentVariation=bbb filter.isOperationDateExpired:
boolean
in query
Дата оплаты просрочена
filter.isOperationDateNotExpired:
boolean
in query
Дата оплаты не просрочена
filter.accountId:
integer[]
in query
Идентификаторы счетов
Array values passed as multiple parameters:
?filter.accountId=aaa&filter.accountId=bbb filter.contrAgentId:
integer[]
in query
Идентификаторы контрагентов
Array values passed as multiple parameters:
?filter.contrAgentId=aaa&filter.contrAgentId=bbb filter.invoiceId:
string[]
in query
Идентификаторы счетов на оплату
Array values passed as multiple parameters:
?filter.invoiceId=aaa&filter.invoiceId=bbb filter.disableNavigationProperties:
boolean
in query
Отключить загрузку свойств навигации
filter.externalId:
string[]
in query
Набор искомых внешних идентификаторов
Array values passed as multiple parameters:
?filter.externalId=aaa&filter.externalId=bbb filter.searchString:
string
in query
Поисковая строка
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)"
}
200 OK
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)"
}
200 OK
OK
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Получение статуса задания на получение документа
taskGuid:
string
(uuid)
in path
Идентификатор задания на получение документа
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"
}
Создание задания на получение документа
Модель счета на оплату
isGenerateHash:
boolean
in query
(no description)
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"invoiceId": "00000000-0000-0000-0000-000000000000",
"billingDate": "string (date)",
"operationDate": "string (date)",
"calculationDate": "string (date)",
"number": "string",
"accountId": "integer (int32)",
"contrAgentId": "integer (int32)",
"items": [
{
"productId": "00000000-0000-0000-0000-000000000000",
"value": "number (double)",
"discount": "number (double)",
"count": "integer (int32)",
"vat": "number (double)",
"sort": "integer (int32)"
}
],
"comment": "string",
"useVat": "boolean"
}
200 OK
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
Получение списка шаблонов счетов на оплату
paging.offset:
integer
(int32)
in query
Смещение от начала списка. По умолчанию 0
paging.limit:
integer
(int32)
in query
Размер фрейма
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
Получение статьи по идентификатору
operationCategoryId:
integer
(int32)
in path
Идентификатор
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"
}
Изменение существующей статьи
Запрос на изменение
operationCategoryId:
integer
(int32)
in path
Идентификатор
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"
}
Удаление статьи
operationCategoryId:
integer
(int32)
in path
Идентификатор
ignoreRules:
boolean
in query
Признак игнорирования проверки привязки правил
200 OK
OK
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Получение списка статей
filter.operationCategoryId:
integer[]
in query
Набор искомых идентификаторов
Array values passed as multiple parameters:
?filter.operationCategoryId=aaa&filter.operationCategoryId=bbb filter.title:
string
(up to 256 chars)
in query
Название
filter.operationCategoryType:
string
Outcome,
Income,
Assets,
Liabilities,
Capital
in query
Тип
filter.activityType:
string
Operating,
Finance,
Investment
in query
Вид деятельности
filter.parentOperationCategoryId:
integer
(int32)
in query
Родительская статья доходов
filter.changesFromDate:
string
(date)
in query
Начальная дата изменений
filter.externalId:
string[]
in query
Набор искомых внешних идентификаторов
Array values passed as multiple parameters:
?filter.externalId=aaa&filter.externalId=bbb paging.offset:
integer
(int32)
in query
Смещение от начала списка. По умолчанию 0
paging.limit:
integer
(int32)
in query
Размер фрейма
sorting.field:
string
Title,
OperationCategoryType,
ActivityType,
ModifyDate
in query
Поле сортировки
sorting.direction:
string
Asc,
Desc
in query
Направление сортировки (По умолчанию 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
Получение операции по идентификатору
operationId:
integer
(int32)
in path
Идентификатор
200 OK
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",
"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)"
},
"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)"
},
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Удаление операции
operationId:
integer
(int32)
in path
Идентификатор
200 OK
OK
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Получение списка операций
filter.operationId:
integer[]
in query
Идентификаторы операций
Array values passed as multiple parameters:
?filter.operationId=aaa&filter.operationId=bbb filter.operationDateStart:
string
(date)
in query
Дата операции. Начало.
filter.operationDateEnd:
string
(date)
in query
Дата операции. Конец.
filter.calculationPeriodDateStart:
string
(date)
in query
Дата начисления. Начало.
filter.calculationPeriodDateEnd:
string
(date)
in query
Дата начисления. Конец.
filter.withoutContrAgentId:
boolean
in query
Без контрагента
filter.contrAgentId:
integer[]
in query
Идентификаторы контрагентов
Array values passed as multiple parameters:
?filter.contrAgentId=aaa&filter.contrAgentId=bbb filter.accountId:
integer[]
in query
Идентификаторы счетов
Array values passed as multiple parameters:
?filter.accountId=aaa&filter.accountId=bbb filter.accountCompanyId:
integer[]
in query
Идентификаторы компаний
Array values passed as multiple parameters:
?filter.accountCompanyId=aaa&filter.accountCompanyId=bbb filter.operationType:
string[]
in query
Типы операций
Array values passed as multiple parameters:
?filter.operationType=aaa&filter.operationType=bbb filter.operationCategoryActivityType:
string[]
in query
Виды деятельности
Array values passed as multiple parameters:
?filter.operationCategoryActivityType=aaa&filter.operationCategoryActivityType=bbb filter.operationCategoryId:
integer[]
in query
Идентификаторы стетей
Array values passed as multiple parameters:
?filter.operationCategoryId=aaa&filter.operationCategoryId=bbb filter.valueMin:
number
(double)
in query
Общая сумма. Минимум
filter.valueMax:
number
(double)
in query
Общая сумма. Максимум
filter.valueOnlyOfWholeOperation:
boolean
in query
Фильтровать только по сумме целой операции
filter.projectId:
integer[]
in query
Идентификаторы проектов
Array values passed as multiple parameters:
?filter.projectId=aaa&filter.projectId=bbb filter.withoutInvoiсeId:
boolean
in query
Без счета на оплату
filter.invoiceId:
string[]
in query
Идентификаторы счетов на оплату
Array values passed as multiple parameters:
?filter.invoiceId=aaa&filter.invoiceId=bbb filter.isCommitted:
boolean
in query
Признак того, что операция проведена
filter.isCalculationCommitted:
boolean
in query
Признак того, что операция в дату начисления подтверждена
filter.lastModificationDateStart:
string
(date)
in query
Дата последней модификации. Начало.
filter.lastModificationDateEnd:
string
(date)
in query
Дата последней модификации. Конец.
filter.externalId:
string[]
in query
Внешние идентификаторы
Array values passed as multiple parameters:
?filter.externalId=aaa&filter.externalId=bbb filter.importLogId:
integer[]
in query
Идентификаторы лога импорта
Array values passed as multiple parameters:
?filter.importLogId=aaa&filter.importLogId=bbb filter.boundMoveOperationId:
integer[]
in query
Идентификаторы связанных операции
Array values passed as multiple parameters:
?filter.boundMoveOperationId=aaa&filter.boundMoveOperationId=bbb filter.searchString:
string
in query
Строка для расширенного поиска по. Атрибуты, участвующие в поиске:
- Комментарий
- Название контрагента
- Название счета
- Название компании
- Название статьи
filter.invoiceSearchString:
string
in query
Строка для расширенного поиска по номеру счета
filter.changesFromDate:
string
(date)
in query
Начальная дата изменений
filter.disableNavigationProperties:
boolean
in query
Отключить загрузку свойств навигации
filter.groupMoveOperations:
boolean
in query
Cгруппировать перемещения
filter.moveComplexOperationType:
string
IncomePart,
OutcomePart
in query
Подтип операции перемещение
filter.accrualComplexOperationType:
string
IncomePart,
OutcomePart
in query
Подтип операции начисление
paging.offset:
integer
(int32)
in query
Смещение от начала списка. По умолчанию 0
paging.limit:
integer
(int32)
in query
Размер фрейма
sorting.field:
string
OperationDate,
CalculationPeriodDate,
ContrAgent,
Account,
AccountCompany,
OperationCategory,
OperationCategoryActivityType,
LastModificationDate,
OperationType,
Value,
Project,
ModifyDate,
FirstAdditionalOperationAttribute,
Invoice
in query
Поле сортировки
sorting.direction:
string
Asc,
Desc
in query
Направление сортировки (По умолчанию 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",
"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)"
},
"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)"
}
],
"total": "integer (int32)",
"deletedItems": [
{
"entityId": "integer (int32)",
"deleteDate": "string (date)"
}
],
"totalDeleted": "integer (int32)"
},
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Получение списка операций
Запрос
paging.offset:
integer
(int32)
in query
Смещение от начала списка. По умолчанию 0
paging.limit:
integer
(int32)
in query
Размер фрейма
sorting.field:
string
OperationDate,
CalculationPeriodDate,
ContrAgent,
Account,
AccountCompany,
OperationCategory,
OperationCategoryActivityType,
LastModificationDate,
OperationType,
Value,
Project,
ModifyDate,
FirstAdditionalOperationAttribute,
Invoice
in query
Поле сортировки
sorting.direction:
string
Asc,
Desc
in query
Направление сортировки (По умолчанию 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",
"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)"
},
"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)"
}
],
"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
{
"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"
}
200 OK
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",
"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)"
},
"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)"
},
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "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"
}
200 OK
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",
"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)"
},
"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)"
},
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "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"
}
200 OK
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",
"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)"
},
"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)"
}
],
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Создание новой операции начисление
Запрос на создание
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"calculationDate": "string (date)",
"isCalculationCommitted": "boolean",
"companyId": "integer (int32)",
"outcomeOperationCategoryId": "integer (int32)",
"incomeOperationCategoryId": "integer (int32)",
"incomeProjectId": "integer (int32)",
"comment": "string",
"value": "number (double)",
"contrAgentId": "integer (int32)",
"currencyCode": "string",
"incomeExternalId": "string",
"outcomeExternalId": "string"
}
200 OK
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",
"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)"
},
"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)"
}
],
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Изменение существующей операции поступления
Запрос на изменение
operationId:
integer
(int32)
in path
Идентификатор
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"
}
200 OK
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",
"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)"
},
"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)"
},
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Изменение существующей операции списания
Запрос на изменение
operationId:
integer
(int32)
in path
Идентификатор
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"
}
200 OK
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",
"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)"
},
"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)"
},
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Изменение существующей операции перемещения
Запрос на изменение
operationId:
integer
(int32)
in path
Идентификатор
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"debitingDate": "string (date)",
"admissionDate": "string (date)",
"debitingAccountId": "integer (int32)",
"admissionAccountId": "integer (int32)",
"debitingValue": "number (double)",
"admissionValue": "number (double)",
"comment": "string",
"valueByProjects": "object",
"isCommitted": "boolean",
"importLogId": "integer (int32)",
"debitingItems": [
{
"calculationDate": "string (date)",
"isCalculationCommitted": "boolean",
"contrAgentId": "integer (int32)",
"operationCategoryId": "integer (int32)",
"projectId": "integer (int32)",
"firstAdditionalOperationAttributeId": "integer (int32)",
"value": "number (double)"
}
],
"admissionItems": [
{
"calculationDate": "string (date)",
"isCalculationCommitted": "boolean",
"contrAgentId": "integer (int32)",
"operationCategoryId": "integer (int32)",
"projectId": "integer (int32)",
"firstAdditionalOperationAttributeId": "integer (int32)",
"value": "number (double)"
}
],
"debitingExternalId": "string",
"admissionExternalId": "string"
}
200 OK
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",
"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)"
},
"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)"
}
],
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Изменение существующей операции начисление
Запрос на изменение
operationId:
integer
(int32)
in path
Идентификатор
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"calculationDate": "string (date)",
"isCalculationCommitted": "boolean",
"companyId": "integer (int32)",
"outcomeOperationCategoryId": "integer (int32)",
"incomeOperationCategoryId": "integer (int32)",
"incomeProjectId": "integer (int32)",
"comment": "string",
"value": "number (double)",
"contrAgentId": "integer (int32)",
"currencyCode": "string",
"incomeExternalId": "string",
"outcomeExternalId": "string"
}
200 OK
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",
"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)"
},
"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)"
}
],
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Объединение операций в перемещение
Запрос на объединение операций в перемещение
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",
"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)"
},
"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)"
}
]
},
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Разъединение операций
operationId:
integer
(int32)
in path
Идентификатор операции
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",
"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)"
},
"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)"
}
]
},
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Смена типа операции
operationId:
integer
(int32)
in path
Идентификатор операции
200 OK
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",
"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)"
},
"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)"
},
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Получение сводной информации по фильтру операций
filter.operationId:
integer[]
in query
Идентификаторы операций
Array values passed as multiple parameters:
?filter.operationId=aaa&filter.operationId=bbb filter.operationDateStart:
string
(date)
in query
Дата операции. Начало.
filter.operationDateEnd:
string
(date)
in query
Дата операции. Конец.
filter.calculationPeriodDateStart:
string
(date)
in query
Дата начисления. Начало.
filter.calculationPeriodDateEnd:
string
(date)
in query
Дата начисления. Конец.
filter.accountId:
integer[]
in query
Идентификаторы счетов
Array values passed as multiple parameters:
?filter.accountId=aaa&filter.accountId=bbb filter.contrAgentId:
integer[]
in query
Идентификаторы контрагентов
Array values passed as multiple parameters:
?filter.contrAgentId=aaa&filter.contrAgentId=bbb filter.operationCategoryId:
integer[]
in query
Идентификаторы стетей
Array values passed as multiple parameters:
?filter.operationCategoryId=aaa&filter.operationCategoryId=bbb filter.operationType:
string[]
in query
Типы операций
Array values passed as multiple parameters:
?filter.operationType=aaa&filter.operationType=bbb filter.projectId:
integer[]
in query
Идентификаторы проектов
Array values passed as multiple parameters:
?filter.projectId=aaa&filter.projectId=bbb filter.firstAdditionalOperationAttributeId:
integer[]
in query
Идентификаторы 1-го дополнительного атрибута
Array values passed as multiple parameters:
?filter.firstAdditionalOperationAttributeId=aaa&filter.firstAdditionalOperationAttributeId=bbb filter.withoutInvoiсeId:
boolean
in query
Без счета на оплату
filter.invoiceId:
string[]
in query
Идентификаторы счетов на оплату
Array values passed as multiple parameters:
?filter.invoiceId=aaa&filter.invoiceId=bbb filter.importLogId:
integer[]
in query
Идентификаторы лога импорта
Array values passed as multiple parameters:
?filter.importLogId=aaa&filter.importLogId=bbb filter.valueMin:
number
(double)
in query
Общая сумма. Минимум
filter.valueMax:
number
(double)
in query
Общая сумма. Максимум
filter.valueOnlyOfWholeOperation:
boolean
in query
Фильтровать только по сумме целой операции
filter.isCommitted:
boolean
in query
Признак того, что операция проведена
filter.isCalculationCommitted:
boolean
in query
Признак того, что операция в дату начисления подтверждена
filter.searchString:
string
in query
Строка для расширенного поиска по. Атрибуты, участвующие в поиске:
- Комментарий
- Название контрагента
- Название счета
- Название компании
- Название статьи
- Название проекта
- Название 1-го дополнительного атрибута операции
filter.invoiceSearchString:
string
in query
Строка для расширенного поиска по номеру счета
filter.moveComplexOperationType:
string
IncomePart,
OutcomePart
in query
Подтип операции перемещение
filter.accrualComplexOperationType:
string
IncomePart,
OutcomePart
in query
Подтип операции начисление
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
Получение товара по идентификатору
productId:
string
(uuid)
in path
Идентификатор
200 OK
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"
}
Изменение существующего товара
Запрос на изменение
productId:
string
(uuid)
in path
Идентификатор
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
"title": "string",
"value": "number (double)",
"currencyCode": "string",
"vat": "number (double)",
"comment": "string",
"externalId": "string"
}
200 OK
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"
}
Удаление товара
productId:
string
(uuid)
in path
Идентификатор
200 OK
OK
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"isSuccess": "boolean",
"errorMessage": "string",
"errorCode": "string"
}
Получение списка товаров
filter.searchString:
string
in query
Строка для расширенного поиска по. Атрибуты, участвующие в поиске:
- Название товара
filter.externalId:
string[]
in query
Набор искомых внешних идентификаторов
Array values passed as multiple parameters:
?filter.externalId=aaa&filter.externalId=bbb paging.offset:
integer
(int32)
in query
Смещение от начала списка. По умолчанию 0
paging.limit:
integer
(int32)
in query
Размер фрейма
sorting.field:
string
Title,
Value,
Vat
in query
Поле сортировки
sorting.direction:
string
Asc,
Desc
in query
Направление сортировки (По умолчанию 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"
}
200 OK
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
Получение проекта по идентификатору
projectId:
integer
(int32)
in path
Идентификатор
200 OK