Reporting
Costing
Explore the data types and operations available in Costing.
48 operations
Compile standalone XML schema syntax into JSON Schema without persisting it; host restrictions apply when embedded.
createCostCategoryMutationCreate a new cost category, failing if the code is already taken. Requires costcategory:write permission.
createCostRateMutationCreate a new cost rate (always version 1). Requires costrate:write permission.
createOperationCostMappingMutationCreate a new operation cost mapping. Requires costcategory:write permission.
createRecordedCostMutationCreate a new recorded cost. Requires recordedcost:write permission.
dataChangeEventsSubscriptionSubscribe 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).
deleteCostCategoryMutationDelete a cost category. Requires costcategory:delete permission.
deleteCostRateMutationDelete 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.
deleteOperationCostMappingMutationDelete an operation cost mapping. Requires costcategory:delete permission.
deleteRecordedCostMutationDelete a recorded cost. Requires recordedcost:delete permission.
exportCostConfigurationMutationExport the tenant's cost configuration (categories, rates, operation mappings) as a flat CSV string for spreadsheet editing.
generateDefaultDataQueryQueryGenerate 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.
getCostCategoryQueryFetch a single cost category by ID. Requires costcategory:read permission.
getCostCategoryByQueryFetch a cost category by external ID or code. Requires costcategory:read permission.
getCostRateQueryFetch a single cost rate by ID. Requires costrate:read permission.
getMagicQueryGraphQLQueryResolves 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.
getMagicQuerySchemaQueryReturns the input JSON Schema and output introspection for a Magic Query noun, so consumers (especially LLMs) can learn its contract before calling magicQuery.
getOperationCostMappingQueryFetch a single operation cost mapping by ID. Requires costcategory:read permission.
getRecordedCostQueryFetch a single recorded cost by ID. Requires recordedcost:read permission.
helpChapterQueryRead a chapter of the current published manual edition.
helpChaptersQueryList human-facing manual chapters from the running deployment.
iacGuidesQueryEvery 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.
iacSchemaQueryThe infrastructure-only view of this schema, for declarative tooling. Contains only annotated resources and the types they reach.
iacSchemaDocumentQueryFetch the JSON Schema document a SCHEMA-kind validator references, for declarative tooling.
iacValidateQueryValidate an infrastructure artifact. Pure and side-effect free; safe to alias many times in one document.
importCostConfigurationMutationImport cost configuration from a CSV string. Upserts cost categories, operation-to-category mappings, and cost rates in a single transaction.
jobCostingSummaryQueryGet a costing summary for a job including material and operation costs. Requires job:read.
listCostCategoriesQueryList cost categories with pagination. Requires costcategory:list permission.
listCostRatesQueryList cost rates with pagination. Requires costrate:list permission.
listDataChangeEventTopicsQueryList all valid data change event topics, grouped by resource. Requires authentication.
listMagicQueriesQueryLists every available Magic Query noun with a short description and its options — the discovery entry point.
listOperationCostMappingsQueryList operation cost mappings. Requires costcategory:list permission.
listRecordedCostsQueryList recorded costs with pagination. Requires recordedcost:list permission.
magicQueryQueryExecutes 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.
pingQueryHealth check endpoint
quotingReadinessCheckQueryCheck whether cost configuration is complete for automated quoting. Returns configured/unconfigured operation kinds and warnings.
renderSchemaXMLQueryRender JSON Schema as native XML without dropping unsupported keywords or changing a saved document.
schemaAuthoringCatalogQueryCompiler-owned vocabulary for the standalone XML JSON Schema dialect, including native form annotations.
searchHelpQuerySearch human-facing manuals using shared semantic and text retrieval.
topicExamplesQueryFetch examples by stable name, in requested order. Unknown names are errors; an empty list returns no examples.
updateCostCategoryMutationUpdate a cost category in place. Only provided fields are changed. Requires costcategory:write permission.
updateCostRateMutationUpdate a cost rate in place (does not create a new version, unlike upsertCostRate). Only provided fields are changed. Requires costrate:write permission.
updateOperationCostMappingMutationUpdate an operation cost mapping. Only provided fields are changed. Requires costcategory:write permission.
updateRecordedCostMutationUpdate a recorded cost. Only provided fields are changed. Requires recordedcost:write permission.
upsertCostCategoryMutationCreate or update a cost category. Requires costcategory:write permission.
upsertCostRateMutationCreate or update a cost rate. Updates create a new version for audit trail. Requires costrate:write permission.
upsertOperationCostMappingMutationCreate or update an operation cost mapping. Requires costcategory:write permission.
upsertRecordedCostMutationRecord an actual cost incurred. Requires recordedcost:write permission.