🧩 Embedding

Handle the creation and management of businesses without them leaving your platform.

Tyms offers seamless embedding capabilities, empowering developers to create, subscribe, and manage businesses entirely via API, without requiring users to leave your product interface.

Whether you're building a fintech app, business dashboard, or back-office system, Tyms makes it easy to embed powerful accounting functionality directly into your platform.

---

🚀 What You Can Do

With Tyms’ embedded API capabilities, you can:

• 🔨 Create a new business programmatically
• 🧾 Subscribe the business to any Tyms pricing plan
• 🔑 Access the business’s API key for accounting operations
• 📚 Start keeping books on behalf of the business (e.g. posting transactions, managing ledgers, generating reports)

All these actions happen within your product, no need for users to manually visit the Tyms dashboard.

---

🔐 Embedded Onboarding Flow

Here’s a typical flow for using Tyms as an embedded accounting engine:

1. Create a Business
   Use the POST /create/business endpoint to register a business on Tyms from your platform.

2. Subscribe the Business
   Select a Tyms subscription plan using the POST /create/business/subscription/{business_uuid} endpoint. You can pre-select a billing frequency or prompt the user on your UI.

3. Get the Business API Key
   Retrieve the unique API key associated with the business to begin making accounting calls on its behalf.

4. Manage Finances Programmatically
   Start using endpoints to:

   • Create invoices and bills
   • Record expenses and payments
   • Generate financial statements (e.g., profit & loss, balance sheet)

---

🔧 Example Use Case

Imagine you're building a small business banking platform. With Tyms embedded:

• A merchant signs up on your platform.
• Behind the scenes, you create a Tyms business for them.
• You subscribe them to a Tyms plan suitable for their business size.
• You pull their API key and start automating their bookkeeping based on their banking activity.

The merchant never has to know about Tyms directly, they simply enjoy built-in accounting inside your product.

---

📘 Best Practices

• Always store and handle API keys securely.
• Clearly notify users about the accounting automation happening on their behalf.
• Use the sandbox environment to test your entire embedding flow before going live.

---

📥 Need Embedding Access?

Email us at [e-mail] with the subject:

📝 "Request for Tyms embedding access"

We’ll activate your business for embedding capabilities and provide access to our sandbox environment so you can test creating and managing businesses programmatically.

---

By embedding Tyms, you're not just integrating accounting, you’re delivering a full, intelligent finance system inside your own platform. Let Tyms handle the books while you focus on building remarkable user experiences.