Quickstart Guide
Get started with Settler in 5 minutes. Follow these steps to create your first reconciliation.
💡 New to Settler? Try the interactive playground to test the API without signing up, or follow this guide to integrate into your application.
1
Create a Workspace
Sign up and create your first workspace
# Using the SDK
import { Settler } from '@settler/sdk';
const client = new Settler({
apiKey: process.env.SETTLER_API_KEY,
});
# Or use the Console
# Visit /console to create a workspace via UI2
Create a Reconciliation Run
Set up your first reconciliation job
const job = await client.jobs.create({
name: "My First Reconciliation",
source: {
adapter: "stripe",
config: {
apiKey: process.env.STRIPE_SECRET_KEY,
},
},
target: {
adapter: "shopify",
config: {
apiKey: process.env.SHOPIFY_API_KEY,
},
},
rules: {
matching: [
{ field: "order_id", type: "exact" },
{ field: "amount", type: "exact", tolerance: 0.01 },
],
},
});
console.log("Job created:", job.id);3
Upload Receipt/Data
Parse receipts or upload transaction data
# Parse a receipt
const receipt = await client.receipts.parse({
file: "https://example.com/receipt.jpg",
});
console.log("Receipt parsed:", receipt.total, receipt.merchant);
# Or upload CSV/JSON
const upload = await client.data.upload({
file: fileBuffer,
format: "csv",
});4
View Results
Check reconciliation results and reports
# Get job status
const status = await client.jobs.get(job.id);
console.log("Status:", status.status);
# Get report
const report = await client.reports.get(job.id);
console.log("Matched:", report.summary.matched);
console.log("Unmatched:", report.summary.unmatched);