# Order Intake

Quotes, estimates, orders, invoices, customers, products and pricing.

## Operations

```graphql
# Order Intake (order-intake)
# Quotes, estimates, orders, invoices, customers, products and pricing.
# Use convertEstimateToOrder and createJobsFromOrder to move work into production.
# Query
compileSchemaXML: String!  # Compile standalone XML schema syntax into JSON Schema without persisting it; host restrictions apply when embedded
customerAccountSummary: CustomerAccountSummaryPayload!  # Fetch a customer account summary with orders, estimates, invoices and financial totals
entityNotes: EntityNotePage!  # Read operational notes with current target permissions
generateDefaultDataQuery: String  # Generate a default GraphQL data query for an event topic
getAddress: AddressState  # Fetch a single address by ID
getAddressBy: AddressState  # Fetch an address by external ID
getBusinessUnit: BusinessUnitState  # Fetch a single business unit by ID
getBusinessUnitBy: BusinessUnitState  # Fetch a business unit by external ID or code
getContact: ContactState  # Fetch a contact by its stable ID
getContactBy: ContactState  # Fetch a contact by external ID or email
getCostCenter: CostCenterState  # Fetch a single cost center by ID
getCostCenterBy: CostCenterState  # Fetch a cost center by external ID or code
getCustomer: CustomerState  # Fetch a single customer by ID
getCustomerBy: CustomerState  # Fetch a customer by external ID
getEntityNote: EntityNote  # Read operational notes with current target permissions
getEntityNoteBySource: EntityNote  # Read operational notes with current target permissions
getEstimate: EstimateState  # Fetch an estimate by ID
getEstimateBy: EstimateState  # Fetch an estimate by external ID
getEstimateLine: EstimateLineState  # Fetch an estimate line by ID
getInvoice: InvoiceState  # Fetch a single invoice by ID
getInvoiceLine: InvoiceLineState  # Fetch a single invoice line by ID
getMagicQueryGraphQL: MagicQueryOperation!  # 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
getMagicQuerySchema: MagicQuerySchema!  # Returns the input JSON Schema and output introspection for a Magic Query noun, so consumers (especially LLMs) can learn its contract before calling magicQuery
getOrder: OrderState  # Fetch an order by ID
getOrderBy: OrderState  # Fetch an order by external ID
getOrderLine: OrderLineState  # Fetch an order line by ID
getPayment: PaymentState  # Fetch a single payment by ID
getPriceBracket: PriceBracketState  # Fetch a single price bracket by ID
getProduct: ProductState  # Fetch a single product by ID
getProductTemplate: ProductTemplateState  # Fetch a product template by ID
getProductTemplateVersion: ProductTemplateVersionState  # Fetch a specific published version
getPurchaseOrder: PurchaseOrderState  # Fetch a single purchase order by ID
getPurchaseOrderLine: PurchaseOrderLineState  # Fetch a single purchase order line by ID
getSupplier: SupplierState  # Fetch a single supplier by ID
getTaxCode: TaxCodeState  # Fetch a single tax code by ID
helpChapter: HelpChapter  # Read a chapter of the current published manual edition
helpChapters: [HelpChapterInfo!]!  # List human-facing manual chapters from the running deployment
iacGuides: [IaCGuide!]!  # Every authoring guide, for a tool that syncs them to a folder
iacSchema: IaCSchemaDocument!  # The infrastructure-only view of this schema, for declarative tooling
iacSchemaDocument: IaCSchemaDocumentPayload!  # Fetch the JSON Schema document a SCHEMA-kind validator references, for declarative tooling
iacValidate: IaCValidationResult!  # Validate an infrastructure artifact
listAddresses: AddressConnection!  # List addresses with pagination
listBusinessUnits: BusinessUnitConnection!  # List business units with pagination
listContacts: ContactConnection!  # List contacts with pagination
listCostCenters: CostCenterConnection!  # List cost centers with pagination
listCustomerPriceOverrides: CustomerPriceOverrideConnection!  # List customer price overrides
listCustomers: CustomerConnection!  # List customers with pagination, filtering, and sorting
listDataChangeEventTopics: [DataChangeEventGroup!]!  # List all valid data change event topics, grouped by resource
listEstimateCostBreakdowns: EstimateCostBreakdownConnection!  # List cost breakdowns for an estimate line
listEstimateLines: EstimateLineConnection!  # List estimate lines with pagination, filtering, and sorting
listEstimates: EstimateConnection!  # List estimates with pagination, filtering, and sorting
listInvoiceLines: InvoiceLineConnection!  # List invoice lines with pagination, filtering, and sorting
listInvoices: InvoiceConnection!  # List invoices with pagination, filtering, and sorting
listMagicQueries: [MagicQueryInfo!]!  # Lists every available Magic Query noun with a short description and its options — the discovery entry point
listOrderLines: OrderLineConnection!  # List order lines with pagination
listOrders: OrderConnection!  # List orders with pagination
listPayments: PaymentConnection!  # List payments with pagination
listPriceBrackets: PriceBracketConnection!  # List price brackets with pagination
listProductTemplateVersions: ProductTemplateVersionConnection!  # List published versions of a template with pagination
listProductTemplates: ProductTemplateConnection!  # List product templates with optional filters, sorted by name
listProducts: ProductConnection!  # List products with pagination, filtering, and sorting
listPurchaseOrderLines: PurchaseOrderLineConnection!  # List purchase order lines with pagination, filtering, and sorting
listPurchaseOrders: PurchaseOrderConnection!  # List purchase orders with pagination, filtering, and sorting
listSuppliers: SupplierConnection!  # List suppliers with pagination, filtering, and sorting
listTaxCodes: TaxCodeConnection!  # List tax codes with pagination
magicQuery: JSON!  # Executes a Magic Query string and returns the predefined query's JSON result
orderFulfillmentCompletion: OrderFulfillmentCompletion!  # Assess current policy across every order line using explicitly attributed quantities
orderLifecycle: OrderLifecyclePayload!  # Fetch a complete order lifecycle: order, lines, estimate, invoices, shipments, and jobs
ping: String!  # Health check endpoint
renderSchemaXML: String!  # Render JSON Schema as native XML without dropping unsupported keywords or changing a saved document
schemaAuthoringCatalog: JSON!  # Compiler-owned vocabulary for the standalone XML JSON Schema dialect, including native form annotations
searchEntityNotes: EntityNoteSearchPage!  # Read operational notes with current target permissions
searchHelp: HelpSearchResult!  # Search human-facing manuals using shared semantic and text retrieval
# Mutation
acceptEstimateAndCreateJobs: AcceptEstimatePayload!  # Accept an estimate and create order + jobs with components/operations from production blueprints
bulkUpdateOrderStatuses: BulkUpdateOrderStatusesPayload!  # Update the status of multiple orders at once
completeOrderFulfillment: UpsertOrderPayload!  # Explicitly complete an order when all its planned quantities satisfy the current milestone; never fabricate delivery or reopen completed work
convertEstimateToOrder: ConvertEstimateToOrderPayload!  # Convert an accepted estimate into an order with order lines
createAddress: UpsertAddressPayload!  # Create a new address
createBusinessUnit: UpsertBusinessUnitPayload!  # Create a new business unit
createContact: UpsertContactPayload!  # Create a new contact
createCostCenter: UpsertCostCenterPayload!  # Create a new cost center
createCustomer: UpsertCustomerPayload!  # Create a new customer
createCustomerPriceOverride: UpsertCustomerPriceOverridePayload!  # Create a new customer price override
createEntityNote: EntityNotePayload!  # Save note changes independently of embedding success
createEstimate: UpsertEstimatePayload!  # Create a new estimate
createEstimateLine: UpsertEstimateLinePayload!  # Create a new estimate line
createInvoice: UpsertInvoicePayload!  # Create a new invoice
createInvoiceLine: UpsertInvoiceLinePayload!  # Create a new invoice line
createJobsFromOrder: CreateJobsFromOrderPayload!  # Create jobs from order lines
createOrder: UpsertOrderPayload!  # Create a new order
createOrderGraph: CreateOrderGraphPayload!  # Create a complete order — header, customer, billing/shipping addresses, and lines — in a single transaction
createOrderLine: UpsertOrderLinePayload!  # Create a new order line
createPriceBracket: UpsertPriceBracketPayload!  # Create a new price bracket
createProduct: UpsertProductPayload!  # Create a new product
createProductTemplate: UpsertProductTemplatePayload!  # Create a new product template
createPurchaseOrderLine: UpsertPurchaseOrderLinePayload!  # Create a new purchase order line
createSupplier: UpsertSupplierPayload!  # Create a new supplier
createTaxCode: UpsertTaxCodePayload!  # Create a new tax code
deleteAddress: DeleteAddressPayload!  # Delete an address
deleteBusinessUnit: DeletePayload!  # Delete a business unit
deleteContact: DeleteContactPayload!  # Delete a contact
deleteCostCenter: DeletePayload!  # Delete a cost center
deleteCustomer: DeletePayload!  # Delete a customer
deleteCustomerPriceOverride: DeletePayload!  # Delete a customer price override
deleteEntityNote: DeletePayload!  # Save note changes independently of embedding success
deleteEstimate: DeletePayload!  # Delete an estimate
deleteEstimateLine: DeletePayload!  # Delete an estimate line
deleteInvoice: DeletePayload!  # Delete an invoice
deleteInvoiceLine: DeletePayload!  # Delete an invoice line
deleteOrder: DeletePayload!  # Delete an order
deleteOrderLine: DeletePayload!  # Delete an order line
deletePayment: DeletePayload!  # Delete a payment record
deletePriceBracket: DeletePayload!  # Delete a price bracket
deleteProduct: DeletePayload!  # Delete a product
deleteProductTemplate: DeleteProductTemplatePayload!  # Delete a product template
deletePurchaseOrder: DeletePayload!  # Delete a purchase order
deletePurchaseOrderLine: DeletePayload!  # Delete a purchase order line
deleteSupplier: DeletePayload!  # Delete a supplier
deleteTaxCode: DeletePayload!  # Delete a tax code
duplicateEstimateForCustomer: DuplicateEstimateForCustomerPayload!  # Duplicate an estimate for a different customer, optionally adjusting prices
generateEstimate: GenerateEstimatePayload!  # Generate an automated estimate by inferring operations, calculating costs, and creating estimate lines
installCanonicalTemplate: UpsertProductTemplatePayload!  # Install a canonical product template (shipped with the app) into the calling tenant as a fresh draft
instantiateProductTemplate: InstantiateProductTemplatePayload!  # Instantiate a published product template into a print job
invoiceOrder: InvoiceOrderPayload!  # Generate an invoice from an order and its lines
issueCreditNote: IssueCreditNotePayload!  # Issue a credit note against an invoice
publishProductTemplate: PublishProductTemplatePayload!  # Publish a product template version
recordPayment: OTCRecordPaymentPayload!  # 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
reindexEntityNotes: EntityNoteReindexResult!  # Queue bounded recoverable indexing work using the current model
reviseEstimate: ReviseEstimatePayload!  # Create a new revision of an estimate, copying all lines
updateAddress: UpsertAddressPayload!  # Update an address
updateBusinessUnit: UpsertBusinessUnitPayload!  # Update a business unit
updateContact: UpsertContactPayload!  # Update a contact
updateCostCenter: UpsertCostCenterPayload!  # Update a cost center
updateCustomer: UpsertCustomerPayload!  # Update a customer
updateCustomerPriceOverride: UpsertCustomerPriceOverridePayload!  # Update a customer price override
updateEntityNote: EntityNotePayload!  # Save note changes independently of embedding success
updateEstimate: UpsertEstimatePayload!  # Update an estimate
updateEstimateLine: UpsertEstimateLinePayload!  # Update an estimate line
updateInvoice: UpsertInvoicePayload!  # Update an existing invoice
updateInvoiceLine: UpsertInvoiceLinePayload!  # Update an invoice line
updateOrder: UpsertOrderPayload!  # Update an order
updateOrderLine: UpsertOrderLinePayload!  # Update an order line
updatePriceBracket: UpsertPriceBracketPayload!  # Update a price bracket
updateProduct: UpsertProductPayload!  # Update a product
updateProductTemplate: UpsertProductTemplatePayload!  # Update a product template
updatePurchaseOrder: UpsertPurchaseOrderPayload!  # Update a purchase order
updatePurchaseOrderLine: UpsertPurchaseOrderLinePayload!  # Update a purchase order line
updateSupplier: UpsertSupplierPayload!  # Update a supplier
updateTaxCode: UpsertTaxCodePayload!  # Update a tax code
upsertAddress: UpsertAddressPayload!  # Create or update an address
upsertBusinessUnit: UpsertBusinessUnitPayload!  # Create or update a business unit
upsertContact: UpsertContactPayload!  # Create or update a contact
upsertCostCenter: UpsertCostCenterPayload!  # Create or update a cost center
upsertCustomer: UpsertCustomerPayload!  # Create or update a customer
upsertCustomerPriceOverride: UpsertCustomerPriceOverridePayload!  # Create or update a customer price override
upsertEstimate: UpsertEstimatePayload!  # Create or update an estimate
upsertEstimateLine: UpsertEstimateLinePayload!  # Create or update an estimate line
upsertInvoice: UpsertInvoicePayload!  # Create or update an invoice
upsertInvoiceLine: UpsertInvoiceLinePayload!  # Create or update an invoice line
upsertOrder: UpsertOrderPayload!  # Create or update an order
upsertOrderLine: UpsertOrderLinePayload!  # Create or update an order line
upsertPriceBracket: UpsertPriceBracketPayload!  # Create or update a price bracket
upsertProduct: UpsertProductPayload!  # Create or update a product
upsertProductTemplate: UpsertProductTemplatePayload!  # Create or update a product template
upsertPurchaseOrder: UpsertPurchaseOrderPayload!  # Create or update a purchase order
upsertPurchaseOrderLine: UpsertPurchaseOrderLinePayload!  # Create or update a purchase order line
upsertSupplier: UpsertSupplierPayload!  # Create or update a supplier
upsertTaxCode: UpsertTaxCodePayload!  # Create or update a tax code
# Subscription
dataChangeEvents: DataChangeEvent!  # Subscribe to real-time data change events

# Call describe_operation(name) for arguments and input types.
```

