Reporting

Costing

Explore the data types and operations available in Costing.

48 operations

compileSchemaXMLQuery

Compile standalone XML schema syntax into JSON Schema without persisting it; host restrictions apply when embedded.

createCostCategoryMutation

Create a new cost category, failing if the code is already taken. Requires costcategory:write permission.

createCostRateMutation

Create a new cost rate (always version 1). Requires costrate:write permission.

createOperationCostMappingMutation

Create a new operation cost mapping. Requires costcategory:write permission.

createRecordedCostMutation

Create a new recorded cost. Requires recordedcost:write permission.

dataChangeEventsSubscription

Subscribe to real-time data change events. Requires read permission on each requested resource. Task topics are the exception: a signed-in user without task:read receives the events of their own tasks only (assigned to them, claimed by them, unclaimed on their teams).

deleteCostCategoryMutation

Delete a cost category. Requires costcategory:delete permission.

deleteCostRateMutation

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.

deleteOperationCostMappingMutation

Delete an operation cost mapping. Requires costcategory:delete permission.

deleteRecordedCostMutation

Delete a recorded cost. Requires recordedcost:delete permission.

exportCostConfigurationMutation

Export the tenant's cost configuration (categories, rates, operation mappings) as a flat CSV string for spreadsheet editing.

generateDefaultDataQueryQuery

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.

getCostCategoryQuery

Fetch a single cost category by ID. Requires costcategory:read permission.

getCostCategoryByQuery

Fetch a cost category by external ID or code. Requires costcategory:read permission.

getCostRateQuery

Fetch a single cost rate by ID. Requires costrate:read permission.

getMagicQueryGraphQLQuery

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.

getMagicQuerySchemaQuery

Returns the input JSON Schema and output introspection for a Magic Query noun, so consumers (especially LLMs) can learn its contract before calling magicQuery.

getOperationCostMappingQuery

Fetch a single operation cost mapping by ID. Requires costcategory:read permission.

getRecordedCostQuery

Fetch a single recorded cost by ID. Requires recordedcost:read permission.

helpChapterQuery

Read a chapter of the current published manual edition.

helpChaptersQuery

List human-facing manual chapters from the running deployment.

iacGuidesQuery

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.

iacSchemaQuery

The infrastructure-only view of this schema, for declarative tooling. Contains only annotated resources and the types they reach.

iacSchemaDocumentQuery

Fetch the JSON Schema document a SCHEMA-kind validator references, for declarative tooling.

iacValidateQuery

Validate an infrastructure artifact. Pure and side-effect free; safe to alias many times in one document.

importCostConfigurationMutation

Import cost configuration from a CSV string. Upserts cost categories, operation-to-category mappings, and cost rates in a single transaction.

jobCostingSummaryQuery

Get a costing summary for a job including material and operation costs. Requires job:read.

listCostCategoriesQuery

List cost categories with pagination. Requires costcategory:list permission.

listCostRatesQuery

List cost rates with pagination. Requires costrate:list permission.

listDataChangeEventTopicsQuery

List all valid data change event topics, grouped by resource. Requires authentication.

listMagicQueriesQuery

Lists every available Magic Query noun with a short description and its options — the discovery entry point.

listOperationCostMappingsQuery

List operation cost mappings. Requires costcategory:list permission.

listRecordedCostsQuery

List recorded costs with pagination. Requires recordedcost:list permission.

magicQueryQuery

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.

pingQuery

Health check endpoint

quotingReadinessCheckQuery

Check whether cost configuration is complete for automated quoting. Returns configured/unconfigured operation kinds and warnings.

renderSchemaXMLQuery

Render JSON Schema as native XML without dropping unsupported keywords or changing a saved document.

schemaAuthoringCatalogQuery

Compiler-owned vocabulary for the standalone XML JSON Schema dialect, including native form annotations.

searchHelpQuery

Search human-facing manuals using shared semantic and text retrieval.

topicExamplesQuery

Fetch examples by stable name, in requested order. Unknown names are errors; an empty list returns no examples.

updateCostCategoryMutation

Update a cost category in place. Only provided fields are changed. Requires costcategory:write permission.

updateCostRateMutation

Update a cost rate in place (does not create a new version, unlike upsertCostRate). Only provided fields are changed. Requires costrate:write permission.

updateOperationCostMappingMutation

Update an operation cost mapping. Only provided fields are changed. Requires costcategory:write permission.

updateRecordedCostMutation

Update a recorded cost. Only provided fields are changed. Requires recordedcost:write permission.

upsertCostCategoryMutation

Create or update a cost category. Requires costcategory:write permission.

upsertCostRateMutation

Create or update a cost rate. Updates create a new version for audit trail. Requires costrate:write permission.

upsertOperationCostMappingMutation

Create or update an operation cost mapping. Requires costcategory:write permission.

upsertRecordedCostMutation

Record an actual cost incurred. Requires recordedcost:write permission.