describePricingEquationApi
Start here before reading, writing or changing a pricing equation. Returns the TypeScript contract the equation runs against (specification, revision, requisition, customer, workflow, done(), variable(), round, useDimension, createBands; for scope ORDER: parts, subtotal, customer, addLineItem), narrowed to the given scope + ownerId: its technology, material names and material variable names, lead-time names, and which modules the manufacturer has. Explains the loop: save(entity=typescriptEquation) to validate and store a version, generateQuote(equationId) to test it, then — only on the manufacturer's explicit request — publishEquation to make it live. Pass includeSource=true to also get the live equation's source, or equationId= to get the source of one specific version (a draft, for example) with its live/not-live state.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| scope | Yes | Which equation to describe the equation API for: PROCESS (a manufacturing process), POST_PROCESSING (a finish), or ORDER (the manufacturer's single order-level equation that adds whole-order line items). Same values as typescriptEquation.scope. | |
| ownerId | No | The owner: processPrices.id (UUID) for scope PROCESS, postProcessing.id (integer, as a string) for scope POST_PROCESSING. Omit for scope ORDER. Not an equationId. | |
| equationId | No | A typescriptEquation id (UUID) of the same scope + ownerId: append THAT version's source instead of the live one, live or not. Use it to read back a draft before you test, revise or publish it. | |
| includeSource | No | true to append the LIVE equation's name, variables and full source. Default false. |