## Exact schema

Download [complete SDL](/schemas/order-intake.graphql) (408672 bytes). Use the SDL to validate operations; the digest omits argument signatures.

## Guides
- [CRM — working with customers, contacts and addresses](/docs/data-model/erp#crm-working-with-customers-contacts-and-addresses)
- [Estimates — prepare and revise an offer](/docs/data-model/erp#estimates-prepare-and-revise-an-offer)
- [Orders — record what the customer is buying](/docs/data-model/erp#orders-record-what-the-customer-is-buying)
- [From a sale to production](/docs/data-model/erp#from-a-sale-to-production)
- [Start the printing job](/docs/data-model/production#start-the-printing-job)
- [Find product templates and published versions](/docs/data-model/production#find-product-templates-and-published-versions)
- [ERP API reference](/docs/data-model/erp-reference)
- [Production API reference](/docs/data-model/production-reference)
- [Product Template Authoring Guide](/docs/product-templates/authoring)
- [Suppliers and purchase orders](/docs/data-model/erp#suppliers-and-purchase-orders)
- [Receive and count warehouse stock](/docs/data-model/logistics#receive-and-count-warehouse-stock)
- [Supply materials to a printing job](/docs/data-model/logistics#supply-materials-to-a-printing-job)
- [Plan the customer delivery](/docs/data-model/logistics#plan-the-customer-delivery)
- [Record delivery requirements](/docs/data-model/logistics#record-delivery-requirements)
- [Prepare shipments and packages](/docs/data-model/logistics#prepare-shipments-and-packages)
- [Record dispatch, receipt and returns](/docs/data-model/logistics#record-dispatch-receipt-and-returns)
- [Review fulfilment and complete the order](/docs/data-model/logistics#review-fulfilment-and-complete-the-order)
- [Warehousing and Logistics API reference](/docs/data-model/logistics-reference)
- [Read locations and carriers](/docs/data-model/logistics#read-locations-and-carriers)
- [Read configured costs and check quoting readiness](/docs/data-model/erp#read-configured-costs-and-check-quoting-readiness)
- [Record and review actual job costs](/docs/data-model/erp#record-and-review-actual-job-costs)
- [Review production and costs](/docs/data-model/production#review-production-and-costs)
- [Invoices, credit notes and payments](/docs/data-model/erp#invoices-credit-notes-and-payments)
- [Business units and cost centres](/docs/data-model/erp#business-units-and-cost-centres)