ERP Costing
Cost categories, centres, rates, operation cost mappings and recorded costs.
47 operations · complete schema 213 KB
magicQuery
Executes a Magic Query string and returns the predefined query's JSON result. On a bad noun or parameter, returns a structured error whose 'extensions' carry 'code', 'actionable_message', and 'suggestions' for self-correction.
getMagicQuerySchema
Returns the input JSON Schema and output introspection for a Magic Query noun, so consumers (especially LLMs) can learn its contract before calling magicQuery.
listMagicQueries
Lists every available Magic Query noun with a short description and its options — the discovery entry point.
getMagicQueryGraphQL
Resolves a Magic Query string to the real GraphQL operation and variables it runs, so consumers can graduate from the façade to raw GraphQL. Does not execute.
listDataChangeEventTopics
List all valid data change event topics, grouped by resource. Requires authentication.
generateDefaultDataQuery
Generate a default GraphQL data query for an event topic. Returns a query string with all scalar fields for the resource, or null if the topic has no matching query. The query uses $id as the variable for the resource ID.
ping
Health check endpoint
getCostCategory
Fetch a single cost category by ID. Requires costcategory:read permission.
getCostCategoryBy
Fetch a cost category by external ID or code. Requires costcategory:read permission.
listCostCategories
List cost categories with pagination. Requires costcategory:list permission.
getCostRate
Fetch a single cost rate by ID. Requires costrate:read permission.
listCostRates
List cost rates with pagination. Requires costrate:list permission.
getRecordedCost
Fetch a single recorded cost by ID. Requires recordedcost:read permission.
listRecordedCosts
List recorded costs with pagination. Requires recordedcost:list permission.
getOperationCostMapping
Fetch a single operation cost mapping by ID. Requires costcategory:read permission.
listOperationCostMappings
List operation cost mappings. Requires costcategory:list permission.
iacSchema
The infrastructure-only view of this schema, for declarative tooling. Contains only annotated resources and the types they reach.
iacValidate
Validate an infrastructure artifact. Pure and side-effect free; safe to alias many times in one document.
iacGuides
Every authoring guide, for a tool that syncs them to a folder. Intended for `schema pull` to call once and write to disk, not for an agent to call while authoring — a file can be grepped and re-read in part, where a response arrives whole.
helpChapters
List human-facing manual chapters from the running deployment.
helpChapter
Read a chapter of the current published manual edition.
searchHelp
Search human-facing manuals using shared semantic and text retrieval.
schemaAuthoringCatalog
Compiler-owned vocabulary for the standalone XML JSON Schema dialect, including native form annotations.
compileSchemaXML
Compile standalone XML schema syntax into JSON Schema without persisting it; host restrictions apply when embedded.
renderSchemaXML
Render JSON Schema as native XML without dropping unsupported keywords or changing a saved document.
iacSchemaDocument
Fetch the JSON Schema document a SCHEMA-kind validator references, for declarative tooling.
quotingReadinessCheck
Check whether cost configuration is complete for automated quoting. Returns configured/unconfigured operation kinds and warnings.
jobCostingSummary
Get a costing summary for a job including material and operation costs. Requires job:read.
createCostCategory
Create a new cost category, failing if the code is already taken. Requires costcategory:write permission.
updateCostCategory
Update a cost category in place. Only provided fields are changed. Requires costcategory:write permission.
upsertCostCategory
Create or update a cost category. Requires costcategory:write permission.
deleteCostCategory
Delete a cost category. Requires costcategory:delete permission.
upsertCostRate
Create or update a cost rate. Updates create a new version for audit trail. Requires costrate:write permission.
createCostRate
Create a new cost rate (always version 1). Requires costrate:write permission.
deleteCostRate
Delete a cost rate nothing depends on. Refused, never cascaded, while recorded costs were priced with it or a later version replaces it; deleting the newest version makes the one it replaced current again. Requires costrate:delete permission.
updateCostRate
Update a cost rate in place (does not create a new version, unlike upsertCostRate). Only provided fields are changed. Requires costrate:write permission.
upsertRecordedCost
Record an actual cost incurred. Requires recordedcost:write permission.
createRecordedCost
Create a new recorded cost. Requires recordedcost:write permission.
updateRecordedCost
Update a recorded cost. Only provided fields are changed. Requires recordedcost:write permission.
deleteRecordedCost
Delete a recorded cost. Requires recordedcost:delete permission.
upsertOperationCostMapping
Create or update an operation cost mapping. Requires costcategory:write permission.
createOperationCostMapping
Create a new operation cost mapping. Requires costcategory:write permission.
updateOperationCostMapping
Update an operation cost mapping. Only provided fields are changed. Requires costcategory:write permission.
deleteOperationCostMapping
Delete an operation cost mapping. Requires costcategory:delete permission.
exportCostConfiguration
Export the tenant's cost configuration (categories, rates, operation mappings) as a flat CSV string for spreadsheet editing.
importCostConfiguration
Import cost configuration from a CSV string. Upserts cost categories, operation-to-category mappings, and cost rates in a single transaction.
dataChangeEvents
Subscribe to real-time data change events. Requires read permission on each requested resource.