Документация API JCat.Работа

Акты

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

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

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

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

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

Имя параметраТипОписаниеПример значенияОбязательное
created_at_fromdateДата начала периода создания акта2017-01-01Нет
created_at_todateДата окончания периода создания акта2020-25-12Нет
act_numberstringНомер акта54321Нет
count_numberstringНомер счета12345Нет
payer_idintegerИдентификатор плательщика777Нет
recipient_idintegerИдентификатор получателя333Нет
act_statusstringСтатус актаsended / not_sendedНет
sortintegerПоле для сортировкиact_number / count_number / created_at / amountНет
directionintegerНаправление для сортировкиasc / descНет

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

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

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

{
  "data": {
    "items": [
      {
        "act_number": 38200,
        "count_number": "42800",
        "created_at": "2018-12-07",
        "amount": 960,
        "payer": "ООО «Джейкет»",
        "recipient": "ООО «Ромашка»",
        "send_date": "2019-01-15",
        "send_method": null,
        "send_address": "г Москва, ул Филевская 2-я, д 8"
      }
    ],
    "total": 1,
    "pages": {
      "page": 1,
      "total": 1
    }
  }
}

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

GET /v1/billing/filter/act_statuses

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

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

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

Запрос на инфо по акту

GET /v1/billing/act_info/{act_id}

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

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

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

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

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

{
  "data": {
    "act_number": "Акт № 777 от 31.10.2018",
    "act_description": "приема-передачи неисключительных прав на использование Сервиса Jcat.ru",
    "act_text": "ООО «Ромашка», именуемое в дальнейшем «Лицензиар» (ИНН 1111111111), и\nООО «Василек», именуемое в дальнейшем «Лицензиат» (ИНН 3333333333), а вместе именуемые «Стороны», составили и подписали настоящий Акт о том,\nчто «Лицензиар» передал, а «Лицензиат» принял на основании договора на условиях простой (неисключительной) лицензии права на использование программ для ЭВМ «Сервис», а именно:",
    "contacts": "Москва: (495) 111-2222\nСанкт-Петербург: (812) 111-2222\nРегионы РФ: 8 (800) 111-2222",
    "warranty_text": "Размер Лицензионного вознаграждения НДС не облагается  в соответствии с п.2 ст. 346.11 НК РФ.\nЛицензиар выполнил все обязательства в полном объёме в срок с надлежащим качеством.\nЛицензиат претензий к Лицензиару не имеет.",
    "payment_text": "Оплата производится в соответствии с условиями договора",
    "general_manager_position": "Главный бухгалтер",
    "general_manager": "Иванова А.В.",
    "general_manager_procuratory": "по доверенности №1 от 11 января 2000 г.",
    "postal_address": "Адрес для отправки почтовой корреспонденции: 333333, г. Москва, Московский проезд, д.1",
    "customer_general_manager": "Генеральный директор Иванов Иван Иваныч",
    "logo": "https:\/\/www.somesite.ru\/img\/logo.jpg",
    "services": [
      {
        "title": "Лицензионное вознаграждение за использование Сервиса",
        "amount": 1000
      }
    ],
    "total_amount": 1000,
    "total_amount_with_vat": 1000,
    "vat_string": "Без налога (НДС)",
    "vat_amount": 0,
    "sum_string": "К оплате: Одна тысяча  рублей 00 коп."
  }
}