Endpointy API

Wszystkie endpointy wymagają nagłówka X-API-Key z tokenem o uprawnieniu read lub wyższym. Bazowy URL to https://api.ogarni.ai.

Dokumenty zakupowe

`GET /api/PurchaseDocuments/my`

Zwraca listę dokumentów zakupowych (paragonów, faktur) użytkownika.

Parametr	Typ	Domyślna	Opis
`from`	DateTime	—	Data początkowa filtra
`to`	DateTime	—	Data końcowa filtra
`sortBy`	string	`purchase_time`	Pole sortowania: `purchase_time` lub `created_at`
`sortDirection`	string	`desc`	Kierunek: `desc` lub `asc`

curl "https://api.ogarni.ai/api/PurchaseDocuments/my?from=2025-01-01&to=2025-01-31&sortBy=purchase_time" \
  -H "X-API-Key: $OGARNIAI_API_TOKEN"

`GET /api/PurchaseDocuments/{id}`

Zwraca szczegóły pojedynczego dokumentu. Odpowiedź 204 No Content oznacza, że dokument jest jeszcze przetwarzany.

`GET /api/PurchaseDocuments/{id}/image`

Zwraca obraz dokumentu (dane binarne z odpowiednim content type).

`GET /api/PurchaseDocuments/{id}/duplicates`

Zwraca sugestie duplikatów dla danego dokumentu.

Kategorie i tagi

`GET /api/Categories`

Zwraca listę kategorii wydatków/przychodów z podkategoriami.

curl "https://api.ogarni.ai/api/Categories" \
  -H "X-API-Key: $OGARNIAI_API_TOKEN"

`GET /api/Tags`

Zwraca listę tagów zdefiniowanych przez użytkownika.

Podsumowania

`GET /api/weekly-summaries/latest`

Zwraca najnowsze podsumowanie tygodniowe wydatków.

`GET /api/weekly-summaries`

Zwraca listę podsumowań tygodniowych. Wspiera paginację przez parametry page i pageSize. Nagłówek odpowiedzi X-Total-Count zawiera łączną liczbę rekordów.

`GET /api/summaries/periods`

Podsumowanie dla własnego zakresu dat.

Parametr	Typ	Wymagany	Opis
`startDate`	DateTime	Tak	Data początkowa
`endDate`	DateTime	Tak	Data końcowa
`granularity`	string	Nie	`Day` (domyślna), `Week` lub `Month`

curl "https://api.ogarni.ai/api/summaries/periods?startDate=2025-01-01&endDate=2025-01-31&granularity=Week" \
  -H "X-API-Key: $OGARNIAI_API_TOKEN"

`GET /api/summaries/presets`

Podsumowanie dla predefiniowanego okresu.

Parametr	Typ	Wymagany	Opis
`preset`	string	Tak	`current-week`, `current-month`, `last-week` lub `last-month`
`granularity`	string	Nie	`Day` (domyślna), `Week` lub `Month`

curl "https://api.ogarni.ai/api/summaries/presets?preset=current-month&granularity=Day" \
  -H "X-API-Key: $OGARNIAI_API_TOKEN"

Powiadomienia

`GET /api/Notifications`

Zwraca listę powiadomień z możliwością filtrowania.

Parametr	Typ	Domyślna	Opis
`isRead`	bool	—	Filtruj wg statusu przeczytania
`type`	enum	—	`Error`=1, `Warning`=2, `Info`=3, `Success`=4
`category`	enum	—	`DocumentProcessing`=1, `WeeklySummary`=2, `System`=3, `DuplicateDetection`=4
`pageSize`	int	50	Liczba wyników na stronę
`pageNumber`	int	1	Numer strony

`GET /api/Notifications/{id}`

Zwraca szczegóły pojedynczego powiadomienia.

`GET /api/Notifications/unread-count`

Zwraca liczbę nieprzeczytanych powiadomień.

curl "https://api.ogarni.ai/api/Notifications/unread-count" \
  -H "X-API-Key: $OGARNIAI_API_TOKEN"

Odpowiedź: {"count": 5}

Grupy

`GET /api/Groups`

Zwraca listę grup finansowych użytkownika.

Parametr	Typ	Domyślna	Opis
`showArchived`	bool	—	Uwzględnij zarchiwizowane grupy

`GET /api/Groups/{groupId}`

Zwraca szczegóły grupy wraz z informacjami o właścicielu.

Pozostałe endpointy

`GET /api/inbound-mailboxes`

Zwraca listę adresów e-mail do przesyłania paragonów (np. user123@receipts.ogarni.ai).

`GET /api/Deduplication/suggestions`

Zwraca sugestie zduplikowanych dokumentów do przeglądu.

`GET /api/external_loyalty`

Zwraca listę połączonych programów lojalnościowych.

`GET /api/BankStatement/supported-banks`

Zwraca listę obsługiwanych banków do importu wyciągów.

`GET /api/RecurringExpenses`

Zwraca listę wydatków cyklicznych.

Parametr	Typ	Domyślna	Opis
`includeInactive`	bool	false	Uwzględnij nieaktywne wydatki cykliczne