Документация API JCat.Недвижимость

Счета

Запрос на вывод списка

GET /v1/billing/counts/{page}/{limit}

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

Имя параметраТипОписаниеПример значенияОбязательное
pageintegerНомер страницы1Нет
limitintegerКол-во записей на страницу10Нет

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

Имя параметраТипОписаниеПример значенияОбязательное
created_at_fromdateДата начала периода создания счета2017-01-01Нет
created_at_todateДата окончания периода создания счета2020-25-12Нет
amountintegerСумма счета5000Нет
payer_idintegerИдентификатор плательщика777Нет
recipient_idintegerИдентификатор получателя333Нет
count_numberstringНомер счета12345Нет
count_statusstringСтатус счетаnot_paid / paid_full / paid_partialНет
sortintegerПоле для сортировкиcount_number / created_at / amount / payment_order / payed_at / acts_amountНет
directionintegerНаправление для сортировкиasc / descНет

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

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

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

{
  "data": {
    "items": [
      {
        "count_id": 42808,
        "count_number": "42808",
        "created_at": "2018-11-23",
        "amount": 960,
        "payer": "ООО «Джейкет»",
        "recipient": "ООО «Ромашка»",
        "payment_order": null,
        "payed_at": null,
        "acts_amount": 960,
        "acts_text": null,
        "status": "not_paid",
        "can_delete": false
      },
      {
        "count_id": 42582,
        "count_number": "42582",
        "created_at": "2018-11-21",
        "amount": 10700,
        "payer": "ООО «АЛЬФА»",
        "recipient": "ООО «Ромашка»",
        "payment_order": null,
        "payed_at": null,
        "acts_amount": 0,
        "acts_text": null,
        "status": "not_paid",
        "can_delete": true
      }
    ],
    "total": 25,
    "pages": {
      "page": 1,
      "total": 13
    }
  }
}

Запрос на список получателей для фильтра

GET /v1/billing/filter/recipients/{page}/{limit}

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

Имя параметраТипОписаниеПример значенияОбязательное
pageintegerНомер страницы1Нет
limitintegerКол-во записей на страницу10Нет

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

Имя параметраТипОписаниеПример значенияОбязательное
with_actsbooleanВыбрать только тех получателей, которые связаны с актами0 или 1Нет

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

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

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

{
  "data": [
    {
      "": "Все"
    },
    {
      "2": "ООО Ромашка"
    },
    {
      "1": "ООО Василек"
    }
  ]
}

Запрос на список плательщиков для фильтра

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

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

Имя параметраТипОписаниеПример значенияОбязательное
pageintegerНомер страницы1Нет
limitintegerКол-во записей на страницу10Нет

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

Имя параметраТипОписаниеПример значенияОбязательное
with_actsbooleanВыбрать только тех плательщиков, которые связаны с актами0 или 1Нет

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

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

Структура ответа аналогична приведенной выше для получателей.

Запрос на список статусов счетов для фильтра

GET /v1/billing/filter/count_statuses

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

  • 200 OK - успешное выполнение

Структура ответа аналогична приведенной выше для получателей.

Запрос на инфо по счету

GET /v1/billing/count_info/{count_id}

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

Имя параметраТипОписаниеПример значенияОбязательное
count_idintegerНомер счета123Да

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

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

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

{
  "data": {
    "count_number": "Счёт № 7777 от 22.11.2018",
    "recipient": "ООО Ромашка",
    "contacts": "Москва: (495) 555-1111\nСанкт-Петербург: (812) 385-3333\nРегионы РФ: 8 (800) 555-1111",
    "bank_itin": "1111111111",
    "bank_kpp": "111111111",
    "bank_account_number": "47772222222000080111",
    "bank_bik": "044525222",
    "bank_correspondent_account": "30111777700000000225",
    "general_manager_position": "Главный бухгалтер",
    "general_manager": "Иванова А.В.",
    "payer": "Лицензиат: ООО «Ромашка» \/ ИНН 3333333333",
    "offer_text": "1. Cчет действителен в течение десяти дней.\n2. В назначении платежа, пожалуйста, указывайте номер счета.\n3. Неисключительное право на использование Сервиса Jcat.ru предоставляется на условиях\nСоглашения",
    "services": [
      {
        "title": "Лицензионное вознаграждение за использование Сервиса. Тариф \"Премиум S222111\", заказ № 222111",
        "amount": 1000
      }
    ],
    "total_amount": 1000,
    "total_amount_with_vat": 1000,
    "vat_string": "Без налога (НДС)",
    "vat_amount": 0,
    "sum_string": "К оплате: Одна тысяча  рублей 00 коп."
  }
}