Keep API reference

APIs for Keep, PayMe's accounting product: partners create and manage sellers, income documents, expenses, and tax and VAT balances, authenticating with OAuth 2.0 client credentials.

Partner Authorization

• Prerequisites: Partner authorization layer protects the Partner's data on the Keep domain against unauthorized access and mutation.
• Authorization Flow: This document provides a high-level overview of the Keep API authentication system.

Seller API

• List income documents: GET /seller/api/documents/income
• Seller API: The Seller API lets accounting integrations create, retrieve, cancel, and preview seller income documents such as invoices and receipts. This page is the editable landing for the Seller API category.
• Create income document: POST /seller/api/documents/income
• Get income document: GET /seller/api/documents/income/{id}
• Cancel income document: POST /seller/api/documents/income/{id}/cancel
• Generate document preview: POST /seller/api/documents/income/preview

Partners API

• Obtain access token: POST /oauth2/token
• Create seller: POST /public/sellers/create
• Get seller: GET /public/sellers/{sellerId}
• Get available plans: GET /public/plans
• List expenses: GET /public/expenses
• Upload expense document: POST /public/expenses
• Update expense: PATCH /public/expenses/{expenseId}
• Update seller: PUT /public/sellers/{sellerId}/update
• Get external URLs for seller: GET /partner/api/sellers/external-urls
• Get finance profile URL: GET /partner/api/sellers/finance-profile
• Set seller billing plan: POST /partner/api/sellers/set-plan
• Create seller comment: POST /partner/api/sellers/comment
• List income documents: GET /partner/api/documents/income
• Create manual income document: POST /partner/api/documents/income/manual
• Setup tax authority for seller: POST /partner/api/tax-authority/setup
• Set VAT balance: POST /partner/api/sellers/vat-balance
• Set tax balance: POST /partner/api/sellers/tax-balance
• Get financial checkpoints: GET /partner/api/statistic/checkpoints
• Get tax predictions: GET /partner/api/statistic/tax-predictions