Все запросы должны сопровождаться заголовком (header) "Authorization" вида "apiKey {hashKey}"

Добавление нового платежа

Для приема платежей пользователь отправляет POST запрос с платежом.

Адрес: /api/apikey/V1/payment/add
Платеж может содержать следующие поля:
Как разбирать импорт

  1. Статья: исходя из Direction ставим либо приход, либо расход.
  2. Тип контрагента: Без типа
  3. Если тип операции не указан, то ставим "Стандартная"
  4. Если статус оплаты не указан, то ставим "Оплачен"
  5. Если приоритет не указан, то ставим "Не срочный"
  6. Дата создания: определяем сами
  7. Дата изменения: определяем сами
  8. Тип внесения: публичное API
Пример json запроса
{
    "priorityId": 532,
    "paymentDate": "2019-09-03",
    "paymentSum": 12345.0,
     "contragentId": 50382,
    "paymentPurpose": "test again",
    "invoiceId": 4289,
    "accountId": 2185,
    "responsible": "no 1",
    "comment": "testest",
    "paymentStatusId": 530,
    "operationTypeId": 411,
    "directionId": 500,
    "externalId": "testeqwerqwer"
}
Обновление платежа

Для обновления платежей пользователь отправляет POST запрос с платежом.

Адрес:/api/apikey/V1/payment/update
Платеж может содержать следующие поля:

Как разбирать импорт

  1. Находим платеж по id
  2. Обновляем в нем все присланные поля.
Удаление платежа

Для удаление платежей пользователь отправляет POST запрос со списком id удаляемых платежей на адрес.

Адрес:/api/apikey/V1/payment/delete

В запросе указывается:
Пример json запроса
{
"listId": [1,2,3,5]
}
Получение платежей
Для получения документов пользователь отправляет GET POST запрос на адрес.

Адрес:/api/apikey/V1/payment/getList

(GET запрос не читает данные, отправленные вместе с запросом)
В запросе указывается:
Пример json запроса
{
"offset":82,
"limit": 5,
"dateFrom": "2019-08-01",
"dateTo": "2019-08-15"
}
В ответе: общее количество записей для указанной интеграции, входные данные запроса и список платежей, удовлетворяющих входным данным.
Добавление нового контрагента
Для создания нового контрагента пользователь отправляет POST запрос со списком контрагентов.

Адрес: /api/apikey/V1/contragent/add

Банковский счет может содержать следующие поля:
Пример json запроса
{
"externalid":"test",
"contragentName": "контрагент",
"inn": "1234",
"kpp": "5678",
"typeId": 521
}
Обновление контрагента
Для обновления контрагента пользователь отправляет POST запрос со списком контрагентов.

Адрес: /api/apikey/V1/contragent/update

Контрагент может содержать следующие поля:
Удаление контрагента
Для удаление контрагента пользователь отправляет POST запрос со списком id удаляемых контрагента .

Адрес: /api/apikey/V1/contragent/delete
Пример json запроса
{
"listId": [1,2,3,5]
}
Получение контрагента
Для получения контрагента пользователь отправляет GET запрос на адрес.

Адрес: /api/apikey/V1/contragent/getList

В запросе указывается:
Пример json запроса
{
"offset":82,
"limit": 5,
}
В ответе: общее количество записей для указанной интеграции, входные данные запроса и список контрагентов, удовлетворяющих входным данным.
Добавление нового счета

Для создания нового счета пользователь отправляет POST запрос со списком счетов.

Адрес: /api/apikey/V1/invoice/add

Счет может содержать следующие поля:
Пример json запроса
{
"externalid": "test",
"invoiceNumber": "1234 1233 1232 1231",
"invoiceSum": 100.0,
"invoiceDate": "2019-06-01",
"invoicePaymentDeadline": "2019-06-15"
}
Обновление счета

Для обновления счета пользователь отправляет POST запрос со списком счетов.

Адрес: /api/apikey/V1/invoice/update

Счет может содержать следующие поля:
Удаление счета

Для удаление счета пользователь отправляет POST запрос со списком id удаляемых счетов адрес.

Адрес: /api/apikey/V1/invoice/delete
Пример json запроса
Пример json для запроса:
{
"listId": [1,2,3,5]
}
Получение счета

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

Адрес: /api/apikey/V1/invoice/getList

В запросе указывается:
Пример json запроса
{
"offset":82,
"limit": 5,
"dateFrom": "2019-08-01",
"dateTo": "2019-08-15"
}
В ответе: общее количество записей для указанной интеграции, входные данные запроса и список счетов, удовлетворяющих входным данным.
Добавление нового документа

Для приема документов факта пользователь отправляет POST запрос со списком документов.

Адрес: /api/apikey/V1/document/add

Документ может содержать следующие поля:
Как разбирать импорт

  1. Статья: исходя из Direction ставим либо приход, либо расход.
  2. Тип контрагента: Без типа
  3. Если тип операции не указан, то ставим "Стандартная"
  4. Дата создания: определяем сами
  5. Дата изменения: определяем сами
  6. Тип внесения: публичное API
  7. По id документа определяем уникальные документы.
  8. Импортируем уникальные документы.
Пример json запроса
Пример json для запроса:
{
  "operationDate": "2019-09-01",
  "amountValue": 5432.0,
  "amountWithVatValue": 6633.0,
  "directionId": 510,
  "quantityValue": 15,
  "contragentId": 50382,
  "paymentPurpose": "jsut cause",
  "operationTypeId": 411,
  "comment": "йцукфыва",
  "externalId": "test1"
}
Обновление документа

Для обновления документов пользователь отправляет POST запрос со списком документов.

Адрес: /api/apikey/V1/document/update

Документ может содержать следующие поля:
Как разбирать импорт

  1. Находим документ по id
  2. Обновляем в нем все присланные поля.
Удаление документа

Для удаление документов пользователь отправляет POST запрос со списком id удаляемых документов на адрес.

Адрес: /api/apikey/V1/document/delete

В запросе указывается:

Пример json запроса
Пример json для запроса:
{
"listId": [1,2,3,5]
}
Получение документа

Для получения документов пользователь отправляет GET POST запрос на адрес.

Адрес: /api/apikey/V1/document/getList

(GET запрос не читает данные, отправленные вместе с запросом)

В запросе указывается:
Пример json запроса
{
"offset":82,
"limit": 5,
"dateFrom": "2019-08-01",
"dateTo": "2019-08-15"
}
В ответе: общее количество записей для указанной интеграции, входные данные запроса и список документов, удовлетворяющих входным данным.
Добавление банковского счета

Для создания нового банковского счета пользователь отправляет POST запрос со списком банковских счетов.

Адрес: /api/apikey/V1/account/add

Банковский счет может содержать следующие поля:
Пример json запроса
{
"externalid": "test",
"accountName": "test bank account",
"number": "12345321123456",
"remainderSum": 9999.0,
"remainderDate": "2019-06-15"
}
Обновление банковского счета

Для обновления банковского счета пользователь отправляет POST запрос со списком банковских счетов.

Адрес: /api/apikey/V1/account/update

Банковский счет может содержать следующие поля:
Удаление банковского счета

Для удаление банковского счета пользователь отправляет POST запрос со списком id удаляемых банковских счетов адрес.

Адрес: /api/apikey/V1/account/delete
Пример json запроса
{
"listId": [1,2,3,5],
accountId: 4
}
В ответе: общее количество записей для указанной интеграции, входные данные запроса и список банковских счетов, удовлетворяющих входным данным.