Keep API reference

Full suite of APIs for our accounting product

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

Internal API

• Get all external URLs for seller: How to call GET /partner/api/sellers/external-urls for Internal API: Retrieve all external URLs for a seller including form, documents, card, finance profile, and payments onboarding URLs.
• Get external credit card URL: GET /partner/api/sellers/external-credit-card
• Get finance profile URL (Internal API): How to call GET /partner/api/sellers/finance-profile for Internal API: Retrieve the finance profile URL for a seller.
• Get payments onboarding URL: GET /partner/api/sellers/external-payments-onboarding
• Get documents upload URL: GET /partner/api/sellers/external-documents-upload
• Get post sign-up form URL: GET /partner/api/sellers/post-sign-up-form
• Change seller billing plan: POST /partner/api/sellers/change-plan
• Update seller direct debit settings: POST /partner/api/sellers/update-direct-debit
• Update seller business registration: POST /partner/api/sellers/update-seller
• Create seller comment (Internal API): How to call POST /partner/api/sellers/comment for Internal API: Add a comment to a seller's record with a specific category.
• Set social security balance: POST /partner/api/sellers/social-security-balance
• Set VAT balance (Internal API): How to call POST /partner/api/sellers/vat-balance for Internal API: Set the VAT balance for a seller.
• Set tax balance (Internal API): How to call POST /partner/api/sellers/tax-balance for Internal API: Set the income tax balance for a seller.
• Process tax return charge: POST /partner/api/sellers/tax-return
• Process business registration charge: POST /partner/api/sellers/business-reg-charge
• Setup tax authority for seller (Internal API): How to call POST /partner/api/tax-authority/setup for Internal API: Configure tax authority integration for a seller including business type and authorization file.
• Activate tax and social security: POST /partner/api/tax-authority/tax-and-social-activation
• Close seller tax authority: POST /partner/api/tax-authority/close-seller
• Update seller tax advance rate: POST /partner/api/tax-authority/update-seller-tax-adv-rate
• Get financial checkpoints (Internal API): How to call GET /partner/api/statistic/checkpoints for Internal API: Retrieve comprehensive financial checkpoints for a seller including income, expenses, tax data, paychecks, and direct debit status.
• Get tax predictions (Internal API): How to call GET /partner/api/statistic/tax-predictions for Internal API: Retrieve tax predictions for a seller including predicted tax amounts, profit, and rates.
• Get seller tax credits: GET /partner/api/statistic/seller-credits
• Get 6111 report data: GET /partner/api/statistic/6111
• List income documents (Internal API): How to call GET /partner/api/documents/income for Internal API: Retrieve a paginated list of income documents for a seller.
• Create iCount income document: POST /partner/api/documents/income/icount
• Create manual income document (Internal API): How to call POST /partner/api/documents/income/manual for Internal API: Create an income document manually with full field specification.
• Upload expense document: POST /partner/api/documents/expense/invoice/upload
• Test hooks endpoint: GET /partner/api/income-documents/hooks
• Test hooks endpoint: POST /partner/api/income-documents/hooks
• Document success webhook: POST /partner/api/income-documents/hooks/success/{docId}
• Document error webhook: POST /partner/api/income-documents/hooks/error/{docId}
• iCount invoice webhook: POST /partner/api/documents/income/hook/icount
• Morning.co invoice webhook: POST /partner/api/documents/income/hook/morning
• AlphaDrive invoice webhook: POST /partner/api/documents/income/hook/alpha-drive
• Activate tax origin: POST /partner/api/tax-authority/tax-and-social-activation/tax-origin
• Activate books good standing: POST /partner/api/tax-authority/tax-and-social-activation/books-good-standing
• Activate social security: POST /partner/api/tax-authority/tax-and-social-activation/social-security
• Create message log entry: POST /public/message-log
• Get message log entries: GET /message-log