Keep API overview

Keep is PayMe's accounting product. Its APIs let partners create and manage sellers, set their billing plans, upload and update expenses, create and list income documents, and read a seller's financial checkpoints and tax predictions; sellers create and read their own income documents.

The two APIs

API Token scope Paths What it covers
Partner API partner-api /api/public/..., /partner/api/... Sellers, Plans, Expenses, Income Documents and Statistics, for the sellers of your partner account.
Seller API seller-api /seller/api/... Income Documents: invoices, receipts and the other document types, created with the new invoicing service.

Both APIs take an OAuth 2.0 access token from Obtain access token, sent as Authorization: Bearer <access_token>.

Read these first

# Page What you learn
1 Authentication and environments Where your credentials come from, the base URL on your partner domain, the client-credentials and refresh-token requests, and the scopes.
2 Errors The error shapes, what each HTTP status means, the messages each endpoint documents, rate limits and request IDs.

Facts to know before you start

Machine-readable docs

Every page is available as Markdown by appending .md to its URL. Each API Reference section publishes one OpenAPI file at /keep/<section>/openapi.json, for example /keep/sellers/openapi.json.