Skip to main content

Request headers

string
required
The service user’s API token in the Bearer YOUR_TOKEN format. The school owner issues the token in the admin panel: Manage → School → For developers → API keys — see the “Authentication” section for details.
integer
required
The numeric ID of the seller — the account the school belongs to. Copy it on the API keys page, in the Integration data → Identifiers card. The token’s permissions are checked against this ID.
integer
required
The numeric ID of the school, found in the same place as Seller-Id. The value must match the seller’s school — otherwise a 400 error with cause: "ForbiddenSchoolMismatch" is returned.
All filter parameters are optional. Array parameters are passed by repeating the parameter in the query string: userIds=1&userIds=2. Ranges (*Range) are passed as nested parameters, for example createdAtDateRange[from] and createdAtDateRange[to].

Request parameters

Pagination

integer
Number of records to skip. Defaults to 0.
integer
Page number (an alternative to skip). Starts at 1.
integer
Number of records per page. From 1 to 1000. Defaults to 100.

Filtering

integer[]
Filter by invoice IDs.
integer[]
Filter by user IDs.
integer[]
Filter by product IDs.
enum[]
Filter by invoice type:
  • Regular: one-time payment;
  • InstallmentInit / SubscriptionInit: setting up an installment plan / subscription (first payment and card binding);
  • InstallmentPay / SubscriptionPay: recurring automatic charges for an installment plan / subscription.
Search (by user/identifiers). Up to 50 characters; leading and trailing spaces are trimmed.
object
Invoice creation date range.
object
Range of the invoice total amount. At least one of the fields must be set.
object
Filter by the invoice’s UTM tags.
object
Filter by the related payment.

Response fields

object
Paginated list of invoices (compact projection). For the full structure, see invoice in the payment reference.

Permission requirements

Requires token authentication and the “School Sales” permission (SellerSales).

Updated: 2026-09-25 14:33 UTC