Quickstart

ERPSpan is a hosted REST + MCP API for Microsoft Dynamics GP. You read and write GP through a small on-prem agent that connects outbound-only over WSS 443 — no inbound firewall holes, no VPN. This quickstart gets you from zero to a live response against a shared demo company (Fabrikam) without installing anything.

1. Get a sandbox key

Sign in to the dashboard, open API Keys, and create a test key. Test keys are prefixed lb_test_ and are free — they route to a shared, read-only Fabrikam demo company, so you don't need to pair an agent to try the API.

export LB_TEST_KEY="lb_test_..."   # paste your test key

2. Make your first call

A lb_test_ key with no connection or company headers is automatically routed to your sandbox. List customers from the Fabrikam demo:

curl https://api.erpspan.com/v1/customers \
  -H "Authorization: Bearer $LB_TEST_KEY"

You'll get a page of canonical JSON — GP's RM00101 rows mapped to clean fields, money as decimal strings, dates as YYYY-MM-DD:

{
  "data": [
    { "id": "AARONFIT0001", "name": "Aaron Fitz Electrical", "creditLimit": "50000.00", "classId": "USA-ILMO-T1" }
  ],
  "nextCursor": "eyJ2IjoxLCJrIjoxfQ"
}

3. Use the typed SDK

The SDK wraps the same API. Object and response types are generated from the OpenAPI spec, so list/get/create are typed per object. Prefer another language? The OpenAPI spec generates a client for any of them.

npm i erpspan

import { ErpSpan } from "erpspan";

const erpspan = ErpSpan(process.env.LB_TEST_KEY!, {
  baseUrl: "https://api.erpspan.com",
});

const { data } = await erpspan.list("customers", { query: { limit: 10 } });
console.log(data.map((c) => c.name));

Next steps

• Authentication — keys, scopes, and connection/company routing.
• Pagination & filters — keyset cursors and per-object filters.
• Errors — the error envelope and every code.
• Connections & agent install — pair a real GP company.
• Writes & batches — create records via eConnect (unposted batches, whitelist).
• MCP setup — expose your GP data to AI agents.