POST/v1/finance/invoices

Отримати список рахунків

finance_invoices

Повертає рахунки, кредит-ноти та квитанції організації посторінково, з фільтрами (період, напрям, категорія, контрагент, валюта, тип документа, оплачено, прострочено, потребує розгляду, пошук за номером і стороною), сортуванням і сумою у звітній валюті з курсом перерахунку. Включаються лише документи, видимі користувачеві. Щоб отримати наступну сторінку, передайте next_cursor як cursor з тими самими фільтрами. Потрібен профіль доступу з доступом до фінансових даних.

Автентифікація

Передайте ключ API в заголовку Authorization: Authorization: Bearer <ключ>.

Параметри заголовка

X-View-Asstring
Лише для ключів API з роллю admin. Виконує запит від імені профілю доступу <profile>[:viewer|verifier|editor], наприклад employee:viewer. Ключ інсталяції не може використовувати цей заголовок (403).

Параметри cookie

kb_view_asstring
Cookie режиму «View as» для сесії. Встановлюється через POST /auth/view-as, очищається через DELETE /auth/view-as.

Тіло запиту

application/json

Об’єкт: FinanceListRequest

filtersFinanceFilter
date_basisstring
Допустимі значення: documentpayment
Типове значення: "document"
orderstring
Допустимі значення: date_descdate_ascamount_descamount_asc
Типове значення: "date_desc"
currency_modeFinanceCurrencyMode
limitinteger
Типове значення: 100≥ 1, ≤ 1000
cursorstring
languagestring
Мова назв категорій, en|ru.

Відповіді

200Сторінка рахунків

Заголовки відповіді

RateLimit-Policy
Чинні ліміти у форматі чернетки IETF draft-ietf-httpapi-ratelimit-headers: елементи через кому "<name>";q=<quota>;w=<window in seconds>. key — частота запитів ключа API (квота — це сплеск, вікно — час, за який квота повністю відновлюється; для сесії цей елемент називається user, без облікових даних — ip); minute, day і month — квоти організації на календарну хвилину, день і місяць за UTC.
RateLimit
Скільки лишилося за кожним лімітом із RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Ліміт найсуворішого елемента в RateLimit-Policy (того, за яким лишилося найменше запитів).
X-RateLimit-Remaining
Скільки запитів лишилося за найсуворішим лімітом.
X-RateLimit-Reset
Кількість секунд до скидання найсуворішого ліміту.

application/json

Об’єкт: FinanceInvoicePage

invoicesarray of FinanceInvoiceRowобов’язково
totalintegerобов’язково
Загальна кількість рахунків, що відповідають фільтрам.
next_cursorstring
Курсор наступної сторінки. Якщо поля немає, це остання сторінка.
currencystring
Звітна валюта полів reporting (режим reporting).
warningsarray of string
Коди попереджень, ті самі, що в FinanceReport.warnings.
has_moreboolean
Чи є наступна сторінка. Є, коли запит передає limit або cursor.

400Неправильний запит: значення параметра або стан об’єкта не дозволяє виконати дію (`detail` — повідомлення).

Заголовки відповіді

RateLimit-Policy
Чинні ліміти у форматі чернетки IETF draft-ietf-httpapi-ratelimit-headers: елементи через кому "<name>";q=<quota>;w=<window in seconds>. key — частота запитів ключа API (квота — це сплеск, вікно — час, за який квота повністю відновлюється; для сесії цей елемент називається user, без облікових даних — ip); minute, day і month — квоти організації на календарну хвилину, день і місяць за UTC.
RateLimit
Скільки лишилося за кожним лімітом із RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Ліміт найсуворішого елемента в RateLimit-Policy (того, за яким лишилося найменше запитів).
X-RateLimit-Remaining
Скільки запитів лишилося за найсуворішим лімітом.
X-RateLimit-Reset
Кількість секунд до скидання найсуворішого ліміту.

application/json

Об’єкт: Error

401Облікові дані не надіслано (ні cookie сесії, ні ключа API) або ключ не знайдено.

Заголовки відповіді

RateLimit-Policy
Чинні ліміти у форматі чернетки IETF draft-ietf-httpapi-ratelimit-headers: елементи через кому "<name>";q=<quota>;w=<window in seconds>. key — частота запитів ключа API (квота — це сплеск, вікно — час, за який квота повністю відновлюється; для сесії цей елемент називається user, без облікових даних — ip); minute, day і month — квоти організації на календарну хвилину, день і місяць за UTC.
RateLimit
Скільки лишилося за кожним лімітом із RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Ліміт найсуворішого елемента в RateLimit-Policy (того, за яким лишилося найменше запитів).
X-RateLimit-Remaining
Скільки запитів лишилося за найсуворішим лімітом.
X-RateLimit-Reset
Кількість секунд до скидання найсуворішого ліміту.

