Зарплатный проект¶
Список сотрудников¶
Запрос списка сотрудников¶
-
POST
api/v1/salary/employee/list
¶ POST api/v1/salary/employee/list HTTP/1.1 Host: enter.tochka.com Content-Type: application/json { "customer_code": "<id организации>" }
Запрос поставлен в очередь¶
HTTP/1.1 200 OK Host: enter.tochka.com Content-Type: application/json { "id": "3adb2116-67a7-4bcd-a025-88250de2ff2", "result": { "code": 201, "message": "queued" } }
id (string) Идентификатор запроса.
result (object) Присутствует при успешном ответе.
- code (integer) Код ответа.
- message (string) Статус ответа. Не предназначен для конечного пользователя.
Получение списка сотрудников¶
-
POST
api/v1/salary/result
¶ POST api/v1/salary/result HTTP/1.1 Host: enter.tochka.com Accept: application/json Content-Type: application/json { "request_id": "3adb2116-67a7-4bcd-a025-88250de2ff2" }
Примечание
Это метод используется для получения результатов всех доступных методов.
Запрос поставлен в очередь¶
HTTP/1.1 200 OK Host: enter.tochka.com Content-Type: application/json { "id": "3adb2116-67a7-4bcd-a025-88250de2ff2", "result": { "code": 201, "message": "queued" } }
id (string) Идентификатор запроса.
result (object) Присутствует при успешном ответе.
- code (integer) Код ответа.
- message (string) Статус ответа. Не предназначен для конечного пользователя.
Произошла ошибка¶
HTTP/1.1 200 OK Host: enter.tochka.com Content-Type: application/json { "id": "<id запроса>", "error": { "code": 200, "message": "Ooops...", "data": [ { "code": -1, "message": "Статус ответа" } ] } }
id (string) Идентификатор запроса.
error (object) Присутствует при ошибке.
- code (integer) Код ошибки.
- message (string) Описание ошибки. Не предназначено для конечного пользователя.
Ответ готов¶
HTTP/1.1 200 OK
Host: enter.tochka.com
Content-Type: application/json
{
"id": "3adb2116-67a7-4bcd-a025-88250de2ff2",
"result": {
"code": 200,
"message": "ok",
"employees": [
{
"accounts": [
{
"account_code": "40802810207500000024",
"bank_code": "044525797"
}
],
"birthdate": "1984-06-02",
"first_name": "Иван",
"last_name": "Иванов",
"middle_name": "Иванович"
}
]
}
}
id (string) Идентификатор запроса.
result (object) Присутствует при успешном ответе.
code (integer) Код ответа.
message (string) Статус ответа. Не предназначен для конечного пользователя.
employees (array) Список сотрудников.
accounts (array) Список счетов сотрудника.
- account_code (string) Номер банковского счёта сотрудника.
- bank_code (string) БИК банка сотрудника.
birthdate (string) Дата рождения сотрудника.
first_name (string) Имя сотрудника.
last_name (string) Фамилия сотрудника.
middle_name (string) Отчество сотрудника.
Присоединение сотрудника¶
Запрос¶
-
POST
api/v1/salary/employee/add
¶ POST api/v1/salary/employee/add HTTP/1.1 Host: enter.tochka.com Accept: application/json Content-Type: application/json { "customer_code": "<id организации>", "employees": [ { "account_code": "40802810207500000024", "bank_code": "044525797", "birthdate": "1980-12-13", "first_name": "Иван", "last_name": "Иванов", "middle_name": "Иванович" } ] }
customer_code (string) Идентификатор клиента.
employees (array) Список сотрудников.
- account_code (string) Номер банковского счёта сотрудника.
- bank_code (string) БИК банка сотрудника.
- birthdate (string) Дата рождения сотрудника.
- first_name (string) Имя сотрудника.
- last_name (string) Фамилия сотрудника.
- middle_name (string) Отчество сотрудника.
Ошибка валидации¶
HTTP/1.1 200 OK
Host: enter.tochka.com
Content-Type: application/json
{
"errors": {"Описание ошибки"},
"message": "Validation failed"
}
Ответ на присоединения сотрудника¶
-
POST
api/v1/salary/result
¶ POST api/v1/salary/result HTTP/1.1 Host: enter.tochka.com Accept: application/json Content-Type: application/json { "request_id": "3adb2116-67a7-4bcd-a025-88250de2ff2" }
Примечание
Это метод используется для получения результатов всех доступных методов.
Запрос поставлен в очередь¶
HTTP/1.1 200 OK Host: enter.tochka.com Content-Type: application/json { "id": "3adb2116-67a7-4bcd-a025-88250de2ff2", "result": { "code": 201, "message": "queued" } }
id (string) Идентификатор запроса.
result (object) Присутствует при успешном ответе.
- code (integer) Код ответа.
- message (string) Статус ответа. Не предназначен для конечного пользователя.
Произошла ошибка¶
HTTP/1.1 200 OK Host: enter.tochka.com Content-Type: application/json { "id": "<id запроса>", "error": { "code": 200, "message": "Ooops...", "data": [ { "code": -1, "message": "Статус ответа" } ] } }
id (string) Идентификатор запроса.
error (object) Присутствует при ошибке.
- code (integer) Код ошибки.
- message (string) Описание ошибки. Не предназначено для конечного пользователя.
Создание платёжной ведомости¶
Запрос на создание¶
-
POST
api/v1/salary/payroll/create
¶
POST api/v1/salary/payroll/create HTTP/1.1
Host: enter.tochka.com
Content-Type: application/json
{
"customer": {
"customer_code": "<id организации>",
"account_code": "40702810101500001711",
"bank_code": "044525797",
"revenue_type": "1"
},
"payments": [
{
"account_code": "40802810207500000024",
"amount": "777.33",
"bank_code": "0445257979",
"birthdate": "1981-01-23",
"first_name": "Иван",
"last_name": "Иванов",
"middle_name": "Иванович",
"recoupment": "77.33"
}
],
"payment_period_start_date": "2018-01-01",
"payment_period_end_date": "2018-01-31",
"purpose_id": "some-id"
}
customer (object) Плательщик.
- customer_code (string) Идентификатор клиента.
- account_code (string) Номер банковского счёта плательщика.
- bank_code (string) БИК банка плательщика.
- |revenue_type| опциональное поле. Код вида дохода физ. лица («1», «2», «3» или пусто). Подробнее: ФЗ 229, Указание Банка России N 5286, ФЗ 12.
payments (array) Список платежей.
- account_code (string) Номер банковского счёта получателя.
- amount (string) Сумма платежа.
- bank_code (string) БИК банка получателя.
- birthdate (string) Дата рождения сотрудника.
- first_name (string) Имя сотрудника.
- last_name (string) Фамилия сотрудника.
- middle_name (string) Отчество сотрудника.
- |recoupment| опциональное поле. Взысканная сумма по |revenue_type|.
payment_period_start_date (string) Дата начала расчётного периода.
payment_period_end_date (string) Дата конца расчётного периода.
purpose_id (string) Идентификатор назначения.
Запрос поставлен в очередь¶
HTTP/1.1 200 OK Host: enter.tochka.com Content-Type: application/json { "id": "3adb2116-67a7-4bcd-a025-88250de2ff2", "result": { "code": 201, "message": "queued" } }
id (string) Идентификатор запроса.
result (object) Присутствует при успешном ответе.
- code (integer) Код ответа.
- message (string) Статус ответа. Не предназначен для конечного пользователя.
Ошибка валидации¶
HTTP/1.1 200 OK
Host: enter.tochka.com
Content-Type: application/json
{
"errors": {"Описание ошибки"},
"message": "Validation failed"
}
Ответ на создание платёжной ведомости¶
-
POST
api/v1/salary/result
¶ POST api/v1/salary/result HTTP/1.1 Host: enter.tochka.com Accept: application/json Content-Type: application/json { "request_id": "3adb2116-67a7-4bcd-a025-88250de2ff2" }
Примечание
Это метод используется для получения результатов всех доступных методов.
Запрос выполнен¶
При получении служебного статуса:¶
- Draft - Черновой документ.
- Validated - Выполнена валидация документа, он готов к подписи, либо уже частично подписан.
- Accepted - Принят в работу.
- Revoked - Исполнение документа отозвано по инициативе владельца.
- Scheduled - Исполнение документа отложено (ожидание внешних систем).
- Waited - Исполнение документа отложено (ожидание внешних систем).
HTTP/1.1 200 OK
Host: enter.tochka.com
Content-Type: application/json
{
"id": "a36ed4e98a548389de0dff0941ccd1fc6772515dc50d2e2ef4792ab3cf803846",
"result":
{
"code": 200,
"message": "ok",
"status": "Validated"
}
}
При получении одного из конечных статусов:¶
- Processed - Обработан.
- Failed - Ошибка при обработке документа.
- Cancelled - Аннулированный.
- Deleted - Документ был удален пользователем.
HTTP/1.1 200 OK
Host: enter.tochka.com
Content-Type: application/json
{
"id": "3adb2116-67a7-4bcd-a025-88250de2ff2",
"result": {
"code": 200,
"message": "ok",
"status": "Processed",
"amount": {
"rated": "781.33",
"total": "777.33"
},
"customer": {
"customer_code": "<id организации>",
"account_code": "40702810101500001711",
"bank_code": "044525797"
},
"payments": [
{
"account_code": "40802810207500000024",
"amount": "777.33",
"first_name": "Иван",
"last_name": "Иванов",
"middle_name": "Иванович"
}
],
"payment_period_start_date": "2018-01-01",
"payment_period_end_date": "2018-01-31",
"purpose_id": "some-id"
}
}
id (string) Идентификатор запроса.
result (object) Присутствует при успешном ответе.
code (integer) Код ответа.
message (string) Статус ответа. Не предназначен для конечного пользователя.
amount (string)
- rated (string) Итоговая сумма с учётом комиссии банка.
- total (string) Итоговая сумма.
customer (object) Плательщик.
- customer_code (string) Идентификатор клиента.
- account_code (string) Номер банковского счёта плательщика.
- bank_code (string) БИК банка плательщика.
payments (array) Список платежей.
- account_code (string) Номер банковского счёта получателя.
- amount (string) Сумма платежа.
- first_name (string) Имя сотрудника.
- last_name (string) Фамилия сотрудника.
- middle_name (string) Отчество сотрудника.
payment_period_start_date (string) Дата начала расчётного периода.
payment_period_end_date (string) Дата конца расчётного периода.
purpose_id (string) Идентификатор назначения.
Произошла ошибка¶
HTTP/1.1 200 OK Host: enter.tochka.com Content-Type: application/json { "id": "<id запроса>", "error": { "code": 200, "message": "Ooops...", "data": [ { "code": -1, "message": "Статус ответа" } ] } }
id (string) Идентификатор запроса.
error (object) Присутствует при ошибке.
- code (integer) Код ошибки.
- message (string) Описание ошибки. Не предназначено для конечного пользователя.
Назначения платежей¶
Запрос возможных назначений¶
-
GET
/api/v1/salary/purposes
¶
Запрос поставлен в очередь¶
HTTP/1.1 200 OK Host: enter.tochka.com Content-Type: application/json { "id": "3adb2116-67a7-4bcd-a025-88250de2ff2", "result": { "code": 201, "message": "queued" } }
id (string) Идентификатор запроса.
result (object) Присутствует при успешном ответе.
- code (integer) Код ответа.
- message (string) Статус ответа. Не предназначен для конечного пользователя.
Получение возможных назначений¶
-
POST
api/v1/salary/result
¶ POST api/v1/salary/result HTTP/1.1 Host: enter.tochka.com Accept: application/json Content-Type: application/json { "request_id": "3adb2116-67a7-4bcd-a025-88250de2ff2" }
Примечание
Это метод используется для получения результатов всех доступных методов.
Запрос поставлен в очередь¶
HTTP/1.1 200 OK Host: enter.tochka.com Content-Type: application/json { "id": "3adb2116-67a7-4bcd-a025-88250de2ff2", "result": { "code": 201, "message": "queued" } }
id (string) Идентификатор запроса.
result (object) Присутствует при успешном ответе.
- code (integer) Код ответа.
- message (string) Статус ответа. Не предназначен для конечного пользователя.
Ответ готов¶
HTTP/1.1 200 OK
Host: enter.tochka.com
Content-Type: application/json
{
"id": "3adb2116-67a7-4bcd-a025-88250de2ff2",
"result": {
"code": 200,
"message": "ok",
"purposes": [
{
"arbitrary": false,
"description": "Заработная плата по трудовому договору",
"priority": "5",
"purpose_id": "some-id"
}
]
}
}
id (string) Идентификатор запроса.
result (object) Присутствует при успешном ответе.
- code (integer) Код ответа.
- message (string) Статус ответа. Не предназначен для конечного пользователя.
purposes (array) Возможные назначения платежа.
- arbitrary (boolean) Произвольное назначение.
- description (integer) Назначение платежа.
- priority (string) Очерёдность платежа.
- purpose_id (string) Идентификатор назначения.