Open-source manufacturing ERP, MES and QMS. Quoting, MRP, inventory, shop floor, quality and lot/serial traceability on one Postgres schema, with a REST API and MCP server. Self-host or use Carbon Cloud.
TypeScript ai-agentsbill-of-materialserpinventory-managementleanmanufacturingmanufacturing-execution-systemmcp-servermesmrpopen-source-erppostgresqlproduction-planningqmsquality-management-systemreact-routerself-hostedsupabasetraceabilitytypescript
// SPDX-License-Identifier: AGPL-3.0-only
// Carbon (github.com/crbnos/carbon). Modified or adapted versions of this file,
// including ports, remain AGPLv3; serving them over a network requires releasing their source.
import { CodeBlock } from "@/components/api/code-block";
import {
Code,
DocEyebrow,
DocLink,
DocPage,
DocTitle,
H2,
Lead,
P,
Warn,
Table,
Row
} from "@/components/api/doc";
import { ContentFooter } from "@/components/api/page-footer";
import { apiBase } from "@/lib/api-data";
import { highlight } from "@/lib/highlight";
import { pageSeo, SEO } from "@/lib/seo";
export const metadata = pageSeo({
title: `${SEO.api.intro.title} | Carbon`,
ogTitle: SEO.api.intro.title,
description: SEO.api.intro.description,
path: "/api/data",
eyebrow: "Data API"
});
const ENV = `# .env
CARBON_DATA_API_URL=${apiBase}
CARBON_DATA_API_KEY=<your-api-key>`;
const INIT = `import { createClient } from '@supabase/supabase-js'
const apiUrl = process.env.CARBON_DATA_API_URL
const apiKey = process.env.CARBON_DATA_API_KEY
export const carbon = createClient(apiUrl, apiKey)`;
export default async function ApiIntroPage() {
const [env, init] = await Promise.all([
highlight(ENV, "curl"),
highlight(INIT, "javascript")
]);
return (
<DocPage>
<DocEyebrow>Data API</DocEyebrow>
<DocTitle>Overview</DocTitle>
<Lead>
The Data API is direct REST access to Carbon's tables and views — the
escape hatch beneath the <DocLink href="/api">Carbon API</DocLink>.
Every table and view is an endpoint.
</Lead>
<P>
Reach for the <DocLink href="/api">Carbon API</DocLink> first. This
surface is for the case it doesn't cover — when you know exactly what
you're touching. Start by creating an{" "}
<DocLink href="/api/data/authentication">API key</DocLink>.
</P>
<Warn title="You are outside the service layer">
Nothing here validates, recalculates, or posts. A write goes straight
to the table, so the values that depend on it — order totals, statuses,
ledger entries — are not maintained for you. Use the{" "}
<DocLink href="/api">Carbon API</DocLink> unless you know exactly what
the table touches.
</Warn>
<H2 id="tables-and-views">Tables & views</H2>
<P>
The API exposes both <strong>tables</strong> (read/write) and{" "}
<strong>views</strong> (read-only, computed). Some resources appear
twice — for example <Code>salesInvoice</Code> (a table) and{" "}
<Code>salesInvoices</Code> (a view). These are not interchangeable.
</P>
<Warn title="Always read from the view">
Tables like <Code>salesInvoice</Code> and <Code>purchaseInvoice</Code>{" "}
have stored total and status columns that are set at creation and{" "}
<strong>not updated</strong> when line items change. The corresponding
views (<Code>salesInvoices</Code>, <Code>purchaseInvoices</Code>)
compute totals, tax, balance, and status live from line items and
settlements. If you read from the table, you will get stale data.
</Warn>
<P>The rule is simple:</P>
<Table>
<Row head cols="1fr 1fr" cells={["Operation", "Use"]} />
<Row
cols="1fr 1fr"
cells={[
"List / retrieve",
<>The <strong>view</strong> (plural, e.g. salesInvoices)</>,
]}
/>
<Row
cols="1fr 1fr"
cells={[
"Create / update / delete",
<>The <strong>table</strong> (singular, e.g. salesInvoice)</>,
]}
/>
</Table>
<P>
In the sidebar, views are marked with an{" "}
<span title="eye icon">eye icon</span> and tables with a{" "}
<span title="grid icon">grid icon</span>. Affected resource pages also
show a banner linking to the correct counterpart.
</P>
<H2 id="quickstart">Quickstart</H2>
<P>
The Data API is standard REST — call it from any language, or use{" "}
<Code>supabase-js</Code> as shown here. Save your key and the API URL as
environment variables:
</P>
<CodeBlock html={env} code={ENV} label=".env" />
<P>Then initialize the client:</P>
<CodeBlock html={init} code={INIT} label="lib/carbon.ts" />
<P>
You can now query any resource with <Code>carbon.from('…')</Code>. Pick
a resource from the sidebar for its endpoints and ready-to-copy samples
— pointed at your configured instance.
</P>
<ContentFooter
next={{ label: "Authentication", url: "/api/data/authentication" }}
/>
</DocPage>
);
}