Order Intake
Quotes, estimates, orders, invoices, customers, products and pricing.
169 operations · complete schema 399 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
getProductTemplate
Fetch a product template by ID. Requires productTemplate:read permission.
listProductTemplates
List product templates with optional filters, sorted by name. Requires productTemplate:list permission.
listProductTemplateVersions
List published versions of a template with pagination. Requires productTemplate:read permission.
getProductTemplateVersion
Fetch a specific published version. Requires productTemplate:read permission.
getCustomer
Fetch a single customer by ID. Requires customer:read permission.
getCustomerBy
Fetch a customer by external ID. Requires customer:read permission.
listCustomers
List customers with pagination, filtering, and sorting. Requires customer:list permission.
listContacts
List contacts with pagination. Requires contact:list permission.
getContact
Fetch a contact by its stable ID. Requires contact:read permission.
getContactBy
Fetch a contact by external ID or email. Requires contact:read permission.
getAddress
Fetch a single address by ID. Requires address:read permission.
getAddressBy
Fetch an address by external ID. Requires address:read permission.
listAddresses
List addresses with pagination. Requires address:list permission.
getBusinessUnit
Fetch a single business unit by ID. Requires businessunit:read permission.
getBusinessUnitBy
Fetch a business unit by external ID or code. Requires businessunit:read permission.
listBusinessUnits
List business units with pagination. Requires businessunit:list permission.
getCostCenter
Fetch a single cost center by ID. Requires costcenter:read permission.
getCostCenterBy
Fetch a cost center by external ID or code. Requires costcenter:read permission.
listCostCenters
List cost centers with pagination. Requires costcenter:list permission.
listCustomerPriceOverrides
List customer price overrides. Requires customerPriceOverride: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.
orderFulfillmentCompletion
Assess current policy across every order line using explicitly attributed quantities
getEntityNote
Read operational notes with current target permissions
getEntityNoteBySource
Read operational notes with current target permissions
entityNotes
Read operational notes with current target permissions
searchEntityNotes
Read operational notes with current target permissions
getOrder
Fetch an order by ID. Requires order:read permission.
getOrderBy
Fetch an order by external ID. Requires order:read permission.
listOrders
List orders with pagination. Requires order:list permission.
getOrderLine
Fetch an order line by ID. Requires order:read permission.
listOrderLines
List order lines with pagination. Requires order:list permission.
getEstimate
Fetch an estimate by ID. Requires estimate:read permission.
getEstimateBy
Fetch an estimate by external ID. Requires estimate:read permission.
listEstimates
List estimates with pagination, filtering, and sorting. Requires estimate:list permission.
getEstimateLine
Fetch an estimate line by ID. Requires estimate:read permission.
listEstimateLines
List estimate lines with pagination, filtering, and sorting. Requires estimate:list permission.
listEstimateCostBreakdowns
List cost breakdowns for an estimate line. Requires estimate:read permission.
getInvoice
Fetch a single invoice by ID. Requires invoice:read permission.
listInvoices
List invoices with pagination, filtering, and sorting. Requires invoice:list permission.
getInvoiceLine
Fetch a single invoice line by ID. Requires invoice:read permission.
listInvoiceLines
List invoice lines with pagination, filtering, and sorting. Requires invoice:list permission.
getPayment
Fetch a single payment by ID. Requires payment:read permission.
listPayments
List payments with pagination. Requires payment:list permission.
getTaxCode
Fetch a single tax code by ID. Requires taxCode:read permission.
listTaxCodes
List tax codes with pagination. Requires taxCode:list permission.
getPriceBracket
Fetch a single price bracket by ID. Requires priceBracket:read permission.
listPriceBrackets
List price brackets with pagination. Requires priceBracket:list permission.
getSupplier
Fetch a single supplier by ID. Requires supplier:read permission.
listSuppliers
List suppliers with pagination, filtering, and sorting. Requires supplier:list permission.
getPurchaseOrder
Fetch a single purchase order by ID. Requires purchaseOrder:read permission.
listPurchaseOrders
List purchase orders with pagination, filtering, and sorting. Requires purchaseOrder:list permission.
getPurchaseOrderLine
Fetch a single purchase order line by ID. Requires purchaseOrder:read permission.
listPurchaseOrderLines
List purchase order lines with pagination, filtering, and sorting. Requires purchaseOrder:list permission.
getProduct
Fetch a single product by ID. Requires product:read permission.
listProducts
List products with pagination, filtering, and sorting. Requires product:list permission.
orderLifecycle
Fetch a complete order lifecycle: order, lines, estimate, invoices, shipments, and jobs. Requires order:read.
customerAccountSummary
Fetch a customer account summary with orders, estimates, invoices and financial totals. Requires customer:read.
upsertProductTemplate
Create or update a product template. Requires productTemplate:write permission.
createProductTemplate
Create a new product template. Requires productTemplate:write permission.
updateProductTemplate
Update a product template. Only provided fields are changed. Requires productTemplate:write permission.
deleteProductTemplate
Delete a product template. Requires productTemplate:delete permission.
publishProductTemplate
Publish a product template version. Requires productTemplate:write permission.
upsertCustomer
Create or update a customer. Requires customer:write permission.
createCustomer
Create a new customer. Requires customer:write permission.
updateCustomer
Update a customer. Only provided fields are changed. Requires customer:write permission.
deleteCustomer
Delete a customer. Requires customer:delete permission.
upsertContact
Create or update a contact. Requires contact:write permission.
createContact
Create a new contact. Requires contact:write permission.
updateContact
Update a contact. Only provided fields are changed. Requires contact:write permission.
deleteContact
Delete a contact. Requires contact:delete permission.
upsertAddress
Create or update an address. Requires address:write permission.
createAddress
Create a new address. Requires address:write permission.
updateAddress
Update an address. Only provided fields are changed. Requires address:write permission.
deleteAddress
Delete an address. Requires address:delete permission.
upsertBusinessUnit
Create or update a business unit. Requires businessunit:write permission.
createBusinessUnit
Create a new business unit. Requires businessunit:write permission.
updateBusinessUnit
Update a business unit. Only provided fields are changed. Requires businessunit:write permission.
deleteBusinessUnit
Delete a business unit. Requires businessunit:delete permission.
upsertCostCenter
Create or update a cost center. Requires costcenter:write permission.
createCostCenter
Create a new cost center. Requires costcenter:write permission.
updateCostCenter
Update a cost center. Only provided fields are changed. Requires costcenter:write permission.
deleteCostCenter
Delete a cost center. Requires costcenter:delete permission.
upsertCustomerPriceOverride
Create or update a customer price override. Requires customerPriceOverride:write permission.
createCustomerPriceOverride
Create a new customer price override. Requires customerPriceOverride:write permission.
updateCustomerPriceOverride
Update a customer price override. Only provided fields are changed. Requires customerPriceOverride:write permission.
deleteCustomerPriceOverride
Delete a customer price override. Requires customerPriceOverride:delete permission.
completeOrderFulfillment
Explicitly complete an order when all its planned quantities satisfy the current milestone; never fabricate delivery or reopen completed work
createEntityNote
Save note changes independently of embedding success
updateEntityNote
Save note changes independently of embedding success
deleteEntityNote
Save note changes independently of embedding success
reindexEntityNotes
Queue bounded recoverable indexing work using the current model
upsertOrder
Create or update an order. Requires order:write permission.
createOrder
Create a new order. Requires order:write permission.
updateOrder
Update an order. Only provided fields are changed. Requires order:write permission.
createOrderGraph
Create a complete order — header, customer, billing/shipping addresses, and lines — in a single transaction. Each nested input reuses the same type as the corresponding individual upsert mutation; nested ids are rejected because this mutation is create-only. The resolver also enforces customer:write / address:write / orderline:write when those nested inputs are provided.
deleteOrder
Delete an order. Requires order:delete permission.
upsertOrderLine
Create or update an order line. Requires order:write permission.
createOrderLine
Create a new order line. Requires order:write permission.
updateOrderLine
Update an order line. Only provided fields are changed. Requires order:write permission.
deleteOrderLine
Delete an order line. Requires order:delete permission.
upsertEstimate
Create or update an estimate. Requires estimate:write permission.
createEstimate
Create a new estimate. Requires estimate:write permission.
updateEstimate
Update an estimate. Only provided fields are changed. Requires estimate:write permission.
deleteEstimate
Delete an estimate. Requires estimate:delete permission.
upsertEstimateLine
Create or update an estimate line. Requires estimate:write permission.
createEstimateLine
Create a new estimate line. Requires estimate:write permission.
updateEstimateLine
Update an estimate line. Only provided fields are changed. Requires estimate:write permission.
deleteEstimateLine
Delete an estimate line. Requires estimate:delete permission.
upsertInvoice
Create or update an invoice. Requires invoice:write permission.
createInvoice
Create a new invoice. Requires invoice:write permission.
updateInvoice
Update an existing invoice. Requires invoice:write permission.
deleteInvoice
Delete an invoice. Requires invoice:delete permission.
upsertInvoiceLine
Create or update an invoice line. Requires invoice:write permission.
createInvoiceLine
Create a new invoice line. Requires invoice:write permission.
updateInvoiceLine
Update an invoice line. Only provided fields are changed. Requires invoice:write permission.
deleteInvoiceLine
Delete an invoice line. Requires invoice:delete permission.
recordPayment
Record a payment against an invoice: writes a payment ledger row and rolls the payment up onto the invoice (`paidAmount`, `paid`/`partiallyPaid`, `paidAt`) and its order (`paymentStatus`), atomically. Requires payment:write permission.
deletePayment
Delete a payment record. Requires payment:delete permission.
upsertTaxCode
Create or update a tax code. Requires taxCode:write permission.
createTaxCode
Create a new tax code. Requires taxCode:write permission.
updateTaxCode
Update a tax code. Only provided fields are changed. Requires taxCode:write permission.
deleteTaxCode
Delete a tax code. Requires taxCode:delete permission.
upsertPriceBracket
Create or update a price bracket. Requires priceBracket:write permission.
createPriceBracket
Create a new price bracket. Requires priceBracket:write permission.
updatePriceBracket
Update a price bracket. Only provided fields are changed. Requires priceBracket:write permission.
deletePriceBracket
Delete a price bracket. Requires priceBracket:delete permission.
upsertSupplier
Create or update a supplier. Requires supplier:write permission.
createSupplier
Create a new supplier. Requires supplier:write permission.
updateSupplier
Update a supplier. Only provided fields are changed. Requires supplier:write permission.
deleteSupplier
Delete a supplier. Requires supplier:delete permission.
upsertPurchaseOrder
Create or update a purchase order. Requires purchaseOrder:write permission.
updatePurchaseOrder
Update a purchase order. Only provided fields are changed. Requires purchaseOrder:write permission.
deletePurchaseOrder
Delete a purchase order. Requires purchaseOrder:delete permission.
upsertPurchaseOrderLine
Create or update a purchase order line. Requires purchaseOrder:write permission.
createPurchaseOrderLine
Create a new purchase order line. Requires purchaseOrder:write permission.
updatePurchaseOrderLine
Update a purchase order line. Only provided fields are changed. Requires purchaseOrder:write permission.
deletePurchaseOrderLine
Delete a purchase order line. Requires purchaseOrder:delete permission.
upsertProduct
Create or update a product. Requires product:write permission.
createProduct
Create a new product. Requires product:write permission.
updateProduct
Update a product. Only provided fields are changed. Requires product:write permission.
deleteProduct
Delete a product. Requires product:delete permission.
convertEstimateToOrder
Convert an accepted estimate into an order with order lines. Requires order:write.
reviseEstimate
Create a new revision of an estimate, copying all lines. Requires estimate:write.
createJobsFromOrder
Create jobs from order lines. Requires job:write.
acceptEstimateAndCreateJobs
Accept an estimate and create order + jobs with components/operations from production blueprints. Requires order:write.
invoiceOrder
Generate an invoice from an order and its lines. Rejects orders that already have an invoice, including concurrent retries. Requires invoice:write.
issueCreditNote
Issue a credit note against an invoice. Requires invoice:write.
generateEstimate
Generate an automated estimate by inferring operations, calculating costs, and creating estimate lines. Requires estimate:write permission.
bulkUpdateOrderStatuses
Update the status of multiple orders at once. Requires order:write.
duplicateEstimateForCustomer
Duplicate an estimate for a different customer, optionally adjusting prices. Requires estimate:write.
instantiateProductTemplate
Instantiate a published product template into a print job. Requires productTemplate:execute permission.
installCanonicalTemplate
Install a canonical product template (shipped with the app) into the calling tenant as a fresh draft. Requires productTemplate:write permission.
dataChangeEvents
Subscribe to real-time data change events. Requires read permission on each requested resource.