Плательщики

Создание плательщика

POST /v1/billing/payers

Принимаемые параметры:

 Результат запроса 

• 201 Created - успешное выполнение
• 403 Forbidden - доступ к разделу ограничен
• 409 Conflict - плательщик с таким ИНН уже существует

 Пример тела ответа 

{
  "data": {
    "id": 269,
  }
}

Получение подробной информации о плательщике пользователя

GET /v1/billing/payers/{id}

Обязательные параметры:

 Результат запроса 

• 200 OK - успешное выполнение
• 403 Forbidden - доступ к разделу и/или плательщику ограничен
• 404 Not Found - плательщик не существует

 Пример тела ответа 

{
  "data": {
    "id": 371,
    "itin": "1736103478",
    "companyName": "ООО \"Кошкин дом\"",
    "legalAddress": "350087, г. Краснодар, пер. Гаражный, д. 2",
    "postalIndex": "350001",
    "postalAddress": "г. Краснодар, ул. Маяковского, д. 10",
    "managerPosition": "Генеральный директор",
    "managerLastname": "Курочкин",
    "managerFirstname": "Леонид",
    "managerPatronymic": "Васильевич",
    "phone": "+79161234567",
    "canDelete": false,
    "versionsCount": 2
  }
}

Редактирование плательщика

PUT /v1/billing/payers/{id}

Обязательные параметры:

Принимаемые параметры:

 Результат запроса 

• 204 No Content - успешное выполнение
• 403 Forbidden - доступ к разделу и/или плательщику ограничен
• 404 Not Found - плательщик не существует

Удаление плательщика

DELETE /v1/billing/payers/{id}

Обязательные параметры:

 Результат запроса 

• 200 OK - запрос на удаление принят
• 403 Forbidden - доступ к разделу и/или плательщику ограничен
• 404 Not Found - плательщик не существует

 Пример тела ответа 

{
  "data": {
    "result": true
  }
}

Поиск плательщиков

Поиск проводится по всей базе, вне зависимости от того, привязан ли плательщик к пользователю или нет

GET /v1/billing/payers/search

Принимаемые параметры:

 Результат запроса 

• 200 OK - успешное выполнение
• 403 Forbidden - доступ к разделу ограничен

 Пример тела ответа 

{
  "data": [
    {
      "id": 269,
      "itin": "1135327136",
      "companyName": "ООО «Ромашка»",
      "legalAddress": "Московская обл, г Павловский Посад, ул. Ленина, д 3, оф 155",
      "postalIndex": "142500",
      "postalAddress": "Московская обл, г Павловский Посад, ул. Ленина, д 3, оф 155",
      "managerPosition": "Директор",
      "managerLastname": "Иванов",
      "managerFirstname": "Иван",
      "managerPatronymic": "Иванович",
      "phone": "+7(495)123-45-67, доб. 111"
    }
  ]
}

Каждый элемент списка содержит следующие данные:

Получение списка плательщиков текущего пользователя

GET /v1/billing/payers/list/{page}/{limit}

Параметры пагинации:

 Результат запроса 

• 200 OK - успешное выполнение
• 403 Forbidden - доступ к разделу ограничен

 Пример тела ответа 

{
  "data": {
    "items": [
      {
        "id": 371,
        "itin": "1736103478",
        "companyName": "ООО \"Кошкин дом\"",
        "legalAddress": "350087, г. Краснодар, пер. Гаражный, д. 2",
        "postalIndex": "350001",
        "postalAddress": "г. Краснодар, ул. Маяковского, д. 10",
        "managerPosition": "Генеральный директор",
        "managerLastname": "Курочкин",
        "managerFirstname": "Леонид",
        "managerPatronymic": "Васильевич",
        "phone": "+79161234567",
        "canDelete": false,
        "versionsCount": 2
      }
    ],
    "total": 1,
    "pages": {
      "page": 1,
      "total": 1
    }
  }
}

Каждый элемент списка содержит следующие данные:

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

Список версий выгружается в обратной хронологической последовательности.

GET /v1/billing/payers/{id}/versions

Обязательные параметры:

 Результат запроса 

• 200 OK - успешное выполнение
• 403 Forbidden - доступ к разделу и/или плательщику ограничен
• 404 Not Found - плательщик не существует

 Пример тела ответа 

{
  "data": [
    {
      "id": 7134,
      "createdAt": "2018-12-15T15:33:14+03:00",
      "itin": "1736103478",
      "companyName": "ООО \"Кошкин дом\"",
      "legalAddress": "350087, г. Краснодар, пер. Гаражный, д. 2",
      "postalIndex": "350001",
      "postalAddress": "г. Краснодар, ул. Маяковского, д. 10",
      "managerPosition": "Генеральный директор",
      "managerLastname": "Курочкин",
      "managerFirstname": "Леонид",
      "managerPatronymic": "Васильевич",
      "phone": "+79161234567"
    },
    {
      "id": 2824,
      "createdAt": "2016-03-16T14:53:37+03:00",
      "itin": "1736103478",
      "companyName": "ООО \"Кошкин дом\"",
      "legalAddress": "350072, г. Краснодар, ул. Солнечная, д. 15",
      "postalIndex": "350001",
      "postalAddress": "г. Краснодар, ул. Маяковского, д. 10",
      "managerPosition": "Генеральный директор",
      "managerLastname": "Васечкин",
      "managerFirstname": "Петр",
      "managerPatronymic": "Николаевич",
      "phone": "+79168423351"
    }
  ]
}

Каждый элемент списка содержит следующие данные:

Привязка плательщика к текущему пользователю

POST /v1/billing/payers/{id}/bind

Обязательные параметры:

 Результат запроса 

• 204 No Content - успешное выполнение
• 403 Forbidden - доступ к разделу ограничен
• 404 Not Found - плательщик не существует