Introduction
Welcome to the Links SDK documentation.
What is Links SDK?
The Links SDK is a comprehensive toolkit designed to unify the fragmented landscape of Financial Technology. It provides a single, standardized interface to manage critical financial entities—such as Contacts, Invoices, Opportunities, and Payments—across a multitude of external systems like Salesforce, Xero, Stripe, and more.
Instead of building separate integrations for each provider, the Links SDK abstracts this complexity into a Unified Data Model, allowing you to write code once that works across diverse platforms.
Why use the Links SDK?
Building financial integrations is often complex and error-prone. The Links SDK simplifies this with:
End-to-End Type Safety
Built with TypeScript in mind. Enjoy full autocomplete, strict typing for request/response schemas, and compile-time error checking.
Unified Data Models
Interact with normalized entities (e.g., UnifiedContact) that look the same whether the data comes from a CRM.
Developer Ergonomics
Simplified error handling, standardized pagination, and intuitive client methods make integration logic cleaner and faster to write.
Core Capabilities
Unified Models
Access and manage your financial data through these standardized entities:
- Unified Customers: Centralized customer profiles and account details.
- Unified Contacts: Individual points of contact associated with your customers.
- Unified Products: Standardized catalog items, services, and pricing.
- Unified Contracts: Agreement terms, dates, and active status tracking.
- Unified Invoices: Billing records, amounts due, and payment status lifecycles.
- Unified Payments: Transaction records, amounts, and reconciliation data.
- Unified Opportunities: Sales deals, pipeline stages, and revenue forecasting.
Ecosystem Integrations
- External Connections: Retrieve metadata and schema information for connected third-party integrations (like Stripe, Salesforce, Hubspot) to build dynamic, context-aware applications.
Getting Started
We have organized the documentation to help you integrate quickly. Choose the guide that matches your current need:
Quick Start
Installation, API Key setup, and making your first request in minutes.
Client Configuration
Detailed guide on authentication, base URLs, and customizing network options.
Usage Examples
A "Cookbook" of real-world code snippets for creating contacts, fetching invoices, and more.
API Reference
Explore the raw HTTP endpoint definitions and OpenAPI specifications.