application/json

Об’єкт: Error

403Дію не дозволено: роль не має достатніх прав, немає доступу до колекції чи картки, запит виконується в режимі «View as» або організацію призупинено чи видалено (`detail` — об’єкт із `code: org_suspended | org_deleted`).

Заголовки відповіді

RateLimit-Policy
Чинні ліміти у форматі чернетки IETF draft-ietf-httpapi-ratelimit-headers: елементи через кому "<name>";q=<quota>;w=<window in seconds>. key — частота запитів ключа API (квота — це сплеск, вікно — час, за який квота повністю відновлюється; для сесії цей елемент називається user, без облікових даних — ip); minute, day і month — квоти організації на календарну хвилину, день і місяць за UTC.
RateLimit
Скільки лишилося за кожним лімітом із RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Ліміт найсуворішого елемента в RateLimit-Policy (того, за яким лишилося найменше запитів).
X-RateLimit-Remaining
Скільки запитів лишилося за найсуворішим лімітом.
X-RateLimit-Reset
Кількість секунд до скидання найсуворішого ліміту.

application/json

Об’єкт: Error

429Забагато запитів (`api.rate_limited`), квоту організації на хвилину, день або місяць вичерпано (`api.quota_exceeded`; `error.details` містить `quota`, `limit` і `reset_at`), досягнуто ліміту організації або сервіс відповідей зайнятий (`answers.engine_busy`). Зачекайте стільки, скільки вказано в заголовку `Retry-After`.

Заголовки відповіді

Retry-After
Кількість секунд, які слід зачекати перед повторним запитом.
RateLimit-Policy
Чинні ліміти у форматі чернетки IETF draft-ietf-httpapi-ratelimit-headers: елементи через кому "<name>";q=<quota>;w=<window in seconds>. key — частота запитів ключа API (квота — це сплеск, вікно — час, за який квота повністю відновлюється; для сесії цей елемент називається user, без облікових даних — ip); minute, day і month — квоти організації на календарну хвилину, день і місяць за UTC.
RateLimit
Скільки лишилося за кожним лімітом із RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Ліміт найсуворішого елемента в RateLimit-Policy (того, за яким лишилося найменше запитів).
X-RateLimit-Remaining
Скільки запитів лишилося за найсуворішим лімітом.
X-RateLimit-Reset
Кількість секунд до скидання найсуворішого ліміту.

application/json

Об’єкт: Error

503Сервіс, від якого залежить цей запит, тимчасово недоступний. Повторіть спробу пізніше.

Заголовки відповіді

RateLimit-Policy
Чинні ліміти у форматі чернетки IETF draft-ietf-httpapi-ratelimit-headers: елементи через кому "<name>";q=<quota>;w=<window in seconds>. key — частота запитів ключа API (квота — це сплеск, вікно — час, за який квота повністю відновлюється; для сесії цей елемент називається user, без облікових даних — ip); minute, day і month — квоти організації на календарну хвилину, день і місяць за UTC.
RateLimit
Скільки лишилося за кожним лімітом із RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Ліміт найсуворішого елемента в RateLimit-Policy (того, за яким лишилося найменше запитів).
X-RateLimit-Remaining
Скільки запитів лишилося за найсуворішим лімітом.
X-RateLimit-Reset
Кількість секунд до скидання найсуворішого ліміту.

application/json

Об’єкт: Error

Коди помилок

Коди, які ця операція може повернути в error.code, крім загальних кодів будь-якого запиту.

Безпечні повтори

Надсилайте заголовок Idempotency-Key (наприклад, UUID) з кожним POST і PATCH. Повтор із тим самим ключем протягом 24 годин повертає збережену відповідь, а не виконує запит знову.

Ліміти частоти

Відповіді містять заголовки RateLimit і RateLimit-Policy, а також давніші X-RateLimit-Limit, X-RateLimit-Remaining і X-RateLimit-Reset. Відповідь 429 містить Retry-After у секундах: зачекайте й повторіть запит.

← finance · Довідник API

curl -X POST 'https://api.sursa.com/v1/finance/invoices' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"filters":{"from":"2026-10-24","to":"2026-10-24","directions":["in"]},"date_basis":"document","order":"date_desc"}' \
  -H "Authorization: Bearer $SURSA_API_KEY"

Спробувати

Ключ API

Ключ зберігається лише в пам’яті цієї вкладки й надсилається тільки на https://api.sursa.com.

Запити працюють зі справжніми даними вашої організації.

X-View-As header

Idempotency-Key

Якщо поле порожнє, для кожного запиту генерується новий ключ.

Тіло запиту (JSON)