Build and connect
All HelloBooks APIs, in one place.
Find an endpoint, inspect its parameters, and open its documentation. Browse public data here or connect a company through the authenticated accounting API.
31 public endpoints43 MCP tools491 accounting operations
565 matching APIs
Authenticated accountingList assetSurvey records
GET /public/v1/orgs/{orgId}/entities/{entityId}/assetSurvey
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `assetSurvey` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/assetSurvey.grpc` → `getAssetSurveys`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("fixedassets:read")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingCreate assetSurvey record(s)
POST /public/v1/orgs/{orgId}/entities/{entityId}/assetSurvey
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `assetSurvey` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/assetSurvey.grpc` → `createAssetSurvey`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("fixedassets:write")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingUpdate assetSurvey record(s)
PUT /public/v1/orgs/{orgId}/entities/{entityId}/assetSurvey
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `assetSurvey` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/assetSurvey.grpc` → `updateAssetSurvey`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("fixedassets:write")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingFetch one assetSurvey record by id
GET /public/v1/orgs/{orgId}/entities/{entityId}/assetSurvey/{id}
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `assetSurvey` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/assetSurvey.grpc` → `getAssetSurveyById`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("fixedassets:read")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingList assetTimingDifference records
GET /public/v1/orgs/{orgId}/entities/{entityId}/assetTimingDifference
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `assetTimingDifference` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/assetTimingDifference.grpc` → `getAssetTimingDifferences`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("fixedassets:read")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingCreate assetTimingDifference record(s)
POST /public/v1/orgs/{orgId}/entities/{entityId}/assetTimingDifference
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `assetTimingDifference` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/assetTimingDifference.grpc` → `createAssetTimingDifference`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("fixedassets:write")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingUpdate assetTimingDifference record(s)
PUT /public/v1/orgs/{orgId}/entities/{entityId}/assetTimingDifference
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `assetTimingDifference` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/assetTimingDifference.grpc` → `updateAssetTimingDifference`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("fixedassets:write")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingFetch one assetTimingDifference record by id
GET /public/v1/orgs/{orgId}/entities/{entityId}/assetTimingDifference/{id}
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `assetTimingDifference` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/assetTimingDifference.grpc` → `getAssetTimingDifferenceById`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("fixedassets:read")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingList assetTransfer records
GET /public/v1/orgs/{orgId}/entities/{entityId}/assetTransfer
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `assetTransfer` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/assetTransfer.grpc` → `getAssetTransfers`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("fixedassets:read")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingCreate assetTransfer record(s)
POST /public/v1/orgs/{orgId}/entities/{entityId}/assetTransfer
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `assetTransfer` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/assetTransfer.grpc` → `createAssetTransfer`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("fixedassets:write")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingDelete assetTransfer record(s)
DELETE /public/v1/orgs/{orgId}/entities/{entityId}/assetTransfer
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `assetTransfer` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/assetTransfer.grpc` → `deleteAssetTransfers`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("fixedassets:write")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingRestore archived assetTransfer record(s)
PUT /public/v1/orgs/{orgId}/entities/{entityId}/assetTransfer/restore
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `assetTransfer` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/assetTransfer.grpc` → `restoreAssetTransfers`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("fixedassets:write")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingList balanceSheet records
GET /public/v1/orgs/{orgId}/entities/{entityId}/balanceSheet
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `balanceSheet` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/reports/balanceSheet.grpc` → `getBalanceSheets`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("reports:read")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingList bill records
GET /public/v1/orgs/{orgId}/entities/{entityId}/bill
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `bill` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/bill.grpc` → `getBills`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("purchases:read")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingCreate bill record(s)
POST /public/v1/orgs/{orgId}/entities/{entityId}/bill
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `bill` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/bill.grpc` → `createBills`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("purchases:write")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingUpdate bill record(s)
PUT /public/v1/orgs/{orgId}/entities/{entityId}/bill
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `bill` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/bill.grpc` → `updateBills`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("purchases:write")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingDelete bill record(s)
DELETE /public/v1/orgs/{orgId}/entities/{entityId}/bill
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `bill` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/bill.grpc` → `deleteBills`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("purchases:write")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingRestore archived bill record(s)
PUT /public/v1/orgs/{orgId}/entities/{entityId}/bill/restore
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `bill` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/bill.grpc` → `restoreBills`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("purchases:write")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingFetch one bill record by id
GET /public/v1/orgs/{orgId}/entities/{entityId}/bill/{id}
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `bill` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/bill.grpc` → `getBillById`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("purchases:read")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingList billAddress records
GET /public/v1/orgs/{orgId}/entities/{entityId}/billAddress
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `billAddress` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/billAddress.grpc` → `getBillAddresses`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("purchases:read")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingCreate billAddress record(s)
POST /public/v1/orgs/{orgId}/entities/{entityId}/billAddress
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `billAddress` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/billAddress.grpc` → `createBillAddresses`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("purchases:write")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingUpdate billAddress record(s)
PUT /public/v1/orgs/{orgId}/entities/{entityId}/billAddress
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `billAddress` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/billAddress.grpc` → `updateBillAddresses`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("purchases:write")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingDelete billAddress record(s)
DELETE /public/v1/orgs/{orgId}/entities/{entityId}/billAddress
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `billAddress` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/billAddress.grpc` → `deleteBillAddresses`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("purchases:write")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingRestore archived billAddress record(s)
PUT /public/v1/orgs/{orgId}/entities/{entityId}/billAddress/restore
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `billAddress` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/billAddress.grpc` → `restoreBillAddresses`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("purchases:write")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingFetch one billAddress record by id
GET /public/v1/orgs/{orgId}/entities/{entityId}/billAddress/{id}
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `billAddress` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/billAddress.grpc` → `getBillAddressById`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("purchases:read")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingList billLine records
GET /public/v1/orgs/{orgId}/entities/{entityId}/billLine
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `billLine` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/billLine.grpc` → `getBillLines`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("purchases:read")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingCreate billLine record(s)
POST /public/v1/orgs/{orgId}/entities/{entityId}/billLine
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `billLine` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/billLine.grpc` → `createBillLines`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("purchases:write")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingUpdate billLine record(s)
PUT /public/v1/orgs/{orgId}/entities/{entityId}/billLine
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `billLine` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/billLine.grpc` → `updateBillLines`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("purchases:write")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingDelete billLine record(s)
DELETE /public/v1/orgs/{orgId}/entities/{entityId}/billLine
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `billLine` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/billLine.grpc` → `deleteBillLines`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("purchases:write")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingFetch one billLine record by id
GET /public/v1/orgs/{orgId}/entities/{entityId}/billLine/{id}
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `billLine` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/billLine.grpc` → `getBillLineById`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("purchases:read")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingPropose a bookkeeping entry as a draft
POST /public/v1/orgs/{orgId}/entities/{entityId}/books/drafts
Step 1 of the draft → confirm → commit flow. Drafts are free: the AI-credit metering that charges every other route excludes this flow, because the commit core meters committed entries instead. Nothing reaches the ledger here.
DECLARED FIELD-CONTRACT GAP: this route is listed in `UNCONTRACTED_ROUTE_PREFIXES` in `middlewares/publicApiSerialize.middleware.js`. The response field allowlist does not apply to it; only the deny-key floor does. It is named here rather than omitted.
COARSE SCOPE, ON PURPOSE — not an oversight and not a gap. This route belongs to the AI-MCP-Hellobooks connector surface, and that server enforces a fixed four-string scope model on tool dispatch (`book:read`, `book:write`, `owner:close`, `audit:export`) and ignores every other string. Requiring a granular domain scope here would gate the flow on a string the connector can never be granted. `book:read` / `book:write` remain first-class grantable bundle scopes, so nothing is lost. The same reasoning keeps dynamic client registration (`POST /oauth/register`) on the two bundles.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingRead a bookkeeping draft
GET /public/v1/orgs/{orgId}/entities/{entityId}/books/drafts/{draftId}
Step 1a. Returns the draft and its status.
DECLARED FIELD-CONTRACT GAP: this route is listed in `UNCONTRACTED_ROUTE_PREFIXES` in `middlewares/publicApiSerialize.middleware.js`. The response field allowlist does not apply to it; only the deny-key floor does. It is named here rather than omitted.
COARSE SCOPE, ON PURPOSE — not an oversight and not a gap. This route belongs to the AI-MCP-Hellobooks connector surface, and that server enforces a fixed four-string scope model on tool dispatch (`book:read`, `book:write`, `owner:close`, `audit:export`) and ignores every other string. Requiring a granular domain scope here would gate the flow on a string the connector can never be granted. `book:read` / `book:write` remain first-class grantable bundle scopes, so nothing is lost. The same reasoning keeps dynamic client registration (`POST /oauth/register`) on the two bundles.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingCommit a confirmed draft to the ledger
POST /public/v1/orgs/{orgId}/entities/{entityId}/books/drafts/{draftId}/commit
Step 3, and the only route on this gateway that posts to the ledger through the metered commit core.
DECLARED FIELD-CONTRACT GAP: this route is listed in `UNCONTRACTED_ROUTE_PREFIXES` in `middlewares/publicApiSerialize.middleware.js`. The response field allowlist does not apply to it; only the deny-key floor does. It is named here rather than omitted.
COARSE SCOPE, ON PURPOSE — not an oversight and not a gap. This route belongs to the AI-MCP-Hellobooks connector surface, and that server enforces a fixed four-string scope model on tool dispatch (`book:read`, `book:write`, `owner:close`, `audit:export`) and ignores every other string. Requiring a granular domain scope here would gate the flow on a string the connector can never be granted. `book:read` / `book:write` remain first-class grantable bundle scopes, so nothing is lost. The same reasoning keeps dynamic client registration (`POST /oauth/register`) on the two bundles.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingConfirm a draft for commit
POST /public/v1/orgs/{orgId}/entities/{entityId}/books/drafts/{draftId}/confirm
Step 2. Requires `book:write`. Approval by a human in HelloBooks is the design intent of this flow; a connector token cannot approve its own draft through the first-party approval path.
DECLARED FIELD-CONTRACT GAP: this route is listed in `UNCONTRACTED_ROUTE_PREFIXES` in `middlewares/publicApiSerialize.middleware.js`. The response field allowlist does not apply to it; only the deny-key floor does. It is named here rather than omitted.
COARSE SCOPE, ON PURPOSE — not an oversight and not a gap. This route belongs to the AI-MCP-Hellobooks connector surface, and that server enforces a fixed four-string scope model on tool dispatch (`book:read`, `book:write`, `owner:close`, `audit:export`) and ignores every other string. Requiring a granular domain scope here would gate the flow on a string the connector can never be granted. `book:read` / `book:write` remain first-class grantable bundle scopes, so nothing is lost. The same reasoning keeps dynamic client registration (`POST /oauth/register`) on the two bundles.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingList budget records
GET /public/v1/orgs/{orgId}/entities/{entityId}/budget
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `budget` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/budget.grpc` → `getBudgets`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("accounting:read")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingCreate budget record(s)
POST /public/v1/orgs/{orgId}/entities/{entityId}/budget
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `budget` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/budget.grpc` → `createBudgets`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("accounting:write")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingUpdate budget record(s)
PUT /public/v1/orgs/{orgId}/entities/{entityId}/budget
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `budget` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/budget.grpc` → `updateBudgets`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("accounting:write")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingDelete budget record(s)
DELETE /public/v1/orgs/{orgId}/entities/{entityId}/budget
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `budget` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/budget.grpc` → `deleteBudgets`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("accounting:write")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingRestore archived budget record(s)
PUT /public/v1/orgs/{orgId}/entities/{entityId}/budget/restore
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `budget` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/budget.grpc` → `restoreBudgets`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("accounting:write")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingList businessOwner records
GET /public/v1/orgs/{orgId}/entities/{entityId}/businessOwner
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `businessOwner` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/businessOwner.grpc` → `getBusinessOwners`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("contacts:read")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingCreate businessOwner record(s)
POST /public/v1/orgs/{orgId}/entities/{entityId}/businessOwner
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `businessOwner` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/businessOwner.grpc` → `createBusinessOwners`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("contacts:write")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingUpdate businessOwner record(s)
PUT /public/v1/orgs/{orgId}/entities/{entityId}/businessOwner
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `businessOwner` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/businessOwner.grpc` → `updateBusinessOwners`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("contacts:write")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingDelete businessOwner record(s)
DELETE /public/v1/orgs/{orgId}/entities/{entityId}/businessOwner
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `businessOwner` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/businessOwner.grpc` → `deleteBusinessOwners`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("contacts:write")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingRestore archived businessOwner record(s)
PUT /public/v1/orgs/{orgId}/entities/{entityId}/businessOwner/restore
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `businessOwner` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/businessOwner.grpc` → `restoreBusinessOwners`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("contacts:write")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingFetch one businessOwner record by id
GET /public/v1/orgs/{orgId}/entities/{entityId}/businessOwner/{id}
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `businessOwner` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/businessOwner.grpc` → `getBusinessOwnerById`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("contacts:read")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingList cashFlow records
GET /public/v1/orgs/{orgId}/entities/{entityId}/cashFlow
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `cashFlow` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/reports/cashFlow.grpc` → `getCashFlow`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("reports:read")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingList cashbook records
GET /public/v1/orgs/{orgId}/entities/{entityId}/cashbook
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `cashbook` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/cashbook.grpc` → `getCashbooks`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("banking:read")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingCreate cashbook record(s)
POST /public/v1/orgs/{orgId}/entities/{entityId}/cashbook
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `cashbook` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/cashbook.grpc` → `createCashbooks`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("banking:write")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingUpdate cashbook record(s)
PUT /public/v1/orgs/{orgId}/entities/{entityId}/cashbook
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `cashbook` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/cashbook.grpc` → `updateCashbooks`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("banking:write")`.
OAuth 2.0; company authorization and operation scopes required
Authenticated accountingDelete cashbook record(s)
DELETE /public/v1/orgs/{orgId}/entities/{entityId}/cashbook
Mounted by the generic resource factory in `routes/publicApi.routes.js` from the registry row `cashbook` in `routes/publicApi.resources.js`. The request is delegated to the SAME internal controller a signed-in user hits (`controllers/GRPC/Accounting/cashbook.grpc` → `deleteCashbooks`), so it inherits that controller's validation, server-side tax computation and audit trail. Guards applied, in order: bearer token (`marketplace_app` audience) → plan API-access entitlement → rate limit → AI-credit metering → permission context of the installing user → tenant path match → `requireScope("banking:write")`.
OAuth 2.0; company authorization and operation scopes required