API udostępnia możliwość filtrowania, sortowania i stronicowania zasobów. W tym celu należy wykorzystywać następująca słowa kluczowych:
- filtrowanie – filter
- sortowanie – orderby
- stronicowanie – skip oraz top
Do filtrowania danych dostępne są do użycia następujące operatory porównań:
- równość – eq
- nierówność – ne
- większe od – gt
- większe lub równe – ge
- mniejsze od – lt
- mniejsze lub równe – le
Przykład
Lista kontrahentów z numerem NIP równym 6770065406:
| [GET] https://app.comarchbetterfly.pl/api2/public/customers/?$filter=CustomerTaxNumber eq '6770065406′ |
Przykład
Lista ostatnich 50 faktur sprzedaży posortowanych malejąco po dacie wystawienia:
| [GET] https://app.comarchbetterfly.pl/api2/public/invoices/?&$orderby=IssueDate desc, Id desc &$skip=0 &$top=50 |
Przykład
Lista proform, które nie zostały przekształcone do faktury sprzedaży, faktury zaliczkowej lub paragonu:
| [GET] https://app.comarchbetterfly.pl/api2/public/proformas/?$filter=InvoiceDocIdNum eq null |
Przykład
Lista faktur, które zostały wystawione po dniu 2023.01.20:
| [GET] https://app.comarchbetterfly.pl/api2/public/invoices/?&$filter=IssueDate gt datetime’2023-01-20′ |
Filtrować można także z użyciem kilku kryteriów stosując wspierane operatory logiczne:
- koniunkcja – and
- alternatywa – or
- zaprzeczenie – not
Przykład
Lista produktów z numerami Id zawartymi w przedziale od 100 do 1000
| [GET] https://app.comarchbetterfly.pl/api2/public/products/?$filter=Id ge 100 and Id le 1000 |
Do wyszukiwania można też zastosować mechanizm full-text search i odnajdywać frazy zawarte m.in. w opisie lub nazwie kontrahencie wybranego na dokumencie
Przykład
Lista faktur proforma zawierająca frazę przykładowy opis
| [GET] https://app.comarchbetterfly.pl/api2/public/proformas/?$fts=’przykładowy opis’ |