# Well Starter Kit

## Docs

- [Create Api-Key](https://docs.wellapp.ai/api-reference/endpoint/api-key/create.md)
- [Delete Api-Key](https://docs.wellapp.ai/api-reference/endpoint/api-key/delete.md)
- [Create Balance](https://docs.wellapp.ai/api-reference/endpoint/balances/create.md): Create a new balance record with local and accounting currency information, foreign exchange rates, and account relationships.
- [Delete Balance](https://docs.wellapp.ai/api-reference/endpoint/balances/delete.md): Permanently delete a specific balance record by its unique ID. This action is irreversible and will remove all associated balance data including local balance, accounting balance, and foreign exchange information.
- [Get Balance](https://docs.wellapp.ai/api-reference/endpoint/balances/get.md): Retrieve a paginated list of balance records with advanced filtering, sorting, and relationship inclusion capabilities. Supports filtering by date ranges, account relationships, workspace associations, and currency information.
- [Get by Balance id](https://docs.wellapp.ai/api-reference/endpoint/balances/get-by-id.md): Fetch detailed information about a single balance record by ID with optional relationship inclusion. Returns comprehensive balance data including local and accounting currency information, foreign exchange rates, and associated relationships.
- [Create Company](https://docs.wellapp.ai/api-reference/endpoint/companies/create.md): Create a new company record with comprehensive business information, registration details, tax information, and various relationships including people, workspaces, and other entities.
- [Delete Company](https://docs.wellapp.ai/api-reference/endpoint/companies/delete.md): Delete a company record
- [Get Company by id](https://docs.wellapp.ai/api-reference/endpoint/companies/get.md): Retrieve a specific company by ID
- [Get Companies](https://docs.wellapp.ai/api-reference/endpoint/companies/getAll.md): Retrieve a paginated list of companies. By default, only basic company data is returned with relationship IDs. Use the 'include' parameter to get detailed relationship data.
- [Remove Workspace from Company](https://docs.wellapp.ai/api-reference/endpoint/companies/remove-workspace-from-company.md): Remove a workspace relationship from a company. This operation soft-deletes the relationship between the company and workspace.
- [Update Company](https://docs.wellapp.ai/api-reference/endpoint/companies/update.md): Update an existing company record
- [Create Connectors](https://docs.wellapp.ai/api-reference/endpoint/connectors/create.md): Create a new connector record with integration details, configuration, and various relationships including published by workspace and media assets.
- [Delete Connectors](https://docs.wellapp.ai/api-reference/endpoint/connectors/delete.md): Permanently delete a specific connector by its unique ID. This action is irreversible and will remove all associated connector data including configuration, relationships, and integration settings.
- [Get Connectors by id](https://docs.wellapp.ai/api-reference/endpoint/connectors/get.md): Retrieve a specific connector by its unique identifier. This endpoint supports:
- [Get Connectors](https://docs.wellapp.ai/api-reference/endpoint/connectors/get-all.md): Retrieve a list of connector records with advanced filtering, sorting, and include capabilities. This endpoint supports:
- [Update Connectors](https://docs.wellapp.ai/api-reference/endpoint/connectors/update.md): Update a connector record with integration details, configuration, and various relationships. All fields are optional for partial updates.
- [Create Document](https://docs.wellapp.ai/api-reference/endpoint/documents/create.md): Create a new document record with file and metadata
- [Delete Document](https://docs.wellapp.ai/api-reference/endpoint/documents/delete.md)
- [Get Document by id](https://docs.wellapp.ai/api-reference/endpoint/documents/get.md)
- [Get Document](https://docs.wellapp.ai/api-reference/endpoint/documents/get-all.md): Retrieve a list of documents with optional filtering, sorting, and relationship inclusion. By default, only document IDs are returned for relationships.
- [Create Email](https://docs.wellapp.ai/api-reference/endpoint/emails/create-email.md): Create a new email address with relationships to people, companies, or workspaces
- [Delete Email](https://docs.wellapp.ai/api-reference/endpoint/emails/delete-email.md): Remove an email address from a person, company, or workspace
- [Get Email by ID](https://docs.wellapp.ai/api-reference/endpoint/emails/get-email-by-id.md): Retrieve a specific email by its UUID or email address with optional relationship details
- [Get Emails](https://docs.wellapp.ai/api-reference/endpoint/emails/get-emails.md): Retrieve a list of email addresses with advanced filtering, sorting, and include capabilities. This endpoint supports:
- [Delete Invoice items](https://docs.wellapp.ai/api-reference/endpoint/invoice-items/delete.md): Permanently delete a specific invoice item by ID. This action cannot be undone.
- [Get Invoice items](https://docs.wellapp.ai/api-reference/endpoint/invoice-items/get.md): Retrieve a paginated list of invoice items with optional filtering, sorting, and relationship inclusion.
- [Get Invoice items by id](https://docs.wellapp.ai/api-reference/endpoint/invoice-items/get-by-id.md): Fetch detailed information about a single invoice item by ID, with optional relationship inclusion.
- [Patch Invoice items](https://docs.wellapp.ai/api-reference/endpoint/invoice-items/patch.md): Create a new invoice item with detailed product information, pricing, taxes, and period specifications.
- [Create Invoice items](https://docs.wellapp.ai/api-reference/endpoint/invoice-items/post.md): Create a new invoice item with detailed product information, pricing, taxes, and period specifications.
- [Delete Invoice](https://docs.wellapp.ai/api-reference/endpoint/invoices/delete.md): Remove an invoice by its unique ID. This action is irreversible.
- [Get Invoice](https://docs.wellapp.ai/api-reference/endpoint/invoices/get.md): Fetch detailed information about a single invoice by ID.
- [Get Invoices](https://docs.wellapp.ai/api-reference/endpoint/invoices/get-all.md): Retrieve a list of invoices filtered by issuer, receiver, status or date range. Supports pagination following JSON:API specification.
- [Patch Invoice](https://docs.wellapp.ai/api-reference/endpoint/invoices/patch.md): Modify an existing invoice by its unique ID.
- [Create Invoices](https://docs.wellapp.ai/api-reference/endpoint/invoices/post.md): Create a new invoice with comprehensive details including issuer/receiver relationships, payment terms, line items, and document attachments. Supports both basic invoice creation and complex scenarios with detailed billing contexts.
- [Create Location](https://docs.wellapp.ai/api-reference/endpoint/location/create.md): Create a new address/location with geographic coordinates and associate it with people, companies, or workspaces.
- [Delete Location](https://docs.wellapp.ai/api-reference/endpoint/location/delete.md): Remove a location from a person, company, or workspace
- [Get Location](https://docs.wellapp.ai/api-reference/endpoint/location/get.md): Retrieve a list of locations with advanced filtering, sorting, and include capabilities. This endpoint supports:
- [Get Location by id](https://docs.wellapp.ai/api-reference/endpoint/location/get-by-id.md): Retrieve a specific location by its UUID with optional relationship details
- [Create Media](https://docs.wellapp.ai/api-reference/endpoint/media/create.md): Create a new media record with relationships to people, companies, or workspaces
- [Delete Media](https://docs.wellapp.ai/api-reference/endpoint/media/delete.md): Delete an existing media record and its associated file
- [Get Media](https://docs.wellapp.ai/api-reference/endpoint/media/get.md): Retrieve a list of media records with advanced filtering, sorting, and include capabilities. This endpoint supports:
- [Get Media by id](https://docs.wellapp.ai/api-reference/endpoint/media/getId.md): Retrieve a specific media record by ID with optional include functionality for related resources.
- [Create Membership](https://docs.wellapp.ai/api-reference/endpoint/memberships/create.md): Create a new membership linking a person to a workspace with a specific role
- [Delete Membership](https://docs.wellapp.ai/api-reference/endpoint/memberships/delete.md): Remove a person from a workspace
- [Get Membership](https://docs.wellapp.ai/api-reference/endpoint/memberships/get.md): Retrieve a specific membership by ID
- [Get All Memberships](https://docs.wellapp.ai/api-reference/endpoint/memberships/get-all.md): Retrieve memberships with optional filtering by person
- [Update Membership](https://docs.wellapp.ai/api-reference/endpoint/memberships/update.md): Update an existing membership role
- [Create Payment Mean](https://docs.wellapp.ai/api-reference/endpoint/payment-means/create.md): Create a new payment method or account for financial transactions. This endpoint supports various payment means types including bank accounts (IBAN/SWIFT), credit/debit cards, digital wallets, and other payment instruments.
- [Delete Payment Mean](https://docs.wellapp.ai/api-reference/endpoint/payment-means/delete.md): Delete a specific payment method or account by its unique ID.
- [Get Payment Mean by id](https://docs.wellapp.ai/api-reference/endpoint/payment-means/get.md): Retrieve a specific payment method or account by its unique identifier.
- [Get Payment Means](https://docs.wellapp.ai/api-reference/endpoint/payment-means/get-all.md): Retrieve a list of payment methods and accounts with advanced filtering, sorting, and include capabilities. This endpoint supports:
- [Update Payment Mean](https://docs.wellapp.ai/api-reference/endpoint/payment-means/update.md): Update an existing payment method or account for financial transactions. This endpoint supports partial updates to payment means including bank accounts (IBAN/SWIFT), credit/debit cards, digital wallets, and other payment instruments.
- [Link Companies to Person](https://docs.wellapp.ai/api-reference/endpoint/people/add-companies-to-person.md): Link existing companies to a person
- [Create Person](https://docs.wellapp.ai/api-reference/endpoint/people/create.md): Create a new person record with optional emails, phone numbers, company relationships, and social links. If a person with the same name and primary email already exists, returns the existing person instead of creating a duplicate.
- [Delete Person](https://docs.wellapp.ai/api-reference/endpoint/people/delete.md): Delete a person record
- [Get Person](https://docs.wellapp.ai/api-reference/endpoint/people/get.md): Retrieve a single person by ID with related emails, phones, and social links
- [Create Phone](https://docs.wellapp.ai/api-reference/endpoint/phones/create-phone.md): Create a new phone number with relationships to people, companies, or workspaces
- [Create Phone Verification Code](https://docs.wellapp.ai/api-reference/endpoint/phones/create-phone-verification-code.md): Validate the verification code received by WhatsApp for a phone number. If the code is valid, sets the is_verify field to true for the person's phone.
- [Verify Phone Number](https://docs.wellapp.ai/api-reference/endpoint/phones/create-verify-phone-number.md): Send verification code by whatsapp to a phone number for verification
- [Delete Person Phone](https://docs.wellapp.ai/api-reference/endpoint/phones/delete-phone.md): Remove a phone number from a person
- [Get Phones by id](https://docs.wellapp.ai/api-reference/endpoint/phones/get-phone-by-id.md): Retrieve a specific phone by its UUID or phone number with optional relationship details
- [Get Phones](https://docs.wellapp.ai/api-reference/endpoint/phones/get-phones.md): Retrieve a list of phone numbers with advanced filtering, sorting, and include capabilities. This endpoint supports:
- [Create Transaction](https://docs.wellapp.ai/api-reference/endpoint/transactions/create.md): Create a new financial transaction record with comprehensive payment details, foreign exchange information, remittance data, fees, and relationship associations.
- [Delete Transaction](https://docs.wellapp.ai/api-reference/endpoint/transactions/delete.md): Delete a specific transaction by its unique ID or perform a soft delete based on business rules.
- [Get Transaction by id](https://docs.wellapp.ai/api-reference/endpoint/transactions/get.md): Retrieve a specific financial transaction by its unique identifier. This endpoint supports:
- [Get Transaction](https://docs.wellapp.ai/api-reference/endpoint/transactions/get-all.md): Retrieve a list of financial transaction records with advanced filtering, sorting, and include capabilities.
- [Update Transaction](https://docs.wellapp.ai/api-reference/endpoint/transactions/update.md): Update a financial transaction record with comprehensive payment details, foreign exchange information, remittance data, fees, and relationship associations. This endpoint supports:
- [Create web link](https://docs.wellapp.ai/api-reference/endpoint/web-link/create.md): Create a web or social media link and associate it with people, companies, or workspaces.
- [Delete web-link](https://docs.wellapp.ai/api-reference/endpoint/web-link/delete.md): Delete a web link by ID
- [Get  web-Link](https://docs.wellapp.ai/api-reference/endpoint/web-link/get.md): Retrieve all web links with optional filtering, sorting, and relationship inclusion
- [Get  web-Link by id](https://docs.wellapp.ai/api-reference/endpoint/web-link/get-by-id.md): Retrieve a specific web link by ID with optional relationship inclusion
- [Create Webhook](https://docs.wellapp.ai/api-reference/endpoint/webhooks/create.md)
- [Delete Webhook](https://docs.wellapp.ai/api-reference/endpoint/webhooks/delete.md)
- [Get Webhook](https://docs.wellapp.ai/api-reference/endpoint/webhooks/get.md)
- [Get Webhooks](https://docs.wellapp.ai/api-reference/endpoint/webhooks/get-all.md)
- [Update Webhook](https://docs.wellapp.ai/api-reference/endpoint/webhooks/update.md)
- [Create Workspace](https://docs.wellapp.ai/api-reference/endpoint/workspaces/create.md): Create a new workspace record
- [Delete Workspace](https://docs.wellapp.ai/api-reference/endpoint/workspaces/delete.md): Delete a workspace record
- [Get Workspace](https://docs.wellapp.ai/api-reference/endpoint/workspaces/get.md): Retrieve a specific workspace by ID
- [Update Workspace](https://docs.wellapp.ai/api-reference/endpoint/workspaces/update.md): Update an existing workspace record
- [Get started](https://docs.wellapp.ai/api-reference/get-started.md)
- [Graphing library](https://docs.wellapp.ai/api-reference/graphing-library.md)
- [Use cases](https://docs.wellapp.ai/api-reference/use-cases.md)
- [Webhooks](https://docs.wellapp.ai/api-reference/webhooks.md)
- [Connectors](https://docs.wellapp.ai/connectors.md)
- [API Key](https://docs.wellapp.ai/database/api-key.md): API Key entity schema for authentication and authorization management
- [Balance](https://docs.wellapp.ai/database/balance.md): Balance entity for tracking account balances, foreign exchange rates, and financial position data
- [Company](https://docs.wellapp.ai/database/company.md): Company entity schema and database structure
- [Company Person](https://docs.wellapp.ai/database/company-person.md): Company-Person relationship entity for managing business relationships and roles
- [Company Workspace](https://docs.wellapp.ai/database/company-workspace.md): Company-Workspace relationship entity for managing cross-workspace company access
- [Document](https://docs.wellapp.ai/database/document.md): Document entity for managing file uploads, processing status, and document classification
- [Email](https://docs.wellapp.ai/database/email.md): Email entity schema for managing email addresses and contact information
- [Invoice](https://docs.wellapp.ai/database/invoice.md): Invoice entity schema for billing and payment document management
- [Invoice Item](https://docs.wellapp.ai/database/invoice-item.md): Invoice Item entity schema for managing line items and billing details
- [Location](https://docs.wellapp.ai/database/location.md): Location entity for managing address information, geographical coordinates, and location relationships
- [Media](https://docs.wellapp.ai/database/media.md): Media entity schema for managing files, images, and digital assets
- [Membership](https://docs.wellapp.ai/database/membership.md): Membership entity schema for managing user workspace relationships and roles
- [People](https://docs.wellapp.ai/database/people.md): People entity schema for managing individual records and personal information
- [Person Document](https://docs.wellapp.ai/database/person-document.md): Person-Document relationship entity for managing document ownership and associations
- [Person Workspace](https://docs.wellapp.ai/database/person-workspace.md): Person-Workspace relationship entity for managing cross-workspace person access
- [Phone](https://docs.wellapp.ai/database/phone.md): Phone entity schema for managing phone numbers and contact information
- [Web Link](https://docs.wellapp.ai/database/web-link.md): Web Link entity schema for managing social media and web profile links
- [Webhook](https://docs.wellapp.ai/database/webhook.md): Webhook entity schema for managing event notifications and external integrations
- [Workspace](https://docs.wellapp.ai/database/workspace.md): Workspace entity schema for organizing tenants and managing organizational data
- [Banking Transaction Fee](https://docs.wellapp.ai/enums/banking-transaction-fee.md): Essential banking transaction fee type indicators for categorizing different charges and fees
- [Business Entity Types by Country](https://docs.wellapp.ai/enums/business-entity-by-country.md): Comprehensive list of business entity types organized by country for international business classification
- [Category Connector](https://docs.wellapp.ai/enums/category-connector.md): Classification system for integration connectors, organizing services and platforms by business function and technical domain
- [Company Roles](https://docs.wellapp.ai/enums/company-roles.md): Relationship types that define how people are connected to companies
- [Connector Data Quality](https://docs.wellapp.ai/enums/connector-data-quality.md): List of resources and attributes imported through integration connectors
- [Currency Rate Source](https://docs.wellapp.ai/enums/currency-rate.md): Essential currency rate source indicators for tracking foreign exchange rate data providers
- [Banking Transaction Status](https://docs.wellapp.ai/enums/details-banking-transaction-status.md): Essential banking transaction status indicators for tracking the complete lifecycle of banking transactions
- [UN/EDIFACT Document Type Codes](https://docs.wellapp.ai/enums/edifact-document-codes.md): ISO standard document type codes for electronic data interchange (EDI) transactions, supporting global business document classification
- [File Types](https://docs.wellapp.ai/enums/file.md): Essential filew type classifications for organizing different types of digital files and media content
- [Invoice Line Unit](https://docs.wellapp.ai/enums/invoice-line-unit.md): UN/CEFACT standard units of measure for invoice line items
- [Invoice Status](https://docs.wellapp.ai/enums/invoice-status.md): Lifecycle states of invoice documents from creation to completion
- [Labels](https://docs.wellapp.ai/enums/label.md): Essential email labels for categorizing and organizing emails
- [Media Types](https://docs.wellapp.ai/enums/media.md): Essential media type classifications for organizing different types of digital files and media content
- [Payment Means](https://docs.wellapp.ai/enums/payment-means.md): Essential payment means type indicators for categorizing different payment methods and instruments
- [Payment Means Status](https://docs.wellapp.ai/enums/payment-means-status.md): Essential payment means status indicators for tracking the lifecycle and availability of payment methods
- [Registry Name](https://docs.wellapp.ai/enums/registry-name.md): Global business registration authorities for company registration verification and validation across international jurisdictions
- [Remittance Info Reference](https://docs.wellapp.ai/enums/remittance-info-reference.md): Essential remittance information reference type indicators for categorizing payment reference formats
- [Roles](https://docs.wellapp.ai/enums/role.md): User role definitions for workspace access control and permission management
- [Scheme Type](https://docs.wellapp.ai/enums/sheme-type.md): Essential scheme type indicators for categorizing different payment and banking schemes
- [Tax Categories](https://docs.wellapp.ai/enums/tax-cat.md): Global tax classification system supporting VAT, GST, sales tax, and international tax standards for comprehensive business compliance
- [Tax ID](https://docs.wellapp.ai/enums/tax-id.md): Comprehensive tax identification types organized by category, covering global tax identification systems for business and individual tax reporting requirements
- [Tax Scheme](https://docs.wellapp.ai/enums/tax-scheme.md): Global tax system identification for VAT, GST, sales tax, and other tax regimes
- [Transaction Type](https://docs.wellapp.ai/enums/transaction.md): Essential transaction type indicators for categorizing different types of financial transactions
- [Universal Document Classification](https://docs.wellapp.ai/enums/universal-document-class.md): Comprehensive business document classification system for automated document processing
- [Web Link](https://docs.wellapp.ai/enums/web-link.md)
- [Authentication](https://docs.wellapp.ai/mcp/authentication.md): API Key and OAuth authentication for Well MCP
- [Changelog](https://docs.wellapp.ai/mcp/changelog.md): Version history for Well MCP Server
- [Client Setup](https://docs.wellapp.ai/mcp/clients.md): Configure Well MCP in your AI client
- [Introduction](https://docs.wellapp.ai/mcp/introduction.md): Connect your AI assistant to Well financial data
- [Quickstart](https://docs.wellapp.ai/mcp/quickstart.md): Get started with Well MCP in 5 minutes
- [Tools Reference](https://docs.wellapp.ai/mcp/tools-reference.md): Available MCP tools for Well

## OpenAPI Specs

- [openapi](https://docs.wellapp.ai/api-reference/openapi.json)