The Prosaic API is a REST API over HTTPS. It takes and returns JSON, and every path sits under one base URL:
https://app.prosaic.works/api/public/v1Each operation on these pages shows its HTTP route and the prosaic-node method that calls it. The method names are the operation IDs in the OpenAPI document, so code, docs and AI tools all use the same names.
Authentication
Send an API key or an OAuth access token as a bearer token on every request:
curl https://app.prosaic.works/api/public/v1/me \
-H "Authorization: Bearer $PROSAIC_API_KEY"API keys start with prsk_ and act as the user who created them. Use an OAuth app when your product acts for other people's workspaces. Authentication covers both, and how to choose a workspace with the x-workspace-id header when a user belongs to more than one.
With the Node SDK, create one client and reuse it:
import Prosaic from 'prosaic-node';
const prosaic = new Prosaic(process.env.PROSAIC_API_KEY!);Requests
- Dates are calendar dates in
YYYY-MM-DDform, such as2026-04-01. Regional formats such as01-04-2026are rejected with a400. - Amounts are accepted as strings or numbers. Send decimal strings, such as
"1150.00", so nothing is lost to floating-point rounding. - IDs in paths, such as
entityId, come from the list endpoints:GET /entitiesfor entities and their tax rates, andGET /entities/{entityId}/chartsfor account codes.
Responses
Most endpoints wrap their result in data, with a meta.count where a count helps:
{ "data": { "id": "…" } }Paginated lists add a pagination object instead:
{
"data": [],
"pagination": {
"currentPage": 1,
"pageSize": 20,
"totalCount": 0,
"totalPages": 0,
"hasNextPage": false,
"hasPreviousPage": false
}
}Ask for a page with the page (from 1) and pageSize query parameters. The SDK's list methods can page for you; see pagination in the Node SDK. Creating a journal, running a report and uploading a file return the object itself, with no data wrapper.
Errors
Errors use standard HTTP status codes, with a JSON body that says what went wrong:
{ "error": "Access denied to the specified entity" }| Status | Meaning |
|---|---|
400 | The request is invalid: a missing field, a bad date, or a journal that does not balance. |
401 | The API key or access token is missing, expired or revoked. |
403 | The user cannot reach that workspace or entity. |
404 | The record does not exist, or is not visible to this user. |
500 | Something went wrong on Prosaic's side. Retry later, and tell us if it persists. |
The Node SDK turns each status into an error class, such as ValidationError and NotFoundError; see errors in the Node SDK.
For AI tools
Every page of this reference is also published as Markdown: add .md to its URL. /docs/api/llms-full.txt holds the whole reference in one file, and the developer MCP server looks operations up by name, method or path.
Chart reporting assignments
Discover workspace choices with GET /api/public/v1/report-categories, or entity choices with GET /api/public/v1/entities/{entityId}/report-categories. The saved reporting group/category pair is authoritative in activated workspaces. Stored subtype remains compatibility data, not a promise that reports derive from it. Trial-balance groupBy=subtype remains available pending its separate retirement. See Chart of accounts for required write choices, permissions and conflict recovery.
