# Well Starter Kit

## Docs

- [Get started](https://docs.wellapp.ai/api-reference/get-started.md)
- [Webhooks](https://docs.wellapp.ai/api-reference/webhooks.md)
- [Use cases](https://docs.wellapp.ai/api-reference/use-cases.md)
- [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.
- [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.
- [Update Company](https://docs.wellapp.ai/api-reference/endpoint/companies/update.md): Update an existing company record
- [Delete Company](https://docs.wellapp.ai/api-reference/endpoint/companies/delete.md): Delete a 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.
- [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.
- [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.
- [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.
- [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.
- [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.
- [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.
- [List People](https://docs.wellapp.ai/api-reference/endpoint/people/get-all.md): Page through a workspace's people. Filtering and sorting (including across related objects) is done through the records query.
- [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
- [Delete Person](https://docs.wellapp.ai/api-reference/endpoint/people/delete.md): Delete a person record
- [Link Companies to Person](https://docs.wellapp.ai/api-reference/endpoint/people/add-companies-to-person.md): Link existing companies to a person
- [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.
- [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.
- [Patch Invoice](https://docs.wellapp.ai/api-reference/endpoint/invoices/patch.md): Modify an existing invoice by its unique ID.
- [Delete Invoice](https://docs.wellapp.ai/api-reference/endpoint/invoices/delete.md): Remove an invoice by its unique ID. This action is irreversible.
- [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.
- [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:
- [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.
- [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
- [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 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
- [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
- [Delete Person Phone](https://docs.wellapp.ai/api-reference/endpoint/phones/delete-phone.md): Remove a phone number from a person
- [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
- [Create Document](https://docs.wellapp.ai/api-reference/endpoint/documents/create.md): Create a new document record with file and metadata
- [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.
- [Delete Document](https://docs.wellapp.ai/api-reference/endpoint/documents/delete.md)
- [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 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.
- [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 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): Workspace-scoped, cursor-paginated list of `social_link` records. Served by the generic read-only resource handler over the data-views pipeline (Hasura row-level security).
- [Get  web-Link by id](https://docs.wellapp.ai/api-reference/endpoint/web-link/get-by-id.md): Fetch one `social_link` by id, workspace-scoped. Returns 404 when the id is outside the caller's workspace.
- [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
- [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.
- [Get Location](https://docs.wellapp.ai/api-reference/endpoint/location/get.md): Workspace-scoped, cursor-paginated list of `location` records. Served by the generic read-only resource handler over the data-views pipeline (Hasura row-level security).
- [Get Location by id](https://docs.wellapp.ai/api-reference/endpoint/location/get-by-id.md): Fetch one `location` by id, workspace-scoped. Returns 404 when the id is outside the caller's workspace.
- [Delete Location](https://docs.wellapp.ai/api-reference/endpoint/location/delete.md): Remove a location from a person, company, or workspace
- [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.
- [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 Workspace](https://docs.wellapp.ai/api-reference/endpoint/workspaces/create.md): Create a new workspace record
- [List Workspaces](https://docs.wellapp.ai/api-reference/endpoint/workspaces/get-all.md): Query workspaces with filtering and sorting — including across related objects.
- [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
- [Delete Workspace](https://docs.wellapp.ai/api-reference/endpoint/workspaces/delete.md): Delete a workspace record
- [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.
- [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
- [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
- [Delete Membership](https://docs.wellapp.ai/api-reference/endpoint/memberships/delete.md): Remove a person from a workspace
- [Create Webhook](https://docs.wellapp.ai/api-reference/endpoint/webhooks/create.md)
- [Update Webhook](https://docs.wellapp.ai/api-reference/endpoint/webhooks/update.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)
- [Delete Webhook](https://docs.wellapp.ai/api-reference/endpoint/webhooks/delete.md)
- [List Transactions](https://docs.wellapp.ai/api-reference/endpoint/transactions/get-all.md): Workspace-scoped, cursor-paginated list of `transaction` records. Served by the generic read-only resource handler over the data-views pipeline (Hasura row-level security).
- [Get Transactions](https://docs.wellapp.ai/api-reference/endpoint/transactions/get.md): Fetch one `transaction` by id, workspace-scoped. Returns 404 when the id is outside the caller's workspace.
- [List Payment Means](https://docs.wellapp.ai/api-reference/endpoint/payment-means/get-all.md): Workspace-scoped, cursor-paginated list of `payment_means` records. Served by the generic read-only resource handler over the data-views pipeline (Hasura row-level security).
- [Get Payment Means](https://docs.wellapp.ai/api-reference/endpoint/payment-means/get.md): Fetch one `payment_means` by id, workspace-scoped. Returns 404 when the id is outside the caller's workspace.
- [List Account Balances](https://docs.wellapp.ai/api-reference/endpoint/account-balances/get-all.md): Workspace-scoped, cursor-paginated list of `account_balance` records. Served by the generic read-only resource handler over the data-views pipeline (Hasura row-level security).
- [Get Account Balances](https://docs.wellapp.ai/api-reference/endpoint/account-balances/get.md): Fetch one `account_balance` by id, workspace-scoped. Returns 404 when the id is outside the caller's workspace.
- [List Accounts](https://docs.wellapp.ai/api-reference/endpoint/accounts/get-all.md): Workspace-scoped, cursor-paginated list of `account` records. Served by the generic read-only resource handler over the data-views pipeline (Hasura row-level security).
- [Get Accounts](https://docs.wellapp.ai/api-reference/endpoint/accounts/get.md): Fetch one `account` by id, workspace-scoped. Returns 404 when the id is outside the caller's workspace.
- [List Cards](https://docs.wellapp.ai/api-reference/endpoint/cards/get-all.md): Workspace-scoped, cursor-paginated list of `card` records. Served by the generic read-only resource handler over the data-views pipeline (Hasura row-level security).
- [Get Cards](https://docs.wellapp.ai/api-reference/endpoint/cards/get.md): Fetch one `card` by id, workspace-scoped. Returns 404 when the id is outside the caller's workspace.
- [List Checks](https://docs.wellapp.ai/api-reference/endpoint/checks/get-all.md): Workspace-scoped, cursor-paginated list of `check` records. Served by the generic read-only resource handler over the data-views pipeline (Hasura row-level security).
- [Get Checks](https://docs.wellapp.ai/api-reference/endpoint/checks/get.md): Fetch one `check` by id, workspace-scoped. Returns 404 when the id is outside the caller's workspace.
- [List Ledger Accounts](https://docs.wellapp.ai/api-reference/endpoint/ledger-accounts/get-all.md): Workspace-scoped, cursor-paginated list of `ledger_account` records. Served by the generic read-only resource handler over the data-views pipeline (Hasura row-level security).
- [Get Ledger Accounts](https://docs.wellapp.ai/api-reference/endpoint/ledger-accounts/get.md): Fetch one `ledger_account` by id, workspace-scoped. Returns 404 when the id is outside the caller's workspace.
- [List Journals](https://docs.wellapp.ai/api-reference/endpoint/journals/get-all.md): Workspace-scoped, cursor-paginated list of `journal` records. Served by the generic read-only resource handler over the data-views pipeline (Hasura row-level security).
- [Get Journals](https://docs.wellapp.ai/api-reference/endpoint/journals/get.md): Fetch one `journal` by id, workspace-scoped. Returns 404 when the id is outside the caller's workspace.
- [List Journal Entries](https://docs.wellapp.ai/api-reference/endpoint/journal-entries/get-all.md): Workspace-scoped, cursor-paginated list of `journal_entry` records. Served by the generic read-only resource handler over the data-views pipeline (Hasura row-level security).
- [Get Journal Entries](https://docs.wellapp.ai/api-reference/endpoint/journal-entries/get.md): Fetch one `journal_entry` by id, workspace-scoped. Returns 404 when the id is outside the caller's workspace.
- [List Tax Rates](https://docs.wellapp.ai/api-reference/endpoint/tax-rates/get-all.md): Workspace-scoped, cursor-paginated list of `tax_rate` records. Served by the generic read-only resource handler over the data-views pipeline (Hasura row-level security).
- [Get Tax Rates](https://docs.wellapp.ai/api-reference/endpoint/tax-rates/get.md): Fetch one `tax_rate` by id, workspace-scoped. Returns 404 when the id is outside the caller's workspace.
- [List Exchange Rates](https://docs.wellapp.ai/api-reference/endpoint/exchange-rates/get-all.md): Workspace-scoped, cursor-paginated list of `exchange_rate` records. Served by the generic read-only resource handler over the data-views pipeline (Hasura row-level security).
- [Get Exchange Rates](https://docs.wellapp.ai/api-reference/endpoint/exchange-rates/get.md): Fetch one `exchange_rate` by id, workspace-scoped. Returns 404 when the id is outside the caller's workspace.
- [List Invoice Items](https://docs.wellapp.ai/api-reference/endpoint/invoice-items/get-all.md): Workspace-scoped, cursor-paginated list of `invoice_item` records. Served by the generic read-only resource handler over the data-views pipeline (Hasura row-level security).
- [Get Invoice Items](https://docs.wellapp.ai/api-reference/endpoint/invoice-items/get.md): Fetch one `invoice_item` by id, workspace-scoped. Returns 404 when the id is outside the caller's workspace.
- [List Categories](https://docs.wellapp.ai/api-reference/endpoint/categories/get-all.md): Workspace-scoped, cursor-paginated list of `category` records. Served by the generic read-only resource handler over the data-views pipeline (Hasura row-level security).
- [Get Categories](https://docs.wellapp.ai/api-reference/endpoint/categories/get.md): Fetch one `category` by id, workspace-scoped. Returns 404 when the id is outside the caller's workspace.
- [List Invoice Transactions](https://docs.wellapp.ai/api-reference/endpoint/invoice-transactions/get-all.md): Workspace-scoped, cursor-paginated list of `invoice_transaction` records. Served by the generic read-only resource handler over the data-views pipeline (Hasura row-level security).
- [Get Invoice Transactions](https://docs.wellapp.ai/api-reference/endpoint/invoice-transactions/get.md): Fetch one `invoice_transaction` by id, workspace-scoped. Returns 404 when the id is outside the caller's workspace.
- [List Media](https://docs.wellapp.ai/api-reference/endpoint/media/get-all.md): Workspace-scoped, cursor-paginated list of `media` records. Served by the generic read-only resource handler over the data-views pipeline (Hasura row-level security).
- [Get Media](https://docs.wellapp.ai/api-reference/endpoint/media/get.md): Fetch one `media` by id, workspace-scoped. Returns 404 when the id is outside the caller's workspace.
- [List Phones](https://docs.wellapp.ai/api-reference/endpoint/phones/get-all.md): Workspace-scoped, cursor-paginated list of `phone` records. Served by the generic read-only resource handler over the data-views pipeline (Hasura row-level security).
- [Get Phones](https://docs.wellapp.ai/api-reference/endpoint/phones/get.md): Fetch one `phone` by id, workspace-scoped. Returns 404 when the id is outside the caller's workspace.
- [List Web Links](https://docs.wellapp.ai/api-reference/endpoint/web-links/get-all.md): Workspace-scoped, cursor-paginated list of `social_link` records. Served by the generic read-only resource handler over the data-views pipeline (Hasura row-level security).
- [Get Web Links](https://docs.wellapp.ai/api-reference/endpoint/web-links/get.md): Fetch one `social_link` by id, workspace-scoped. Returns 404 when the id is outside the caller's workspace.
- [List Locations](https://docs.wellapp.ai/api-reference/endpoint/locations/get-all.md): Workspace-scoped, cursor-paginated list of `location` records. Served by the generic read-only resource handler over the data-views pipeline (Hasura row-level security).
- [Get Locations](https://docs.wellapp.ai/api-reference/endpoint/locations/get.md): Fetch one `location` by id, workspace-scoped. Returns 404 when the id is outside the caller's workspace.
- [List Chat Conversations](https://docs.wellapp.ai/api-reference/endpoint/chat-conversations/get-all.md): Workspace-scoped, cursor-paginated list of `chat_conversation` records. Served by the generic read-only resource handler over the data-views pipeline (Hasura row-level security).
- [Get Chat Conversations](https://docs.wellapp.ai/api-reference/endpoint/chat-conversations/get.md): Fetch one `chat_conversation` by id, workspace-scoped. Returns 404 when the id is outside the caller's workspace.
- [List Workspace Connectors](https://docs.wellapp.ai/api-reference/endpoint/workspace-connectors/get-all.md): Workspace-scoped, cursor-paginated list of `workspace_connector` records. Served by the generic read-only resource handler over the data-views pipeline (Hasura row-level security).
- [Get Workspace Connectors](https://docs.wellapp.ai/api-reference/endpoint/workspace-connectors/get.md): Fetch one `workspace_connector` by id, workspace-scoped. Returns 404 when the id is outside the caller's workspace.
- [List Workspace Connector Sync Logs](https://docs.wellapp.ai/api-reference/endpoint/workspace-connector-sync-logs/get-all.md): Workspace-scoped, cursor-paginated list of `workspace_connector_sync_log` records. Served by the generic read-only resource handler over the data-views pipeline (Hasura row-level security).
- [Get Workspace Connector Sync Logs](https://docs.wellapp.ai/api-reference/endpoint/workspace-connector-sync-logs/get.md): Fetch one `workspace_connector_sync_log` by id, workspace-scoped. Returns 404 when the id is outside the caller's workspace.
- [List Blueprint Runs](https://docs.wellapp.ai/api-reference/endpoint/blueprint-runs/get-all.md): Workspace-scoped, cursor-paginated list of `blueprint_run` records. Served by the generic read-only resource handler over the data-views pipeline (Hasura row-level security).
- [Get Blueprint Runs](https://docs.wellapp.ai/api-reference/endpoint/blueprint-runs/get.md): Fetch one `blueprint_run` by id, workspace-scoped. Returns 404 when the id is outside the caller's workspace.
- [Account](https://docs.wellapp.ai/object-reference/accounts.md): Account represents a bank or financial account (deposit, credit, loan, investment, payroll, or other) held by a workspace, company, or individual
- [Document](https://docs.wellapp.ai/object-reference/documents.md): A Document represents a file (PDF, image, or other binary) uploaded to or ingested into a workspace
- [Invoice](https://docs.wellapp.ai/object-reference/invoices.md): Invoice is the core billing document entity in Well, representing receivable and payable documents (commercial invoices, credit notes, purchase orders, receipts
- [Journal](https://docs.wellapp.ai/object-reference/journals.md): A Journal (record root: `journals`) represents a named accounting book used to categorize and post financial entries within a workspace — for example, a Sales j
- [Journal Entry](https://docs.wellapp.ai/object-reference/journal_entries.md): A JournalEntry represents one accounting entry inside a Journal — the atomic unit of double-entry bookkeeping on Well
- [Ledger Account](https://docs.wellapp.ai/object-reference/ledger_accounts.md): A LedgerAccount represents a single line in a workspace's chart of accounts (CoA), classified by accounting type (ASSET, LIABILITY, EQUITY, REVENUE, EXPENSE) an
- [Payment Means](https://docs.wellapp.ai/object-reference/payment_means.md): A PaymentMeans record represents a payment instrument — a bank account, card, or paper check — linked to a financial transaction as either the debtor or credito
- [People](https://docs.wellapp.ai/object-reference/people.md): People is a workspace-scoped entity representing an individual contact — an employee, owner, or other relationship a business interacts with
- [Transaction](https://docs.wellapp.ai/object-reference/transactions.md): A Transaction represents a single monetary movement recorded against a bank account — a debit or credit of funds initiated by a connector sync (e.g
- [Account Balance](https://docs.wellapp.ai/object-reference/account_balances.md): AccountBalance represents a time-bounded balance snapshot for a bank account, recording opening and closing booked/value figures in a specified currency alongsi
- [Card](https://docs.wellapp.ai/object-reference/cards.md): A `card` represents a physical or virtual payment card (credit, debit, prepaid, corporate, or virtual) associated with a workspace
- [Category](https://docs.wellapp.ai/object-reference/categories.md): Category is a workspace-global catalog entity representing a named classification tag that can be applied to companies or transactions
- [Check](https://docs.wellapp.ai/object-reference/checks.md): Check represents a paper cheque instrument within the Well financial graph
- [CompanyCategory](https://docs.wellapp.ai/object-reference/company_categories.md): CompanyCategory is a pivot relation that links a Company to a Category within the Well financial graph
- [CompanyEmail](https://docs.wellapp.ai/object-reference/company_emails.md): CompanyEmail is a soft-deletable pivot (bridge) entity that links a Company to an Email address within the same workspace
- [CompanyFinancial](https://docs.wellapp.ai/object-reference/company_financials.md): CompanyFinancial is a one-to-one 'financial profile' extension of the Company entity that stores default ledger-account preferences (accounts receivable and pay
- [CompanyMedia](https://docs.wellapp.ai/object-reference/company_media.md): CompanyMedia is a soft-deleteable pivot (bridge) entity that links a Company to a Media asset
- [CompanyPhone](https://docs.wellapp.ai/object-reference/company_phones.md): CompanyPhone is a soft-deletable pivot (bridge) entity that links a Company to a Phone record, carrying contact-channel metadata (`is_primary`, `is_verify`, `la
- [CompanyRelation](https://docs.wellapp.ai/object-reference/company_relations.md): CompanyRelation models a directed link between two Company entities, capturing structural or commercial relationships (parent/subsidiary hierarchy, supplier cha
- [Email](https://docs.wellapp.ai/object-reference/emails.md): The `email` resource is a canonically-stored email address shared across the financial graph
- [Exchange Rate](https://docs.wellapp.ai/object-reference/exchange_rates.md): ExchangeRate represents a daily FX conversion rate between two ISO 4217 currencies for a given date
- [Invoice Item](https://docs.wellapp.ai/object-reference/invoice_items.md): InvoiceItem represents a single line item on an invoice — a discrete charge for a product or service with its own quantity, price, tax, and period metadata
- [Invoice Payment Means](https://docs.wellapp.ai/object-reference/invoice_payment_means.md): InvoicePaymentMeans is a junction (pivot) relation that associates one Invoice with one PaymentMeans, recording the payment instrument through which an invoice
- [Invoice Transaction](https://docs.wellapp.ai/object-reference/invoice_transactions.md): InvoiceTransaction is the reconciliation pivot record that links one Invoice to one Transaction, recording the exact amount (and optional accounting-currency eq
- [JournalEntryLine](https://docs.wellapp.ai/object-reference/journal_entry_lines.md): A Journal Entry Line (`journal_entry_lines`) is a single debit or credit leg within a double-entry journal entry
- [Media](https://docs.wellapp.ai/object-reference/media.md): Media is an atomic, reusable binary-asset record that stores logos, avatars, and banners for companies and people in the Well platform
- [PersonEmail](https://docs.wellapp.ai/object-reference/person_emails.md): PersonEmail is the pivot relation that links a People record to an Email address within the financial graph
- [PersonLocation](https://docs.wellapp.ai/object-reference/person_locations.md): PersonLocation is a pivot (bridge) entity that links a `People` record to a `Location` record, recording whether that address is the person's primary address an
- [PersonMedia](https://docs.wellapp.ai/object-reference/person_media.md): PersonMedia is a soft-deletable pivot (junction) entity that links a People record to a Media record, enabling a person to have one or more associated media ass
- [PersonPhone](https://docs.wellapp.ai/object-reference/person_phones.md): PersonPhone is a pivot entity that links a People record to a Phone record within a workspace, carrying metadata about the association
- [PersonWebLink](https://docs.wellapp.ai/object-reference/person_web_links.md): PersonWebLink is a soft-deletable bridge (pivot) relation that attaches one or more web hyperlinks to a person record
- [Phone](https://docs.wellapp.ai/object-reference/phones.md): Phone is a shared atomic resource representing a single telephone number stored in its canonical decomposed form: ITU-T country-calling-code, national-number st
- [ReconciliationLink](https://docs.wellapp.ai/object-reference/reconciliation_links.md): ReconciliationLink records a single AI-produced assertion that two distinct entity records represent the same real-world object (source → target)
- [TransactionDocument](https://docs.wellapp.ai/object-reference/transaction_documents.md): TransactionDocument is a soft-deletable N:M join entity that links a `Transaction` to a `Document` (e.g
- [Web Link](https://docs.wellapp.ai/object-reference/web_links.md): A WebLink (table `core_api.web_links`) is an atomic contact-channel record that stores a URL together with its social/web platform classification
- [ApiKey](https://docs.wellapp.ai/object-reference/api_keys.md): ApiKey represents a long-lived programmatic credential scoped to a workspace (and optionally to a specific person/member) that authenticates API requests via th
- [McpOAuthClient](https://docs.wellapp.ai/object-reference/mcp_oauth_clients.md): McpOAuthClient stores OAuth 2.0 clients dynamically registered via RFC 7591 Dynamic Client Registration (DCR)
- [Membership](https://docs.wellapp.ai/object-reference/memberships.md): A Membership represents a user's participation in a workspace, binding a Person (identified by their Firebase auth identity) to a Workspace with a specific role
- [Provider](https://docs.wellapp.ai/object-reference/providers.md): Provider is the Well platform's catalog entry for every external service or application that a workspace can connect to or interact with via the Well extension
- [TempAccessToken](https://docs.wellapp.ai/object-reference/temp_access_tokens.md): TempAccessToken is a short-lived, single-use JWT backing record used to authenticate guest OAuth connector install flows
- [Webhook](https://docs.wellapp.ai/object-reference/webhooks.md): A `Webhook` represents an outbound HTTP subscription registered by a workspace
- [Workspace](https://docs.wellapp.ai/object-reference/workspaces.md): A Workspace is the top-level multi-tenant boundary in the Well platform
- [Workspace Connector](https://docs.wellapp.ai/object-reference/workspace_connectors.md): A `workspace_connector` is an activation record that binds a generic `Connector` definition to a specific workspace, creating a live, credentialed integration i
- [Workspace Connector Sync Log](https://docs.wellapp.ai/object-reference/workspace_connector_sync_logs.md): WorkspaceConnectorSyncLog is an append-style audit record that captures the lifecycle of a single connector sync run for a workspace
- [WorkspaceGroup](https://docs.wellapp.ai/object-reference/workspace_groups.md): A WorkspaceGroup is a named collection that groups multiple workspaces together, enabling cross-workspace access management and shared membership
- [WorkspaceGroupMembership](https://docs.wellapp.ai/object-reference/workspace_group_memberships.md): WorkspaceGroupMembership represents a single person's membership within a workspace group, capturing the lifecycle from invitation through acceptance or revocat
- [WorkspaceGroupWorkspace](https://docs.wellapp.ai/object-reference/workspace_group_workspaces.md): WorkspaceGroupWorkspace is the join-table entity that links a WorkspaceGroup to an individual Workspace, forming the 'which workspaces belong to this group' edg
- [WorkspaceProvider](https://docs.wellapp.ai/object-reference/workspace_providers.md): WorkspaceProvider is the join table that records which global Provider entries a specific workspace has explicitly selected and/or was auto-matched to, acting a
- [WorkspaceSubscription](https://docs.wellapp.ai/object-reference/workspace_subscriptions.md): WorkspaceSubscription is the billing anchor for a Well workspace
- [Blueprint Run](https://docs.wellapp.ai/object-reference/blueprint_runs.md): A `blueprint_run` records a single execution of the Blueprint Analyzer — Well's multi-phase web-navigation agent (Claude Opus) that autonomously browses a targe
- [BlueprintPersistenceError](https://docs.wellapp.ai/object-reference/blueprint_persistence_errors.md): BlueprintPersistenceError is a structured diagnostic sink for failures that occur during blueprint run persistence — replacing silent `logger.error` catches in
- [BlueprintStep](https://docs.wellapp.ai/object-reference/blueprint_steps.md): BlueprintStep records a single atomic action taken by the Blueprint Analyzer AI agent during a web-navigation run
- [Chat Conversation](https://docs.wellapp.ai/object-reference/chat_conversations.md): A ChatConversation record represents a single AI chat session within a workspace, persisting the full message history, model-side context snapshot, UI tab state
- [Contribution](https://docs.wellapp.ai/object-reference/contributions.md): A `Contribution` is an audit and progress-tracking record for a user-initiated blueprint contribution run — typically triggered when a workspace user submits or
- [EmailEvent](https://docs.wellapp.ai/object-reference/email_events.md): EmailEvent is an append-only event log for the outbound email lifecycle
- [Memory](https://docs.wellapp.ai/object-reference/memories.md): The `memories` table stores persistent AI memory blobs that the chat agent reads before composing a response
- [SessionEvent](https://docs.wellapp.ai/object-reference/session_events.md): SessionEvent is an append-only time-series log of Firebase auth token issuances, recording one row per distinct (membership, token_issued_at) tuple
- [Skill](https://docs.wellapp.ai/object-reference/skills.md): A `Skill` is a workspace-scoped markdown document the AI chat LLM consumes at query time
- [Task](https://docs.wellapp.ai/object-reference/tasks.md): A Task represents a discrete unit of work within a workspace — it can be user-created, agent-created, or system-seeded as part of an onboarding or provider-scor
- [TaskTemplate](https://docs.wellapp.ai/object-reference/task_templates.md): TaskTemplate is a global, workspace-independent catalogue of onboarding and activation tasks that Well ships as canonical seed data
- [AccountWorkspaceConnector](https://docs.wellapp.ai/object-reference/account_workspace_connectors.md): AccountWorkspaceConnector is a per-entity junction record that tracks provenance for an Account → WorkspaceConnector association
- [BrowsingSignal](https://docs.wellapp.ai/object-reference/browsing_signals.md): BrowsingSignal is an append-only infrastructure entity that records hourly deltas of provider-domain visits flushed by the Chrome extension
- [CanvasView](https://docs.wellapp.ai/object-reference/canvas_views.md): CanvasView stores a user-customised investor-report canvas layout for a workspace
- [Collect](https://docs.wellapp.ai/object-reference/collects.md): A `Collect` represents a single data-collection run initiated by an authenticated user, typically driven by the browser extension (popup, side panel, or bluepri
- [CollectError](https://docs.wellapp.ai/object-reference/collect_errors.md): CollectError is a structured diagnostic sink for runtime errors raised by the Chrome extension while executing a saved blueprint (auth walls, page-not-found, ti
- [CompanyWorkspaceConnector](https://docs.wellapp.ai/object-reference/company_workspace_connectors.md): CompanyWorkspaceConnector is a per-row provenance junction table that records the relationship between a `Company` entity and a `WorkspaceConnector` instance, d
- [ConnectorFilter](https://docs.wellapp.ai/object-reference/connector_filters.md): ConnectorFilter defines the document-routing rules applied to output connectors during sync orchestration
- [ConnectorMapping](https://docs.wellapp.ai/object-reference/connector_mappings.md): A `ConnectorMapping` row is the compiled JSONata expression that the connector sync pipeline uses to transform one MCP tool's response payload into one of twelv
- [ConnectorSyncDiagnostic](https://docs.wellapp.ai/object-reference/connector_sync_diagnostics.md): ConnectorSyncDiagnostic is an infrastructure-layer audit log that captures structured failure and informational signals emitted by SyncConfigService during MCP
- [Custom Column](https://docs.wellapp.ai/object-reference/custom_columns.md): A Custom Column is a per-workspace, per-root virtual column a user adds to a records table (e.g
- [Custom Column Value](https://docs.wellapp.ai/object-reference/custom_column_values.md): A Custom Column Value is one computed-or-entered cell: the value of a Custom Column for a single record
- [DocumentExtraction](https://docs.wellapp.ai/object-reference/document_extractions.md): DocumentExtraction stores the parsed-text output of one parser run against one Document
- [DocumentStructuredExtraction](https://docs.wellapp.ai/object-reference/document_structured_extractions.md): A `document_structured_extraction` record is the persisted output of one LLM structured-extraction pass over a parsed document
- [DocumentWorkspaceConnector](https://docs.wellapp.ai/object-reference/document_workspace_connectors.md): DocumentWorkspaceConnector is a junction table that records the relationship between a Document and the WorkspaceConnector responsible for ingesting or distribu
- [EnrichmentTask](https://docs.wellapp.ai/object-reference/enrichment_tasks.md): EnrichmentTask is the durable work-item record for Well's asynchronous enrichment pipeline
- [ExtractPrompt](https://docs.wellapp.ai/object-reference/extract_prompts.md): ExtractPrompt stores named, versioned AI extraction prompt templates that drive the document-extraction pipeline when ingesting invoices and documents
- [FieldRule](https://docs.wellapp.ai/object-reference/field_rules.md): A `FieldRule` stores a workspace-scoped AI grounding configuration for a single column (field_key) within a record root (e.g
- [FieldRuleValue](https://docs.wellapp.ai/object-reference/field_rule_values.md): FieldRuleValue stores the computed or user-supplied value for a single custom-column rule applied to a single record
- [InvoiceWorkspaceConnector](https://docs.wellapp.ai/object-reference/invoice_workspace_connectors.md): InvoiceWorkspaceConnector is a direction-discriminated junction row recording which WorkspaceConnector was responsible for creating or routing a given Invoice
- [JournalEntryPostingAttempt](https://docs.wellapp.ai/object-reference/journal_entry_posting_attempts.md): JournalEntryPostingAttempt is an append-only audit ledger that records every attempt to post a double-entry journal entry from a source document (invoice, invoi
- [PeopleWorkspaceConnector](https://docs.wellapp.ai/object-reference/people_workspace_connectors.md): PeopleWorkspaceConnector is a direction-discriminated junction table that records per-row provenance between a `People` record and a `WorkspaceConnector` instan
- [TransactionWorkspaceConnector](https://docs.wellapp.ai/object-reference/transaction_workspace_connectors.md): TransactionWorkspaceConnector is a per-row provenance junction that records which WorkspaceConnector sourced or received a given Transaction — analogous to Docu
- [WorkspaceAccountingSettings](https://docs.wellapp.ai/object-reference/workspace_accounting_settings.md): WorkspaceAccountingSettings stores the per-workspace accounting configuration that governs how Well processes invoices, journal entries, and reporting for a giv
- [WorkspaceConnectorSyncTarget](https://docs.wellapp.ai/object-reference/workspace_connector_sync_targets.md): WorkspaceConnectorSyncTarget is the junction table that maps a single WorkspaceConnector to one or more target Workspace rows, enabling multi-workspace sync: on
- [WorkspaceIdentityExtraction](https://docs.wellapp.ai/object-reference/workspace_identity_extractions.md): WorkspaceIdentityExtraction is an evidence ledger that the self-invoice consensus mechanism uses to identify the workspace owner's own business identity from pr
- [WorkspacePostingMapping](https://docs.wellapp.ai/object-reference/workspace_posting_mappings.md): WorkspacePostingMapping encodes a single posting rule that maps a semantic document context (CoA version, semantic role, posting kind, document polarity) to acc
- [WorkspaceView](https://docs.wellapp.ai/object-reference/workspace_views.md): WorkspaceView represents a named, workspace-scoped configuration for displaying a record root (e.g
- [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)
- [Connectors](https://docs.wellapp.ai/connectors.md)
- [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
- [Authentication](https://docs.wellapp.ai/mcp/authentication.md): API Key and OAuth authentication for Well MCP
- [Tools Reference](https://docs.wellapp.ai/mcp/tools-reference.md): Available MCP tools for Well
- [Client Setup](https://docs.wellapp.ai/mcp/clients.md): Configure Well MCP in your AI client
- [Changelog](https://docs.wellapp.ai/mcp/changelog.md): Version history for Well MCP Server
- [Graphing library](https://docs.wellapp.ai/api-reference/graphing-library.md)

## OpenAPI Specs

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