Для: Администраторы
Чтение счетов-фактур с помощью клавиши управления
Составьте список опубликованных счетов-фактур вашего центра и ознакомьтесь с одним из них, указав сумму, платеж и возврат, для целей бухгалтерского учета или отчетности.
В этой статье4 разделов
Прежде чем начать
На этой странице рассматривается процесс чтения счетов-фактур. Все данные о фактурах представлены в формате https://prd-api-manage.caseactive.com/v1/<hub id>. С помощью этого инструмента можно просмотреть все опубликованные счета-фактуры, включая те, которые уже закрыты, но не включающие проекты, находящиеся в стадии разработки. Этот инструмент не позволяет создавать, изменять, возвращать или оплачивать счета-фактуры.
Звонки
| Вызов | Что это делает |
|---|---|
GET /invoices | Список публикуемых счетов-фактур; самые последние счета расположены в начале списка. |
GET /invoices/<case_id>/<invoice_id> | Читает один счет-фактуру. |
| Параметр | Что это делает | Необходимый | По умолчанию |
|---|---|---|---|
status | Только счета с таким статусом: open, paid, void, uncollectible или processing | Нет. | Все |
case_id | Есть только один случай, когда были выставлены счета. | Нет. | Каждый случай |
limit | Сколько счетов может содержаться на одной странице – до 1000. | Нет. | 20 |
start_key | startKey из предыдущей страницы | Нет. | Первая страница |
Пока ещё остается несколько счетов. Звоните по номеру nextLink или отправляйте сообщения по адресу startKey, используя start_key в качестве ключа для обмена информацией. В этом списке нет фильтра по дате или по времени последней изменения счета. Чтобы узнать о любых изменениях, произошедших после вашей последней синхронизации, включая как платежи, так и возвраты средств, вы можете использовать таблицу case_invoices с помощью параметра filter_by=updated_on:>, за которым следует время временной шкале Unix секунд. Изменения отображаются через несколько секунд после их сохранения. Поэтому начинайте работу с каждой новой записью немного раньше, чем заканчивается предыдущая. Для поиска информации о возвратах средств используйте filter_by=refund_status:=succeeded. Подробнее смотрите в разделе Поиск случаев и пользователей с возможностью управления ими.
Счет-фактура
Каждое значение представляет собой целое число в долларах США: 96300 равно 963,00 долларов.
{
"data": {
"case_id": "cc-1a2b3c4d5e6f70",
"invoice_id": "invoice::20260915143000_ab12cd34ef5678",
"host_id": "ca-7e6d5c4b3a2f10",
"name": "September legal services",
"description": "Consultation and filing for Jane Sample's claim",
"invoice_number": "INV-1042",
"po_number": "PO-778",
"terms": "Net 15",
"host_ref_id": "acct-1042",
"notes": "Thank you for your business.",
"participants_ids": ["cu-4f1c2a9e8b7d60"],
"user_id": "cu-9d8c7b6a5f4e30",
"status": "paid",
"due_date": "2026-09-30T17:00:00+00:00",
"transactions": {
"transactions": [
{"transaction_type": "charge", "description": "Consultation (hours)", "value": 35000, "quantity": 2, "currency": "usd"},
{"transaction_type": "charge", "description": "Court filing fee", "value": 30000, "quantity": 1, "currency": "usd"}
],
"discount": 0.1,
"tax": 0.07
},
"subtotal": 100000,
"discount": 0.1,
"discount_amount": 10000,
"discounted_amount": 90000,
"tax": 0.07,
"tax_amount": 6300,
"total": 96300,
"payment_gateway": "stripe",
"stripe_payment": {"user_id": "cu-4f1c2a9e8b7d60", "fees": 2863, "stripe_fee": 2823, "application_fee": 40, "net": 93437},
"payment_attempts": [{"datetime": "2026-09-20T14:05:12+00:00", "success": true, "user_id": "cu-4f1c2a9e8b7d60"}],
"completed_on": "2026-09-20T14:05:20+00:00",
"published": 1,
"created_on": "2026-09-15T14:30:00+00:00",
"updated_on": "2026-09-20T14:05:20+00:00"
}
}
| Поле | Что в нём содержится |
|---|---|
invoice_id, case_id | Форма счета-фактуры, а также сам документ. Прочитайте один счет-фактуру вместе с формой. |
name, description | Название и описание произведения |
invoice_number, po_number, terms, notes, host_ref_id | Написано на счету-фактуре. host_ref_id является его идентификационным номером. |
participants_ids | Люди, которым это предназначено. |
user_id | Кто его создал? |
status | open: ожидает оплаты. paid: оплачено онлайн или заявлено как оплаченное. void: отменено. uncollectible и processing: установлены вами сотрудниками. paid и void являются окончательными значениями. |
due_date | Когда придет время… |
transactions | Его строки состоят из элементов типа charge или credit. Кроме того, в них присутствуют элементы description, value в центах, а также quantity. Также указаны соответствующие ставки. |
subtotal | Сумма начисленных сборов меньше суммы кредитов; эта сумма никогда не может быть меньше 0. |
discount, discount_amount, discounted_amount | Процент дисконтирования, выраженный в долях (0.1), составляет 10%. Дисконт в ценах в центах, а также общая сумма после вычитания дисконта. |
tax, tax_amount | Налоговая ставка в виде дроби0.07 Это составляет 7%). А налог в ценовом выражении — это сумма после вычета скидки. |
total | Какова сумма, в центах? |
payment_gateway | stripe – когда платеж производится онлайн; manual – когда платеж зафиксирован вашим сотрудником. |
stripe_payment | Что касается онлайн-платежей: кто произвел платеж, каковы сборы и сумма денег в ценах. |
payment_attempts | Попытки оплатить через интернет: когда это удалось, и почему не удалось. |
refunded | Если происходит возврат средств, то это указано в параметрах status (pending, succeeded, failed или canceled), amount в центах и reason. Состояние самой финансовой операции остается неизменным – paid. |
completed_on | Когда платеж был произведен или отменен. |
Если звонок отклонен
| Статус | message | Почему |
|---|---|---|
| 404 | InvoiceDoesNotExistException | На этой коробке нет никаких счетов-фактур с таким идентификатором. |
| 400 | InvoiceNotPublishedException | Инвойт представляет собой вексель. |
| 400 | SchemaFieldsException | status не является одним из пяти. |
| 400 | InvalidStartKeyException | start_key не входил в этот список. |
Что касается текста ошибок и остальных кодов, см. раздел Управление ошибками API и статусными кодами.